tiger_lib/ck3/data/
messages.rs

1use crate::block::Block;
2use crate::db::{Db, DbKind};
3use crate::everything::Everything;
4use crate::game::GameFlags;
5use crate::item::{Item, ItemLoader};
6use crate::token::Token;
7use crate::validator::Validator;
8
9#[derive(Clone, Debug)]
10pub struct Message {}
11
12inventory::submit! {
13    ItemLoader::Normal(GameFlags::Ck3, Item::Message, Message::add)
14}
15
16impl Message {
17    pub fn add(db: &mut Db, key: Token, block: Block) {
18        db.add(Item::Message, key, block, Box::new(Self {}));
19    }
20}
21
22impl DbKind for Message {
23    fn validate(&self, _key: &Token, block: &Block, data: &Everything) {
24        let mut vd = Validator::new(block, data);
25
26        vd.field_choice("display", &["feed", "toast", "popup"]);
27        vd.field_item("message_filter_type", Item::MessageFilterType);
28        vd.field_item("title", Item::Localization); // docs say text
29        vd.field_item("desc", Item::Localization);
30        vd.field_item("tooltip", Item::Localization);
31        vd.field_item("soundeffect", Item::Sound);
32        vd.field_icon("icon", "NGameIcons|MESSAGE_ICON_PATH", ".dds");
33        vd.field_choice("style", &["good", "bad", "neutral"]);
34
35        vd.advice_field("flags", "removed in 1.12");
36        vd.multi_field_value("flag");
37        vd.field_bool("combine_into_one");
38    }
39
40    fn has_property(&self, _key: &Token, block: &Block, property: &str, data: &Everything) -> bool {
41        if property == "displays_effect" {
42            if let Some(desc) = block.get_field_value("desc") {
43                data.localization.uses_macro(desc.as_str(), "EFFECT")
44            } else {
45                true
46            }
47        } else {
48            false
49        }
50    }
51}
52
53#[derive(Clone, Debug)]
54pub struct MessageFilterType {}
55
56inventory::submit! {
57    ItemLoader::Normal(GameFlags::Ck3, Item::MessageFilterType, MessageFilterType::add)
58}
59
60impl MessageFilterType {
61    pub fn add(db: &mut Db, key: Token, block: Block) {
62        db.add(Item::MessageFilterType, key, block, Box::new(Self {}));
63    }
64}
65
66impl DbKind for MessageFilterType {
67    fn validate(&self, key: &Token, block: &Block, data: &Everything) {
68        let mut vd = Validator::new(block, data);
69
70        let loca = format!("message_filter_{key}");
71        data.verify_exists_implied(Item::Localization, &loca, key);
72
73        vd.field_choice("display", &["feed", "toast", "hidden", "popup"]);
74        vd.field_bool("always_show");
75        vd.field_bool("auto_pause");
76        vd.field_integer("sort_order");
77        vd.field_item("group", Item::MessageGroupType);
78    }
79}
80
81#[derive(Clone, Debug)]
82pub struct MessageGroupType {}
83
84inventory::submit! {
85    ItemLoader::Normal(GameFlags::Ck3, Item::MessageGroupType, MessageGroupType::add)
86}
87
88impl MessageGroupType {
89    pub fn add(db: &mut Db, key: Token, block: Block) {
90        db.add(Item::MessageGroupType, key, block, Box::new(Self {}));
91    }
92}
93
94impl DbKind for MessageGroupType {
95    fn validate(&self, key: &Token, block: &Block, data: &Everything) {
96        let mut vd = Validator::new(block, data);
97
98        let loca = format!("message_group_type_{key}");
99        data.verify_exists_implied(Item::Localization, &loca, key);
100
101        vd.field_integer("sort_order");
102    }
103}