Struct screeps::objects::Structure

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

Parent class for all objects that represent a structure in the game world.

Screeps documentation

Implementations

impl Structure

pub fn hits(&self) -> u32

Retrieve the current hits of this structure, or 0 if this structure is indestructible, such as a notice area border wall, portal, or room controller.

Screeps documentation

impl Structure

pub fn hits_max(&self) -> u32

Retrieve the maximum hits of this structure, or 0 if this structure is indestructible, such as a notice area border wall, portal, or room controller.

Screeps documentation

impl Structure

pub fn structure_type(&self) -> StructureType

The type of structure this is.

Screeps documentation

impl Structure

pub fn destroy(&self) -> i8

Destroy the structure, if possible.

Screeps documentation

impl Structure

pub fn is_active(&self) -> bool

Determine if the structure is active and can be used at the current RCL.

Screeps documentation

impl Structure

pub fn notify_when_attacked(&self, val: bool) -> i8

Set whether a notification email should be sent when the structure is attacked.

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::_new(JSIDX_NULL)

pub const UNDEFINED: JsValue = JsValue::_new(JSIDX_UNDEFINED)

pub const TRUE: JsValue = JsValue::_new(JSIDX_TRUE)

pub const FALSE: JsValue = JsValue::_new(JSIDX_FALSE)

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 Structure

fn as_ref(&self) -> &JsValue

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

impl AsRef<RoomObject> for Structure

fn as_ref(&self) -> &RoomObject

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

impl AsRef<Structure> for OwnedStructure

fn as_ref(&self) -> &Structure

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

impl AsRef<Structure> for Structure

fn as_ref(&self) -> &Structure

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

impl AsRef<Structure> for StructureContainer

fn as_ref(&self) -> &Structure

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<Structure> for StructureExtension

fn as_ref(&self) -> &Structure

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

impl AsRef<Structure> for StructureExtractor

fn as_ref(&self) -> &Structure

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

impl AsRef<Structure> for StructureFactory

fn as_ref(&self) -> &Structure

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

impl AsRef<Structure> for StructureInvaderCore

fn as_ref(&self) -> &Structure

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

impl AsRef<Structure> for StructureKeeperLair

fn as_ref(&self) -> &Structure

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

impl AsRef<Structure> for StructureLab

fn as_ref(&self) -> &Structure

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

impl AsRef<Structure> for StructureLink

fn as_ref(&self) -> &Structure

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

impl AsRef<Structure> for StructureNuker

fn as_ref(&self) -> &Structure

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

impl AsRef<Structure> for StructureObserver

fn as_ref(&self) -> &Structure

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

impl AsRef<Structure> for StructurePortal

fn as_ref(&self) -> &Structure

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

impl AsRef<Structure> for StructurePowerBank

fn as_ref(&self) -> &Structure

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

impl AsRef<Structure> for StructurePowerSpawn

fn as_ref(&self) -> &Structure

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

impl AsRef<Structure> for StructureRampart

fn as_ref(&self) -> &Structure

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

impl AsRef<Structure> for StructureRoad

fn as_ref(&self) -> &Structure

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

impl AsRef<Structure> for StructureSpawn

fn as_ref(&self) -> &Structure

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

impl AsRef<Structure> for StructureStorage

fn as_ref(&self) -> &Structure

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

impl AsRef<Structure> for StructureTerminal

fn as_ref(&self) -> &Structure

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

impl AsRef<Structure> for StructureTower

fn as_ref(&self) -> &Structure

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

impl AsRef<Structure> for StructureWall

fn as_ref(&self) -> &Structure

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

impl Clone for Structure

fn clone(&self) -> Structure

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Structure

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

Formats the value using the given formatter.

impl Deref for Structure

type Target = RoomObject

The resulting type after dereferencing.

fn deref(&self) -> &RoomObject

Dereferences the value.

impl From<JsValue> for Structure

fn from(obj: JsValue) -> Structure

Converts to this type from the input type.

impl From<OwnedStructure> for Structure

fn from(obj: OwnedStructure) -> Structure

Converts to this type from the input type.

impl From<Structure> for JsValue

fn from(obj: Structure) -> JsValue

Converts to this type from the input type.

impl From<Structure> for RoomObject

fn from(obj: Structure) -> RoomObject

Converts to this type from the input type.

impl From<Structure> for StructureObject

fn from(structure: Structure) -> Self

Converts to this type from the input type.

impl From<StructureContainer> for Structure

fn from(obj: StructureContainer) -> Structure

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<StructureExtension> for Structure

fn from(obj: StructureExtension) -> Structure

Converts to this type from the input type.

impl From<StructureExtractor> for Structure

fn from(obj: StructureExtractor) -> Structure

Converts to this type from the input type.

impl From<StructureFactory> for Structure

fn from(obj: StructureFactory) -> Structure

Converts to this type from the input type.

impl From<StructureInvaderCore> for Structure

fn from(obj: StructureInvaderCore) -> Structure

Converts to this type from the input type.

impl From<StructureKeeperLair> for Structure

fn from(obj: StructureKeeperLair) -> Structure

Converts to this type from the input type.

impl From<StructureLab> for Structure

fn from(obj: StructureLab) -> Structure

Converts to this type from the input type.

impl From<StructureLink> for Structure

fn from(obj: StructureLink) -> Structure

Converts to this type from the input type.

impl From<StructureNuker> for Structure

fn from(obj: StructureNuker) -> Structure

Converts to this type from the input type.

impl From<StructureObserver> for Structure

fn from(obj: StructureObserver) -> Structure

Converts to this type from the input type.

impl From<StructurePortal> for Structure

fn from(obj: StructurePortal) -> Structure

Converts to this type from the input type.

impl From<StructurePowerBank> for Structure

fn from(obj: StructurePowerBank) -> Structure

Converts to this type from the input type.

impl From<StructurePowerSpawn> for Structure

fn from(obj: StructurePowerSpawn) -> Structure

Converts to this type from the input type.

impl From<StructureRampart> for Structure

fn from(obj: StructureRampart) -> Structure

Converts to this type from the input type.

impl From<StructureRoad> for Structure

fn from(obj: StructureRoad) -> Structure

Converts to this type from the input type.

impl From<StructureSpawn> for Structure

fn from(obj: StructureSpawn) -> Structure

Converts to this type from the input type.

impl From<StructureStorage> for Structure

fn from(obj: StructureStorage) -> Structure

Converts to this type from the input type.

impl From<StructureTerminal> for Structure

fn from(obj: StructureTerminal) -> Structure

Converts to this type from the input type.

impl From<StructureTower> for Structure

fn from(obj: StructureTower) -> Structure

Converts to this type from the input type.

impl From<StructureWall> for Structure

fn from(obj: StructureWall) -> Structure

Converts to this type from the input type.

impl FromWasmAbi for Structure

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 Structure

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 Structure

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 Structure

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 Structure

type Abi = <JsValue as LongRefFromWasmAbi>::Abi

Same as RefFromWasmAbi::Abi

type Anchor = Structure

Same as RefFromWasmAbi::Anchor

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

Same as RefFromWasmAbi::ref_from_abi

impl OptionFromWasmAbi for Structure

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 Structure

fn none() -> Self::Abi

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

impl OptionIntoWasmAbi for Structure

fn none() -> Self::Abi

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

impl RefFromWasmAbi for Structure

type Abi = <JsValue as RefFromWasmAbi>::Abi

The wasm ABI type references to Self are recovered from.

type Anchor = ManuallyDrop<Structure>

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 WasmDescribe for Structure

fn describe()