Struct screeps::objects::RoomTerrain
source · pub struct RoomTerrain { /* private fields */ }
Expand description
A matrix representing the terrain of a room, held in the JavaScript heap.
Use [LocalRoomTerrain
] to store and access the same data in Rust
memory.
Implementations§
source§impl RoomTerrain
impl RoomTerrain
source§impl RoomTerrain
impl RoomTerrain
sourcepub fn new(room_name: RoomName) -> Option<RoomTerrain>
pub fn new(room_name: RoomName) -> Option<RoomTerrain>
Gets the terrain for any room by name, regardless of current visibility of the room.
sourcepub fn get_raw_buffer(&self) -> Uint8Array
pub fn get_raw_buffer(&self) -> Uint8Array
Get a copy of the underlying Uint8Array with the data about the room’s terrain.
sourcepub fn get_raw_buffer_to_array(
&self,
destination: &Uint8Array
) -> Result<(), ErrorCode>
pub fn get_raw_buffer_to_array( &self, destination: &Uint8Array ) -> Result<(), ErrorCode>
Copy the data about the room’s terrain into an existing Uint8Array
.
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<JsValue> for RoomTerrain
impl AsRef<JsValue> for RoomTerrain
source§impl AsRef<RoomTerrain> for RoomTerrain
impl AsRef<RoomTerrain> for RoomTerrain
source§fn as_ref(&self) -> &RoomTerrain
fn as_ref(&self) -> &RoomTerrain
source§impl Deref for RoomTerrain
impl Deref for RoomTerrain
source§impl From<JsValue> for RoomTerrain
impl From<JsValue> for RoomTerrain
source§fn from(obj: JsValue) -> RoomTerrain
fn from(obj: JsValue) -> RoomTerrain
source§impl From<RoomTerrain> for JsValue
impl From<RoomTerrain> for JsValue
source§fn from(obj: RoomTerrain) -> JsValue
fn from(obj: RoomTerrain) -> JsValue
source§impl From<RoomTerrain> for LocalRoomTerrain
impl From<RoomTerrain> for LocalRoomTerrain
source§fn from(terrain: RoomTerrain) -> LocalRoomTerrain
fn from(terrain: RoomTerrain) -> LocalRoomTerrain
source§impl FromWasmAbi for RoomTerrain
impl FromWasmAbi for RoomTerrain
source§impl<'a> IntoWasmAbi for &'a RoomTerrain
impl<'a> IntoWasmAbi for &'a RoomTerrain
source§impl IntoWasmAbi for RoomTerrain
impl IntoWasmAbi for RoomTerrain
source§impl JsCast for RoomTerrain
impl JsCast for RoomTerrain
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 LongRefFromWasmAbi for RoomTerrain
impl LongRefFromWasmAbi for RoomTerrain
§type Abi = <JsValue as LongRefFromWasmAbi>::Abi
type Abi = <JsValue as LongRefFromWasmAbi>::Abi
RefFromWasmAbi::Abi
§type Anchor = RoomTerrain
type Anchor = RoomTerrain
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 RoomTerrain
impl OptionFromWasmAbi for RoomTerrain
source§impl<'a> OptionIntoWasmAbi for &'a RoomTerrain
impl<'a> OptionIntoWasmAbi for &'a RoomTerrain
source§impl OptionIntoWasmAbi for RoomTerrain
impl OptionIntoWasmAbi for RoomTerrain
source§impl RefFromWasmAbi for RoomTerrain
impl RefFromWasmAbi for RoomTerrain
§type Abi = <JsValue as RefFromWasmAbi>::Abi
type Abi = <JsValue as RefFromWasmAbi>::Abi
Self
are recovered from.§type Anchor = ManuallyDrop<RoomTerrain>
type Anchor = ManuallyDrop<RoomTerrain>
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.Auto Trait Implementations§
impl RefUnwindSafe for RoomTerrain
impl !Send for RoomTerrain
impl !Sync for RoomTerrain
impl Unpin for RoomTerrain
impl UnwindSafe for RoomTerrain
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> 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
.