Struct screeps_api::websocket::objects::StructurePortal

pub struct StructurePortal {
    pub id: String,
    pub room: RoomName,
    pub x: u32,
    pub y: u32,
    pub unstable_date: Option<Timespec>,
    pub decay_time: Option<u32>,
    pub destination: PortalDestination,
}

A portal object, which creeps can use to exit this room into another room somewhere else.

Fields

id: String

Unique 'id' identifier for all game objects on a server.

room: RoomName

Room object is in.

x: u32

X position within the room (0-50).

y: u32

Y position within the room (0-50).

unstable_date: Option<Timespec>

The date at which this portal will "destabilize" and start decaying. After this date passes, there will be a set number of ticks left for the portal to live.

Will be None if this portal is already de-stable.

decay_time: Option<u32>

The game time at which this portal will no longer exist. This property will be None while the portal is still "stable" - see unstable_date.

destination: PortalDestination

Where creeps entering this portal will end up.

Methods

impl StructurePortal

pub fn update(&mut self, update: StructurePortalUpdate)

Updates this structure with all values present in the given update.

Trait Implementations

impl PartialEq<StructurePortal> for StructurePortal

fn eq(&self, other: &StructurePortal) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &StructurePortal) -> bool

This method tests for !=.

impl Clone for StructurePortal

fn clone(&self) -> StructurePortal

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for StructurePortal

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for StructurePortal

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.