Struct GameMap

pub struct GameMap {
    height: u32,
    width: u32,
    province_map: RgbImage,
    title_color_map: HashMap<Rc<str>, Rgb<u8>>,
}

A struct representing a game map, from which we can create [Map] instances

Fields

height: u32

width: u32

province_map: RgbImage

title_color_map: HashMap<Rc<str>, Rgb<u8>>

Implementations

impl GameMap

pub fn new<P: AsRef<Path>>( provinces_path: P, rivers_path: P, definition_path: P, province_barony_map: &HashMap<u32, Rc<str>>, ) -> Result<Self, MapError>

Creates a new GameMap from a province map and a definition.csv file located inside the provided path. The function expects the path to be a valid CK3 game directory.

Trait Implementations

impl MapGenerator for GameMap

fn create_map<C: Into<Rgb<u8>> + Clone, F: Fn(&str) -> C, I: IntoIterator<Item = Rc<str>>>( &self, assoc: F, key_list: Option<I>, ) -> RgbImage

Creates a new instance of map, with pixels colored in accordance with assoc function. key_list acts as a whitelist of keys to use assoc on. If it’s None then assoc is applied to all keys.

fn create_map_flat<C: Into<Rgb<u8>> + Clone, I: IntoIterator<Item = Rc<str>>>( &self, key_list: I, target_color: C, ) -> RgbImage

Creates a new instance of map, with all pixels corresponding to keys in the key_list colored same as the target_color

impl Serialize for GameMap

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

where __S: Serializer,

Serialize this value into the given Serde serializer.