Struct screeps::objects::ScoreCollector

pub struct ScoreCollector { /* private fields */ }

Available on crate feature seasonal-season-1 only.

An object representing a ScoreCollector, which can have ResourceType::Score transferred to it in order to score points on the leaderboard.

Screeps documentation

Implementations

impl ScoreCollector

pub fn store(&self) -> Store

The Store of the container, which contains information about what resources it is it holding.

Screeps documentation

Methods from Deref<Target = RoomObject>

pub fn js_pos(&self) -> RoomPosition

Gets the RoomPosition of an object, which is a reference to an object in the javascript heap. In most cases, you’ll likely want a native Position instead of using this function (see HasPosition::pos), there may be cases where this can provide some slight performance benefits due to reducing object churn in the js heap, so this is kept public.

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 = _

pub const UNDEFINED: JsValue = _

pub const TRUE: JsValue = _

pub const FALSE: JsValue = _

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 ScoreCollector

fn as_ref(&self) -> &JsValue

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

impl AsRef<RoomObject> for ScoreCollector

fn as_ref(&self) -> &RoomObject

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

impl AsRef<ScoreCollector> for ScoreCollector

fn as_ref(&self) -> &ScoreCollector

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

impl Clone for ScoreCollector

fn clone(&self) -> ScoreCollector

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ScoreCollector

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

Formats the value using the given formatter.

impl Deref for ScoreCollector

type Target = RoomObject

The resulting type after dereferencing.

fn deref(&self) -> &RoomObject

Dereferences the value.

impl From<JsValue> for ScoreCollector

fn from(obj: JsValue) -> ScoreCollector

Converts to this type from the input type.

impl From<ScoreCollector> for JsValue

fn from(obj: ScoreCollector) -> JsValue

Converts to this type from the input type.

impl From<ScoreCollector> for ObjectWithPosition

fn from(v: ScoreCollector) -> ObjectWithPosition

Converts to this type from the input type.

impl From<ScoreCollector> for RoomObject

fn from(obj: ScoreCollector) -> RoomObject

Converts to this type from the input type.

impl From<ScoreCollector> for StoreObject

fn from(v: ScoreCollector) -> StoreObject

Converts to this type from the input type.

impl From<ScoreCollector> for TypedRoomObject

fn from(v: ScoreCollector) -> TypedRoomObject

Converts to this type from the input type.

impl FromWasmAbi for ScoreCollector

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 HasId for ScoreCollector

fn js_raw_id(&self) -> JsString

Object ID of the object stored in JavaScript memory, without its associated type information.

fn id(&self) -> ObjectId<Self>

where Self: Sized,

Object ID of the object stored in Rust memory, which can be used to efficiently fetch a fresh reference to the object on subsequent ticks.

fn raw_id(&self) -> RawObjectId

Object ID of the object stored in Rust memory, without its associated type information.

fn js_id(&self) -> JsObjectId<Self>

where Self: Sized,

Object ID of the object stored in JavaScript memory, which can be used to efficiently fetch a fresh reference to the object on subsequent ticks.

impl HasStore for ScoreCollector

fn store(&self) -> Store

The store of the object, containing information about the resources it is holding.

impl<'a> IntoWasmAbi for &'a ScoreCollector

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 ScoreCollector

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 ScoreCollector

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

where 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) -> T

where T: JsCast,

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

fn unchecked_ref<T>(&self) -> &T

where T: JsCast,

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

fn is_instance_of<T>(&self) -> bool

where 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 ScoreCollector

type Abi = <JsValue as LongRefFromWasmAbi>::Abi

Same as RefFromWasmAbi::Abi

type Anchor = ScoreCollector

Same as RefFromWasmAbi::Anchor

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

Same as RefFromWasmAbi::ref_from_abi

impl OptionFromWasmAbi for ScoreCollector

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 ScoreCollector

fn none() -> Self::Abi

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

impl OptionIntoWasmAbi for ScoreCollector

fn none() -> Self::Abi

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

impl RefFromWasmAbi for ScoreCollector

type Abi = <JsValue as RefFromWasmAbi>::Abi

The wasm ABI type references to Self are recovered from.

type Anchor = ManuallyDrop<ScoreCollector>

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<ScoreCollector> for ObjectWithPosition

type Error = &'static str

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryInto<ScoreCollector> for StoreObject

type Error = &'static str

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryInto<ScoreCollector> for TypedRoomObject

type Error = &'static str

The type returned in the event of a conversion error.

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

Performs the conversion.

impl WasmDescribe for ScoreCollector

fn describe()

impl Transferable for ScoreCollector