Struct RegionMap 

pub struct RegionMap { /* private fields */ }

Region of each cell of the campaign map.

Implementations

impl RegionMap

pub fn from_map_data(map_data: &ESF) -> Result<Self>

Reads the region map of a campaign map.

Arguments

• map_data - Decoded map_data.esf of the campaign map.

Errors

Returns an error if the map data lacks the region list or the hex map, or the hex map is too short.

pub fn world_size(&self) -> (f32, f32)

Returns the size of the map in world units.

pub fn scale(&self) -> MapScale

Returns the scale between the map’s world and raw units.

pub fn keys(&self) -> &[String]

Returns the region keys of the map, in REGIONS_BLOCK order.

pub fn region_at(&self, cell: HexCell) -> Option<&str>

Returns the key of the region a cell belongs to.

Returns

None for cells outside the map or with an unknown region index.

pub fn region_index_at(&self, cell: HexCell) -> Option<usize>

Returns the index (in REGIONS_BLOCK order) of the region a cell belongs to, or None for cells outside the map.

pub fn area_at(&self, cell: HexCell) -> Option<usize>

Returns the index of the area (in the region’s REGION_AREAS order) a cell is in, or None for cells outside the map.

pub fn size(&self) -> (u32, u32)

Returns the size of the map in cells.

pub fn edge_masks(&self, cell: HexCell) -> [u8; 2]

Returns the two hex-edge masks of a cell (bit n stands for the n-th neighbour in the game’s direction order), or zeros for cells outside the map.

pub fn cells_by_region(&self) -> HashMap<&str, Vec<HexCell>>

Returns the cells of every region, by region key.

pub fn neighbour_pairs(&self) -> HashSet<(&str, &str)>

Returns every pair of different regions with neighbouring cells, each pair once with the keys in order.

Trait Implementations

impl Clone for RegionMap

fn clone(&self) -> RegionMap

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RegionMap

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

Formats the value using the given formatter.

impl Default for RegionMap

fn default() -> RegionMap

Returns the “default value” for a type.

impl PartialEq for RegionMap

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for RegionMap