tiger_lib/ck3/data/
factions.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
use crate::block::{Block, BV};
use crate::context::ScopeContext;
use crate::db::{Db, DbKind};
use crate::desc::validate_desc;
use crate::effect::validate_effect;
use crate::everything::Everything;
use crate::game::GameFlags;
use crate::item::{Item, ItemLoader};
use crate::scopes::Scopes;
use crate::token::Token;
use crate::tooltipped::Tooltipped;
use crate::trigger::validate_trigger;
use crate::validate::validate_modifiers_with_base;
use crate::validator::Validator;

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

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

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

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

        if !vd.field_validated_rooted("name", Scopes::Faction, validate_desc) {
            data.verify_exists(Item::Localization, key);
        }

        // TODO: docs say description but vanilla uses desc. Verify.
        if !vd.field_validated_rooted("description", Scopes::Faction, validate_desc) {
            let loca = format!("{key}_desc");
            data.verify_exists_implied(Item::Localization, &loca, key);
        }

        vd.req_field("short_effect_desc");
        vd.field_validated_rooted("short_effect_desc", Scopes::Faction, validate_desc);

        vd.field_validated_block_rooted("demand", Scopes::Faction, |block, data, sc| {
            validate_effect(block, data, sc, Tooltipped::No);
        });
        vd.field_validated_block_rooted("update_effect", Scopes::Faction, |block, data, sc| {
            validate_effect(block, data, sc, Tooltipped::No);
        });
        // docs say "on_declaration"
        vd.field_validated_block_rooted("on_war_start", Scopes::Faction, |block, data, sc| {
            validate_effect(block, data, sc, Tooltipped::No);
        });
        vd.field_validated_block_rooted("character_leaves", Scopes::Faction, |block, data, sc| {
            validate_effect(block, data, sc, Tooltipped::No);
        });
        vd.field_validated_key_block("leader_leaves", |key, block, data| {
            let mut sc = ScopeContext::new(Scopes::Faction, key);
            sc.define_name("faction_member", Scopes::Character, key);
            validate_effect(block, data, &mut sc, Tooltipped::No);
        });
        vd.field_validated_key_block("ai_join_score", |key, block, data| {
            let mut sc = ScopeContext::new(Scopes::Character, key);
            sc.define_name("faction", Scopes::Faction, key);
            validate_modifiers_with_base(block, data, &mut sc);
        });
        vd.field_validated_key_block("ai_create_score", |key, block, data| {
            let mut sc = ScopeContext::new(Scopes::Character, key);
            sc.define_name("target", Scopes::Character, key);
            // TODO: check if it's a claimant faction before setting claimant and title
            sc.define_name("claimant", Scopes::Character, key);
            sc.define_name("title", Scopes::LandedTitle, key);
            validate_modifiers_with_base(block, data, &mut sc);
        });
        vd.field_validated_key_block("county_join_score", |key, block, data| {
            let mut sc = ScopeContext::new(Scopes::LandedTitle, key);
            sc.define_name("faction", Scopes::Faction, key);
            validate_modifiers_with_base(block, data, &mut sc);
        });
        vd.field_validated_key_block("county_create_score", |key, block, data| {
            let mut sc = ScopeContext::new(Scopes::LandedTitle, key);
            sc.define_name("target", Scopes::Character, key);
            validate_modifiers_with_base(block, data, &mut sc);
        });
        vd.field_script_value_rooted("county_power", Scopes::LandedTitle);
        vd.field_validated_block_rooted(
            "ai_demand_chance",
            Scopes::Faction,
            validate_modifiers_with_base,
        );
        vd.field_validated_block_rooted(
            "discontent_progress",
            Scopes::Faction,
            validate_modifiers_with_base,
        );
        vd.field_validated_rooted("power_threshold", Scopes::Faction, |bv, data, sc| match bv {
            BV::Value(t) => _ = t.expect_integer(),
            BV::Block(b) => validate_modifiers_with_base(b, data, sc),
        });
        vd.field_validated_block_rooted("is_valid", Scopes::Faction, |block, data, sc| {
            validate_trigger(block, data, sc, Tooltipped::No);
        });
        vd.field_validated_key_block("is_character_valid", |key, block, data| {
            let mut sc = ScopeContext::new(Scopes::Character, key);
            sc.define_name("faction", Scopes::Faction, key);
            validate_trigger(block, data, &mut sc, Tooltipped::No);
        });
        vd.field_validated_key_block("is_county_valid", |key, block, data| {
            let mut sc = ScopeContext::new(Scopes::LandedTitle, key);
            sc.define_name("faction", Scopes::Faction, key);
            validate_trigger(block, data, &mut sc, Tooltipped::No);
        });
        vd.field_validated_key_block("can_character_join", |key, block, data| {
            let mut sc = ScopeContext::new(Scopes::Character, key);
            sc.define_name("faction", Scopes::Faction, key);
            validate_trigger(block, data, &mut sc, Tooltipped::Yes);
        });
        vd.field_validated_key_block("can_character_create", |key, block, data| {
            let mut sc = ScopeContext::new(Scopes::Character, key);
            sc.define_name("target", Scopes::Character, key);
            validate_trigger(block, data, &mut sc, Tooltipped::Yes);
        });
        vd.field_validated_key_block("can_character_create_ui", |key, block, data| {
            let mut sc = ScopeContext::new(Scopes::Character, key);
            sc.define_name("target", Scopes::Character, key);
            validate_trigger(block, data, &mut sc, Tooltipped::Yes);
        });
        vd.field_validated_key_block("can_character_become_leader", |key, block, data| {
            let mut sc = ScopeContext::new(Scopes::Character, key);
            sc.define_name("faction", Scopes::Faction, key);
            validate_trigger(block, data, &mut sc, Tooltipped::No);
        });
        vd.field_validated_key_block("can_county_join", |key, block, data| {
            let mut sc = ScopeContext::new(Scopes::LandedTitle, key);
            sc.define_name("faction", Scopes::Faction, key);
            validate_trigger(block, data, &mut sc, Tooltipped::No);
        });
        vd.field_validated_key_block("can_county_create", |key, block, data| {
            let mut sc = ScopeContext::new(Scopes::LandedTitle, key);
            sc.define_name("target", Scopes::Character, key);
            validate_trigger(block, data, &mut sc, Tooltipped::No);
        });

        vd.field_bool("character_allow_create");
        vd.field_bool("character_allow_join");
        vd.field_bool("county_allow_create");
        vd.field_bool("county_allow_join");
        vd.field_bool("leaders_allowed_to_leave");
        vd.field_bool("player_can_join");
        vd.field_bool("multiple_targeting");

        vd.field_item("casus_belli", Item::CasusBelli);
        vd.field_item("special_character_title", Item::Localization);

        vd.field_bool("ignore_soft_block");
        vd.field_bool("inherit_membership");
        vd.field_bool("requires_county");
        vd.field_bool("requires_character");
        vd.field_bool("requires_leader");
        vd.field_bool("county_can_switch_to_other_faction");
        vd.field_integer("sort_order");
        vd.field_bool("show_special_title");

        // undocumented fields follow
        vd.field_validated_block_rooted("on_creation", Scopes::Faction, |block, data, sc| {
            validate_effect(block, data, sc, Tooltipped::No);
        });
        vd.field_validated_block_rooted("on_destroy", Scopes::Faction, |block, data, sc| {
            validate_effect(block, data, sc, Tooltipped::No);
        });
    }
}