tiger-lib 1.18.0

Library used by the tools ck3-tiger, vic3-tiger, and imperator-tiger. This library holds the bulk of the code for them. It can be built either for ck3-tiger with the feature ck3, or for vic3-tiger with the feature vic3, or for imperator-tiger with the feature imperator, but not both at the same time.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104

use crate::block::Block;
use crate::db::{Db, DbKind};
use crate::everything::Everything;
use crate::game::GameFlags;
use crate::hoi4::modif::ModifKinds;
use crate::item::{Item, ItemLoader};
use crate::modif::validate_modifs;
use crate::report::{ErrorKey, err};
use crate::token::Token;
use crate::validate::validate_color;
use crate::validator::Validator;

#[derive(Clone, Debug)]
pub struct Terrain {
    pub(super) is_water: bool,
}

inventory::submit! {
    ItemLoader::Normal(GameFlags::Hoi4, Item::Terrain, Terrain::add)
}

impl Terrain {
    #[allow(clippy::needless_pass_by_value)]
    pub fn add(db: &mut Db, key: Token, mut block: Block) {
        if key.is("categories") {
            for (key, block) in block.drain_definitions_warn() {
                let is_water = block.get_field_bool("is_water").unwrap_or(false);
                db.add(Item::Terrain, key, block, Box::new(Self { is_water }));
            }
        } else if key.is("terrain") {
            for (key, block) in block.drain_definitions_warn() {
                db.add(Item::GraphicalTerrain, key, block, Box::new(GraphicalTerrain {}));
            }
        } else {
            let msg = "unexpected key";
            let info = "expected only `categories`";
            err(ErrorKey::UnknownField).msg(msg).info(info).loc(&key).push();
        }
    }
}

impl DbKind for Terrain {
    fn validate(&self, key: &Token, block: &Block, data: &Everything) {
        let mut vd = Validator::new(block, data);

        data.verify_exists(Item::Localization, key);
        let loca = format!("{key}_desc");
        data.verify_exists_implied(Item::Localization, &loca, key);

        vd.field_validated_block("color", validate_color);
        vd.field_bool("naval_terrain");
        vd.field_numeric("movement_cost");
        vd.field_numeric("attrition");
        vd.field_bool("is_water");
        vd.field_choice("sound_type", &["sea", "forest", "desert", "plains"]); // TODO: other choices
        vd.field_numeric("match_value");
        vd.field_integer("combat_width");
        vd.field_integer("combat_support_width");
        vd.field_numeric("ai_terrain_importance_factor");
        vd.field_numeric("supply_flow_penalty_factor");

        vd.field_validated_block("buildings_max_level", |block, data| {
            let mut vd = Validator::new(block, data);
            vd.unknown_value_fields(|key, value| {
                data.verify_exists(Item::Building, key);
                value.expect_integer();
            });
        });

        vd.field_validated_block("units", validate_unit);

        vd.unknown_block_fields(|key, block| {
            data.verify_exists(Item::SubUnit, key);

            let mut vd = Validator::new(block, data);
            vd.field_validated_block("units", validate_unit);
            validate_modifs(block, data, ModifKinds::all(), vd);
        });

        validate_modifs(block, data, ModifKinds::all(), vd);
    }
}

fn validate_unit(block: &Block, data: &Everything) {
    let mut vd = Validator::new(block, data);
    vd.field_numeric("attack");
    vd.field_numeric("movement");
    vd.field_numeric("defence");
}

#[derive(Clone, Debug)]
pub struct GraphicalTerrain {}

impl DbKind for GraphicalTerrain {
    fn validate(&self, _key: &Token, block: &Block, data: &Everything) {
        let mut vd = Validator::new(block, data);

        vd.field_item("type", Item::Terrain);
        vd.field_list_integers_exactly("color", 1);
        vd.field_integer("texture");
        vd.field_bool("spawn_city");
        vd.field_bool("perm_snow");
    }
}