Struct ImperatorProvinces

pub struct ImperatorProvinces {
    colors: HashSet<Rgb<u8>>,
    provinces: HashMap<u32, Province>,
    definition_csv: Option<FileEntry>,
    adjacencies: Vec<Adjacency>,
    impassable: HashSet<u32>,
    sea_or_river: HashSet<u32>,
}

Fields

colors: HashSet<Rgb<u8>>

Colors in the provinces.png

provinces: HashMap<u32, Province>

Provinces defined in definition.csv. Imperator requires uninterrupted indices starting at 0, but we want to be able to warn and continue if they’re not, so it’s a hashmap.

definition_csv: Option<FileEntry>

Kept and used for error reporting.

adjacencies: Vec<Adjacency>

impassable: HashSet<u32>

sea_or_river: HashSet<u32>

Implementations

impl ImperatorProvinces

fn parse_definition(&mut self, csv: &[Token])

pub fn load_impassable(&mut self, block: &Block)

pub fn verify_exists_implied(&self, key: &str, item: &Token, max_sev: Severity)

pub fn exists(&self, key: &str) -> bool

pub fn iter_keys(&self) -> impl Iterator<Item = &Token>

pub fn validate(&self, _data: &Everything)

Trait Implementations

impl Clone for ImperatorProvinces

fn clone(&self) -> ImperatorProvinces

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ImperatorProvinces

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

Formats the value using the given formatter.

impl Default for ImperatorProvinces

fn default() -> ImperatorProvinces

Returns the “default value” for a type.

impl FileHandler<FileContent> for ImperatorProvinces

fn subpath(&self) -> PathBuf

Which files this handler is interested in. This is a directory prefix of files it wants to handle, relative to the mod or vanilla root.

fn load_file( &self, entry: &FileEntry, parser: &ParserMemory, ) -> Option<FileContent>

This is called for each matching file, in arbitrary order. If a T is returned, it will be passed to handle_file later. Since load_file is executed multi-threaded while handle_file is single-threaded, try to do the heavy work in this function.

fn handle_file(&mut self, entry: &FileEntry, content: FileContent)

This is called for each matching file in turn, in lexical order. That’s the order in which the CK3 game engine loads them too.

fn finalize(&mut self)

This is called after all files have been handled. The FileHandler can generate indexes, perform full-data checks, etc.

fn config(&mut self, _config: &Block)

The FileHandler can read settings it needs from the ck3-tiger config.