Skip to main content

tiger_lib/vic3/data/
ships.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::modif::validate_modifs;
7use crate::scopes::Scopes;
8use crate::token::Token;
9use crate::tooltipped::Tooltipped;
10use crate::validate::validate_color;
11use crate::validator::Validator;
12use crate::vic3::modif::ModifKinds;
13use crate::vic3::tables::modifs::maybe_warn_modifiable_capitalization;
14
15#[derive(Clone, Debug)]
16pub struct ShipType {}
17#[derive(Clone, Debug)]
18pub struct ShipGroup {}
19#[derive(Clone, Debug)]
20pub struct ShipVeterancyLevel {}
21
22inventory::submit! {
23    ItemLoader::Normal(GameFlags::Vic3, Item::ShipType, ShipType::add)
24}
25inventory::submit! {
26    ItemLoader::Normal(GameFlags::Vic3, Item::ShipGroup, ShipGroup::add)
27}
28inventory::submit! {
29    ItemLoader::Normal(GameFlags::Vic3, Item::ShipVeterancyLevel, ShipVeterancyLevel::add)
30}
31
32impl ShipType {
33    pub fn add(db: &mut Db, key: Token, block: Block) {
34        db.add(Item::ShipType, key, block, Box::new(Self {}));
35    }
36}
37impl ShipGroup {
38    pub fn add(db: &mut Db, key: Token, block: Block) {
39        db.add(Item::ShipGroup, key, block, Box::new(Self {}));
40    }
41}
42impl ShipVeterancyLevel {
43    pub fn add(db: &mut Db, key: Token, block: Block) {
44        db.add(Item::ShipVeterancyLevel, key, block, Box::new(Self {}));
45    }
46}
47
48impl DbKind for ShipType {
49    fn validate(&self, key: &Token, block: &Block, data: &Everything) {
50        let mut vd = Validator::new(block, data);
51
52        maybe_warn_modifiable_capitalization(key);
53
54        data.verify_exists(Item::Localization, key);
55        let loca = format!("{key}_desc");
56        data.verify_exists_implied(Item::Localization, &loca, key);
57
58        vd.field_validated_block("modifier", |block, data| {
59            let vd = Validator::new(block, data);
60            validate_modifs(block, data, ModifKinds::Ship, vd);
61        });
62
63        vd.field_item("ship_group", Item::ShipGroup);
64
65        vd.field_validated_block("construction_goods", |block, data| {
66            let vd = Validator::new(block, data);
67            validate_modifs(block, data, ModifKinds::Goods, vd);
68        });
69        vd.field_validated_block("materiel_goods", |block, data| {
70            let vd = Validator::new(block, data);
71            validate_modifs(block, data, ModifKinds::Goods, vd);
72        });
73        vd.field_validated_block("distance_to_port_modifier", |block, data| {
74            let vd = Validator::new(block, data);
75            validate_modifs(block, data, ModifKinds::Ship, vd);
76        });
77
78        vd.field_list_items("unlocking_technologies", Item::Technology);
79        vd.field_bool("use_modificaitons");
80        vd.field_numeric("base_construction_cost");
81        vd.field_numeric("modification_construction_cost");
82        vd.field_numeric("combat_power_multiplier");
83
84        vd.field_item("icon", Item::File);
85
86        vd.field_script_value_no_breakdown_rooted("ai_weight", Scopes::Country);
87
88        vd.multi_field_validated_block("modifications", |block, data| {
89            let mut vd = Validator::new(block, data);
90            vd.unknown_block_fields(|key, block| {
91                let mut vd = Validator::new(block, data);
92                data.verify_exists(Item::ShipModificationSlot, key);
93                for value in vd.values() {
94                    data.verify_exists(Item::ShipModification, value);
95                }
96            });
97        });
98
99        vd.multi_field_validated_block("default_modifications", |block, data| {
100            let mut vd = Validator::new(block, data);
101            vd.unknown_value_fields(|key, value| {
102                data.verify_exists(Item::ShipModificationSlot, key);
103                data.verify_exists(Item::ShipModification, value);
104            });
105        });
106
107        // undocumented
108
109        vd.field_bool("can_be_flagship");
110        vd.field_trigger_rooted("is_obsolete", Tooltipped::No, Scopes::Country);
111        vd.field_trigger_rooted("is_very_obsolete", Tooltipped::No, Scopes::Country);
112        vd.field_item("profile_texture", Item::File);
113    }
114}
115
116impl DbKind for ShipGroup {
117    fn validate(&self, key: &Token, block: &Block, data: &Everything) {
118        let mut vd = Validator::new(block, data);
119
120        maybe_warn_modifiable_capitalization(key);
121
122        data.verify_exists(Item::Localization, key);
123        let loca = format!("{key}_desc");
124        data.verify_exists_implied(Item::Localization, &loca, key);
125
126        vd.field_item("icon", Item::File);
127        vd.field_validated_block("color", validate_color);
128        vd.field_script_value_no_breakdown_rooted("ai_weight", Scopes::Country);
129
130        // undocumented
131
132        vd.field_choice("category", &["capital_group", "cruiser_group", "torpedo_group", "supply"]);
133    }
134}
135
136impl DbKind for ShipVeterancyLevel {
137    fn validate(&self, key: &Token, block: &Block, data: &Everything) {
138        let mut vd = Validator::new(block, data);
139
140        data.verify_exists(Item::Localization, key);
141
142        vd.field_item("icon", Item::File);
143        vd.field_numeric("experience_threshold");
144        vd.field_validated_block("modifier", |block, data| {
145            let vd = Validator::new(block, data);
146            validate_modifs(block, data, ModifKinds::Ship, vd);
147        });
148    }
149}