Struct screeps::objects::PowerCreep

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

A PowerCreep unit in the game world.

Screeps documentation

Implementations

impl PowerCreep

pub fn create(name: &JsString, _class: PowerCreepClass) -> ReturnCode

Create a new power creep in your account. Note that it will not initially be spawned.

Screeps documentation

impl PowerCreep

pub fn class(&self) -> PowerCreepClass

Retrieve this power creep’s PowerCreepClass.

Screeps documentation

impl PowerCreep

pub fn hits(&self) -> u32

Retrieve the current hits of this power creep.

Screeps documentation

impl PowerCreep

pub fn hits_max(&self) -> u32

Retrieve the maximum hits of this power creep.

Screeps documentation

impl PowerCreep

pub fn level(&self) -> u32

Current level of the power creep, which can be increased with [PowerCreep::upgrade] if you have unspent GPL.

Screeps documentation

impl PowerCreep

pub fn memory(&self) -> JsValue

A shortcut to Memory.powerCreeps[power_creep.name].

Screeps documentation

impl PowerCreep

pub fn set_memory(&self, val: &JsValue)

Sets a new value to Memory.powerCreeps[power_creep.name].

Screeps documentation

impl PowerCreep

pub fn my(&self) -> bool

Whether this power creep is owned by the player.

Screeps documentation

impl PowerCreep

pub fn owner(&self) -> Owner

The Owner of this power creep that contains the owner’s username.

Screeps documentation

impl PowerCreep

pub fn saying(&self) -> Option<JsString>

What the power creep said last tick.

Screeps documentation

impl PowerCreep

pub fn store(&self) -> Store

The Store of the power creep, which contains information about what resources it is it carrying.

Screeps documentation

impl PowerCreep

pub fn shard(&self) -> Option<JsString>

The shard the power creep is currently spawned on, if spawned.

Screeps documentation

impl PowerCreep

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

The number of ticks the power creep has left to live, which can be renewed at a StructurePowerSpawn or [StructurePowerBank]

Screeps documentation

impl PowerCreep

pub fn cancel_order(&self, target: &JsString) -> ReturnCode

Cancel an a successfully called power creep function from earlier in the tick, with a JsString that must contain the JS version of the function name.

Screeps documentation

impl PowerCreep

pub fn drop(&self, ty: ResourceType, amount: Option<u32>) -> ReturnCode

Drop a resource on the ground from the power creep’s Store.

Screeps documentation

impl PowerCreep

pub fn enable_room(&self, target: &StructureController) -> ReturnCode

Enable powers to be used in this room on a StructureController in melee range. You do not need to own the controller.

Screeps documentation

impl PowerCreep

pub fn move_direction(&self, direction: Direction) -> ReturnCode

Move one square in the specified direction.

Screeps documentation

impl PowerCreep

pub fn move_by_path(&self, path: &JsValue) -> ReturnCode

Move the power creep along a previously determined path returned from a pathfinding function, in array or serialized string form.

Screeps documentation

impl PowerCreep

pub fn notify_when_attacked(&self, enabled: bool) -> ReturnCode

Whether to send an email notification when this power creep is attacked.

Screeps documentation

impl PowerCreep

pub fn pickup(&self, target: &Resource) -> ReturnCode

Pick up a Resource in melee range (or at the same position as the creep).

Screeps documentation

impl PowerCreep

pub fn renew(&self, target: &RoomObject) -> ReturnCode

Renew the power creep’s TTL using a StructurePowerSpawn or [StructurePowerBank] in melee range.

Screeps documentation

impl PowerCreep

pub fn say(&self, message: &str, public: bool) -> ReturnCode

Display a string in a bubble above the power creep next tick. 10 character limit.

Screeps documentation

impl PowerCreep

pub fn suicide(&self) -> ReturnCode

Immediately kill the power creep.

Screeps documentation

impl PowerCreep

pub fn use_power( &self, power: PowerType, target: Option<&RoomObject> ) -> ReturnCode

Use one of the power creep’s powers.

Screeps documentation

impl PowerCreep

pub fn powers(&self) -> JsHashMap<PowerType, PowerInfo>

The levels of this power creep’s abilities, with PowerType keys and values containing power level and cooldown.

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 PowerCreep

fn as_ref(&self) -> &JsValue

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

impl AsRef<PowerCreep> for PowerCreep

fn as_ref(&self) -> &PowerCreep

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

impl AsRef<RoomObject> for PowerCreep

fn as_ref(&self) -> &RoomObject

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

impl Clone for PowerCreep

fn clone(&self) -> PowerCreep

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PowerCreep

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

Formats the value using the given formatter.

impl Deref for PowerCreep

type Target = RoomObject

The resulting type after dereferencing.

fn deref(&self) -> &RoomObject

Dereferences the value.

impl From<JsValue> for PowerCreep

fn from(obj: JsValue) -> PowerCreep

Converts to this type from the input type.

impl From<PowerCreep> for JsValue

fn from(obj: PowerCreep) -> JsValue

Converts to this type from the input type.

impl From<PowerCreep> for MovableObject

fn from(v: PowerCreep) -> MovableObject

Converts to this type from the input type.

impl From<PowerCreep> for ObjectWithMaybeId

fn from(v: PowerCreep) -> ObjectWithMaybeId

Converts to this type from the input type.

impl From<PowerCreep> for ObjectWithPosition

