Struct screeps::objects::ConstructionSite
source · pub struct ConstructionSite { /* private fields */ }
Expand description
A ConstructionSite
which is an object representing a structure under
construction.
Implementations§
source§impl ConstructionSite
impl ConstructionSite
sourcepub fn my(&self) -> bool
pub fn my(&self) -> bool
Whether you own the ConstructionSite
.
sourcepub fn owner(&self) -> Owner
pub fn owner(&self) -> Owner
The Owner
of this construction site, which contains the owner’s
username.
sourcepub fn progress(&self) -> u32
pub fn progress(&self) -> u32
The current progress toward completion of the structure being built.
sourcepub fn progress_total(&self) -> u32
pub fn progress_total(&self) -> u32
The total progess toward constuction progress needed for the structure to be completed.
sourcepub fn structure_type(&self) -> StructureType
pub fn structure_type(&self) -> StructureType
The type of structure being constructed.
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>
Available on crate feature std
only.
pub fn as_string(&self) -> Option<String>
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.
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<ConstructionSite> for ConstructionSite
impl AsRef<ConstructionSite> for ConstructionSite
source§fn as_ref(&self) -> &ConstructionSite
fn as_ref(&self) -> &ConstructionSite
source§impl AsRef<JsValue> for ConstructionSite
impl AsRef<JsValue> for ConstructionSite
source§impl AsRef<RoomObject> for ConstructionSite
impl AsRef<RoomObject> for ConstructionSite
source§fn as_ref(&self) -> &RoomObject
fn as_ref(&self) -> &RoomObject
source§impl Clone for ConstructionSite
impl Clone for ConstructionSite
source§fn clone(&self) -> ConstructionSite
fn clone(&self) -> ConstructionSite
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for ConstructionSite
impl Debug for ConstructionSite
source§impl Deref for ConstructionSite
impl Deref for ConstructionSite
§type Target = RoomObject
type Target = RoomObject
source§fn deref(&self) -> &RoomObject
fn deref(&self) -> &RoomObject
source§impl From<ConstructionSite> for JsValue
impl From<ConstructionSite> for JsValue
source§fn from(obj: ConstructionSite) -> JsValue
fn from(obj: ConstructionSite) -> JsValue
source§impl From<ConstructionSite> for ObjectWithPosition
impl From<ConstructionSite> for ObjectWithPosition
source§fn from(v: ConstructionSite) -> ObjectWithPosition
fn from(v: ConstructionSite) -> ObjectWithPosition
source§impl From<ConstructionSite> for RoomObject
impl From<ConstructionSite> for RoomObject
source§fn from(obj: ConstructionSite) -> RoomObject
fn from(obj: ConstructionSite) -> RoomObject
source§impl From<ConstructionSite> for TypedRoomObject
impl From<ConstructionSite> for TypedRoomObject
source§fn from(v: ConstructionSite) -> TypedRoomObject
fn from(v: ConstructionSite) -> TypedRoomObject
source§impl From<JsValue> for ConstructionSite
impl From<JsValue> for ConstructionSite
source§fn from(obj: JsValue) -> ConstructionSite
fn from(obj: JsValue) -> ConstructionSite
source§impl FromWasmAbi for ConstructionSite
impl FromWasmAbi for ConstructionSite
source§impl<'a> IntoWasmAbi for &'a ConstructionSite
impl<'a> IntoWasmAbi for &'a ConstructionSite
source§impl IntoWasmAbi for ConstructionSite
impl IntoWasmAbi for ConstructionSite
source§impl JsCast for ConstructionSite
impl JsCast for ConstructionSite
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 ConstructionSite
impl JsCollectionFromValue for ConstructionSite
fn from_value(val: JsValue) -> Self
source§impl LongRefFromWasmAbi for ConstructionSite
impl LongRefFromWasmAbi for ConstructionSite
§type Abi = <JsValue as LongRefFromWasmAbi>::Abi
type Abi = <JsValue as LongRefFromWasmAbi>::Abi
RefFromWasmAbi::Abi
§type Anchor = ConstructionSite
type Anchor = ConstructionSite
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 MaybeHasId for ConstructionSite
impl MaybeHasId for ConstructionSite
source§fn try_js_raw_id(&self) -> Option<JsString>
fn try_js_raw_id(&self) -> Option<JsString>
The Object ID of the ConstructionSite
, or None
if it was created
this tick.
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 OptionFromWasmAbi for ConstructionSite
impl OptionFromWasmAbi for ConstructionSite
source§impl<'a> OptionIntoWasmAbi for &'a ConstructionSite
impl<'a> OptionIntoWasmAbi for &'a ConstructionSite
source§impl OptionIntoWasmAbi for ConstructionSite
impl OptionIntoWasmAbi for ConstructionSite
source§impl RefFromWasmAbi for ConstructionSite
impl RefFromWasmAbi for ConstructionSite
§type Abi = <JsValue as RefFromWasmAbi>::Abi
type Abi = <JsValue as RefFromWasmAbi>::Abi
Self
are recovered from.§type Anchor = ManuallyDrop<ConstructionSite>
type Anchor = ManuallyDrop<ConstructionSite>
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<ConstructionSite> for ObjectWithPosition
impl TryInto<ConstructionSite> for ObjectWithPosition
source§impl TryInto<ConstructionSite> for TypedRoomObject
impl TryInto<ConstructionSite> for TypedRoomObject
Auto Trait Implementations§
impl RefUnwindSafe for ConstructionSite
impl !Send for ConstructionSite
impl !Sync for ConstructionSite
impl Unpin for ConstructionSite
impl UnwindSafe for ConstructionSite
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> HasPosition for Twhere
T: AsRef<RoomObject>,
impl<T> HasPosition for Twhere
T: AsRef<RoomObject>,
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
.