tiger_lib/vic3/data/
commanders.rs

1use crate::block::Block;
2use crate::context::ScopeContext;
3use crate::db::{Db, DbKind};
4use crate::desc::validate_desc;
5use crate::everything::Everything;
6use crate::game::GameFlags;
7use crate::item::{Item, ItemLoader};
8use crate::modif::validate_modifs;
9use crate::report::{ErrorKey, warn};
10use crate::scopes::Scopes;
11use crate::token::Token;
12use crate::tooltipped::Tooltipped;
13use crate::trigger::validate_trigger;
14use crate::validator::Validator;
15use crate::vic3::modif::ModifKinds;
16
17#[derive(Clone, Debug)]
18pub struct CommanderOrder {}
19
20inventory::submit! {
21    ItemLoader::Normal(GameFlags::Vic3, Item::CommanderOrder, CommanderOrder::add)
22}
23
24impl CommanderOrder {
25    pub fn add(db: &mut Db, key: Token, block: Block) {
26        db.add(Item::CommanderOrder, key, block, Box::new(Self {}));
27    }
28}
29
30impl DbKind for CommanderOrder {
31    fn validate(&self, key: &Token, block: &Block, data: &Everything) {
32        let mut vd = Validator::new(block, data);
33
34        data.verify_exists(Item::Localization, key);
35        let loca = format!("{key}_desc");
36        data.verify_exists_implied(Item::Localization, &loca, key);
37        let loca = format!("{key}_gerund");
38        data.verify_exists_implied(Item::Localization, &loca, key);
39        let loca = format!("{key}_tooltip");
40        data.verify_exists_implied(Item::Localization, &loca, key);
41
42        vd.field_item("texture", Item::File);
43        vd.field_choice("military_type", &["army", "navy"]);
44        // undocumented
45        vd.field_choice(
46            "behavior",
47            &["advance", "defend", "intercept", "blockade", "raid_convoys", "escort_convoys"],
48        );
49        // undocumented
50        vd.advice_field("ai_usage", "renamed to `behavior` in 1.9");
51        vd.field_bool("is_basic_order_type");
52
53        vd.field_validated_key_block("possible", |key, block, data| {
54            if block.has_key_recursive("error_check") {
55                let msg = "error_check is no longer used to control visibility";
56                let info = "there is now a separate `visible` trigger";
57                warn(ErrorKey::Removed).msg(msg).info(info).loc(key).push();
58            }
59            // TODO: `NOT = { has_trait = foo }` in this trigger will be misrepresented in the UI
60            let mut sc = ScopeContext::new(Scopes::Character, key);
61            validate_trigger(block, data, &mut sc, Tooltipped::No);
62        });
63        vd.field_validated_block("modifier", |block, data| {
64            let vd = Validator::new(block, data);
65            let mk = ModifKinds::Character | ModifKinds::Battle;
66            validate_modifs(block, data, mk, vd);
67        });
68
69        // TODO: this should be a state inside a unit's Item::Entity
70        // The connection between the units and the entities is very indirect.
71        vd.field_value("entity_animation");
72
73        if block.field_value_is("military_type", "navy") {
74            vd.field_item("naval_entity", Item::Entity);
75        } else {
76            vd.ban_field("naval_entity", || "navy");
77        }
78
79        vd.field_trigger_rooted("visible", Tooltipped::No, Scopes::Character);
80
81        vd.field_numeric_range("indicator_position_angle", 0.0..360.0);
82        vd.field_numeric_range("indicator_position_angle_for_enemy", 0.0..360.0);
83        vd.field_item("clicksound", Item::Sound);
84        vd.field_numeric("escape_power_ratio");
85        vd.field_numeric("experience");
86
87        // TODO: verify scope type
88        let mut sc = ScopeContext::new(Scopes::Character, key);
89        // undocumented
90        vd.field_script_value("ai_weight", &mut sc);
91    }
92}
93
94#[derive(Clone, Debug)]
95pub struct CommanderRank {}
96
97inventory::submit! {
98    ItemLoader::Normal(GameFlags::Vic3, Item::CommanderRank, CommanderRank::add)
99}
100
101impl CommanderRank {
102    pub fn add(db: &mut Db, key: Token, block: Block) {
103        db.add(Item::CommanderRank, key, block, Box::new(Self {}));
104    }
105}
106
107impl DbKind for CommanderRank {
108    // This entire item type is undocumented
109    fn validate(&self, key: &Token, block: &Block, data: &Everything) {
110        let mut vd = Validator::new(block, data);
111
112        data.verify_exists(Item::Localization, key);
113
114        vd.field_item("texture", Item::File);
115
116        // A comment in the script says
117        // "If you're adding more ranks that commanders can be promoted to, make sure to change HIGHEST_PROMOTION_RANK in defines"
118        // but that doesn't limit the possible `rank_value` values, since they can be set in other
119        // ways than promotion.
120        vd.field_integer_range("rank_value", 1..);
121
122        vd.field_validated_block("character_modifier", |block, data| {
123            let vd = Validator::new(block, data);
124            validate_modifs(block, data, ModifKinds::Character, vd);
125        });
126        for field in &["general_modifier", "admiral_modifier"] {
127            vd.field_validated_block(field, |block, data| {
128                let vd = Validator::new(block, data);
129                validate_modifs(
130                    block,
131                    data,
132                    ModifKinds::Character | ModifKinds::Battle | ModifKinds::MilitaryFormation,
133                    vd,
134                );
135            });
136        }
137        vd.field_validated_block("country_modifier", |block, data| {
138            let vd = Validator::new(block, data);
139            validate_modifs(block, data, ModifKinds::Country, vd);
140        });
141        vd.field_validated_block("interest_group_modifier", |block, data| {
142            let vd = Validator::new(block, data);
143            validate_modifs(block, data, ModifKinds::InterestGroup, vd);
144        });
145
146        let mut sc = ScopeContext::new(Scopes::Character, key);
147        vd.field_validated_sc("title", &mut sc, validate_desc);
148    }
149}
tiger_lib/vic3/data/commanders.rs

tiger_lib/vic3/data/
commanders.rs
