tiger_lib/ck3/data/
epidemics.rs

1use crate::Everything;
2use crate::block::{BV, Block};
3use crate::ck3::modif::ModifKinds;
4use crate::ck3::tables::misc::OUTBREAK_INTENSITIES;
5use crate::context::ScopeContext;
6use crate::db::{Db, DbKind};
7use crate::desc::validate_desc;
8use crate::game::GameFlags;
9use crate::item::{Item, ItemLoader};
10use crate::modif::validate_modifs;
11use crate::report::{ErrorKey, warn};
12use crate::scopes::Scopes;
13use crate::script_value::validate_non_dynamic_script_value;
14use crate::token::Token;
15use crate::tooltipped::Tooltipped;
16use crate::validate::{validate_duration, validate_possibly_named_color};
17use crate::validator::Validator;
18
19#[derive(Clone, Debug)]
20pub struct EpidemicType {}
21
22inventory::submit! {
23    ItemLoader::Normal(GameFlags::Ck3, Item::EpidemicType, EpidemicType::add)
24}
25
26impl EpidemicType {
27    pub fn add(db: &mut Db, key: Token, block: Block) {
28        db.add(Item::EpidemicType, key, block, Box::new(Self {}));
29    }
30}
31
32impl DbKind for EpidemicType {
33    fn validate(&self, key: &Token, block: &Block, data: &crate::Everything) {
34        let mut vd = Validator::new(block, data);
35        vd.req_field("trait");
36        vd.field_item("trait", Item::Trait);
37        vd.field_validated("color", validate_possibly_named_color);
38
39        if !vd.field_validated_rooted("name", Scopes::Epidemic, validate_desc) {
40            let loca = format!("epidemic_{key}");
41            data.verify_exists_implied(Item::Localization, &loca, key);
42        }
43
44        vd.field_integer_range("priority", 1..);
45
46        vd.field_validated_block("shader_data", |block, data| {
47            let mut vd = Validator::new(block, data);
48            vd.field_precise_numeric_range("strength", 0.0..=1.0);
49            vd.field_precise_numeric_range("edge_fade", 0.0..=1.0);
50            vd.field_precise_numeric_range("tile_multiplier", 0.0..=1.0);
51            vd.field_integer_range("texture_index", 0..);
52            vd.field_choice("channel", &["red", "green", "blue", "alpha"]);
53        });
54
55        vd.field_trigger_builder(
56            "can_infect_character",
57            Tooltipped::No,
58            build_character_epidemic_sc,
59        );
60
61        vd.field_script_value_no_breakdown_builder("character_infection_chance", |key| {
62            let mut sc = build_character_epidemic_sc(key);
63            // undocumented
64            sc.define_name("province", Scopes::Province, key);
65            sc
66        });
67
68        vd.field_effect_builder(
69            "on_character_infected",
70            Tooltipped::No,
71            build_character_epidemic_sc,
72        );
73        vd.field_effect_builder("on_province_infected", Tooltipped::No, build_province_epidemic_sc);
74        vd.field_effect_builder(
75            "on_province_recovered",
76            Tooltipped::No,
77            build_province_epidemic_sc,
78        );
79        vd.field_effect_rooted("on_start", Tooltipped::No, Scopes::Epidemic);
80        vd.field_effect_builder("on_monthly", Tooltipped::No, build_character_epidemic_sc);
81        vd.field_effect_rooted("on_end", Tooltipped::No, Scopes::Epidemic);
82
83        vd.field_validated_block("infection_levels", |block, data| {
84            let mut vd = Validator::new(block, data);
85            vd.unknown_block_fields(|key, block| {
86                let mut vd = Validator::new(block, data);
87                validate_non_dynamic_script_value(&BV::Value(key.clone()), data);
88
89                vd.field_validated_block("province_modifier", |block, data| {
90                    let vd = Validator::new(block, data);
91                    validate_modifs(block, data, ModifKinds::Province, vd);
92                });
93
94                vd.field_validated_block("county_modifier", |block, data| {
95                    let vd = Validator::new(block, data);
96                    validate_modifs(block, data, ModifKinds::County, vd);
97                });
98
99                vd.field_validated_block("realm_modifier", |block, data| {
100                    let vd = Validator::new(block, data);
101                    validate_modifs(block, data, ModifKinds::Character, vd);
102                });
103            });
104        });
105
106        vd.field_validated_block("outbreak_intensities", |block, data| {
107            let mut vd = Validator::new(block, data);
108            for &level in OUTBREAK_INTENSITIES {
109                vd.req_field(level);
110                vd.field_validated_block(level, validate_outbreak_level);
111            }
112        });
113
114        if !data.item_exists(Item::EpidemicDeathReason, key.as_str()) {
115            let msg = format!("no deathreason found for epidemic {key}");
116            let info = "this will lead to the game showing 0 deaths from this epidemic";
117            warn(ErrorKey::MissingItem).msg(msg).info(info).loc(key).push();
118        }
119    }
120}
121
122fn build_character_epidemic_sc(key: &Token) -> ScopeContext {
123    let mut sc = ScopeContext::new(Scopes::Character, key);
124    sc.define_name("epidemic", Scopes::Epidemic, key);
125    sc
126}
127
128fn build_province_epidemic_sc(key: &Token) -> ScopeContext {
129    let mut sc = ScopeContext::new(Scopes::Province, key);
130    sc.define_name("epidemic", Scopes::Epidemic, key);
131    sc
132}
133
134fn validate_outbreak_level(block: &Block, data: &Everything) {
135    let mut vd = Validator::new(block, data);
136    vd.field_bool("global_notification");
137    vd.field_script_value_no_breakdown_builder("outbreak_chance", |key| {
138        let mut sc = ScopeContext::new(Scopes::Province, key);
139        sc.define_name("epidemic_type", Scopes::EpidemicType, key);
140        sc
141    });
142
143    vd.field_script_value_builder("spread_chance", build_province_epidemic_sc);
144    vd.field_script_value_no_breakdown_builder("max_provinces", |key| {
145        ScopeContext::new(Scopes::None, key)
146    });
147
148    vd.field_validated_block_build_sc(
149        "infection_duration",
150        build_province_epidemic_sc,
151        validate_duration,
152    );
153
154    vd.field_validated_block_build_sc(
155        "infection_progress_duration",
156        build_province_epidemic_sc,
157        validate_duration,
158    );
159
160    vd.field_validated_block_build_sc(
161        "infection_recovery_duration",
162        build_province_epidemic_sc,
163        validate_duration,
164    );
165}