Struct HexCell 

pub struct HexCell { /* private fields */ }

A cell of the logical hex grid of the campaign map.

Implementations

impl HexCell

pub fn x(&self) -> u16

Column.

pub fn y(&self) -> u16

Row.

impl HexCell

pub fn new(x: u16, y: u16) -> Self

Creates a cell from its column and row.

pub fn neighbours(&self) -> impl Iterator<Item = HexCell> + '_

Returns the existing neighbours of the cell, in the game’s direction order.

Returns

Up to six cells; neighbours that would fall outside the u16 range are skipped.

pub fn neighbour(&self, direction: u8) -> Option<HexCell>

Returns the neighbour in a direction (0 to 5, in the game’s direction order).

Returns

None if the neighbour would fall outside the u16 range, or the direction is over 5.

pub fn neighbour_mask(&self, predicate: impl FnMut(HexCell) -> bool) -> u8

Returns the edge mask of the neighbours matching a predicate: bit n stands for the n-th neighbour in the game’s direction order. Neighbours outside the u16 range never match.

pub fn footprint(&self) -> Vec<HexCell>

Returns the cell followed by its neighbours, in the order the game stores slot footprints.

Trait Implementations

impl Clone for HexCell

fn clone(&self) -> HexCell

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for HexCell

impl Debug for HexCell

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

Formats the value using the given formatter.

impl Default for HexCell

fn default() -> HexCell

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for HexCell

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for HexCell

impl Hash for HexCell

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for HexCell

fn cmp(&self, other: &HexCell) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for HexCell

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for HexCell

fn partial_cmp(&self, other: &HexCell) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for HexCell

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for HexCell