fn from(v: PowerCreep) -> ObjectWithPosition

Converts to this type from the input type.

impl From<PowerCreep> for RoomObject

fn from(obj: PowerCreep) -> RoomObject

Converts to this type from the input type.

impl From<PowerCreep> for StoreObject

fn from(v: PowerCreep) -> StoreObject

Converts to this type from the input type.

impl From<PowerCreep> for TransferableObject

fn from(v: PowerCreep) -> TransferableObject

Converts to this type from the input type.

impl From<PowerCreep> for TypedRoomObject

fn from(v: PowerCreep) -> TypedRoomObject

Converts to this type from the input type.

impl FromWasmAbi for PowerCreep

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 HasHits for PowerCreep

fn hits(&self) -> u32

Retrieve the current hits of this object.

fn hits_max(&self) -> u32

Retrieve the maximum hits of this object.

impl HasNativeId for PowerCreep

fn native_id(&self) -> JsString

impl HasStore for PowerCreep

fn store(&self) -> Store

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

impl<'a> IntoWasmAbi for &'a PowerCreep

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 PowerCreep

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 PowerCreep

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 PowerCreep

type Abi = <JsValue as LongRefFromWasmAbi>::Abi

Same as RefFromWasmAbi::Abi

type Anchor = PowerCreep

Same as RefFromWasmAbi::Anchor

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

Same as RefFromWasmAbi::ref_from_abi

impl OptionFromWasmAbi for PowerCreep

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 PowerCreep

fn none() -> Self::Abi

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

impl OptionIntoWasmAbi for PowerCreep

fn none() -> Self::Abi

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

impl RefFromWasmAbi for PowerCreep

type Abi = <JsValue as RefFromWasmAbi>::Abi

The wasm ABI type references to Self are recovered from.

type Anchor = ManuallyDrop<PowerCreep>

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 SharedCreepProperties for PowerCreep

fn memory(&self) -> JsValue

A shortcut to the part of the Memory tree used for this creep by default

fn set_memory(&self, val: &JsValue)

Sets a new value to the memory object shortcut for this creep.

fn my(&self) -> bool

Whether this creep is owned by the player.

fn name(&self) -> String

The creep’s name as an owned reference to a String.

fn owner(&self) -> Owner

The Owner of this creep that contains the owner’s username.

fn saying(&self) -> Option<JsString>

What the creep said last tick.

fn ticks_to_live(&self) -> Option<u32>

The number of ticks the creep has left to live.

fn cancel_order(&self, target: &JsString) -> ReturnCode

Cancel an a successfully called creep function from earlier in the tick, with a JsString that must contain the JS version of the function name.

fn drop(&self, ty: ResourceType, amount: Option<u32>) -> ReturnCode

Drop a resource on the ground from the creep’s Store.

fn move_direction(&self, direction: Direction) -> ReturnCode

Move one square in the specified direction.

fn move_by_path(&self, path: &JsValue) -> ReturnCode

Move the creep along a previously determined path returned from a pathfinding function, in array or serialized string form.

fn move_to<T>(&self, target: T) -> ReturnCodewhere T: HasPosition,

Move the creep toward the specified goal, either a RoomPosition or RoomObject. Note that using this function will store data in Memory.creeps[creep_name] and enable the default serialization behavior of the Memory object, which may hamper attempts to directly use RawMemory.

fn move_to_with_options<T, F>( &self, target: T, options: Option<MoveToOptions<F>> ) -> ReturnCodewhere T: HasPosition, F: FnMut(RoomName, CostMatrix) -> SingleRoomCostResult,

Move the creep toward the specified goal, either a RoomPosition or RoomObject. Note that using this function will store data in Memory.creeps[creep_name] and enable the default serialization behavior of the Memory object, which may hamper attempts to directly use RawMemory.

fn notify_when_attacked(&self, enabled: bool) -> ReturnCode

Whether to send an email notification when this creep is attacked.

fn pickup(&self, target: &Resource) -> ReturnCode

Pick up a Resource in melee range (or at the same position as the creep).

fn say(&self, message: &str, public: bool) -> ReturnCode

Display a string in a bubble above the creep next tick. 10 character limit.

fn suicide(&self) -> ReturnCode

Immediately kill the creep.

fn transfer<T>( &self, target: &T, ty: ResourceType, amount: Option<u32> ) -> ReturnCodewhere T: Transferable,

Transfer a resource from the creep’s store to Structure, PowerCreep, or another Creep.

fn withdraw<T>( &self, target: &T, ty: ResourceType, amount: Option<u32> ) -> ReturnCodewhere T: Withdrawable,

Withdraw a resource from a Structure, Tombstone, or Ruin.

impl TryInto<PowerCreep> for MovableObject

type Error = &'static str

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryInto<PowerCreep> for ObjectWithMaybeId

type Error = &'static str

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryInto<PowerCreep> for ObjectWithPosition

type Error = &'static str

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryInto<PowerCreep> for StoreObject

type Error = &'static str

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryInto<PowerCreep> for TransferableObject

type Error = &'static str

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryInto<PowerCreep> for TypedRoomObject

type Error = &'static str

The type returned in the event of a conversion error.

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

Performs the conversion.

impl WasmDescribe for PowerCreep

fn describe()

impl Attackable for PowerCreep

impl Healable for PowerCreep

impl Transferable for PowerCreep