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

use crate::block::Block;
use crate::context::ScopeContext;
use crate::db::{Db, DbKind};
use crate::everything::Everything;
use crate::game::GameFlags;
use crate::item::{Item, ItemLoader};
use crate::report::{ErrorKey, err};
use crate::scopes::Scopes;
use crate::token::Token;
use crate::tooltipped::Tooltipped;
use crate::validate::validate_possibly_named_color;
use crate::validator::Validator;

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

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

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

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

        let loca = format!("alert_{key}_name");
        data.verify_exists_implied(Item::Localization, &loca, key);
        let loca = format!("alert_{key}_hint");
        data.verify_exists_implied(Item::Localization, &loca, key);
        let loca = format!("alert_{key}_action");
        data.verify_exists_implied(Item::Localization, &loca, key);
        let loca = format!("{key}_setting_name");
        data.verify_exists_implied(Item::Localization, &loca, key);
        let loca = format!("alert_{key}_desc");
        data.localization.suggest(&loca, key);

        vd.req_field("script_context");
        let mut sc = ScopeContext::new(Scopes::None, key);
        if let Some(script_context) = vd.field_value("script_context") {
            let mut found = false;
            for &(context, s) in SCRIPT_CONTEXTS {
                if script_context.is(context) {
                    sc = ScopeContext::new(s, key);
                    sc.define_name("actor", Scopes::Country, key);
                    if context == "player_invasion" {
                        sc.define_name("is_naval_invasion", Scopes::Bool, key);
                        sc.define_name("attacker", Scopes::Country, key);
                        sc.define_name("defender", Scopes::Country, key);
                    }
                    found = true;
                    break;
                }
            }
            if !found {
                let msg = "unknown script context";
                err(ErrorKey::Choice).msg(msg).loc(script_context).push();
            }
        }

        vd.field_item("texture", Item::File);
        vd.field_trigger("valid", Tooltipped::No, &mut sc);
        // TODO figure out the valid panel and popup values
        vd.exclusive_fields(&["open_panel", "open_popup"]);
        vd.field_value("open_panel");
        vd.field_value("open_popup");
        vd.field_choice("type", &["alert", "important_action", "angry_important_action"]);
        vd.field_item("alert_group", Item::AlertGroup);
        vd.field_validated("color", validate_possibly_named_color);
    }
}

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

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

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

impl DbKind for AlertGroup {
    fn validate(&self, key: &Token, block: &Block, data: &Everything) {
        // Just check that the alert group is empty
        Validator::new(block, data);

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

// LAST UPDATED VIC3 VERSION 1.12.2
const SCRIPT_CONTEXTS: &[(&str, Scopes)] = &[
    ("player_country", Scopes::Country),
    ("player_decision", Scopes::Country),
    ("player_country_formation", Scopes::Country),
    ("player_diplomatic_play", Scopes::DiplomaticPlay),
    ("player_diplomatic_pact", Scopes::DiplomaticPact),
    ("player_diplomatic_action", Scopes::DiplomaticAction),
    ("player_diplomatic_relations", Scopes::DiplomaticRelations),
    ("player_interest_group", Scopes::InterestGroup),
    ("player_invaded_state", Scopes::State),
    ("player_market", Scopes::Market),
    ("player_invasion", Scopes::Invasion),
    ("player_state", Scopes::State),
    ("player_building", Scopes::Building),
    ("player_market_goods", Scopes::MarketGoods),
    ("player_commander", Scopes::Character),
    ("player_military_formation", Scopes::MilitaryFormation),
    ("player_subject", Scopes::Country),
    ("player_treaty", Scopes::Treaty),
    ("player_article", Scopes::TreatyArticle),
    // undocumented from here
    ("player_front", Scopes::Front),
    ("player_war", Scopes::War),
    ("player_company", Scopes::Company),
    ("player_state_local_goods", Scopes::StateGoods),
];