tiger_lib/ck3/data/
schemes.rs

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
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
use crate::block::Block;
use crate::ck3::tables::misc::AGENT_SLOT_CONTRIBUTION_TYPE;
use crate::ck3::validate::validate_cost;
use crate::context::ScopeContext;
use crate::db::{Db, DbKind};
use crate::desc::validate_desc;
use crate::effect::validate_effect;
use crate::everything::Everything;
use crate::game::GameFlags;
use crate::item::{Item, ItemLoader};
use crate::modif::{validate_modifs, ModifKinds};
use crate::report::{warn, ErrorKey};
use crate::scopes::Scopes;
use crate::script_value::validate_non_dynamic_script_value;
use crate::token::Token;
use crate::tooltipped::Tooltipped;
use crate::trigger::validate_trigger;
use crate::validate::{validate_duration, validate_modifiers_with_base};
use crate::validator::{Builder, Validator};

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

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

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

impl DbKind for Scheme {
    fn validate(&self, key: &Token, block: &Block, data: &Everything) {
        let mut vd = Validator::new(block, data);
        let target_scopes =
            Scopes::Character | Scopes::LandedTitle | Scopes::Culture | Scopes::Faith;
        let mut sc = ScopeContext::new(Scopes::Character, key);
        sc.define_name("scheme", Scopes::Scheme, key);
        sc.define_name("target", target_scopes, key);
        sc.define_name("owner", Scopes::Character, key);
        sc.define_name("exposed", Scopes::Bool, key);

        // let modif = format!("max_{key}_schemes_add");
        // data.verify_exists_implied(Item::ModifierFormat, &modif, key);
        // let modif = format!("{key}_scheme_power_add");
        // data.verify_exists_implied(Item::ModifierFormat, &modif, key);
        // let modif = format!("{key}_scheme_power_mult");
        // data.verify_exists_implied(Item::ModifierFormat, &modif, key);
        // let modif = format!("{key}_scheme_resistance_add");
        // data.verify_exists_implied(Item::ModifierFormat, &modif, key);
        // let modif = format!("{key}_scheme_resistance_mult");
        // data.verify_exists_implied(Item::ModifierFormat, &modif, key);

        data.verify_exists(Item::Localization, key);
        let loca = format!("{key}_action");
        data.verify_exists_implied(Item::Localization, &loca, key);

        vd.req_field("desc");
        vd.field_validated_sc("desc", &mut sc, validate_desc);
        vd.req_field("success_desc");
        vd.field_validated_sc("success_desc", &mut sc, validate_desc); // undocumented
        vd.field_validated_sc("discovery_desc", &mut sc, validate_desc); // undocumented

        vd.req_field("skill");
        vd.field_item("skill", Item::Skill);

        // "political" is undocumented
        vd.field_choice("category", &["personal", "contract", "hostile", "political"]);
        vd.field_choice("target_type", &["character", "title", "culture", "faith", "nothing"]);

        vd.advice_field("hostile", "deprecated; replaced with `category`");
        vd.field_bool("hostile");

        let icon = vd.field_value("icon").unwrap_or(key);
        data.verify_icon("NGameIcons|SCHEME_TYPE_ICON_PATH", icon, ".dds");
        vd.field_item("illustration", Item::File);

        vd.field_validated_block("allow", |block, data| {
            validate_trigger(block, data, &mut sc, Tooltipped::Yes);
        });
        vd.field_validated_block("valid", |block, data| {
            validate_trigger(block, data, &mut sc, Tooltipped::No);
        });

        vd.field_integer("agent_join_threshold");
        vd.field_integer("agent_leave_threshold");
        vd.field_bool("uses_resistance");

        vd.field_bool("is_basic");

        vd.field_validated_block("valid_agent", |block, data| {
            validate_trigger(block, data, &mut sc, Tooltipped::No);
        });

        vd.field_list("agent_groups_owner_perspective"); // TODO
        vd.field_list("agent_groups_target_character_perspective"); // TODO

        vd.field_script_value("odds_prediction", &mut sc);

        vd.field_validated_key_block("agent_join_chance", |key, block, data| {
            let mut sc = sc.clone();
            sc.define_name("gift", Scopes::Bool, key);
            validate_modifiers_with_base(block, data, &mut sc);
        });
        vd.field_validated_block_sc("agent_success_chance", &mut sc, validate_modifiers_with_base);
        vd.field_validated_block_sc("base_success_chance", &mut sc, validate_modifiers_with_base);
        vd.advice_field(
            "base_maximum_success_chance",
            "docs say `base_maximum_success_chance` but it's `base_maximum_success`",
        );
        vd.field_script_value("base_maximum_success", &mut sc);
        vd.advice_field("maximum_success", "Replaced with `base_maximum_success`");
        vd.field_integer_range("minimum_success", 0..=100);
        vd.field_integer_range("maximum_secrecy", 0..=100);
        vd.field_integer_range("minimum_secrecy", 0..=100);
        vd.advice_field("maximum_progress_chance", "Removed in 1.13");
        vd.advice_field("minimum_progress_chance", "Removed in 1.13");
        vd.field_script_value("base_progress_goal", &mut sc);
        vd.field_integer("maximum_breaches");

        vd.advice_field("power_per_skill_point", "Replaced with `speed_per_skill_point`");
        vd.advice_field("resistance_per_skill_point", "Removed in 1.13");
        vd.advice_field("power_per_agent_skill_point", "Removed in 1.13");
        vd.advice_field(
            "spymaster_power_per_skill_point",
            "Replaced with `spymaster_speed_per_skill_point`",
        );
        vd.advice_field("spymaster_resistance_per_skill_point", "Removed in 1.13");
        vd.advice_field("tier_resistance", "Removed in 1.13");
        vd.advice_field("uses_agents", "Removed in 1.13");

        vd.field_validated_block("pulse_actions", |block, data| {
            let mut vd = Validator::new(block, data);
            vd.field_list_items("entries", Item::SchemePulseAction);
            vd.field_validated("chance_of_no_event", validate_non_dynamic_script_value);
        });

        vd.field_validated_block_sc("cooldown", &mut sc, validate_duration);

        vd.field_bool("is_secret");
        vd.field_validated_block("use_secrecy", |block, data| {
            validate_trigger(block, data, &mut sc, Tooltipped::No);
        });
        let sc_secrecy: &Builder = &|key| {
            let mut sc = ScopeContext::new(Scopes::Scheme, key);
            let target_scopes =
                Scopes::Character | Scopes::LandedTitle | Scopes::Culture | Scopes::Faith;
            sc.define_name("target", target_scopes, key);
            sc.define_name("owner", Scopes::Character, key);
            sc.define_name("exposed", Scopes::Bool, key);
            sc
        };
        vd.field_script_value_full("base_secrecy", sc_secrecy, false);

        // on_start is undocumented
        for field in &[
            "on_start",
            "on_phase_completed",
            "on_hud_click",
            "on_monthly",
            "on_semiyearly",
            "on_invalidated",
        ] {
            vd.field_validated_key_block(field, |key, block, data| {
                let mut sc = ScopeContext::new(Scopes::Scheme, key);
                validate_effect(block, data, &mut sc, Tooltipped::No);
            });
        }
        vd.advice_field("on_ready", "Replaced with `on_phase_completed`");
        vd.advice_field("on_agent_join", "Removed in 1.13");
        vd.advice_field("on_agent_leave", "Removed in 1.13");
        vd.advice_field("on_agent_exposed", "Removed in 1.13");

        vd.field_bool("freeze_scheme_when_traveling");
        vd.field_bool("freeze_scheme_when_traveling_target");
        vd.field_bool("cancel_scheme_when_traveling");
        vd.field_bool("cancel_scheme_when_traveling_target");

        vd.field_script_value("speed_per_skill_point", &mut sc);
        vd.field_script_value("speed_per_target_skill_point", &mut sc);
        vd.field_script_value("success_chance_growth_per_skill_point", &mut sc);
        vd.field_script_value("spymaster_speed_per_skill_point", &mut sc);
        vd.field_script_value("target_spymaster_speed_per_skill_point", &mut sc);
        vd.field_integer("tier_speed");

        // undocumented

        vd.field_script_value("phases_per_agent_charge", &mut sc);
    }
}

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

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

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

