Struct RoomExitsData 

pub struct RoomExitsData { /* private fields */ }

Compactly stores information about all the exits in a room.

Implementations

impl RoomExitsData

pub fn new_from_compressed_edge_terrain_data( data: RoomEdgeTerrain, room: RoomName, ) -> Self

pub fn memory_size(&self) -> usize

The amount of memory used to store this data, in bytes.

pub fn top_edge_exits(&self) -> Vec<RoomExit>

The exits, if any, along the top edge of the room.

pub fn right_edge_exits(&self) -> Vec<RoomExit>

The exits, if any, along the right edge of the room.

pub fn bottom_edge_exits(&self) -> Vec<RoomExit>

The exits, if any, along the bottom edge of the room.

pub fn left_edge_exits(&self) -> Vec<RoomExit>

The exits, if any, along the left edge of the room.

pub fn num_top_exits(&self) -> usize

The number of exits along the top edge of the room.

This is more efficient than constructing all of the exits, if you just need the exit count.

pub fn num_right_exits(&self) -> usize

The number of exits along the right edge of the room.

This is more efficient than constructing all of the exits, if you just need the exit count.

pub fn num_bottom_exits(&self) -> usize

The number of exits along the bottom edge of the room.

This is more efficient than constructing all of the exits, if you just need the exit count.

pub fn num_left_exits(&self) -> usize

The number of exits along the left edge of the room.

This is more efficient than constructing all of the exits, if you just need the exit count.

pub fn num_exits(&self) -> usize

The total number of exits along all edges of the room.

This is more efficient than constructing all of the exits, if you just need the exit count.

pub fn edge_terrain_data(&self) -> &RoomEdgeTerrain

A reference to the underlying edge terrain data for the room.

pub fn connected_to_top_neighbor(&self) -> bool

Returns true if the top edge has exits and has a neighbor to the north, false otherwise.

This is more efficient than self.top_edge_exits().len() if you’re just wanting connectivity data, as it doesn’t create the exits themselves, just checks for their existence.

pub fn connected_to_right_neighbor(&self) -> bool

Returns true if the right edge has exits and has a neighbor to the east, false otherwise.

This is more efficient than self.right_edge_exits().len() if you’re just wanting connectivity data, as it doesn’t create the exits themselves, just checks for their existence.

pub fn connected_to_bottom_neighbor(&self) -> bool

Returns true if the bottom edge has exits and has a neighbor to the south, false otherwise.

This is more efficient than self.bottom_edge_exits().len() if you’re just wanting connectivity data, as it doesn’t create the exits themselves, just checks for their existence.

pub fn connected_to_left_neighbor(&self) -> bool

Returns true if the left edge has exits and has a neighbor to the west, false otherwise.

This is more efficient than self.left_edge_exits().len() if you’re just wanting connectivity data, as it doesn’t create the exits themselves, just checks for their existence.

pub fn get_exit_by_index(&self, index: usize) -> Option<RoomExit>

Returns the room exit identified by iterating through edges clockwise (top, right, bottom, left) and then scanning through each edge linearly (left-to-right, top-to-bottom).

Example: If a room has no exits along the top edge, but has 2 exits along the right edge, then the exit at index 0 would be the exit on the right edge with the lower start position, and the exit at index 1 would be the exit on the right edge with the higher start position.

Returns None if the index represents a non-existent exit; this can happen if:

• There are no exits to the room
• There are exits to the room, but the index is greater than the number of exits - 1 (since we use a zero-based index)

pub fn room(&self) -> RoomName

The room this data is for.

pub fn iter(&self) -> RoomExitsIter

Returns an iterator over all the exits in the room.

Trait Implementations

impl Clone for RoomExitsData

fn clone(&self) -> RoomExitsData

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RoomExitsData

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

Formats the value using the given formatter.

impl Copy for RoomExitsData