brdb 0.9.1

A library for reading and writing Brickadia's World files.
Documentation 
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

use std::{collections::HashMap, fmt::Display, sync::Arc};

use crate::{
    errors::BrdbSchemaError,
    schema::as_brdb::AsBrdbValue,
    wrapper::{BString, BrdbComponent},
};

#[derive(Clone)]
pub struct LiteralComponent {
    pub component_name: BString,
    pub data: Arc<HashMap<BString, Box<dyn AsBrdbValue>>>,
}

impl LiteralComponent {
    pub fn new(component_name: impl Into<BString>) -> Self {
        Self {
            component_name: component_name.into(),
            data: Default::default(),
        }
    }

    pub fn with_data(
        mut self,
        data: impl IntoIterator<Item = (impl Into<BString>, Box<dyn AsBrdbValue>)>,
    ) -> Self {
        self.data = Arc::new(data.into_iter().map(|(k, v)| (k.into(), v)).collect());
        self
    }

    pub fn new_from_data(
        component_name: impl Into<BString>,
        data: Arc<HashMap<BString, Box<dyn AsBrdbValue>>>,
    ) -> Self {
        Self {
            component_name: component_name.into(),
            data,
        }
    }
}

impl AsBrdbValue for LiteralComponent {
    fn has_brdb_struct_prop(
        &self,
        schema: &crate::schema::BrdbSchema,
        _struct_name: crate::schema::BrdbInterned,
        prop_name: crate::schema::BrdbInterned,
    ) -> bool {
        prop_name
            .get(schema)
            .is_some_and(|name| self.data.contains_key(name))
    }

    fn as_brdb_struct_prop_value(
        &self,
        schema: &crate::schema::BrdbSchema,
        _struct_name: crate::schema::BrdbInterned,
        prop_name: crate::schema::BrdbInterned,
    ) -> Result<&dyn AsBrdbValue, crate::errors::BrdbSchemaError> {
        let prop_name_str = prop_name.get(schema).unwrap();
        match self.data.get(prop_name_str) {
            Some(value) => Ok(value.as_ref()),
            None => Err(BrdbSchemaError::MissingStructField(
                self.component_name.to_string(),
                prop_name_str.to_string(),
            )),
        }
    }

    fn as_brdb_struct_prop_array(
        &self,
        schema: &crate::schema::BrdbSchema,
        _struct_name: crate::schema::BrdbInterned,
        prop_name: crate::schema::BrdbInterned,
    ) -> Result<crate::schema::as_brdb::BrdbArrayIter<'_>, crate::errors::BrdbSchemaError> {
        let prop_name_str = prop_name.get(schema).unwrap();
        match self.data.get(prop_name_str) {
            // Literal gate data only carries scalars; a stored value for an
            // array-typed field can't be iterated, so keep the loud default.
            Some(_) => Err(BrdbSchemaError::UnimplementedCast(
                "struct property array".to_owned(),
                std::any::type_name::<Self>(),
            )),
            // An unset array field (e.g. PrefabSpawner's SpawnedEntityIds) is
            // "missing" — the schema writer serializes it as an empty array,
            // matching the scalar missing-field behavior above.
            None => Err(BrdbSchemaError::MissingStructField(
                self.component_name.to_string(),
                prop_name_str.to_string(),
            )),
        }
    }
}

impl BrdbComponent for LiteralComponent {
    fn component_type(&self) -> Option<BString> {
        Some(self.component_name.clone())
    }
}

/// A literal component representing a seat
pub fn seat_component(
    allow_nearby: bool,
    hidden_interaction: bool,
    prompt_label: impl Display,
) -> LiteralComponent {
    LiteralComponent::new("Component_Internal_Seat").with_data([
        ("PlayerInput", Box::new(()) as Box<dyn AsBrdbValue>),
        ("bIsOccupied", Box::new(false)),
        ("bAllowNearbyInteraction", Box::new(allow_nearby)),
        ("bHiddenInteraction", Box::new(hidden_interaction)),
        ("PromptCustomLabel", Box::new(prompt_label.to_string())),
    ])
}