Struct screeps::objects::Creep

pub struct Creep { /* private fields */ }

A Creep unit in the game world.

Screeps documentation

Implementations

impl Creep

pub fn body(&self) -> Vec<BodyPart>

Retrieve a Vec<BodyPart> containing details about the creep’s body parts and boosts.

Screeps documentation

pub fn fatigue(&self) -> u32

The amount of fatigue the creep has. If greater than 0, it cannot move this tick without being pulled.

Screeps documentation

pub fn hits(&self) -> u32

Retrieve the current hits of this creep.

Screeps documentation

pub fn hits_max(&self) -> u32

Retrieve the maximum hits of this creep, which generally equals 50 per body part.

Screeps documentation

pub fn memory(&self) -> JsValue

A shortcut to Memory.creeps[creep.name].

Screeps documentation

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

Sets a new value to Memory.creeps[creep.name].

Screeps documentation

pub fn my(&self) -> bool

Whether this creep is owned by the player.

Screeps documentation

pub fn owner(&self) -> Owner

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

Screeps documentation

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

What the creep said last tick.

Screeps documentation

pub fn spawning(&self) -> bool

Whether the creep is still spawning.

Screeps documentation

pub fn store(&self) -> Store

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

Screeps documentation

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

The number of ticks the creep has left to live

Screeps documentation

pub fn attack<T>(&self, target: &T) -> Result<(), ErrorCode>

where T: ?Sized + Attackable,

Attack a target in melee range using a creep’s attack parts.

Screeps documentation

pub fn attack_controller( &self, target: &StructureController ) -> Result<(), ErrorCode>

Attack a StructureController in melee range using a creep’s claim parts.

Screeps documentation

pub fn build(&self, target: &ConstructionSite) -> Result<(), ErrorCode>

Use a creep’s work parts to consume carried energy, putting it toward progress in a ConstructionSite in range 3.

Screeps documentation

pub fn cancel_order(&self, target: &JsString) -> Result<(), ErrorCode>

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.

Screeps documentation

pub fn claim_controller( &self, target: &StructureController ) -> Result<(), ErrorCode>

Claim an unowned StructureController in melee range as your own using a creep’s claim parts.

Screeps documentation

pub fn claim_reactor(&self, target: &Reactor) -> Result<(), ErrorCode>

Available on crate feature seasonal-season-5 only.

Claim a Reactor in melee range as your own using a creep’s claim parts.

Screeps documentation

pub fn dismantle<T>(&self, target: &T) -> Result<(), ErrorCode>

where T: ?Sized + Dismantleable,

Dismantle a Structure in melee range, removing DISMANTLE_POWER hits per effective work part, giving the creep energy equivalent to half of the cost to repair the same hits. Can only be used against types of structures that can be constructed; if StructureType::construction_cost is None, dismantling is impossible.

Screeps documentation

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

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

Screeps documentation

pub fn generate_safe_mode( &self, target: &StructureController ) -> Result<(), ErrorCode>

Consume ResourceType::Ghodium (in the amount of SAFE_MODE_COST) from the creep’s Store to add a safe mode activation to a StructureController in melee range.

Screeps documentation

pub fn get_active_bodyparts(&self, ty: Part) -> u8

Get the number of parts of the given type the creep has in its body, excluding fully damaged parts.

Screeps documentation

pub fn harvest<T>(&self, target: &T) -> Result<(), ErrorCode>

where T: ?Sized + Harvestable,

Harvest from a Source, Mineral, or Deposit in melee range.

Screeps documentation

pub fn heal<T>(&self, target: &T) -> Result<(), ErrorCode>

where T: ?Sized + Healable,

Heal a Creep or PowerCreep in melee range, including itself.

Screeps documentation

pub fn move_direction(&self, direction: Direction) -> Result<(), ErrorCode>

Move one square in the specified direction.

Screeps documentation

pub fn move_pulled_by(&self, target: &Creep) -> Result<(), ErrorCode>

Accept an attempt by another creep to pull this one.

Screeps documentation

pub fn move_by_path(&self, path: &JsValue) -> Result<(), ErrorCode>

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

Screeps documentation

pub fn notify_when_attacked(&self, enabled: bool) -> Result<(), ErrorCode>

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

Screeps documentation

pub fn pickup(&self, target: &Resource) -> Result<(), ErrorCode>

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

Screeps documentation

pub fn pull(&self, target: &Creep) -> Result<(), ErrorCode>

Help another creep to move by pulling, if the second creep accepts.

Screeps documentation

pub fn ranged_attack<T>(&self, target: &T) -> Result<(), ErrorCode>

where T: ?Sized + Attackable,

Attack a target in range 3 using a creep’s ranged attack parts.

Screeps documentation

pub fn ranged_heal<T>(&self, target: &T) -> Result<(), ErrorCode>

where T: ?Sized + Healable,

Heal a target in range 3 using a creep’s heal parts.

Screeps documentation

pub fn ranged_mass_attack(&self) -> Result<(), ErrorCode>

Attack all enemy targets in range using a creep’s ranged attack parts, with lower damage depending on range.

Screeps documentation

pub fn repair<T>(&self, target: &T) -> Result<(), ErrorCode>

where T: ?Sized + Repairable,

Repair a target in range 3 using carried energy and the creep’s work parts.

Screeps documentation

pub fn reserve_controller( &self, target: &StructureController ) -> Result<(), ErrorCode>

