Struct screeps::objects::StructureController

#[repr(transparent)]
pub struct StructureController { /* private fields */ }

An object representing a StructureController.

Screeps documentation

Implementations

impl StructureController

pub fn is_power_enabled(&self) -> bool

Whether power is enabled in the room, allowing power creeps to use powers.

Screeps documentation

impl StructureController

pub fn level(&self) -> u8

The current room control level (RCL) of the room.

Screeps documentation

impl StructureController

pub fn progress(&self) -> u32

The progress toward upgrading the controller to the next level

Screeps documentation

impl StructureController

pub fn progress_total(&self) -> u32

The total StructureController::progress needed to upgrade the controller to the next level.

Screeps documentation

impl StructureController

pub fn reservation(&self) -> Option<Reservation>

Information about the reservation of this controller, if it is currently reserved.

Screeps documentation

impl StructureController

pub fn safe_mode(&self) -> Option<u32>

The number of ticks remaining in safe mode, or 0 if safe mode isn’t currently active.

Screeps documentation

impl StructureController

pub fn safe_mode_available(&self) -> u32

The number of of available safe mode activations, which can be increased by using Creep::generate_safe_mode

Screeps documentation

impl StructureController

pub fn safe_mode_cooldown(&self) -> Option<u32>

The cooldown remaining until safe mode can be activated again.

Screeps documentation

impl StructureController

pub fn sign(&self) -> Option<Sign>

Information about the sign on this controller, if it has been signed by Creep::sign_controller.

Screeps documentation

impl StructureController

pub fn ticks_to_downgrade(&self) -> u32

The number of ticks until the level of the controller will be decremented due to a lack of [Creep::upgrade_controller] activity.

Screeps documentation

impl StructureController

pub fn upgrade_blocked(&self) -> u32

The number of ticks until the controller can be upgraded, or have safe mode activated, due to Creep::attack_controller.

Screeps documentation

impl StructureController

pub fn activate_safe_mode(&self) -> ReturnCode

Activate safe mode for the room, preventing hostile creep actions in the room for 20,000 ticks

Screeps documentation

impl StructureController

pub fn unclaim(&self) -> ReturnCode

Relinquish ownership of the controller and its room.

Screeps documentation

Methods from Deref<Target = RoomObject>

pub fn pos(&self) -> RoomPosition

Position of the object.

Screeps documentation

pub fn room(&self) -> Option<Room>

A link to the room that the object is currently in, or None if the object is a power creep not spawned on the current shard, or a flag or construction site not in a visible room.

Screeps documentation

Methods from Deref<Target = JsValue>

pub const NULL: JsValue = JsValue{ idx: JSIDX_NULL, _marker: marker::PhantomData,}

pub const UNDEFINED: JsValue = JsValue{ idx: JSIDX_UNDEFINED, _marker: marker::PhantomData,}

pub const TRUE: JsValue = JsValue{ idx: JSIDX_TRUE, _marker: marker::PhantomData,}

pub const FALSE: JsValue = JsValue{ idx: JSIDX_FALSE, _marker: marker::PhantomData,}

pub fn as_f64(&self) -> Option<f64>

Returns the f64 value of this JS value if it’s an instance of a number.

If this JS value is not an instance of a number then this returns None.

pub fn is_string(&self) -> bool

Tests whether this JS value is a JS string.

pub fn as_string(&self) -> Option<String>

Available on crate feature std only.

If this JS value is a string value, this function copies the JS string value into wasm linear memory, encoded as UTF-8, and returns it as a Rust String.

To avoid the copying and re-encoding, consider the JsString::try_from() function from js-sys instead.

If this JS value is not an instance of a string or if it’s not valid utf-8 then this returns None.

UTF-16 vs UTF-8

JavaScript strings in general are encoded as UTF-16, but Rust strings are encoded as UTF-8. This can cause the Rust string to look a bit different than the JS string sometimes. For more details see the documentation about the str type which contains a few caveats about the encodings.

pub fn as_bool(&self) -> Option<bool>

Returns the bool value of this JS value if it’s an instance of a boolean.

If this JS value is not an instance of a boolean then this returns None.

pub fn is_null(&self) -> bool

Tests whether this JS value is null

pub fn is_undefined(&self) -> bool

Tests whether this JS value is undefined

pub fn is_symbol(&self) -> bool

Tests whether the type of this JS value is symbol

pub fn is_object(&self) -> bool

Tests whether typeof self == "object" && self !== null.

