tiger_lib/ck3/data/
modifiers.rs

1#![allow(non_upper_case_globals)]
2
3use crate::block::Block;
4use crate::ck3::modif::ModifKinds;
5use crate::context::ScopeContext;
6use crate::db::{Db, DbKind};
7use crate::everything::Everything;
8use crate::game::GameFlags;
9use crate::item::{Item, ItemLoader};
10use crate::modif::validate_modifs;
11use crate::token::Token;
12use crate::validator::Validator;
13
14#[derive(Clone, Debug)]
15pub struct Modifier {}
16
17inventory::submit! {
18    ItemLoader::Normal(GameFlags::Ck3, Item::Modifier, Modifier::add)
19}
20
21impl Modifier {
22    pub fn add(db: &mut Db, key: Token, block: Block) {
23        db.add_exact_dup_ok(Item::Modifier, key, block, Box::new(Self {}));
24    }
25}
26
27impl DbKind for Modifier {
28    fn validate(&self, key: &Token, block: &Block, data: &Everything) {
29        let mut vd = Validator::new(block, data);
30
31        // There are {key} and {key}_desc locas but both are optional
32        data.mark_used(Item::Localization, key.as_str());
33        let loca = format!("{key}_desc");
34        data.mark_used(Item::Localization, &loca);
35
36        vd.field_icon("icon", "NGameIcons|STATICMODIFIER_ICON_PATH", ".dds");
37
38        vd.field_bool("stacking");
39        vd.field_bool("hide_effects");
40        // `scale` is validated in `validate_call`
41        vd.field_block("scale");
42        validate_modifs(block, data, ModifKinds::all(), vd);
43    }
44
45    fn validate_call(
46        &self,
47        _key: &Token,
48        block: &Block,
49        _from: &Token,
50        _from_block: &Block,
51        data: &Everything,
52        sc: &mut ScopeContext,
53    ) {
54        let mut vd = Validator::new(block, data);
55        // docs say that the object the scale is applied to is `root`, but I suspect it's really `this`.
56        // TODO: verify
57        vd.field_validated_block("scale", |block, data| {
58            let mut vd = Validator::new(block, data);
59            vd.req_field("value");
60            vd.field_script_value("value", sc);
61            vd.field_item("desc", Item::Localization);
62            // Undocumented `display_mode`
63            // TODO: get all possible values
64            vd.field_choice("display_mode", &["scaled"]);
65        });
66        vd.no_warn_remaining();
67    }
68
69    fn validate_property_use(
70        &self,
71        _key: &Token,
72        block: &Block,
73        _property: &Token,
74        caller: &str,
75        data: &Everything,
76    ) {
77        let mut vd = Validator::new(block, data);
78        // skip over the known fields
79        vd.field("icon");
80        vd.field("stacking");
81        vd.field("hide_effects");
82        vd.field("scale");
83
84        // TODO: make validate_modifs explain why it expected this kind
85        validate_modifs(block, data, get_modif_kinds(caller), vd);
86    }
87}
88
89// LAST UPDATED CK3 VERSION 1.12.1
90/// Get the modifier kinds from property name
91/// See `effects.log` from the game data dumps.
92fn get_modif_kinds(name: &str) -> ModifKinds {
93    for substr in [
94        "artifact_modifier",
95        "character_modifier",
96        "dynasty_modifier",
97        "house_modifier",
98        "house_unity_modifier",
99        "legend_owner_modifier",
100    ] {
101        if name.contains(substr) {
102            return ModifKinds::Character;
103        }
104    }
105    if name.contains("county_modifier") {
106        return ModifKinds::County;
107    }
108    if name.contains("province_modifier") {
109        return ModifKinds::Province;
110    }
111    if name.contains("scheme_modifier") {
112        return ModifKinds::Scheme;
113    }
114    if name.contains("travel_plan_modifier") {
115        return ModifKinds::TravelPlan;
116    }
117
118    ModifKinds::empty()
119}
tiger_lib/ck3/data/modifiers.rs

tiger_lib/ck3/data/
modifiers.rs
