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
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139

use crate::block::Block;
use crate::db::{Db, DbKind};
use crate::everything::Everything;
use crate::game::GameFlags;
use crate::item::{Item, ItemLoader};
use crate::modif::validate_modifs;
use crate::report::{ErrorKey, warn};
use crate::scopes::Scopes;
use crate::token::Token;
use crate::tooltipped::Tooltipped;
use crate::validate::validate_possibly_named_color;
use crate::validator::Validator;
use crate::vic3::modif::ModifKinds;
use crate::vic3::tables::modifs::maybe_warn_modifiable_capitalization;

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

inventory::submit! {
    ItemLoader::Normal(GameFlags::Vic3, Item::CombatUnit, CombatUnit::add)
}

impl CombatUnit {
    pub fn add(db: &mut Db, key: Token, block: Block) {
        db.add(Item::CombatUnit, key, block, Box::new(Self {}));
    }
}

impl DbKind for CombatUnit {
    // This whole item type is undocumented.
    fn validate(&self, key: &Token, block: &Block, data: &Everything) {
        maybe_warn_modifiable_capitalization(key);

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

        let mut vd = Validator::new(block, data);
        vd.req_field("group");
        vd.req_field("combat_unit_image");

        vd.field_item("group", Item::CombatUnitGroup);
        vd.field_integer("max_manpower");
        vd.field_bool("conscript_peasant_levies");
        vd.multi_field_validated_block("battle_modifier", |block, data| {
            let vd = Validator::new(block, data);
            validate_modifs(block, data, ModifKinds::Unit, vd);
        });
        vd.multi_field_validated_block("upkeep_modifier", |block, data| {
            let vd = Validator::new(block, data);
            validate_modifs(block, data, ModifKinds::Goods, vd);
        });
        vd.multi_field_validated_block("formation_modifier", |block, data| {
            let vd = Validator::new(block, data);
            validate_modifs(block, data, ModifKinds::MilitaryFormation, vd);
        });
        vd.field_trigger_rooted("can_build_conscript", Tooltipped::No, Scopes::Country);
        vd.multi_field_list_items("unlocking_technologies", Item::Technology);
        let mut seen_unconditional = None;
        vd.multi_field_validated_key_block("combat_unit_image", |key, block, data| {
            if let Some(unconditional) = &seen_unconditional {
                let msg = "there was a previous `combat_unit_image` without a trigger, so this one will not be used";
                let info = "try moving that one to the end";
                warn(ErrorKey::Validation).msg(msg).info(info).loc(key).loc_msg(unconditional, "previous").push();
            }
            let mut vd = Validator::new(block, data);
            vd.field_trigger_rooted("trigger", Tooltipped::No, Scopes::Culture);
            if !block.has_key("trigger") {
                seen_unconditional = Some(key.clone());
            }
            vd.field_item("texture", Item::File);
        });
        if seen_unconditional.is_none() {
            let msg = "there should be a `combat_unit_image` with no trigger as a fallback";
            warn(ErrorKey::Validation).msg(msg).loc(key).push();
        }
        vd.field_list_items("upgrades", Item::CombatUnit);
    }
}

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

inventory::submit! {
    ItemLoader::Normal(GameFlags::Vic3, Item::CombatUnitGroup, CombatUnitGroup::add)
}

impl CombatUnitGroup {
    pub fn add(db: &mut Db, key: Token, block: Block) {
        db.add(Item::CombatUnitGroup, key, block, Box::new(Self {}));
    }
}

impl DbKind for CombatUnitGroup {
    // This whole item type is undocumented.
    fn validate(&self, key: &Token, block: &Block, data: &Everything) {
        data.verify_exists(Item::TextIcon, key);
        data.verify_exists(Item::Localization, key);
        let loca = format!("{key}_desc");
        data.verify_exists_implied(Item::Localization, &loca, key);

        let mut vd = Validator::new(block, data);
        vd.field_choice("type", &["army", "navy"]);
        vd.field_integer("manpower_max");
        vd.field_bool("default_group");
        vd.field_validated("color", validate_possibly_named_color);
        vd.field_item("icon", Item::File);
    }
}

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

inventory::submit! {
    ItemLoader::Normal(GameFlags::Vic3, Item::CombatUnitExperienceLevel, CombatUnitExperienceLevel::add)
}

impl CombatUnitExperienceLevel {
    pub fn add(db: &mut Db, key: Token, block: Block) {
        db.add(Item::CombatUnitExperienceLevel, key, block, Box::new(Self {}));
    }
}

impl DbKind for CombatUnitExperienceLevel {
    // This whole item type is undocumented.
    fn validate(&self, key: &Token, block: &Block, data: &Everything) {
        data.verify_exists(Item::Localization, key);

        let mut vd = Validator::new(block, data);
        // TODO: is there a requirement for levels to be consecutive?
        vd.field_integer("level");
        vd.field_item("icon", Item::File);
        vd.field_integer("needed_experience");
        vd.field_validated_block("unit_modifier", |block, data| {
            let vd = Validator::new(block, data);
            validate_modifs(block, data, ModifKinds::Unit, vd);
        });
    }
}