Struct History

pub struct History {
    history: HashMap<&'static str, HistoryEffect>,
}

The history files in Vic3 are fairly simple. Files under common/history/ have keyword = { effect... } as top-level blocks, where the effects from the same keywords are all added together. The keywords seem to be arbitrary, except for GLOBAL which is documented to go last.

Fields

history: HashMap<&'static str, HistoryEffect>

Implementations

impl History

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

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

Trait Implementations

impl Clone for History

fn clone(&self) -> History

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for History

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

Formats the value using the given formatter.

impl Default for History

fn default() -> History

Returns the “default value” for a type.

impl FileHandler<Block> for History

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 config(&mut self, _config: &Block)

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

fn finalize(&mut self)

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