tiger_lib/ck3/data/
laws.rs

1use crate::block::Block;
2use crate::ck3::modif::ModifKinds;
3use crate::ck3::validate::validate_cost;
4use crate::context::ScopeContext;
5use crate::db::{Db, DbKind};
6use crate::everything::Everything;
7use crate::game::GameFlags;
8use crate::item::{Item, ItemLoader};
9use crate::modif::validate_modifs;
10use crate::report::{ErrorKey, err};
11use crate::scopes::Scopes;
12use crate::token::Token;
13use crate::tooltipped::Tooltipped;
14use crate::validator::Validator;
15
16#[derive(Clone, Debug)]
17pub struct LawGroup {}
18
19inventory::submit! {
20    ItemLoader::Normal(GameFlags::Ck3, Item::LawGroup, LawGroup::add)
21}
22
23impl LawGroup {
24    pub fn add(db: &mut Db, key: Token, block: Block) {
25        db.add(Item::LawGroup, key, block, Box::new(Self {}));
26    }
27}
28
29impl DbKind for LawGroup {
30    fn add_subitems(&self, _key: &Token, block: &Block, db: &mut Db) {
31        for (key, block) in block.iter_definitions() {
32            for token in block.get_field_values("flag") {
33                db.add_flag(Item::LawFlag, token.clone());
34            }
35            for block in block.get_field_blocks("triggered_flag") {
36                if let Some(token) = block.get_field_value("flag") {
37                    db.add_flag(Item::LawFlag, token.clone());
38                }
39            }
40            db.add(Item::Law, key.clone(), block.clone(), Box::new(Law {}));
41        }
42        for token in block.get_field_values("flag") {
43            db.add_flag(Item::LawFlag, token.clone());
44        }
45    }
46
47    fn validate(&self, _key: &Token, block: &Block, data: &Everything) {
48        let mut vd = Validator::new(block, data);
49
50        if let Some(token) = vd.field_value("default") {
51            if block.get_field_block(token.as_str()).is_none() {
52                let msg = "law not defined in this group";
53                err(ErrorKey::MissingItem).msg(msg).loc(token).push();
54            }
55        }
56        vd.field_bool("cumulative");
57
58        vd.multi_field_value("flag");
59
60        vd.field_bool("is_treasury_budget_group");
61        vd.field_trigger_rooted("can_change_law_group", Tooltipped::Yes, Scopes::Character);
62
63        // The laws. They are validated in the Law class.
64        vd.unknown_block_fields(|_, _| ());
65    }
66}
67
68#[derive(Clone, Debug)]
69pub struct Law {}
70
71impl Law {}
72
73impl DbKind for Law {
74    fn validate(&self, key: &Token, block: &Block, data: &Everything) {
75        let mut vd = Validator::new(block, data);
76        let mut sc = ScopeContext::new(Scopes::Character, key);
77
78        data.verify_exists(Item::Localization, key);
79        let loca = format!("{key}_effects");
80        data.verify_exists_implied(Item::Localization, &loca, key);
81        let loca = format!("{key}_effects_not_in_prev");
82        data.mark_used(Item::Localization, &loca);
83
84        vd.field_item("pass_phrase", Item::Localization);
85        vd.field_item("confirmation_title", Item::Localization);
86        vd.field_item("confirmation_button_text", Item::Localization);
87
88        vd.field_trigger_rooted("can_keep", Tooltipped::No, Scopes::Character);
89        vd.field_trigger_rooted("can_have", Tooltipped::No, Scopes::Character);
90        vd.field_trigger_rooted("can_pass", Tooltipped::Yes, Scopes::Character);
91        vd.field_trigger_rooted("should_start_with", Tooltipped::Yes, Scopes::Character);
92        vd.field_trigger_rooted("can_title_have", Tooltipped::Yes, Scopes::LandedTitle);
93        vd.field_trigger_rooted("can_realm_have", Tooltipped::Yes, Scopes::Character);
94        vd.field_trigger_rooted("should_show_for_title", Tooltipped::No, Scopes::LandedTitle);
95        vd.field_trigger_rooted("can_remove_from_title", Tooltipped::Yes, Scopes::LandedTitle);
96
97        vd.field_validated_block_rooted("pass_cost", Scopes::Character, validate_cost);
98        vd.field_validated_block_rooted("revoke_cost", Scopes::Character, validate_cost);
99
100        vd.multi_field_validated_block("modifier", |block, data| {
101            let vd = Validator::new(block, data);
102            validate_modifs(block, data, ModifKinds::Character, vd);
103        });
104
105        vd.multi_field_value("flag");
106        vd.field_validated_block("triggered_flag", |block, data| {
107            let mut vd = Validator::new(block, data);
108            vd.req_field("trigger");
109            vd.req_field("flag");
110            vd.field_trigger_rooted("trigger", Tooltipped::No, Scopes::Character);
111            vd.field_value("flag");
112        });
113
114        let title_law = block.has_key("can_title_have");
115        let sc_builder = |key: &Token| {
116            let mut sc = ScopeContext::new(Scopes::Character, key);
117            if title_law {
118                sc.define_name("title", Scopes::LandedTitle, key);
119            }
120            sc
121        };
122
123        vd.field_bool("shown_in_encyclopedia");
124        vd.field_effect_builder("on_pass", Tooltipped::Yes, sc_builder);
125        vd.field_effect_builder("on_after_pass", Tooltipped::Yes, sc_builder);
126        vd.field_effect_builder("on_revoke", Tooltipped::Yes, sc_builder);
127
128        vd.field_validated_block("succession", |block, data| {
129            let mut vd = Validator::new(block, data);
130            // "generate" and "player_heir" are undocumented
131            vd.field_choice(
132                "order_of_succession",
133                &[
134                    "inheritance",
135                    "election",
136                    "appointment",
137                    "theocratic",
138                    "company",
139                    "generate",
140                    "generate_from_template",
141                    "player_heir",
142                    "noble_family",
143                ],
144            );
145            let order_of_succession =
146                block.get_field_value("order_of_succession").map_or("none", Token::as_str);
147
148            if order_of_succession == "inheritance" || order_of_succession == "noble_family" {
149                vd.field_choice("title_division", &["partition", "single_heir"]);
150            } else {
151                vd.ban_field(
152                    "title_division",
153                    || "order_of_succession = inheritance or noble_family",
154                );
155            }
156
157            // TODO: children may only be used if title_division == partition
158            vd.field_choice("traversal_order", &["children", "dynasty_house", "dynasty"]);
159            vd.field_choice("rank", &["oldest", "youngest"]);
160            if let Some(title_division) = block.get_field_value("title_division") {
161                if let Some(traversal_order) = block.get_field_value("traversal_order") {
162                    if title_division.is("partition") && !traversal_order.is("children") {
163                        let msg = "partition is only for `traversal_order = children`";
164                        err(ErrorKey::Validation).msg(msg).loc(title_division).push();
165                    }
166                }
167            }
168
169            if order_of_succession == "theocratic"
170                || order_of_succession == "company"
171                || order_of_succession == "generate"
172            {
173                vd.field_item("pool_character_config", Item::PoolSelector);
174            } else {
175                vd.ban_field(
176                    "pool_character_config",
177                    || "theocratic, company, or generate succession",
178                );
179            }
180
181            if order_of_succession == "election" {
182                vd.field_item("election_type", Item::SuccessionElection);
183            } else {
184                vd.ban_field("election_type", || "order_of_succession = election");
185            }
186
187            if order_of_succession == "appointment" {
188                vd.field_item("appointment_type", Item::SuccessionAppointment);
189            } else {
190                vd.ban_field("appointment_type", || "order_of_succession = appointment");
191            }
192
193            vd.field_choice(
194                "gender_law",
195                &["male_only", "male_preference", "equal", "female_preference", "female_only"],
196            );
197            vd.field_choice("faith", &["same_faith", "same_religion", "same_family"]);
198            vd.field_bool("create_primary_tier_titles");
199            vd.field_numeric("primary_heir_minimum_share");
200            vd.field_bool("exclude_rulers");
201            vd.field_bool("limit_to_courtiers");
202        });
203
204        vd.field_script_value_no_breakdown("ai_will_do", &mut sc);
205
206        // undocumented
207
208        vd.field_integer("title_allegiance_opinion");
209        vd.field_trigger_rooted("potential", Tooltipped::No, Scopes::Character);
210        vd.field_trigger_rooted("requires_approve", Tooltipped::No, Scopes::Character);
211        // TODO: should be Item::WidgetName, but the name used in vanilla (widget_clan_law) is not
212        // recognized by the gui parser because it's hidden in a type declaration.
213        vd.field_value("widget_name");
214    }
215}
tiger_lib/ck3/data/laws.rs

tiger_lib/ck3/data/
laws.rs