impl DbKind for AgentType {
    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}_i");
        data.verify_exists_implied(Item::Localization, &loca, key);
        let loca = format!("{key}_desc");
        data.verify_exists_implied(Item::Localization, &loca, key);

        vd.field_validated_key_block("valid_agent_for_slot", |key, block, data| {
            let target_scopes =
                Scopes::Character | Scopes::LandedTitle | Scopes::Culture | Scopes::Faith;
            let mut sc = ScopeContext::new(Scopes::Character, key);
            sc.define_name("owner", Scopes::Character, key);
            sc.define_name("target", target_scopes, key);
            validate_trigger(block, data, &mut sc, Tooltipped::Yes);
        });
        vd.field_choice("contribution_type", AGENT_SLOT_CONTRIBUTION_TYPE);

        let sc_builder: &Builder = &|key| {
            let target_scopes =
                Scopes::Character | Scopes::LandedTitle | Scopes::Culture | Scopes::Faith;
            let mut sc = ScopeContext::new(Scopes::Character, key);
            sc.define_name("owner", Scopes::Character, key);
            sc.define_name("scheme", Scopes::Scheme, key);
            sc.define_name("target", target_scopes, key);
            sc
        };
        vd.field_script_value_full("contribution", sc_builder, true);
    }
}

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

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

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

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

        let sc_builder: &Builder = &|key| {
            let mut sc = ScopeContext::new(Scopes::Scheme, key);
            sc.define_name("scheme", Scopes::Scheme, key); // docs say "activity"
            sc.define_name("owner", Scopes::Character, key);
            sc
        };

        let icon = vd.field_value("icon").unwrap_or(key);
        data.verify_icon("NGameIcons|STATICMODIFIER_ICON_PATH", icon, ".dds");

        vd.field_localization("hud_text", &mut sc_builder(key));

        vd.field_validated_key_block("is_valid", |key, block, data| {
            validate_trigger(block, data, &mut sc_builder(key), Tooltipped::No);
        });
        vd.field_script_value_full("weight", sc_builder, false);
        vd.field_validated_key_block("effect", |key, block, data| {
            validate_effect(block, data, &mut sc_builder(key), Tooltipped::No);
        });
    }
}

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

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

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