pub fn is_array(&self) -> bool

Tests whether this JS value is an instance of Array.

pub fn is_function(&self) -> bool

Tests whether the type of this JS value is function.

pub fn is_bigint(&self) -> bool

Tests whether the type of this JS value is bigint.

pub fn js_typeof(&self) -> JsValue

Applies the unary typeof JS operator on a JsValue.

MDN documentation

pub fn js_in(&self, obj: &JsValue) -> bool

Applies the binary in JS operator on the two JsValues.

MDN documentation

pub fn is_truthy(&self) -> bool

Tests whether the value is “truthy”.

pub fn is_falsy(&self) -> bool

Tests whether the value is “falsy”.

pub fn loose_eq(&self, other: &JsValue) -> bool

Compare two JsValues for equality, using the == operator in JS.

MDN documentation

pub fn bit_not(&self) -> JsValue

Applies the unary ~ JS operator on a JsValue.

MDN documentation

pub fn unsigned_shr(&self, rhs: &JsValue) -> u32

Applies the binary >>> JS operator on the two JsValues.

MDN documentation

pub fn checked_div(&self, rhs: &JsValue) -> JsValue

Applies the binary / JS operator on two JsValues, catching and returning any RangeError thrown.

MDN documentation

pub fn pow(&self, rhs: &JsValue) -> JsValue

Applies the binary ** JS operator on the two JsValues.

MDN documentation

pub fn lt(&self, other: &JsValue) -> bool

Applies the binary < JS operator on the two JsValues.

MDN documentation

pub fn le(&self, other: &JsValue) -> bool

Applies the binary <= JS operator on the two JsValues.

MDN documentation

pub fn ge(&self, other: &JsValue) -> bool

Applies the binary >= JS operator on the two JsValues.

MDN documentation

pub fn gt(&self, other: &JsValue) -> bool

Applies the binary > JS operator on the two JsValues.

MDN documentation

pub fn unchecked_into_f64(&self) -> f64

Applies the unary + JS operator on a JsValue. Can throw.

MDN documentation

Trait Implementations

impl AsRef<JsValue> for StructureController

fn as_ref(&self) -> &JsValue

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<OwnedStructure> for StructureController

fn as_ref(&self) -> &OwnedStructure

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<RoomObject> for StructureController

fn as_ref(&self) -> &RoomObject

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<Structure> for StructureController

fn as_ref(&self) -> &Structure

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<StructureController> for StructureController

fn as_ref(&self) -> &StructureController

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for StructureController

fn clone(&self) -> StructureController

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StructureController

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

Formats the value using the given formatter.

impl Deref for StructureController

type Target = RoomObject

The resulting type after dereferencing.

fn deref(&self) -> &RoomObject

Dereferences the value.

impl From<JsValue> for StructureController

fn from(obj: JsValue) -> StructureController

Converts to this type from the input type.

impl From<StructureController> for JsValue

fn from(obj: StructureController) -> JsValue

Converts to this type from the input type.

impl From<StructureController> for ObjectWithId

fn from(v: StructureController) -> ObjectWithId

Converts to this type from the input type.

impl From<StructureController> for ObjectWithMaybeId

fn from(v: StructureController) -> ObjectWithMaybeId

Converts to this type from the input type.

impl From<StructureController> for ObjectWithPosition

fn from(v: StructureController) -> ObjectWithPosition

Converts to this type from the input type.

impl From<StructureController> for OwnedStructure

fn from(obj: StructureController) -> OwnedStructure

Converts to this type from the input type.

impl From<StructureController> for OwnedStructureObject

fn from(v: StructureController) -> OwnedStructureObject

Converts to this type from the input type.

impl From<StructureController> for RoomObject

fn from(obj: StructureController) -> RoomObject

Converts to this type from the input type.

impl From<StructureController> for Structure

fn from(obj: StructureController) -> Structure

Converts to this type from the input type.

impl From<StructureController> for StructureObject

fn from(v: StructureController) -> StructureObject

Converts to this type from the input type.

impl From<StructureController> for TypedRoomObject

fn from(v: StructureController) -> TypedRoomObject

Converts to this type from the input type.

impl FromWasmAbi for StructureController

type Abi = <JsValue as FromWasmAbi>::Abi

The wasm ABI type that this converts from when coming back out from the ABI boundary.

unsafe fn from_abi(js: Self::Abi) -> Self

Recover a Self from Self::Abi.

impl<'a> IntoWasmAbi for &'a StructureController

