openworldformat 0.1.0

The Open World Format Rust reference: the world document, the session fold (log, branches, state), and the ext-physics solver — serde-only, no engine required.
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
115
116
117
118
119
120
121
122
123
124
125
126
127
128

//! Light definitions — directional, point, and spot lights.

use serde::{Deserialize, Serialize};

/// Light source attached to an entity.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
pub struct LightDef {
    /// Type of light source.
    #[serde(default)]
    pub light_type: LightType,
    /// Light color, sRGB-encoded RGBA in `0..=1`.
    #[serde(default = "default_white")]
    pub color: [f32; 4],
    /// Intensity (lumens for Point/Spot, lux for Directional).
    #[serde(default = "default_intensity")]
    pub intensity: f32,
    /// Direction vector for directional/spot lights.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub direction: Option<[f32; 3]>,
    /// Whether this light casts shadows.
    #[serde(default = "default_true")]
    pub shadows: bool,
    /// Maximum range/radius for point and spot lights (in world units).
    /// `None` uses the engine default. Ignored for directional lights.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub range: Option<f32>,
    /// Outer cone angle in radians (spot lights only).
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub outer_angle: Option<f32>,
    /// Inner cone angle in radians (spot lights only).
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub inner_angle: Option<f32>,
}

impl Default for LightDef {
    fn default() -> Self {
        Self {
            light_type: LightType::default(),
            color: default_white(),
            intensity: default_intensity(),
            direction: None,
            shadows: true,
            range: None,
            outer_angle: None,
            inner_angle: None,
        }
    }
}

/// Light source type.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Default, Serialize, Deserialize)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
#[serde(rename_all = "lowercase")]
pub enum LightType {
    #[default]
    Directional,
    Point,
    Spot,
}

fn default_white() -> [f32; 4] {
    [1.0, 1.0, 1.0, 1.0]
}

fn default_intensity() -> f32 {
    1000.0
}

fn default_true() -> bool {
    true
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn light_type_roundtrip() {
        for lt in [LightType::Directional, LightType::Point, LightType::Spot] {
            let json = serde_json::to_string(&lt).unwrap();
            let back: LightType = serde_json::from_str(&json).unwrap();
            assert_eq!(lt, back);
        }
    }

    #[test]
    fn light_def_defaults() {
        let l = LightDef::default();
        assert_eq!(l.light_type, LightType::Directional);
        assert!(l.shadows);
        assert_eq!(l.intensity, 1000.0);
        assert!(l.range.is_none());
        assert!(l.outer_angle.is_none());
        assert!(l.inner_angle.is_none());
    }

    #[test]
    fn spot_light_roundtrip_with_angles() {
        let light = LightDef {
            light_type: LightType::Spot,
            color: [1.0, 0.9, 0.7, 1.0],
            intensity: 800.0,
            direction: Some([0.0, -1.0, 0.0]),
            shadows: true,
            range: Some(25.0),
            outer_angle: Some(0.7),
            inner_angle: Some(0.5),
        };
        let json = serde_json::to_string(&light).unwrap();
        let back: LightDef = serde_json::from_str(&json).unwrap();
        assert_eq!(light, back);
        assert_eq!(back.range, Some(25.0));
        assert_eq!(back.outer_angle, Some(0.7));
        assert_eq!(back.inner_angle, Some(0.5));
    }

    #[test]
    fn light_without_optional_fields_deserializes() {
        // Simulate loading an old save without range/angle fields
        let json = r#"{"light_type":"point","color":[1,1,1,1],"intensity":500,"shadows":true}"#;
        let light: LightDef = serde_json::from_str(json).unwrap();
        assert_eq!(light.light_type, LightType::Point);
        assert!(light.range.is_none());
        assert!(light.outer_angle.is_none());
        assert!(light.inner_angle.is_none());
    }
}