tiger_lib/ck3/data/
tax_slots.rs

1use crate::block::Block;
2use crate::ck3::modif::ModifKinds;
3use crate::context::ScopeContext;
4use crate::db::{Db, DbKind};
5use crate::everything::Everything;
6use crate::game::GameFlags;
7use crate::item::{Item, ItemLoader};
8use crate::modif::validate_modifs;
9use crate::scopes::Scopes;
10use crate::script_value::validate_script_value_no_breakdown;
11use crate::token::Token;
12use crate::tooltipped::Tooltipped;
13use crate::validator::Validator;
14
15#[derive(Clone, Debug)]
16pub struct TaxSlotType {}
17
18inventory::submit! {
19    ItemLoader::Normal(GameFlags::Ck3, Item::TaxSlotType, TaxSlotType::add)
20}
21
22impl TaxSlotType {
23    pub fn add(db: &mut Db, key: Token, block: Block) {
24        db.add(Item::TaxSlotType, key, block, Box::new(Self {}));
25    }
26}
27
28impl DbKind for TaxSlotType {
29    fn validate(&self, key: &Token, block: &Block, data: &Everything) {
30        data.verify_exists(Item::Localization, key);
31
32        let mut vd = Validator::new(block, data);
33        vd.field_item("government", Item::GovernmentType);
34        // Undocumented
35        vd.field_item("default_obligation", Item::TaxSlotObligation);
36        // Documented erroneously as `vassal_contracts` in _tax_slot_type.info
37        vd.field_list_items("obligations", Item::TaxSlotObligation);
38
39        vd.field_script_value_builder("tax_slot_vassal_limit", |key| {
40            let mut sc = ScopeContext::new(Scopes::TaxSlot, key);
41            sc.define_name("liege", Scopes::Character, key);
42            sc.define_name("tax_collector", Scopes::Character, key);
43            sc
44        });
45
46        vd.field_trigger_builder("is_valid_tax_collector", Tooltipped::No, |key| {
47            let mut sc = ScopeContext::new(Scopes::Character, key);
48            sc.define_name("liege", Scopes::Character, key);
49            sc
50        });
51
52        vd.field_list("aptitude_level_breakpoints");
53        vd.field_script_value_rooted("tax_collector_aptitude", Scopes::Character);
54
55        for field in &["on_tax_collector_hired", "on_tax_collector_fired"] {
56            vd.field_effect_builder(field, Tooltipped::No, |key| {
57                let mut sc = ScopeContext::new(Scopes::None, key);
58                sc.define_name("liege", Scopes::Character, key);
59                sc.define_name("tax_slot", Scopes::TaxSlot, key);
60                sc.define_name("tax_collector", Scopes::Character, key);
61                sc
62            });
63        }
64
65        for field in &["on_vassal_assigned", "on_vassal_removed"] {
66            vd.field_effect_builder(field, Tooltipped::No, |key| {
67                let mut sc = ScopeContext::new(Scopes::None, key);
68                sc.define_name("liege", Scopes::Character, key);
69                sc.define_name("tax_slot", Scopes::TaxSlot, key);
70                sc.define_name("vassal", Scopes::Character, key);
71                sc
72            });
73        }
74    }
75}
76
77#[derive(Clone, Debug)]
78pub struct TaxSlotObligation {}
79
80inventory::submit! {
81    ItemLoader::Normal(GameFlags::Ck3, Item::TaxSlotObligation, TaxSlotObligation::add)
82}
83
84impl TaxSlotObligation {
85    pub fn add(db: &mut Db, key: Token, block: Block) {
86        db.add(Item::TaxSlotObligation, key, block, Box::new(Self {}));
87    }
88}
89
90impl DbKind for TaxSlotObligation {
91    fn add_subitems(&self, _key: &Token, block: &Block, db: &mut Db) {
92        for token in block.get_field_values("flag") {
93            // TODO: not 100% sure of this.
94            db.add_flag(Item::SubjectContractFlag, token.clone());
95        }
96    }
97
98    fn validate(&self, key: &Token, block: &Block, data: &Everything) {
99        data.verify_exists(Item::Localization, key);
100        let loca = format!("{key}_flavor_desc");
101        data.verify_exists_implied(Item::Localization, &loca, key);
102
103        data.verify_icon("NGameIcons|TAX_SLOT_OBLIGATION_TYPE_PATH", key, ".dds");
104
105        let mut vd = Validator::new(block, data);
106        vd.field_trigger_builder("is_shown", Tooltipped::No, |key| {
107            let mut sc = ScopeContext::new(Scopes::None, key);
108            sc.define_name("tax_slot", Scopes::TaxSlot, key);
109            sc.define_name("liege", Scopes::Character, key);
110            sc.define_name("tax_collector", Scopes::Character, key);
111            sc
112        });
113
114        vd.field_trigger_builder("is_valid", Tooltipped::Yes, |key| {
115            let mut sc = ScopeContext::new(Scopes::None, key);
116            sc.define_name("tax_slot", Scopes::TaxSlot, key);
117            sc.define_name("liege", Scopes::Character, key);
118            sc.define_name("tax_collector", Scopes::Character, key);
119            sc
120        });
121
122        vd.field_trigger_builder("is_vassal_valid", Tooltipped::Yes, |key| {
123            let mut sc = ScopeContext::new(Scopes::None, key);
124            sc.define_name("tax_slot", Scopes::TaxSlot, key);
125            sc.define_name("liege", Scopes::Character, key);
126            sc.define_name("vassal", Scopes::Character, key);
127            sc.define_name("tax_collector", Scopes::Character, key);
128            sc
129        });
130
131        // Documented `vassal_opinion` does not work
132        vd.field_numeric("tax_factor");
133        vd.field_numeric("levies_factor");
134
135        // Undocumented
136        vd.field_validated_block("liege_modifier", |block, data| {
137            let vd = Validator::new(block, data);
138            validate_modifs(block, data, ModifKinds::Character, vd);
139        });
140
141        vd.advice_field("vassal_modifier", "was changed to subject_modifier in 1.16");
142        vd.field_validated_block("subject_modifier", |block, data| {
143            let vd = Validator::new(block, data);
144            validate_modifs(block, data, ModifKinds::Character, vd);
145        });
146
147        vd.multi_field_value("flag");
148
149        // Undocumented; may have more scopes available
150        vd.field_validated_key("ai_will_do", |key, bv, data| {
151            let mut sc = ScopeContext::new(Scopes::None, key);
152            sc.define_name("is_current_obligation", Scopes::Bool, key);
153            sc.define_name("liege", Scopes::Character, key);
154            sc.define_name("num_slots_with_obligation", Scopes::Value, key);
155            sc.define_name("num_vassal_slots", Scopes::Value, key);
156            validate_script_value_no_breakdown(bv, data, &mut sc);
157        });
158    }
159}
tiger_lib/ck3/data/tax_slots.rs

tiger_lib/ck3/data/
tax_slots.rs
