Struct screeps::objects::Room

pub struct Room { /* private fields */ }

A reference to a Room object, a 50x50 chunk of the Screeps game world.

Screeps documentation

Implementations

impl Room

pub fn controller(&self) -> Option<StructureController>

The StructureController for the room, or None in rooms that cannot be claimed.

Screeps documentation

impl Room

pub fn energy_available(&self) -> u32

Energy available for spawning at the start of the current tick.

Screeps documentation

impl Room

pub fn energy_capacity_available(&self) -> u32

Total energy capacity of all spawns and extensions in the room.

Screeps documentation

impl Room

pub fn memory(&self) -> JsValue

A shortcut to Memory.rooms[room.name].

Screeps documentation

impl Room

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

Sets a new value to Memory.rooms[room.name].

Screeps documentation

impl Room

pub fn storage(&self) -> Option<StructureStorage>

The StructureStorage built in the room, or None in rooms where there isn’t one.

Screeps documentation

impl Room

pub fn terminal(&self) -> Option<StructureTerminal>

The StructureTerminal built in the room, or None in rooms where there isn’t one.

Screeps documentation

impl Room

pub fn get_position_at(&self, x: u8, y: u8) -> RoomPosition

Gets the RoomPosition for the given coordinates.

Screeps documentation

impl Room

pub fn get_terrain(&self) -> RoomTerrain

Gets the RoomTerrain object for this room.

Screeps documentation

impl Room

pub fn name(&self) -> RoomName

The room’s name.

Screeps documentation

pub fn serialize_path(path: &[Step]) -> String

Serialize a path array from Room::find_path into a string representation safe to store in memory.

Screeps documentation

pub fn deserialize_path(path: &str) -> Vec<Step>

Deserialize a string representation from Room::serialize_path back to a path array.

Screeps documentation

pub fn visual(&self) -> RoomVisual

pub fn create_construction_site( &self, x: u8, y: u8, ty: StructureType, name: Option<&JsString> ) -> Result<(), ErrorCode>

Creates a construction site at given coordinates within this room. If it’s a StructureSpawn, a name can optionally be assigned for the structure.

See RoomPosition::create_construction_site to create at a specified position.

Screeps documentation

pub fn create_flag( &self, x: u8, y: u8, name: Option<&JsString>, color: Option<Color>, secondary_color: Option<Color> ) -> Result<JsString, ErrorCode>

Creates a Flag at given coordinates within this room. The name of the flag is returned if the creation is successful.

Screeps documentation

pub fn find<T>(&self, ty: T, options: Option<&FindOptions>) -> Vec<T::Item>

where T: FindConstant,

Find all objects of the specified type in the room, without passing additional options.

Returns an Vec containing the found objects, which should be converted into the type of object you searched for.

Screeps documentation

pub fn find_exit_to(&self, room: RoomName) -> ExitDirection

Find an exit from the current room which leads to a target room.

Screeps documentation

pub fn find_path<F, R>( &self, origin: &RoomPosition, goal: &RoomPosition, options: Option<FindPathOptions<F, R>> ) -> Path

where F: FnMut(RoomName, CostMatrix) -> R, R: RoomCostResult,

Find a path within the room from one position to another.

Screeps documentation

pub fn get_event_log(&self) -> Vec<Event>

pub fn get_event_log_raw(&self) -> String

pub fn look_at(&self, target: &RoomPosition) -> Vec<LookResult>

Get all objects at a position.

Screeps documentation

pub fn look_at_xy(&self, x: u8, y: u8) -> Vec<LookResult>

Get all objects at the given room coordinates.

Screeps documentation

pub fn look_at_area( &self, top_y: u8, left_x: u8, bottom_y: u8, right_x: u8 ) -> Vec<PositionedLookResult>

Get all objects in a certain area.

Screeps documentation

pub fn look_for_at<T, U>(&self, _ty: T, target: &U) -> Vec<T::Item>

where T: LookConstant, U: HasPosition,

Get all objects of a given type at this position, if any.

Screeps documentation

pub fn look_for_at_xy<T>(&self, _ty: T, x: u8, y: u8) -> Vec<T::Item>

where T: LookConstant,

Get all objects of a given type at the given coordinates, if any.

Screeps documentation

pub fn look_for_at_area<T>( &self, _ty: T, top_y: u8, left_x: u8, bottom_y: u8, right_x: u8 ) -> Vec<PositionedLookResult>

where T: LookConstant,

Get all objects of a certain type in a certain area.

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<JsValue> for Room

fn as_ref(&self) -> &JsValue

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

impl AsRef<Room> for Room

fn as_ref(&self) -> &Room

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

impl Clone for Room

fn clone(&self) -> Room

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Room

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

Formats the value using the given formatter.

impl Deref for Room

type Target = JsValue

The resulting type after dereferencing.

fn deref(&self) -> &JsValue

Dereferences the value.

impl From<JsValue> for Room

fn from(obj: JsValue) -> Room

Converts to this type from the input type.

impl From<Room> for JsValue

fn from(obj: Room) -> JsValue

Converts to this type from the input type.

impl FromWasmAbi for Room

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<'a> IntoWasmAbi for &'a Room

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 Room

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 Room

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 Room

fn from_value(val: JsValue) -> Self

impl LongRefFromWasmAbi for Room

type Abi = <JsValue as LongRefFromWasmAbi>::Abi

Same as RefFromWasmAbi::Abi

type Anchor = Room

Same as RefFromWasmAbi::Anchor

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

Same as RefFromWasmAbi::ref_from_abi

impl OptionFromWasmAbi for Room

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 Room

fn none() -> Self::Abi

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

impl OptionIntoWasmAbi for Room

fn none() -> Self::Abi

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

impl PartialEq for Room

fn eq(&self, other: &Room) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl RefFromWasmAbi for Room

type Abi = <JsValue as RefFromWasmAbi>::Abi

The wasm ABI type references to Self are recovered from.

type Anchor = ManuallyDrop<Room>

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 WasmDescribe for Room

fn describe()

impl Eq for Room