Struct RoomExit 

pub struct RoomExit { /* private fields */ }

Compact representation of an entire exit along a room edge.

Note: Storing collections of these will not be as efficient as just storing the raw edge terrain. This structure should be used for when you need to work with and reason about the exit properties, not for when you need to store all of the exits on an edge. For storing all the exit data in a compact representation, see RoomExitsData.

Implementations

impl RoomExit

pub fn new_from_packed(packed: u16) -> Self

Creates a new RoomExit from the packed representation.

Note: This will convert the exit direction to ExitDirection::Top if the relevant bits are not a valid ExitDirection.

pub fn new(start: u8, length: u8, direction: ExitDirection) -> Self

Creates a new RoomExit from the start and length parameters.

pub fn get_packed_from_parameters( start: u8, length: u8, direction: ExitDirection, ) -> u16

Helper function to get the packed representation from the start and length parameters.

pub fn start(&self) -> u8

The start position of this exit.

pub fn len(&self) -> u8

The length of this exit.

pub fn end(&self) -> u8

The end position of this exit.

pub fn exit_direction(&self) -> ExitDirection

The edge that this exit is on.

pub fn packed(&self) -> u16

The packed representation of this exit.

pub fn memory_size(&self) -> usize

How much space this exit takes up in memory (in bytes).

pub fn get_exits_from_edge_terrain( terrain: &RoomEdgeTerrain, ) -> (Vec<Self>, Vec<Self>, Vec<Self>, Vec<Self>)

Extracts the individual exits for each edge from the compressed room edge terrain.

Returned ordering is: Top, Right, Bottom, Left

pub fn get_exits_from_single_edge( terrain: &[Terrain; 50], direction: ExitDirection, ) -> Vec<Self>

Utility function that processes edge terrain into a list of exits.

Returned vector can be empty if the edge is entirely Walls, and thus has no exits.

Trait Implementations

impl Clone for RoomExit

fn clone(&self) -> RoomExit

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RoomExit

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

Formats the value using the given formatter.

impl PartialEq for RoomExit

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Copy for RoomExit

impl StructuralPartialEq for RoomExit