tiger_lib/ck3/data/
important_actions.rs

1use crate::block::Block;
2use crate::context::ScopeContext;
3use crate::db::{Db, DbKind};
4use crate::everything::Everything;
5use crate::game::GameFlags;
6use crate::item::{Item, ItemLoader};
7use crate::scopes::Scopes;
8use crate::token::Token;
9use crate::tooltipped::Tooltipped;
10use crate::validator::Validator;
11
12#[derive(Clone, Debug)]
13pub struct ImportantAction {}
14
15inventory::submit! {
16    ItemLoader::Normal(GameFlags::Ck3, Item::ImportantAction, ImportantAction::add)
17}
18
19impl ImportantAction {
20    pub fn add(db: &mut Db, key: Token, block: Block) {
21        db.add(Item::ImportantAction, key, block, Box::new(Self {}));
22    }
23}
24
25impl DbKind for ImportantAction {
26    fn validate(&self, key: &Token, block: &Block, data: &Everything) {
27        let mut vd = Validator::new(block, data);
28
29        data.verify_exists(Item::Localization, key);
30        let loca = format!("{key}_label");
31        data.mark_used(Item::Localization, &loca); // TODO: when is _label needed?
32        let loca = format!("{key}_desc");
33        data.verify_exists_implied(Item::Localization, &loca, key);
34        let loca = format!("{key}_click");
35        data.verify_exists_implied(Item::Localization, &loca, key);
36        if block.field_value_is("combine_into_one", "yes") {
37            data.verify_exists_implied(Item::Localization, &loca, key);
38            let loca = format!("{key}_combined_label");
39            data.mark_used(Item::Localization, &loca); // TODO: when is _label needed?
40            let loca = format!("{key}_combined_group_label");
41            data.mark_used(Item::Localization, &loca); // TODO: when is _label needed?
42            let loca = format!("{key}_combined_group_name");
43            data.verify_exists_implied(Item::Localization, &loca, key);
44            let loca = format!("{key}_combined_group_description");
45            data.verify_exists_implied(Item::Localization, &loca, key);
46            if block.has_key("unimportant") {
47                let loca = format!("{key}_combined_unimportant");
48                data.verify_exists_implied(Item::Localization, &loca, key);
49            }
50        }
51
52        vd.field_choice("type", &["action", "alert", "tutorial"]);
53
54        if let Some(token) = vd.field_value("icon") {
55            data.verify_icon("NGameIcons|IMPORTANT_ACTIONS_TYPE_ICON_PATH", token, ".dds");
56        } else if block.field_value_is("type", "alert") {
57            data.verify_icon("NGameIcons|IMPORTANT_ACTIONS_TYPE_ICON_PATH", key, ".dds");
58        }
59
60        vd.field_bool("is_dangerous");
61        vd.field_integer("priority");
62        vd.field_bool("combine_into_one");
63
64        // TODO: "only interface effects are allowed"
65        vd.field_effect_rooted("check_create_action", Tooltipped::No, Scopes::Character);
66        // TODO: "only interface effects are allowed"
67        vd.field_effect_builder("effect", Tooltipped::No, |key| {
68            let mut sc = ScopeContext::new(Scopes::Character, key);
69            // TODO: The scope context will contain all scopes passed in the try_create_important_action call
70            sc.set_strict_scopes(false);
71            sc
72        });
73
74        vd.field_item("soundeffect", Item::Sound);
75
76        // undocumented
77        vd.field_trigger_builder("unimportant", Tooltipped::No, |key| {
78            let mut sc = ScopeContext::new(Scopes::Character, key);
79            sc.define_name("actor", Scopes::Character, key);
80            sc.define_name("recipient", Scopes::Character, key);
81            sc
82        });
83    }
84}
tiger_lib/ck3/data/important_actions.rs

tiger_lib/ck3/data/
important_actions.rs