impl DbKind for Countermeasure {
    fn add_subitems(&self, _key: &Token, block: &Block, db: &mut Db) {
        if let Some(parameters) = block.get_field_block("parameters") {
            for (key, _) in parameters.iter_assignments() {
                db.add_flag(Item::CountermeasureParameter, key.clone());
            }
        }
    }

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

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

        data.verify_icon("NGameIcons|SCHEME_COUNTERMEASURE_TYPE_ICON_PATH", key, ".dds");

        vd.field_validated_key_block("is_shown", |key, block, data| {
            let mut sc = ScopeContext::new(Scopes::Character, key);
            validate_trigger(block, data, &mut sc, Tooltipped::No);
        });
        vd.field_validated_key_block("is_valid_showing_failures_only", |key, block, data| {
            let mut sc = ScopeContext::new(Scopes::Character, key);
            validate_trigger(block, data, &mut sc, Tooltipped::FailuresOnly);
        });
        vd.field_validated_key_block("on_activate", |key, block, data| {
            let mut sc = ScopeContext::new(Scopes::Character, key);
            validate_effect(block, data, &mut sc, Tooltipped::Yes);
        });

        let mut sc = ScopeContext::new(Scopes::Character, key);
        vd.field_validated_block_sc("activation_cost", &mut sc, validate_cost);

        vd.field_validated_block("owner_modifier", |block, data| {
            let vd = Validator::new(block, data);
            validate_modifs(block, data, ModifKinds::Character, vd);
        });

        vd.field_script_value_full("ai_will_do", Scopes::Character, false);

        vd.field_validated_block("parameters", |block, data| {
            let mut vd = Validator::new(block, data);
            vd.unknown_value_fields(|_, value| {
                if !value.is("yes") {
                    let msg = "only `yes` currently makes sense here";
                    warn(ErrorKey::Validation).msg(msg).loc(value).push();
                }
            });
        });

        // undocumented

        vd.field_item("frame", Item::File);
    }
}