Reserve an unowned StructureController in melee range using a creep’s claim parts.

Screeps documentation

pub fn say(&self, message: &str, public: bool) -> Result<(), ErrorCode>

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

Screeps documentation

pub fn sign_controller( &self, target: &StructureController, text: &str ) -> Result<(), ErrorCode>

Add (or remove, using an empty string) a sign to a StructureController in melee range.

Screeps documentation

pub fn suicide(&self) -> Result<(), ErrorCode>

Immediately kill the creep.

Actions taken by the creep earlier in the tick may be cancelled.

Screeps documentation

pub fn upgrade_controller( &self, target: &StructureController ) -> Result<(), ErrorCode>

Upgrade a StructureController in range 3 using carried energy and the creep’s work parts.

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<Creep> for Creep

fn as_ref(&self) -> &Creep

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

impl AsRef<JsValue> for Creep

fn as_ref(&self) -> &JsValue

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

impl AsRef<RoomObject> for Creep

fn as_ref(&self) -> &RoomObject

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

impl Clone for Creep

fn clone(&self) -> Creep

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Creep

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

Formats the value using the given formatter.

impl Deref for Creep

type Target = RoomObject

The resulting type after dereferencing.

fn deref(&self) -> &RoomObject

Dereferences the value.

impl From<Creep> for JsValue

fn from(obj: Creep) -> JsValue

Converts to this type from the input type.

impl From<Creep> for MovableObject

fn from(v: Creep) -> MovableObject

Converts to this type from the input type.

impl From<Creep> for ObjectWithPosition

fn from(v: Creep) -> ObjectWithPosition

Converts to this type from the input type.

impl From<Creep> for RoomObject

fn from(obj: Creep) -> RoomObject

Converts to this type from the input type.

impl From<Creep> for StoreObject

fn from(v: Creep) -> StoreObject

Converts to this type from the input type.

impl From<Creep> for TransferableObject

fn from(v: Creep) -> TransferableObject

Converts to this type from the input type.

impl From<Creep> for TypedRoomObject

fn from(v: Creep) -> TypedRoomObject

Converts to this type from the input type.

impl From<JsValue> for Creep

fn from(obj: JsValue) -> Creep

Converts to this type from the input type.

impl FromWasmAbi for Creep

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 Creep

fn hits(&self) -> u32

Retrieve the current hits of this object.

fn hits_max(&self) -> u32

Retrieve the maximum hits of this object.

impl HasStore for Creep

fn store(&self) -> Store

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

impl<'a> IntoWasmAbi for &'a Creep

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 Creep

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 Creep

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 JsCollectionFromValue for Creep

fn from_value(val: JsValue) -> Self

impl LongRefFromWasmAbi for Creep

type Abi = <JsValue as LongRefFromWasmAbi>::Abi

Same as RefFromWasmAbi::Abi

type Anchor = Creep

Same as RefFromWasmAbi::Anchor

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

Same as RefFromWasmAbi::ref_from_abi

impl MaybeHasId for Creep

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

The Object ID of the Creep, or None if it began spawning this tick.

Screeps documentation

fn try_id(&self) -> Option<ObjectId<Self>>

where Self: Sized,

Object ID of the object, which can be used to efficiently fetch a fresh reference to the object on subsequent ticks, or None if the object doesn’t currently have an ID.

fn try_raw_id(&self) -> Option<RawObjectId>

Object ID of the object, without its associated type information, or None if the object doesn’t currently have an ID.

fn try_js_id(&self) -> Option<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, or None if the object doesn’t currently have an ID.

impl OptionFromWasmAbi for Creep

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 Creep

fn none() -> Self::Abi

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

impl OptionIntoWasmAbi for Creep

fn none() -> Self::Abi

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

impl RefFromWasmAbi for Creep

type Abi = <JsValue as RefFromWasmAbi>::Abi

The wasm ABI type references to Self are recovered from.

type Anchor = ManuallyDrop<Creep>

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 Creep

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) -> Result<(), ErrorCode>

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>) -> Result<(), ErrorCode>

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

fn move_direction(&self, direction: Direction) -> Result<(), ErrorCode>

Move one square in the specified direction.

fn move_by_path(&self, path: &JsValue) -> Result<(), ErrorCode>

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) -> Result<(), ErrorCode>

where 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>> ) -> Result<(), ErrorCode>

where 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) -> Result<(), ErrorCode>

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

fn pickup(&self, target: &Resource) -> Result<(), ErrorCode>

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

fn say(&self, message: &str, public: bool) -> Result<(), ErrorCode>

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

fn suicide(&self) -> Result<(), ErrorCode>

Immediately kill the creep.

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

where T: Transferable + ?Sized,

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> ) -> Result<(), ErrorCode>

where T: Withdrawable + ?Sized,

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

impl TryInto<Creep> for MovableObject

type Error = &'static str

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryInto<Creep> for ObjectWithPosition

type Error = &'static str

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryInto<Creep> for StoreObject

type Error = &'static str

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryInto<Creep> for TransferableObject

type Error = &'static str

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryInto<Creep> for TypedRoomObject

type Error = &'static str

The type returned in the event of a conversion error.

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

Performs the conversion.

impl WasmDescribe for Creep

fn describe()

impl Attackable for Creep

impl Healable for Creep

impl Transferable for Creep