type Abi = <&'a JsValue as IntoWasmAbi>::Abi

The wasm ABI type that this converts into when crossing the ABI boundary.

fn into_abi(self) -> Self::Abi

Convert self into Self::Abi so that it can be sent across the wasm ABI boundary.

impl IntoWasmAbi for StructureController

type Abi = <JsValue as IntoWasmAbi>::Abi

The wasm ABI type that this converts into when crossing the ABI boundary.

fn into_abi(self) -> Self::Abi

Convert self into Self::Abi so that it can be sent across the wasm ABI boundary.

impl JsCast for StructureController

fn instanceof(val: &JsValue) -> bool

Performs a dynamic instanceof check to see whether the JsValue provided is an instance of this type.

fn unchecked_from_js(val: JsValue) -> Self

Performs a zero-cost unchecked conversion from a JsValue into an instance of Self

fn unchecked_from_js_ref(val: &JsValue) -> &Self

Performs a zero-cost unchecked conversion from a &JsValue into an instance of &Self.

fn has_type<T>(&self) -> boolwhere T: JsCast,

Test whether this JS value has a type T.

fn dyn_into<T>(self) -> Result<T, Self>where T: JsCast,

Performs a dynamic cast (checked at runtime) of this value into the target type T.

fn dyn_ref<T>(&self) -> Option<&T>where T: JsCast,

Performs a dynamic cast (checked at runtime) of this value into the target type T.

fn unchecked_into<T>(self) -> Twhere T: JsCast,

Performs a zero-cost unchecked cast into the specified type.

fn unchecked_ref<T>(&self) -> &Twhere T: JsCast,

Performs a zero-cost unchecked cast into a reference to the specified type.

fn is_instance_of<T>(&self) -> boolwhere T: JsCast,

Test whether this JS value is an instance of the type T.

fn is_type_of(val: &JsValue) -> bool

Performs a dynamic check to see whether the JsValue provided is a value of this type.

impl LongRefFromWasmAbi for StructureController

type Abi = <JsValue as LongRefFromWasmAbi>::Abi

Same as RefFromWasmAbi::Abi

type Anchor = StructureController

Same as RefFromWasmAbi::Anchor

unsafe fn long_ref_from_abi(js: Self::Abi) -> Self::Anchor

Same as RefFromWasmAbi::ref_from_abi

impl OptionFromWasmAbi for StructureController

fn is_none(abi: &Self::Abi) -> bool

Tests whether the argument is a “none” instance. If so it will be deserialized as None, and otherwise it will be passed to FromWasmAbi.

impl<'a> OptionIntoWasmAbi for &'a StructureController

fn none() -> Self::Abi

Returns an ABI instance indicating “none”, which JS will interpret as the None branch of this option.

impl OptionIntoWasmAbi for StructureController

fn none() -> Self::Abi

Returns an ABI instance indicating “none”, which JS will interpret as the None branch of this option.

impl RefFromWasmAbi for StructureController

type Abi = <JsValue as RefFromWasmAbi>::Abi

The wasm ABI type references to Self are recovered from.

type Anchor = ManuallyDrop<StructureController>

The type that holds the reference to Self for the duration of the invocation of the function that has an &Self parameter. This is required to ensure that the lifetimes don’t persist beyond one function call, and so that they remain anonymous.

unsafe fn ref_from_abi(js: Self::Abi) -> Self::Anchor

Recover a Self::Anchor from Self::Abi.

impl TryInto<StructureController> for ObjectWithId

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into( self ) -> Result<StructureController, <Self as TryInto<StructureController>>::Error>

Performs the conversion.

impl TryInto<StructureController> for ObjectWithMaybeId

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into( self ) -> Result<StructureController, <Self as TryInto<StructureController>>::Error>

Performs the conversion.

impl TryInto<StructureController> for ObjectWithPosition

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into( self ) -> Result<StructureController, <Self as TryInto<StructureController>>::Error>

Performs the conversion.

impl TryInto<StructureController> for OwnedStructureObject

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into( self ) -> Result<StructureController, <Self as TryInto<StructureController>>::Error>

Performs the conversion.

impl TryInto<StructureController> for StructureObject

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into( self ) -> Result<StructureController, <Self as TryInto<StructureController>>::Error>

Performs the conversion.

impl TryInto<StructureController> for TypedRoomObject

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into( self ) -> Result<StructureController, <Self as TryInto<StructureController>>::Error>

Performs the conversion.

impl WasmDescribe for StructureController

fn describe()