Struct screeps::objects::StructureSpawn
source · pub struct StructureSpawn { /* private fields */ }
Expand description
An object representing a StructureSpawn
, which creates your creeps.
Implementations§
source§impl StructureSpawn
impl StructureSpawn
source§impl StructureSpawn
impl StructureSpawn
sourcepub fn set_memory(&self, val: &JsValue)
pub fn set_memory(&self, val: &JsValue)
Sets a new value to Memory.spawns[spawn.name]
.
source§impl StructureSpawn
impl StructureSpawn
sourcepub fn name_jsstring(&self) -> JsString
pub fn name_jsstring(&self) -> JsString
The spawn’s name as a JsString
.
source§impl StructureSpawn
impl StructureSpawn
source§impl StructureSpawn
impl StructureSpawn
source§impl StructureSpawn
impl StructureSpawn
sourcepub fn spawn_creep(&self, body: &[Part], name: &str) -> Result<(), ErrorCode>
pub fn spawn_creep(&self, body: &[Part], name: &str) -> Result<(), ErrorCode>
Create a new creep with the specified body part Array
, name
JsString
, and optional spawning options. Note that successfully
spawning will store data in Memory.creeps[creep_name]
regardless
of whether any memory data was passed in the options object and enable
the default serialization behavior of the Memory
object, which may
hamper attempts to directly use RawMemory
. todo, add note+docs
about how to replace Memory and/or delete RawMemory._parsed
sourcepub fn spawn_creep_with_options(
&self,
body: &[Part],
name: &str,
opts: &SpawnOptions,
) -> Result<(), ErrorCode>
pub fn spawn_creep_with_options( &self, body: &[Part], name: &str, opts: &SpawnOptions, ) -> Result<(), ErrorCode>
Create a new creep with the specified body part Array
, name
JsString
, and optional spawning options. Note that successfully
spawning will store data in Memory.creeps[creep_name]
regardless
of whether any memory data was passed in the options object and enable
the default serialization behavior of the Memory
object, which may
hamper attempts to directly use RawMemory
. todo, add note+docs
about how to replace Memory and/or delete RawMemory._parsed
sourcepub fn recycle_creep(&self, creep: &Creep) -> Result<(), ErrorCode>
pub fn recycle_creep(&self, creep: &Creep) -> Result<(), ErrorCode>
Kill a Creep
in melee range, returning 100% of its TTL-adjusted
resources (5x more than if the creep is killed another way). Can be used
while spawning.
Methods from Deref<Target = RoomObject>§
sourcepub fn js_pos(&self) -> RoomPosition
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.
Methods from Deref<Target = JsValue>§
pub const NULL: JsValue = _
pub const UNDEFINED: JsValue = _
pub const TRUE: JsValue = _
pub const FALSE: JsValue = _
sourcepub fn as_f64(&self) -> Option<f64>
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
.
sourcepub fn as_string(&self) -> Option<String>
pub fn as_string(&self) -> Option<String>
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.
sourcepub fn as_bool(&self) -> Option<bool>
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
.
sourcepub fn is_undefined(&self) -> bool
pub fn is_undefined(&self) -> bool
Tests whether this JS value is undefined
sourcepub fn is_function(&self) -> bool
pub fn is_function(&self) -> bool
Tests whether the type of this JS value is function
.
sourcepub fn js_in(&self, obj: &JsValue) -> bool
pub fn js_in(&self, obj: &JsValue) -> bool
Applies the binary in
JS operator on the two JsValue
s.
sourcepub fn loose_eq(&self, other: &JsValue) -> bool
pub fn loose_eq(&self, other: &JsValue) -> bool
Compare two JsValue
s for equality, using the ==
operator in JS.
sourcepub fn unsigned_shr(&self, rhs: &JsValue) -> u32
pub fn unsigned_shr(&self, rhs: &JsValue) -> u32
Applies the binary >>>
JS operator on the two JsValue
s.
sourcepub fn checked_div(&self, rhs: &JsValue) -> JsValue
pub fn checked_div(&self, rhs: &JsValue) -> JsValue
Applies the binary /
JS operator on two JsValue
s, catching and returning any RangeError
thrown.
sourcepub fn pow(&self, rhs: &JsValue) -> JsValue
pub fn pow(&self, rhs: &JsValue) -> JsValue
Applies the binary **
JS operator on the two JsValue
s.
sourcepub fn lt(&self, other: &JsValue) -> bool
pub fn lt(&self, other: &JsValue) -> bool
Applies the binary <
JS operator on the two JsValue
s.
sourcepub fn le(&self, other: &JsValue) -> bool
pub fn le(&self, other: &JsValue) -> bool
Applies the binary <=
JS operator on the two JsValue
s.
sourcepub fn ge(&self, other: &JsValue) -> bool
pub fn ge(&self, other: &JsValue) -> bool
Applies the binary >=
JS operator on the two JsValue
s.
sourcepub fn gt(&self, other: &JsValue) -> bool
pub fn gt(&self, other: &JsValue) -> bool
Applies the binary >
JS operator on the two JsValue
s.
sourcepub fn unchecked_into_f64(&self) -> f64
pub fn unchecked_into_f64(&self) -> f64
Applies the unary +
JS operator on a JsValue
. Can throw.
Trait Implementations§
source§impl AsRef<JsValue> for StructureSpawn
impl AsRef<JsValue> for StructureSpawn
source§impl AsRef<OwnedStructure> for StructureSpawn
impl AsRef<OwnedStructure> for StructureSpawn
source§fn as_ref(&self) -> &OwnedStructure
fn as_ref(&self) -> &OwnedStructure
source§impl AsRef<RoomObject> for StructureSpawn
impl AsRef<RoomObject> for StructureSpawn
source§fn as_ref(&self) -> &RoomObject
fn as_ref(&self) -> &RoomObject
source§impl AsRef<Structure> for StructureSpawn
impl AsRef<Structure> for StructureSpawn
source§impl AsRef<StructureSpawn> for StructureSpawn
impl AsRef<StructureSpawn> for StructureSpawn
source§fn as_ref(&self) -> &StructureSpawn
fn as_ref(&self) -> &StructureSpawn
source§impl Clone for StructureSpawn
impl Clone for StructureSpawn
source§fn clone(&self) -> StructureSpawn
fn clone(&self) -> StructureSpawn
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for StructureSpawn
impl Debug for StructureSpawn
source§impl Deref for StructureSpawn
impl Deref for StructureSpawn
§type Target = RoomObject
type Target = RoomObject
source§fn deref(&self) -> &RoomObject
fn deref(&self) -> &RoomObject
source§impl From<JsValue> for StructureSpawn
impl From<JsValue> for StructureSpawn
source§fn from(obj: JsValue) -> StructureSpawn
fn from(obj: JsValue) -> StructureSpawn
source§impl From<StructureSpawn> for JsValue
impl From<StructureSpawn> for JsValue
source§fn from(obj: StructureSpawn) -> JsValue
fn from(obj: StructureSpawn) -> JsValue
source§impl From<StructureSpawn> for ObjectWithPosition
impl From<StructureSpawn> for ObjectWithPosition
source§fn from(v: StructureSpawn) -> ObjectWithPosition
fn from(v: StructureSpawn) -> ObjectWithPosition
source§impl From<StructureSpawn> for OwnedStructure
impl From<StructureSpawn> for OwnedStructure
source§fn from(obj: StructureSpawn) -> OwnedStructure
fn from(obj: StructureSpawn) -> OwnedStructure
source§impl From<StructureSpawn> for OwnedStructureObject
impl From<StructureSpawn> for OwnedStructureObject
source§fn from(v: StructureSpawn) -> OwnedStructureObject
fn from(v: StructureSpawn) -> OwnedStructureObject
source§impl From<StructureSpawn> for RoomObject
impl From<StructureSpawn> for RoomObject
source§fn from(obj: StructureSpawn) -> RoomObject
fn from(obj: StructureSpawn) -> RoomObject
source§impl From<StructureSpawn> for StoreObject
impl From<StructureSpawn> for StoreObject
source§fn from(v: StructureSpawn) -> StoreObject
fn from(v: StructureSpawn) -> StoreObject
source§impl From<StructureSpawn> for Structure
impl From<StructureSpawn> for Structure
source§fn from(obj: StructureSpawn) -> Structure
fn from(obj: StructureSpawn) -> Structure
source§impl From<StructureSpawn> for StructureObject
impl From<StructureSpawn> for StructureObject
source§fn from(v: StructureSpawn) -> StructureObject
fn from(v: StructureSpawn) -> StructureObject
source§impl From<StructureSpawn> for TransferableObject
impl From<StructureSpawn> for TransferableObject
source§fn from(v: StructureSpawn) -> TransferableObject
fn from(v: StructureSpawn) -> TransferableObject
source§impl From<StructureSpawn> for TypedRoomObject
impl From<StructureSpawn> for TypedRoomObject
source§fn from(v: StructureSpawn) -> TypedRoomObject
fn from(v: StructureSpawn) -> TypedRoomObject
source§impl FromWasmAbi for StructureSpawn
impl FromWasmAbi for StructureSpawn
source§impl HasStore for StructureSpawn
impl HasStore for StructureSpawn
source§impl<'a> IntoWasmAbi for &'a StructureSpawn
impl<'a> IntoWasmAbi for &'a StructureSpawn
source§impl IntoWasmAbi for StructureSpawn
impl IntoWasmAbi for StructureSpawn
source§impl JsCast for StructureSpawn
impl JsCast for StructureSpawn
source§fn instanceof(val: &JsValue) -> bool
fn instanceof(val: &JsValue) -> bool
instanceof
check to see whether the JsValue
provided is an instance of this type. Read moresource§fn unchecked_from_js(val: JsValue) -> Self
fn unchecked_from_js(val: JsValue) -> Self
source§fn unchecked_from_js_ref(val: &JsValue) -> &Self
fn unchecked_from_js_ref(val: &JsValue) -> &Self
source§fn has_type<T>(&self) -> boolwhere
T: JsCast,
fn has_type<T>(&self) -> boolwhere
T: JsCast,
T
. Read moresource§fn dyn_into<T>(self) -> Result<T, Self>where
T: JsCast,
fn dyn_into<T>(self) -> Result<T, Self>where
T: JsCast,
T
. Read moresource§fn dyn_ref<T>(&self) -> Option<&T>where
T: JsCast,
fn dyn_ref<T>(&self) -> Option<&T>where
T: JsCast,
T
. Read moresource§fn unchecked_into<T>(self) -> Twhere
T: JsCast,
fn unchecked_into<T>(self) -> Twhere
T: JsCast,
source§fn unchecked_ref<T>(&self) -> &Twhere
T: JsCast,
fn unchecked_ref<T>(&self) -> &Twhere
T: JsCast,
source§impl JsCollectionFromValue for StructureSpawn
impl JsCollectionFromValue for StructureSpawn
fn from_value(val: JsValue) -> Self
source§impl LongRefFromWasmAbi for StructureSpawn
impl LongRefFromWasmAbi for StructureSpawn
§type Abi = <JsValue as LongRefFromWasmAbi>::Abi
type Abi = <JsValue as LongRefFromWasmAbi>::Abi
RefFromWasmAbi::Abi
§type Anchor = StructureSpawn
type Anchor = StructureSpawn
RefFromWasmAbi::Anchor
source§unsafe fn long_ref_from_abi(js: Self::Abi) -> Self::Anchor
unsafe fn long_ref_from_abi(js: Self::Abi) -> Self::Anchor
RefFromWasmAbi::ref_from_abi
source§impl OptionFromWasmAbi for StructureSpawn
impl OptionFromWasmAbi for StructureSpawn
source§impl<'a> OptionIntoWasmAbi for &'a StructureSpawn
impl<'a> OptionIntoWasmAbi for &'a StructureSpawn
source§impl OptionIntoWasmAbi for StructureSpawn
impl OptionIntoWasmAbi for StructureSpawn
source§impl RefFromWasmAbi for StructureSpawn
impl RefFromWasmAbi for StructureSpawn
§type Abi = <JsValue as RefFromWasmAbi>::Abi
type Abi = <JsValue as RefFromWasmAbi>::Abi
Self
are recovered from.§type Anchor = ManuallyDrop<StructureSpawn>
type Anchor = ManuallyDrop<StructureSpawn>
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.source§impl TryInto<StructureSpawn> for ObjectWithPosition
impl TryInto<StructureSpawn> for ObjectWithPosition
source§impl TryInto<StructureSpawn> for OwnedStructureObject
impl TryInto<StructureSpawn> for OwnedStructureObject
source§impl TryInto<StructureSpawn> for StoreObject
impl TryInto<StructureSpawn> for StoreObject
source§impl TryInto<StructureSpawn> for StructureObject
impl TryInto<StructureSpawn> for StructureObject
source§impl TryInto<StructureSpawn> for TransferableObject
impl TryInto<StructureSpawn> for TransferableObject
source§impl TryInto<StructureSpawn> for TypedRoomObject
impl TryInto<StructureSpawn> for TypedRoomObject
impl Attackable for StructureSpawn
impl Dismantleable for StructureSpawn
impl Repairable for StructureSpawn
impl Transferable for StructureSpawn
impl Withdrawable for StructureSpawn
Auto Trait Implementations§
impl Freeze for StructureSpawn
impl RefUnwindSafe for StructureSpawn
impl !Send for StructureSpawn
impl !Sync for StructureSpawn
impl Unpin for StructureSpawn
impl UnwindSafe for StructureSpawn
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)source§impl<T> HasId for T
impl<T> HasId for T
source§fn js_raw_id(&self) -> JsString
fn js_raw_id(&self) -> JsString
source§fn id(&self) -> ObjectId<Self>where
Self: Sized,
fn id(&self) -> ObjectId<Self>where
Self: Sized,
source§fn raw_id(&self) -> RawObjectId
fn raw_id(&self) -> RawObjectId
source§fn js_id(&self) -> JsObjectId<Self>where
Self: Sized,
fn js_id(&self) -> JsObjectId<Self>where
Self: Sized,
source§impl<T> HasPosition for Twhere
T: AsRef<RoomObject>,
impl<T> HasPosition for Twhere
T: AsRef<RoomObject>,
source§impl<T> MaybeHasId for Twhere
T: HasId,
impl<T> MaybeHasId for Twhere
T: HasId,
source§fn try_js_raw_id(&self) -> Option<JsString>
fn try_js_raw_id(&self) -> Option<JsString>
None
if the object doesn’t currently
have an ID.source§fn try_id(&self) -> Option<ObjectId<Self>>where
Self: Sized,
fn try_id(&self) -> Option<ObjectId<Self>>where
Self: Sized,
None
if the
object doesn’t currently have an ID.source§fn try_raw_id(&self) -> Option<RawObjectId>
fn try_raw_id(&self) -> Option<RawObjectId>
None
if the object doesn’t currently have an ID.source§impl<T> OwnedStructureProperties for Twhere
T: AsRef<OwnedStructure>,
impl<T> OwnedStructureProperties for Twhere
T: AsRef<OwnedStructure>,
source§impl<T> ReturnWasmAbi for Twhere
T: IntoWasmAbi,
impl<T> ReturnWasmAbi for Twhere
T: IntoWasmAbi,
§type Abi = <T as IntoWasmAbi>::Abi
type Abi = <T as IntoWasmAbi>::Abi
IntoWasmAbi::Abi
source§fn return_abi(self) -> <T as ReturnWasmAbi>::Abi
fn return_abi(self) -> <T as ReturnWasmAbi>::Abi
IntoWasmAbi::into_abi
, except that it may throw and never
return in the case of Err
.