Struct screeps_api::websocket::objects::Source

pub struct Source {
    pub id: String,
    pub room: RoomName,
    pub x: u32,
    pub y: u32,
    pub energy: i32,
    pub energy_capacity: i32,
    pub invader_harvested: u32,
    pub next_regeneration_time: Option<u32>,
    pub ticks_to_regeneration: u32,
}

A source object, which creeps can gain energy by mining from.

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).

energy: i32

The source's current energy - available to be mined be creeps.

energy_capacity: i32

The source's maximum energy - what energy resets to on regeneration.

invader_harvested: u32

The amount of energy either harvested on this source specifically or for the room since the last invasion (not sure which it is).

next_regeneration_time: Option<u32>

The game time at which the source will next regenerate. None when waiting on a creep to first harvest it.

ticks_to_regeneration: u32

The number of ticks between when a source is first harvested after regeneration and when it next regenerates.

Methods

impl Source

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

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

Trait Implementations

impl PartialEq<Source> for Source

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

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

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

This method tests for !=.

impl Clone for Source

fn clone(&self) -> Source

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Source

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Source

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

Deserialize this value from the given Serde deserializer.