tiger_lib/ck3/data/
court_scene.rs

1use std::cmp::max;
2
3use crate::block::Block;
4use crate::ck3::data::scripted_animations::validate_scripted_animation;
5use crate::ck3::tables::misc::SUPPORT_TYPES;
6use crate::context::ScopeContext;
7use crate::db::{Db, DbKind};
8use crate::everything::Everything;
9use crate::game::GameFlags;
10use crate::item::{Item, ItemLoader, LoadAsFile, Recursive};
11use crate::pdxfile::PdxEncoding;
12use crate::report::{ErrorKey, warn};
13use crate::scopes::Scopes;
14use crate::token::Token;
15use crate::tooltipped::Tooltipped;
16use crate::validator::Validator;
17
18#[derive(Clone, Debug)]
19pub struct CourtSceneGroup {}
20
21inventory::submit! {
22    ItemLoader::Normal(GameFlags::Ck3, Item::CourtSceneGroup, CourtSceneGroup::add)
23}
24
25impl CourtSceneGroup {
26    pub fn add(db: &mut Db, key: Token, block: Block) {
27        db.add(Item::CourtSceneGroup, key, block, Box::new(Self {}));
28    }
29}
30
31impl DbKind for CourtSceneGroup {
32    fn validate(&self, _key: &Token, block: &Block, data: &Everything) {
33        let mut vd = Validator::new(block, data);
34
35        vd.field_choice("order_type", &["random", "ascending", "descending"]);
36        vd.field_choice("position_type", &["dynamic", "static"]);
37        vd.field_choice("access_type", &["random", "top"]);
38        vd.field_value("value"); // TODO
39    }
40}
41
42#[derive(Clone, Debug)]
43pub struct CourtSceneRole {}
44
45inventory::submit! {
46    ItemLoader::Normal(GameFlags::Ck3, Item::CourtSceneRole, CourtSceneRole::add)
47}
48
49impl CourtSceneRole {
50    pub fn add(db: &mut Db, key: Token, block: Block) {
51        db.add(Item::CourtSceneRole, key, block, Box::new(Self {}));
52    }
53}
54
55impl DbKind for CourtSceneRole {
56    fn validate(&self, key: &Token, block: &Block, data: &Everything) {
57        let mut vd = Validator::new(block, data);
58        let mut sc = ScopeContext::new(Scopes::Character, key);
59        sc.define_name("ruler", Scopes::Character, key);
60
61        vd.field_validated_sc("scripted_animation", &mut sc, validate_scripted_animation);
62        vd.field_item("camera", Item::PortraitCamera);
63
64        vd.field_effect_rooted("effect", Tooltipped::No, Scopes::Character);
65
66        vd.field_bool("is_low_priority");
67        vd.field_item("group", Item::CourtSceneGroup);
68    }
69}
70
71#[derive(Clone, Debug)]
72pub struct CourtSceneCulture {}
73
74inventory::submit! {
75    ItemLoader::Normal(GameFlags::Ck3, Item::CourtSceneCulture, CourtSceneCulture::add)
76}
77
78impl CourtSceneCulture {
79    pub fn add(db: &mut Db, key: Token, block: Block) {
80        db.add(Item::CourtSceneCulture, key, block, Box::new(Self {}));
81    }
82}
83
84impl DbKind for CourtSceneCulture {
85    fn validate(&self, key: &Token, block: &Block, data: &Everything) {
86        let mut vd = Validator::new(block, data);
87        let mut sc = ScopeContext::new(Scopes::Character, key);
88
89        vd.field_trigger("trigger", Tooltipped::No, &mut sc);
90    }
91}
92
93#[derive(Clone, Debug)]
94pub struct CourtSceneSetting {}
95
96inventory::submit! {
97    ItemLoader::Full(GameFlags::Ck3, Item::CourtSceneSetting, PdxEncoding::Utf8OptionalBom, ".txt", LoadAsFile::Yes, Recursive::No, CourtSceneSetting::add)
98}
99
100impl CourtSceneSetting {
101    pub fn add(db: &mut Db, key: Token, block: Block) {
102        // TODO: validate grandeur_levels.txt as well
103        if !key.is("grandeur_levels") {
104            db.add(Item::CourtSceneSetting, key, block, Box::new(Self {}));
105        }
106    }
107}
108
109impl DbKind for CourtSceneSetting {
110    fn validate(&self, _key: &Token, block: &Block, data: &Everything) {
111        let mut vd = Validator::new(block, data);
112
113        vd.field_value("name");
114        vd.field_item("culture", Item::CourtSceneCulture);
115        vd.field_integer("visual_culture_level");
116        vd.field_item("cubemap", Item::File);
117        vd.field_item("environment", Item::File);
118        vd.field_precise_numeric("audio_culture");
119
120        let mut cameras = Vec::new();
121        vd.field_validated_block("camera", |block, data| {
122            let mut vd = Validator::new(block, data);
123            for block in vd.blocks() {
124                validate_camera(block, data, &mut cameras);
125            }
126            if cameras.is_empty() {
127                let msg = "need at least one camera";
128                warn(ErrorKey::Validation).msg(msg).loc(block).push();
129            }
130        });
131
132        #[allow(clippy::cast_possible_wrap)] // We're not going to have 2^63 cameras
133        vd.field_integer_range("default_camera", 0..=max(cameras.len() as i64 - 1, 0));
134        vd.field_precise_numeric("shadows_fade");
135        vd.field_precise_numeric("shadows_strength");
136
137        vd.field_validated_block("lights", |block, data| {
138            let mut vd = Validator::new(block, data);
139            for block in vd.blocks() {
140                validate_light(block, data);
141            }
142        });
143
144        vd.field_validated_block("characters", |block, data| {
145            let mut vd = Validator::new(block, data);
146            for block in vd.blocks() {
147                validate_character(block, data, &cameras);
148            }
149        });
150
151        vd.field_validated_block("assets", |block, data| {
152            let mut vd = Validator::new(block, data);
153            for block in vd.blocks() {
154                validate_asset(block, data);
155            }
156        });
157
158        vd.field_validated_block("artifacts", |block, data| {
159            let mut vd = Validator::new(block, data);
160            for block in vd.blocks() {
161                validate_artifact(block, data);
162            }
163        });
164
165        vd.field_validated_key_block("support_type", |key, block, data| {
166            let mut vd = Validator::new(block, data);
167            let mut seen = Vec::new();
168            vd.unknown_value_fields(|key, value| {
169                if SUPPORT_TYPES.contains(&key.as_str()) {
170                    seen.push(key.as_str());
171                } else {
172                    let msg = format!("expected one of {}", SUPPORT_TYPES.join(", "));
173                    warn(ErrorKey::Choice).msg(msg).loc(key).push();
174                }
175                data.verify_exists(Item::Entity, value);
176            });
177            for s in SUPPORT_TYPES {
178                if !seen.contains(s) {
179                    let msg = format!("support type {s} missing");
180                    warn(ErrorKey::FieldMissing).msg(msg).loc(key).push();
181                }
182            }
183        });
184    }
185}
186
187fn validate_camera(block: &Block, data: &Everything, cameras: &mut Vec<&'static str>) {
188    let mut vd = Validator::new(block, data);
189    vd.req_field("description");
190    if let Some(token) = vd.field_value("description") {
191        cameras.push(token.as_str());
192    }
193    vd.field_precise_numeric("fov");
194    vd.field_list_precise_numeric_exactly("position", 3);
195    vd.field_precise_numeric("pitch");
196    vd.field_precise_numeric("yaw");
197    vd.field_list_precise_numeric_exactly("camera_near_far", 2);
198    vd.field_bool("is_camera_used_for_screenshots");
199    vd.field_item("royal_court_camera_name_key", Item::Localization);
200}
201
202fn validate_light(block: &Block, data: &Everything) {
203    let mut vd = Validator::new(block, data);
204    vd.field_value("description");
205    vd.field_block("light"); // TODO
206    vd.field_block("shadow_camera"); // TODO
207}
208
209fn validate_character(block: &Block, data: &Everything, cameras: &[&'static str]) {
210    let mut vd = Validator::new(block, data);
211    vd.field_list_precise_numeric_exactly("position", 3);
212    vd.field_list_precise_numeric_exactly("rotation", 3);
213    vd.field_precise_numeric("direction");
214    vd.field_value("locator"); // TODO
215    vd.field_value("description");
216    if let Some(token) = vd.field_value("camera") {
217        if !cameras.contains(&token.as_str()) {
218            warn(ErrorKey::MissingItem).msg("unknown camera").loc(token).push();
219        }
220    }
221    vd.field_list_items("roles", Item::CourtSceneRole);
222}
223
224fn validate_asset(block: &Block, data: &Everything) {
225    let mut vd = Validator::new(block, data);
226    vd.field_list_precise_numeric_exactly("position", 3);
227    vd.field_list_precise_numeric_exactly("rotation", 3);
228    vd.field_precise_numeric("direction");
229    vd.field_precise_numeric("scale");
230    vd.field_value("description");
231    vd.field_item("asset", Item::Asset);
232    vd.field_value("roles"); // TODO
233    vd.field_item("tag", Item::CourtSceneRole);
234}
235
236fn validate_artifact(block: &Block, data: &Everything) {
237    let mut vd = Validator::new(block, data);
238    vd.field_list_precise_numeric_exactly("position", 3);
239    vd.field_list_precise_numeric_exactly("rotation", 3);
240    vd.field_precise_numeric("direction");
241    vd.field_value("locator"); // TODO
242    vd.field_item("slot", Item::ArtifactSlot);
243}
tiger_lib/ck3/data/court_scene.rs

tiger_lib/ck3/data/
court_scene.rs
