Struct Localization

pub struct Localization {
    check_langs: BitArray<[u16; 1], Lsb0>,
    mod_langs: BitArray<[u16; 1], Lsb0>,
    locas: Box<[HashMap<String, LocaEntry>; 11]>,
}

Database of all loaded localization keys and their values, for all supported languages.

Fields

check_langs: BitArray<[u16; 1], Lsb0>

Which languages to check, according to the config file.

mod_langs: BitArray<[u16; 1], Lsb0>

Which languages also actually exist in the mod. This is used to not warn about missing loca when a mod doesn’t have the language at all. (This saves them the effort of configuring check_langs).

locas: Box<[HashMap<String, LocaEntry>; 11]>

Database of all localizations, indexed first by language and then by localization key.

Implementations

impl Localization

fn iter_lang_idx(&self) -> impl Iterator<Item = usize> + '_

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

fn all_collision_keys(&self, lang: Language) -> HashMap<u32, Vec<&LocaEntry>>

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

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

pub fn verify_name_exists(&self, name: &Token, max_sev: Severity)

pub fn exists_lang(&self, key: &str, lang: Language) -> bool

pub fn verify_exists_lang(&self, token: &Token, lang: Option<Language>)

pub fn verify_exists_implied_lang( &self, key: &str, token: &Token, lang: Option<Language>, )

pub fn mark_used(&self, key: &str)

fn check_loca_code( value: &LocaValue, data: &Everything, sc: &mut ScopeContext, lang: Language, )

pub fn verify_key_has_options( &self, loca: &str, key: &Token, n: i64, prefix: &str, )

fn validate_loca( entry: &LocaEntry, from: &HashMap<String, LocaEntry>, data: &Everything, sc: &mut ScopeContext, lang: Language, )

pub fn validate_use(&self, key: &str, data: &Everything, sc: &mut ScopeContext)

fn check_collisions(&self, lang: Language)

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

pub fn mark_category_used(&self, prefix: &str)

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

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

Trait Implementations

impl Debug for Localization

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

Formats the value using the given formatter.

impl Default for Localization

fn default() -> Self

Returns the “default value” for a type.

impl FileHandler<(Language, Vec<LocaEntry>)> for Localization

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<(Language, Vec<LocaEntry>)>

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, loaded: (Language, Vec<LocaEntry>))

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.