tiger_lib/ck3/data/
laws.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
use crate::block::Block;
use crate::ck3::validate::validate_cost;
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::report::{err, ErrorKey};
use crate::scopes::Scopes;
use crate::token::Token;
use crate::tooltipped::Tooltipped;
use crate::trigger::validate_trigger;
use crate::validator::Validator;

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

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

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

impl DbKind for LawGroup {
    fn add_subitems(&self, _key: &Token, block: &Block, db: &mut Db) {
        for (key, block) in block.iter_definitions() {
            for token in block.get_field_values("flag") {
                db.add_flag(Item::LawFlag, token.clone());
            }
            for block in block.get_field_blocks("triggered_flag") {
                if let Some(token) = block.get_field_value("flag") {
                    db.add_flag(Item::LawFlag, token.clone());
                }
            }
            db.add(Item::Law, key.clone(), block.clone(), Box::new(Law {}));
        }
        for token in block.get_field_values("flag") {
            db.add_flag(Item::LawFlag, token.clone());
        }
    }

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

        if let Some(token) = vd.field_value("default") {
            if block.get_field_block(token.as_str()).is_none() {
                let msg = "law not defined in this group";
                err(ErrorKey::MissingItem).msg(msg).loc(token).push();
            }
        }
        vd.field_bool("cumulative");

        vd.multi_field_value("flag");
        // The laws. They are validated in the Law class.
        vd.unknown_block_fields(|_, _| ());
    }
}

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

impl Law {}

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

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

        vd.field_validated_block_rooted("can_keep", Scopes::Character, |block, data, sc| {
            validate_trigger(block, data, sc, Tooltipped::No);
        });
        vd.field_validated_block_rooted("can_have", Scopes::Character, |block, data, sc| {
            validate_trigger(block, data, sc, Tooltipped::No);
        });
        vd.field_validated_block_rooted("can_pass", Scopes::Character, |block, data, sc| {
            validate_trigger(block, data, sc, Tooltipped::Yes);
        });
        vd.field_validated_block_rooted(
            "should_start_with",
            Scopes::Character,
            |block, data, sc| {
                validate_trigger(block, data, sc, Tooltipped::Yes);
            },
        );

        vd.field_validated_block_rooted(
            "can_title_have",
            Scopes::LandedTitle,
            |block, data, sc| {
                validate_trigger(block, data, sc, Tooltipped::Yes);
            },
        );
        vd.field_validated_block_rooted(
            "should_show_for_title",
            Scopes::LandedTitle,
            |block, data, sc| {
                validate_trigger(block, data, sc, Tooltipped::No);
            },
        );
        vd.field_validated_block_rooted(
            "can_remove_from_title",
            Scopes::LandedTitle,
            |block, data, sc| {
                validate_trigger(block, data, sc, Tooltipped::Yes);
            },
        );

        vd.field_validated_block_rooted("pass_cost", Scopes::Character, validate_cost);
        vd.field_validated_block_rooted("revoke_cost", Scopes::Character, validate_cost);

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

        vd.multi_field_value("flag");
        vd.field_validated_block("triggered_flag", |block, data| {
            let mut vd = Validator::new(block, data);
            vd.req_field("trigger");
            vd.req_field("flag");
            vd.field_validated_block_rooted("trigger", Scopes::Character, |block, data, sc| {
                validate_trigger(block, data, sc, Tooltipped::No);
            });
            vd.field_value("flag");
        });

        let title_law = block.has_key("can_title_have");

        vd.field_validated_key_block("on_pass", |key, block, data| {
            let mut sc = ScopeContext::new(Scopes::Character, key);
            if title_law {
                sc.define_name("title", Scopes::LandedTitle, key);
            }
            validate_effect(block, data, &mut sc, Tooltipped::Yes);
        });
        vd.field_validated_key_block("on_revoke", |key, block, data| {
            let mut sc = ScopeContext::new(Scopes::Character, key);
            if title_law {
                sc.define_name("title", Scopes::LandedTitle, key);
            }
            sc.define_name("title", Scopes::LandedTitle, key);
            validate_effect(block, data, &mut sc, Tooltipped::Yes);
        });

        vd.field_validated_block("succession", |block, data| {
            let mut vd = Validator::new(block, data);
            // "generate" and "player_heir" are undocumented
            vd.field_choice(
                "order_of_succession",
                &[
                    "inheritance",
                    "election",
                    "appointment",
                    "theocratic",
                    "company",
                    "generate",
                    "player_heir",
                    "noble_family",
                ],
            );
            vd.field_choice("title_division", &["partition", "single_heir"]);
            vd.field_choice("traversal_order", &["children", "dynasty_house", "dynasty"]);
            vd.field_choice("rank", &["oldest", "youngest"]);
            if let Some(title_division) = block.get_field_value("title_division") {
                if let Some(traversal_order) = block.get_field_value("traversal_order") {
                    if title_division.is("partition") && !traversal_order.is("children") {
                        let msg = "partition is only for `traversal_order = children`";
                        err(ErrorKey::Validation).msg(msg).loc(title_division).push();
                    }
                }
            }

            let order_of_succession =
                block.get_field_value("order_of_succession").map_or("none", Token::as_str);
            if order_of_succession == "theocratic"
                || order_of_succession == "company"
                || order_of_succession == "generate"
            {
                vd.field_item("pool_character_config", Item::PoolSelector);
            } else {
                vd.ban_field("pool_character_config", || {
                    "theocratic, company, or generate succession"
                });
            }

            if order_of_succession == "election" {
                vd.field_item("election_type", Item::SuccessionElection);
            } else {
                vd.ban_field("election_type", || "order_of_succession = election");
            }

            if order_of_succession == "appointment" {
                vd.field_item("appointment_type", Item::SuccessionAppointment);
            } else {
                vd.ban_field("appointment_type", || "order_of_succession = appointment");
            }

            vd.field_choice(
                "gender_law",
                &["male_only", "male_preference", "equal", "female_preference", "female_only"],
            );
            vd.field_choice("faith", &["same_faith", "same_religion", "same_family"]);
            vd.field_bool("create_primary_tier_titles");
            vd.field_numeric("primary_heir_minimum_share");
            vd.field_bool("exclude_rulers");
            vd.field_bool("limit_to_courtiers");
        });

        vd.field_script_value_no_breakdown("ai_will_do", &mut sc);

        // undocumented

        vd.field_bool("shown_in_encyclopedia");
        vd.field_integer("title_allegiance_opinion");
        vd.field_validated_block_rooted("potential", Scopes::Character, |block, data, sc| {
            validate_trigger(block, data, sc, Tooltipped::No);
        });
        vd.field_validated_block_rooted(
            "requires_approve",
            Scopes::Character,
            |block, data, sc| {
                validate_trigger(block, data, sc, Tooltipped::No);
            },
        );
        // TODO: should be Item::WidgetName, but the name used in vanilla (widget_clan_law) is not
        // recognized by the gui parser because it's hidden in a type declaration.
        vd.field_value("widget_name");
    }
}