Struct Characters

pub struct Characters {
    config_only_born: Option<Date>,
    characters: HashMap<&'static str, Character>,
    duplicates: Vec<Character>,
}

Fields

config_only_born: Option<Date>

characters: HashMap<&'static str, Character>

duplicates: Vec<Character>

These are characters with duplicate ids. We can’t put them in the characters map because of the ids, but we do want to validate them.

Implementations

impl Characters

fn load_item(&mut self, key: Token, block: Block)

pub fn verify_exists_gender(&self, item: &Token, gender: Gender)

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

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

pub fn is_alive(&self, item: &Token, date: Date) -> bool

pub fn verify_alive(&self, item: &Token, date: Date)

pub fn get_dynasty<'a>( &'a self, id: &Token, date: Date, data: &'a Everything, ) -> Option<&'a Token>

pub fn get_house(&self, id: &Token, date: Date) -> Option<&Token>

pub fn get_culture(&self, id: &Token, date: Date) -> Option<&Token>

pub fn get_faith(&self, id: &Token, date: Date) -> Option<&Token>

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

fn check_ancestor_cycles(&self, ch: &Character) -> Option<Vec<Token>>

pub fn check_pod_flags(&self, data: &Everything)

Trait Implementations

impl Debug for Characters

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

Formats the value using the given formatter.

impl Default for Characters

fn default() -> Characters

Returns the “default value” for a type.

impl FileHandler<Block> for Characters

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

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

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<Block>

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, block: Block)

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.