Struct screeps::objects::Room

pub struct Room(_);

Methods

impl Room

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

pub fn energy_available(&self) -> u32

pub fn energy_capacity_available(&self) -> u32

pub fn name(&self) -> String

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

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

impl Room

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

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

pub fn create_construction_site<T: ?Sized>(
    &self,
    at: &T,
    ty: StructureType
) -> ReturnCode where
    T: HasPosition, 

pub fn create_named_construction_site<T: ?Sized>(
    &self,
    at: &T,
    ty: StructureType,
    name: &str
) -> ReturnCode where
    T: HasPosition, 

pub fn create_flag<T: ?Sized>(
    &self,
    at: &T,
    name: &str,
    main_color: Color,
    secondary_color: Color
) -> ReturnCode where
    T: HasPosition, 

pub fn find<T>(&self, ty: T) -> Vec<T::Item> where
    T: FindConstant, 

pub fn find_exit_to(&self, room: &Room) -> Result<Exit, ReturnCode>

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

pub fn get_event_log_raw(&self) -> String

pub fn get_position_at(&self, x: u32, y: u32) -> Option<RoomPosition>

pub fn get_terrain(&self) -> RoomTerrain

pub fn look_at<T: ?Sized + HasPosition>(&self, target: &T) -> Vec<LookResult>

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

pub fn look_at_area(
    &self,
    top: u32,
    left: u32,
    bottom: u32,
    right: u32
) -> Vec<PositionedLookResult>

pub fn find_path<'a, O: ?Sized, T: ?Sized, F>(
    &self,
    from_pos: &O,
    to_pos: &T,
    opts: FindOptions<'a, F>
) -> Path where
    O: HasPosition,
    T: HasPosition,
    F: Fn(String, CostMatrix) -> Option<CostMatrix<'a>> + 'a, 

pub fn look_for_at<T, U>(&self, ty: T, target: &U) -> Vec<T::Item> where
    T: LookConstant,
    U: HasPosition, 

pub fn look_for_at_xy<T>(&self, ty: T, x: u32, y: u32) -> Vec<T::Item> where
    T: LookConstant, 

pub fn look_for_at_area<T>(
    &self,
    ty: T,
    horiz: Range<u8>,
    vert: Range<u8>
) -> Vec<T::Item> where
    T: LookConstant, 

Looks for a given thing over a given area of bounds.

To keep with Range convention, the start is inclusive, and the end is exclusive.

Note: to ease the implementation and efficiency of the rust interface, this is limited to returning an array of values without their positions. If position data is needed, all room objects should contain positions alongside them. (for terrain data, I would recommend using a different method?)

If you really do need more information here, I would recommend making a PR to add it!

Panics

Panics if start>end for either range, or if end>50 for either range.

Examples

use screeps::constants::look;
room.look_for_at_area(look::ENERGY, 20..26, 20..26);

pub fn memory(&self) -> MemoryReference

pub fn name_local(&self) -> LocalRoomName

Trait Implementations

impl FromExpectedType<Reference> for Room

fn from_expected_type(reference: Reference) -> Result<Self, ConversionError>

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 From<Room> for Reference

fn from(value: Room) -> Self

Performs the conversion.

impl Eq for Room

impl PartialEq<Room> for Room

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

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

#[must_use]

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

This method tests for !=.

impl AsRef<Reference> for Room

fn as_ref(&self) -> &Reference

Performs the conversion.

impl TryFrom<Room> for Reference

type Error = Void

The type returned in the event of a conversion error.

fn try_from(value: Room) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Reference> for Room

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(reference: Reference) -> Result<Self, Self::Error>

Performs the conversion.

impl<'_r> TryFrom<&'_r Reference> for Room

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(reference: &Reference) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Value> for Room

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(value: Value) -> Result<Self, Self::Error>

Performs the conversion.

impl<'_r> TryFrom<&'_r Value> for Room

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(value: &Value) -> Result<Self, Self::Error>

Performs the conversion.

impl InstanceOf for Room

fn instance_of(reference: &Reference) -> bool

Checks whenever a given Reference if of type Self.

impl JsSerialize for Room

impl ReferenceType for Room

unsafe fn from_reference_unchecked(reference: Reference) -> Self

Converts a given reference into a concrete reference-like wrapper. Doesn't do any type checking; highly unsafe to use!

impl JsSerializeOwned for Room

fn into_js_owned<'_a>(value: &'_a mut Option<Self>) -> SerializedValue<'_a>

impl<'_r> JsSerializeOwned for &'_r Room

fn into_js_owned<'_a>(value: &'_a mut Option<Self>) -> SerializedValue<'_a>