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

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::scopes::Scopes;
use crate::token::Token;
use crate::tooltipped::Tooltipped;
use crate::validator::Validator;

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

inventory::submit! {
    ItemLoader::Normal(GameFlags::Ck3, Item::ImportantAction, ImportantAction::add)
}

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

impl DbKind for ImportantAction {
    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}_label");
        data.mark_used(Item::Localization, &loca); // TODO: when is _label needed?
        let loca = format!("{key}_desc");
        data.verify_exists_implied(Item::Localization, &loca, key);
        let loca = format!("{key}_click");
        data.verify_exists_implied(Item::Localization, &loca, key);
        if block.field_value_is("combine_into_one", "yes") {
            data.verify_exists_implied(Item::Localization, &loca, key);
            let loca = format!("{key}_combined_label");
            data.mark_used(Item::Localization, &loca); // TODO: when is _label needed?
            let loca = format!("{key}_combined_group_label");
            data.mark_used(Item::Localization, &loca); // TODO: when is _label needed?
            let loca = format!("{key}_combined_group_name");
            data.verify_exists_implied(Item::Localization, &loca, key);
            let loca = format!("{key}_combined_group_description");
            data.verify_exists_implied(Item::Localization, &loca, key);
            if block.has_key("unimportant") {
                let loca = format!("{key}_combined_unimportant");
                data.verify_exists_implied(Item::Localization, &loca, key);
            }
        }

        vd.field_choice("type", &["action", "alert", "tutorial"]);

        if let Some(token) = vd.field_value("icon") {
            data.verify_icon("NGameIcons|IMPORTANT_ACTIONS_TYPE_ICON_PATH", token, ".dds");
        } else if block.field_value_is("type", "alert") {
            data.verify_icon("NGameIcons|IMPORTANT_ACTIONS_TYPE_ICON_PATH", key, ".dds");
        }

        vd.field_bool("is_dangerous");
        vd.field_integer("priority");
        vd.field_bool("combine_into_one");

        // TODO: "only interface effects are allowed"
        vd.field_effect_rooted("check_create_action", Tooltipped::No, Scopes::Character);
        // TODO: "only interface effects are allowed"
        vd.field_effect_builder("effect", Tooltipped::No, |key| {
            let mut sc = ScopeContext::new(Scopes::Character, key);
            // TODO: The scope context will contain all scopes passed in the try_create_important_action call
            sc.set_strict_scopes(false);
            sc
        });

        vd.field_item("soundeffect", Item::Sound);

        // undocumented
        vd.field_trigger_builder("unimportant", Tooltipped::No, |key| {
            let mut sc = ScopeContext::new(Scopes::Character, key);
            sc.define_name("actor", Scopes::Character, key);
            sc.define_name("recipient", Scopes::Character, key);
            sc
        });
    }
}