Struct screeps::objects::RoomPosition

pub struct RoomPosition { /* private fields */ }

An object representing a position in a room, stored in JavaScript memory.

Use Position to store and access the same data in Rust memory.

Screeps documentation

Implementations

impl RoomPosition

pub fn set_room_name(&self) -> JsString

Change the room the position refers to; must be a valid room name.

Screeps documentation

impl RoomPosition

pub fn x(&self) -> u8

X coordinate of the position within the room.

Screeps documentation

impl RoomPosition

pub fn set_x(&self) -> u8

Set a new X coordinate; must be in the range 0..49.

Screeps documentation

impl RoomPosition

pub fn y(&self) -> u8

Y coordinate of the position within the room.

Screeps documentation

impl RoomPosition

pub fn set_y(&self) -> u8

Set a new Y coordinate; must be in the range 0..49.

Screeps documentation

impl RoomPosition

pub fn packed(&self) -> u32

Gets the efficient internal i32 representation of the position.

impl RoomPosition

pub fn set_packed(&self, val: u32)

Sets the position to a new one by passing an i32 that represents a packed position.

impl RoomPosition

pub fn get_direction_to(&self, goal: &JsValue) -> Direction

Get the Direction toward a position or room object.

Screeps documentation

impl RoomPosition

pub fn get_direction_to_xy(&self, x: u8, y: u8) -> Direction

Get the Direction toward the given coordinates in the same room.

Screeps documentation

impl RoomPosition

pub fn get_range_to(&self, goal: &JsValue) -> u32

Get the range to a position or room object in the same room.

Screeps documentation

impl RoomPosition

pub fn get_range_to_xy(&self, x: u8, y: u8) -> u32

Get the range to the given coordinates in the same room.

Screeps documentation

impl RoomPosition

pub fn in_range_to(&self, goal: &JsValue, range: u8) -> bool

Get the range to a position or room object in the same room.

Screeps documentation

impl RoomPosition

pub fn in_range_to_xy(&self, x: u8, y: u8, range: u8) -> bool

Get the range to the given coordinates in the same room.

Screeps documentation

impl RoomPosition

pub fn is_equal_to(&self, goal: &JsValue) -> bool

Determine whether this position is at the same position as another position or room object.

Screeps documentation

impl RoomPosition

pub fn is_equal_to_xy(&self, x: u8, y: u8) -> bool

Determine whether this position is at the given coordinates in the room.

Screeps documentation

impl RoomPosition

pub fn is_near_to(&self, goal: &JsValue) -> bool

Determine whether this position is within 1 range of another position or room object.

Screeps documentation

impl RoomPosition

pub fn is_near_to_xy(&self, x: u8, y: u8) -> bool

Determine whether this position is within 1 range of the given coordinates in the room.

Screeps documentation

impl RoomPosition

pub fn new(x: u8, y: u8, room_name: RoomName) -> RoomPosition

Create a new RoomPosition using the normal constructor, taking coordinates and the room name.

Screeps documentation

pub fn room_name(&self) -> RoomName

Name of the room the position is in, as an owned JsString reference to a string in Javascript memory.

Screeps documentation

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

Creates a ConstructionSite at this position. If it’s a StructureSpawn, a name can optionally be assigned for the structure.

Screeps documentation

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

Creates a Flag at this position. If successful, returns the name of the created flag.

Screeps documentation

pub fn find_closest_by_path<T>( &self, find: T, options: Option<&Object> ) -> Option<T::Item>

where T: FindConstant,

Find the closest object by path among a list of objects, or use a find constant to search for all objects of that type in the room.

Screeps documentation

pub fn find_closest_by_range<T>(&self, find: T) -> Option<T::Item>

where T: FindConstant,

Find the closest object by range among a list of objects, or use a find constant to search for all objects of that type in the room. Will not work for objects in other rooms.

Screeps documentation

pub fn find_in_range<T>(&self, find: T, range: u8) -> Vec<T::Item>

where T: FindConstant,

Find all relevant objects within a certain range among a list of objects, or use a find constant to search all objects of that type in the room.

Screeps documentation

pub fn find_path_to<T, F, R>( &self, target: &T, options: Option<FindPathOptions<F, R>> ) -> Path

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

Find a path from this position to a position or room object, with an optional options object

Screeps documentation

pub fn find_path_to_xy<F, R>( &self, x: RoomCoordinate, y: RoomCoordinate, options: Option<FindPathOptions<F, R>> ) -> Path

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

Find a path from this position to the given coordinates in the same room, with an optional options object.

Screeps documentation

pub fn look(&self) -> Result<Vec<LookResult>, ErrorCode>

Get all objects at this position. Will fail if the position is in a room that’s not visible during the current tick.

Screeps documentation

pub fn look_for<T>(&self, _ty: T) -> Result<Vec<T::Item>, ErrorCode>

where T: LookConstant,

Get all objects of a given type at this position, if any. Will fail if the position is in a room that’s not visible during the current tick.

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 RoomPosition

fn as_ref(&self) -> &JsValue

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

impl AsRef<RoomPosition> for RoomPosition

fn as_ref(&self) -> &RoomPosition

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

impl Clone for RoomPosition

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Deref for RoomPosition

type Target = JsValue

The resulting type after dereferencing.

fn deref(&self) -> &JsValue

Dereferences the value.

impl From<&Position> for RoomPosition

fn from(pos: &Position) -> Self

Converts to this type from the input type.

impl From<&RoomPosition> for Position

fn from(js_pos: &RoomPosition) -> Self

Converts to this type from the input type.

impl From<JsValue> for RoomPosition

fn from(obj: JsValue) -> RoomPosition

Converts to this type from the input type.

impl From<Position> for RoomPosition

fn from(pos: Position) -> Self

Converts to this type from the input type.

impl From<RoomPosition> for JsValue

fn from(obj: RoomPosition) -> JsValue

Converts to this type from the input type.

impl From<RoomPosition> for ObjectWithPosition

fn from(v: RoomPosition) -> ObjectWithPosition

Converts to this type from the input type.

impl From<RoomPosition> for Position

fn from(js_pos: RoomPosition) -> Self

Converts to this type from the input type.

impl FromWasmAbi for RoomPosition

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 HasPosition for RoomPosition

fn pos(&self) -> Position

Position of the object.

impl<'a> IntoWasmAbi for &'a RoomPosition

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 RoomPosition

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 RoomPosition

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 LongRefFromWasmAbi for RoomPosition

type Abi = <JsValue as LongRefFromWasmAbi>::Abi

Same as RefFromWasmAbi::Abi

type Anchor = RoomPosition

Same as RefFromWasmAbi::Anchor

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

Same as RefFromWasmAbi::ref_from_abi

impl OptionFromWasmAbi for RoomPosition

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 RoomPosition

fn none() -> Self::Abi

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

impl OptionIntoWasmAbi for RoomPosition

fn none() -> Self::Abi

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

impl RefFromWasmAbi for RoomPosition

type Abi = <JsValue as RefFromWasmAbi>::Abi

The wasm ABI type references to Self are recovered from.

type Anchor = ManuallyDrop<RoomPosition>

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 TryInto<RoomPosition> for ObjectWithPosition

type Error = &'static str

The type returned in the event of a conversion error.

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

Performs the conversion.

impl WasmDescribe for RoomPosition

fn describe()