tiger_lib/vic3/data/
gamerules.rs

1use crate::block::Block;
2use crate::db::{Db, DbKind};
3use crate::everything::Everything;
4use crate::game::GameFlags;
5use crate::item::{Item, ItemLoader};
6use crate::report::{ErrorKey, warn};
7use crate::token::Token;
8use crate::validator::Validator;
9
10#[derive(Clone, Debug)]
11pub struct GameRule {}
12
13inventory::submit! {
14    ItemLoader::Normal(GameFlags::Vic3, Item::GameRule, GameRule::add)
15}
16
17impl GameRule {
18    pub fn add(db: &mut Db, key: Token, block: Block) {
19        db.add(Item::GameRule, key, block, Box::new(Self {}));
20    }
21}
22
23/// LAST UPDATED VIC3 VERSION 1.12.2
24/// Taken from `common/game_rules/_game_rules.info`
25const SIMPLE_GAME_RULE_FLAGS: &[&str] = &[
26    "blocks_achievements",
27    "lenient_ai",
28    "harsh_ai",
29    "low_ai_aggression",
30    "high_ai_aggression",
31    "no_subject_flags",
32    "no_subject_map_color",
33    // undocumented flags follow
34    "autonomous_investment",
35    "no_pop_consolidation",
36    "minor_pop_consolidation",
37    "moderate_pop_consolidation",
38    "aggressive_pop_consolidation",
39    "directly_controlled_investment",
40    "give_ruler_selector",
41    "loyalties_grace_period_none",
42    "loyalties_grace_period_short",
43    "loyalties_grace_period_long",
44    "loyalties_grace_period_extra_long",
45    "no_fantastical_content",
46    "use_custom_rng_seed",
47    "no_dynamic_naming",
48    "free_construction_scaled_player_exemption",
49    "free_construction_unscaled",
50    "give_fantastical_content",
51    "no_ruler_selector",
52];
53
54impl DbKind for GameRule {
55    fn add_subitems(&self, _key: &Token, block: &Block, db: &mut Db) {
56        for (key, _) in block.iter_definitions() {
57            db.add_flag(Item::GameRuleSetting, key.clone());
58        }
59    }
60
61    fn validate(&self, key: &Token, block: &Block, data: &Everything) {
62        let mut vd = Validator::new(block, data);
63
64        let loca = format!("rule_{key}");
65        data.verify_exists_implied(Item::Localization, &loca, key);
66
67        vd.req_field("default");
68        if let Some(token) = vd.field_value("default") {
69            if block.get_field_block(token.as_str()).is_none() {
70                let msg = "default value not found among the settings";
71                warn(ErrorKey::MissingItem).strong().msg(msg).loc(token).push();
72            }
73        }
74
75        vd.unknown_block_fields(|key, block| {
76            let mut vd = Validator::new(block, data);
77            let loca = format!("setting_{key}");
78            data.verify_exists_implied(Item::Localization, &loca, key);
79            let loca = format!("setting_{key}_desc");
80            data.verify_exists_implied(Item::Localization, &loca, key);
81
82            vd.multi_field_validated_value("flag", |_, mut vd| {
83                vd.maybe_prefix_item("disable_", Item::ProductionMethod);
84                vd.maybe_prefix_item("force_", Item::ProductionMethod);
85                vd.choice(SIMPLE_GAME_RULE_FLAGS);
86            });
87        });
88    }
89}
tiger_lib/vic3/data/gamerules.rs

tiger_lib/vic3/data/
gamerules.rs
