tiger_lib/ck3/data/
struggle.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
use crate::block::Block;
use crate::context::ScopeContext;
use crate::db::{Db, DbKind};
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::pdxfile::PdxEncoding;
use crate::report::{warn, ErrorKey};
use crate::scopes::Scopes;
use crate::script_value::validate_script_value;
use crate::token::Token;
use crate::tooltipped::Tooltipped;
use crate::validate::validate_duration;
use crate::validator::Validator;

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

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

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

impl DbKind for Struggle {
    fn add_subitems(&self, _key: &Token, block: &Block, db: &mut Db) {
        if let Some(block) = block.get_field_block("phase_list") {
            for (key, block) in block.iter_definitions() {
                db.add_flag(Item::StrugglePhase, key.clone());
                for field in &["war_effects", "culture_effects", "faith_effects", "other_effects"] {
                    if let Some(block) = block.get_field_block(field) {
                        for field in &[
                            "common_parameters",
                            "involved_parameters",
                            "interloper_parameters",
                            "uninvolved_parameters",
                        ] {
                            if let Some(block) = block.get_field_block(field) {
                                for (key, value) in block.iter_assignments() {
                                    if value.is("yes") {
                                        db.add_flag(Item::StrugglePhaseParameter, key.clone());
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }

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

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

        vd.field_list_items("cultures", Item::Culture);
        vd.field_list_items("faiths", Item::Faith);
        vd.field_list_items("regions", Item::Region);

        vd.field_validated_block_sc("transition_state_duration", &mut sc, validate_duration);
        vd.field_numeric_range("involvement_prerequisite_percentage", 0.0..=1.0);

        vd.req_field("phase_list");
        vd.field_validated_block("phase_list", |block, data| {
            let mut has_one = false;
            let mut has_ending = false;
            let phases = block.iter_definitions_warn().map(|(key, _)| key).collect::<Vec<_>>();
            let mut vd = Validator::new(block, data);
            vd.unknown_block_fields(|key, block| {
                data.verify_exists(Item::Localization, key);
                let loca = format!("{key}_desc");
                data.verify_exists_implied(Item::Localization, &loca, key);
                data.verify_icon("NGameIcons|STRUGGLE_PHASE_TYPE_ICON_PATH", key, ".dds");
                has_one = true;
                validate_phase(block, data, &phases);
                if let Some(vec) = block.get_field_list("ending_decisions") {
                    has_ending |= !vec.is_empty();
                }
            });
            if !has_one {
                warn(ErrorKey::Validation).msg("must have at least one phase").loc(block).push();
            }
            // TODO: Verify if it is OK to have an ending phase but no ending decisions
            if !has_ending {
                let msg = "must have at least one phase with ending_decisions";
                warn(ErrorKey::Validation).msg(msg).loc(block).push();
            }
        });

        vd.req_field("start_phase");
        vd.field_item("start_phase", Item::StrugglePhase);

        vd.field_validated_block("on_start", |block, data| {
            validate_effect(block, data, &mut sc, Tooltipped::No);
        });
        vd.field_validated_block("on_end", |block, data| {
            validate_effect(block, data, &mut sc, Tooltipped::No); // TODO: check tooltipped
        });
        vd.field_validated_block("on_change_phase", |block, data| {
            validate_effect(block, data, &mut sc, Tooltipped::No); // TODO: check tooltipped
        });
        vd.field_validated_block_rooted("on_join", Scopes::Character, |block, data, sc| {
            validate_effect(block, data, sc, Tooltipped::No); // TODO: check tooltipped
        });
        vd.field_validated_block("on_monthly", |block, data| {
            validate_effect(block, data, &mut sc, Tooltipped::No);
        });
    }
}

fn validate_phase(block: &Block, data: &Everything, phases: &[&Token]) {
    let mut vd = Validator::new(block, data);

    // Ending phase
    if vd.field_block("on_start") {
        // Undocumented
        vd.field_bool("save_progress");
        vd.field_validated_block_rooted("on_start", Scopes::Struggle, |block, data, sc| {
            validate_effect(block, data, sc, Tooltipped::Yes);
        });
        vd.unknown_fields(|key, _| {
            let msg = format!("ending phase should not have {key}, which will be ignored");
            warn(ErrorKey::UnknownField).msg(msg).loc(key).push();
        });
    } else {
        vd.field_validated_block_rooted("duration", Scopes::None, |block, data, sc| {
            if let Some(bv) = block.get_field("points") {
                if let Some(token) = bv.expect_value() {
                    token.expect_integer();
                }
            } else {
                validate_duration(block, data, sc);
            }
        });

        vd.field_item("background", Item::File);
        vd.req_field("future_phases");
        vd.field_validated_block("future_phases", |block, data| {
            let mut vd = Validator::new(block, data);
            let mut has_one = false;
            vd.unknown_block_fields(|key, block| {
                let mut vd = Validator::new(block, data);
                has_one = true;
                data.verify_exists(Item::StrugglePhase, key);
                if !phases.contains(&key) {
                    let msg = format!("{key} is not a struggle phase of this struggle");
                    warn(ErrorKey::UnknownField).msg(msg).loc(key).push();
                }
                vd.field_bool("default");
                vd.field_validated_block("catalysts", validate_catalyst_list);
            });
            if !has_one {
                warn(ErrorKey::Validation)
                    .msg("must have at least one future phase")
                    .loc(block)
                    .push();
            }
        });

        for field in &["war_effects", "culture_effects", "faith_effects", "other_effects"] {
            vd.field_validated_block(field, validate_phase_effects);
        }

        vd.field_list_items("ending_decisions", Item::Decision);
    }
}

fn validate_catalyst_list(block: &Block, data: &Everything) {
    let mut vd = Validator::new(block, data);
    vd.unknown_fields(|key, bv| {
        if bv.expect_value().is_some() {
            data.verify_exists(Item::Catalyst, key);
            let mut sc = ScopeContext::new(Scopes::None, key);
            validate_script_value(bv, data, &mut sc);
        }
    });
}

fn validate_phase_effects(block: &Block, data: &Everything) {
    let mut vd = Validator::new(block, data);
    vd.field_item("name", Item::Localization);
    vd.field_validated_block("common_parameters", validate_struggle_parameters);
    vd.field_validated_block("involved_parameters", validate_struggle_parameters);
    vd.field_validated_block("interloper_parameters", validate_struggle_parameters);
    vd.field_validated_block("uninvolved_parameters", validate_struggle_parameters);

    for field in &["involved_character_modifier", "interloper_character_modifier"] {
        vd.field_validated_block(field, |block, data| {
            let vd = Validator::new(block, data);
            validate_modifs(block, data, ModifKinds::Character, vd);
        });
    }

    for field in &["involved_doctrine_character_modifier", "interloper_doctrine_character_modifier"]
    {
        vd.field_validated_block(field, |block, data| {
            let mut vd = Validator::new(block, data);
            vd.field_item("doctrine", Item::Doctrine);
            validate_modifs(block, data, ModifKinds::Character, vd);
        });
    }

    for field in &[
        "all_county_modifier",
        "involved_county_modifier",
        "interloper_county_modifier",
        "uninvolved_county_modifier",
    ] {
        vd.field_validated_block(field, |block, data| {
            let vd = Validator::new(block, data);
            validate_modifs(block, data, ModifKinds::County, vd);
        });
    }
}

fn validate_struggle_parameters(block: &Block, data: &Everything) {
    let mut vd = Validator::new(block, data);
    vd.unknown_value_fields(|key, value| {
        if !value.is("yes") {
            let msg = format!("expected `{key} = yes`");
            warn(ErrorKey::Validation).msg(msg).loc(value).push();
        }

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

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

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

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

impl DbKind for Catalyst {
    fn validate(&self, _key: &Token, block: &Block, data: &Everything) {
        let mut _vd = Validator::new(block, data);
    }
}

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

inventory::submit! {
    ItemLoader::Full(GameFlags::Ck3, Item::StruggleHistory, PdxEncoding::Utf8Bom, ".txt", true, StruggleHistory::add)
}

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

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

        vd.unknown_block_fields(|key, block| {
            key.expect_date();
            let mut vd = Validator::new(block, data);
            vd.field_validated_block("effect", |block, data| {
                validate_effect(block, data, &mut sc, Tooltipped::No);
            });
        });
    }
}