Struct TerrainCache 

pub struct TerrainCache { /* private fields */ }

A simple passthrough cache that preferentially returns cached terrain data, dynamically pulling terrain data as-needed from game state and caching it before returning it.

Implementations

impl TerrainCache

pub fn new() -> Self

Initializes a new, empty terrain cache.

pub fn get_cached_terrain( &self, room_name: &RoomName, ) -> Option<&LocalRoomTerrain>

Returns the cached room terrain, if it exists.

Returns None if the room terrain isn’t cached.

pub fn is_terrain_cached(&self, room_name: &RoomName) -> bool

Returns whether the terrain is cached for a particular room.

pub fn get_terrain(&mut self, room_name: &RoomName) -> Option<&LocalRoomTerrain>

Returns the room terrain, pulling and caching it from the game state if it’s not already cached.

Returns None only if screeps::objects::RoomTerrain::new returns None.

Note: This method can, but might not, pull from the game state, which requires crossing the WASM boundary.

pub fn update_cached_terrain( &mut self, room_name: RoomName, local_terrain: LocalRoomTerrain, )

Updates the terrain cache for a specific room.

This allows for pre-loading the cache with any existing room terrain you might already have available.

pub fn remove_cached_terrain(&mut self, room_name: &RoomName)

Removes the terrain cached for a specific room.

Trait Implementations

impl Clone for TerrainCache

fn clone(&self) -> TerrainCache

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TerrainCache

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

Formats the value using the given formatter.

impl Default for TerrainCache

fn default() -> Self

Returns the “default value” for a type.