vpin 0.23.5

Rust library for working with Visual Pinball VPX 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
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
use super::{dragpoint::DragPoint, vertex2d::Vertex2D};
use crate::impl_shared_attributes;
use crate::vpx::biff::{self, BiffRead, BiffReader, BiffWrite};
use crate::vpx::gameitem::select::{TimerData, WriteSharedAttributes};
use log::warn;
use serde::{Deserialize, Deserializer, Serialize, Serializer};

/// The visual shape of a trigger.
#[derive(Debug, PartialEq, Clone, Default)]
#[cfg_attr(test, derive(fake::Dummy))]
pub enum TriggerShape {
    /// No visible mesh (invisible trigger)
    None = 0,
    /// Simple wire trigger
    #[default]
    WireA = 1,
    /// Star-shaped trigger (uses `radius` for scaling)
    Star = 2,
    /// Wire trigger rotated -23° around X axis
    WireB = 3,
    /// Button trigger (uses `radius` for scaling, z offset +5)
    Button = 4,
    /// Wire trigger rotated 140° around X axis, z offset -19
    WireC = 5,
    /// D-shaped wire trigger
    WireD = 6,
    /// Inder-style trigger
    Inder = 7,
}

impl From<u32> for TriggerShape {
    fn from(value: u32) -> Self {
        match value {
            0 => TriggerShape::None,
            1 => TriggerShape::WireA,
            2 => TriggerShape::Star,
            3 => TriggerShape::WireB,
            4 => TriggerShape::Button,
            5 => TriggerShape::WireC,
            6 => TriggerShape::WireD,
            7 => TriggerShape::Inder,
            _ => TriggerShape::WireA,
        }
    }
}

impl From<&TriggerShape> for u32 {
    fn from(value: &TriggerShape) -> Self {
        match value {
            TriggerShape::None => 0,
            TriggerShape::WireA => 1,
            TriggerShape::Star => 2,
            TriggerShape::WireB => 3,
            TriggerShape::Button => 4,
            TriggerShape::WireC => 5,
            TriggerShape::WireD => 6,
            TriggerShape::Inder => 7,
        }
    }
}

/// Serialize as lowercase string
impl Serialize for TriggerShape {
    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: Serializer,
    {
        let shape_str = match self {
            TriggerShape::None => "none",
            TriggerShape::WireA => "wire_a",
            TriggerShape::Star => "star",
            TriggerShape::WireB => "wire_b",
            TriggerShape::Button => "button",
            TriggerShape::WireC => "wire_c",
            TriggerShape::WireD => "wire_d",
            TriggerShape::Inder => "inder",
        };
        serializer.serialize_str(shape_str)
    }
}

/// Deserialize from lowercase string
/// or number for backwards compatibility
impl<'de> Deserialize<'de> for TriggerShape {
    fn deserialize<D>(deserializer: D) -> Result<TriggerShape, D::Error>
    where
        D: serde::Deserializer<'de>,
    {
        struct TriggerShapeVisitor;

        impl serde::de::Visitor<'_> for TriggerShapeVisitor {
            type Value = TriggerShape;

            fn expecting(&self, formatter: &mut std::fmt::Formatter) -> std::fmt::Result {
                formatter.write_str("a string or number representing a TargetType")
            }

            fn visit_u64<E>(self, value: u64) -> Result<TriggerShape, E>
            where
                E: serde::de::Error,
            {
                match value {
                    0 => Ok(TriggerShape::None),
                    1 => Ok(TriggerShape::WireA),
                    2 => Ok(TriggerShape::Star),
                    3 => Ok(TriggerShape::WireB),
                    4 => Ok(TriggerShape::Button),
                    5 => Ok(TriggerShape::WireC),
                    6 => Ok(TriggerShape::WireD),
                    7 => Ok(TriggerShape::Inder),
                    _ => Err(serde::de::Error::invalid_value(
                        serde::de::Unexpected::Unsigned(value),
                        &"a number between 0 and 7",
                    )),
                }
            }

            fn visit_str<E>(self, value: &str) -> Result<TriggerShape, E>
            where
                E: serde::de::Error,
            {
                match value {
                    "none" => Ok(TriggerShape::None),
                    "wire_a" => Ok(TriggerShape::WireA),
                    "star" => Ok(TriggerShape::Star),
                    "wire_b" => Ok(TriggerShape::WireB),
                    "button" => Ok(TriggerShape::Button),
                    "wire_c" => Ok(TriggerShape::WireC),
                    "wire_d" => Ok(TriggerShape::WireD),
                    "inder" => Ok(TriggerShape::Inder),

                    _ => Err(serde::de::Error::unknown_variant(
                        value,
                        &[
                            "none", "wire_a", "star", "wire_b", "button", "wire_c", "wire_d",
                            "inder",
                        ],
                    )),
                }
            }
        }

        deserializer.deserialize_any(TriggerShapeVisitor)
    }
}

#[derive(Debug, PartialEq)]
#[cfg_attr(test, derive(fake::Dummy))]
pub struct Trigger {
    pub name: String,
    pub center: Vertex2D,

    /// Radius of the trigger in VPU (Visual Pinball Units).
    ///
    /// Used for:
    /// - Hit detection: defines the circular collision area
    /// - Mesh scaling for Button and Star shapes: the mesh is uniformly scaled
    ///   by this value in x, y, and z directions
    /// - Animation limits for Button and Star shapes
    ///
    /// For wire-type triggers (WireA, WireB, WireC, WireD, Inder), use `scale_x`
    /// and `scale_y` instead for mesh scaling.
    ///
    /// Default: 25.0
    ///
    /// BIFF tag: RADI
    pub radius: f32,
    pub rotation: f32,
    /// Wire thickness for wire-type triggers (WireA, WireB, WireC, WireD, Inder).
    ///
    /// This value (in VPU) is added to each vertex position along its normal direction,
    /// effectively making the wire mesh thicker or thinner.
    /// Only applies to wire-based trigger shapes, ignored for Star and Button.
    ///
    /// A value of 0.0 means the default (no vertex offset).
    ///
    /// Default: 0.0 (normal size based on the mesh)
    ///
    /// BIFF tag: WITI (was missing in 10.01)
    pub wire_thickness: Option<f32>,
    pub scale_x: f32,
    pub scale_y: f32,
    pub material: String,
    /// Name of the surface (ramp or wall top) this trigger sits on.
    /// Used to determine the trigger's base height (z position).
    /// If empty, the trigger sits on the playfield.
    /// BIFF tag: SURF
    pub surface: String,

    pub is_visible: bool,
    pub is_enabled: bool,
    pub hit_height: f32,

    /// The visual shape of the trigger.
    ///
    /// Determines which mesh is used for rendering and how scaling is applied.
    /// Wire-type triggers (WireA/B/C/D/Inder) use `scale_x`/`scale_y` for scaling
    /// and support `wire_thickness`. Star and Button use `radius` for uniform scaling.
    ///
    /// Default: TriggerShape::WireA
    ///
    /// BIFF tag: SHAP
    pub shape: TriggerShape,

    /// Animation speed multiplier for the trigger's hit/unhit animation.
    ///
    /// Controls how fast the trigger moves when activated. The animation offset
    /// is updated each frame by: `offset += delta_time_ms * anim_speed`
    ///
    /// Higher values make the trigger animate faster. A value of 1.0 is the
    /// default speed.
    ///
    /// Default: 1.0
    ///
    /// BIFF tag: ANSP
    pub anim_speed: f32,

    /// Whether this trigger appears in playfield reflections.
    ///
    /// When `true`, the ball is rendered in the reflection pass.
    /// When `false`, the ball won't appear as a reflection on the playfield.
    ///
    /// BIFF tag: `REEN` (was missing in 10.01)
    pub is_reflection_enabled: Option<bool>,

    /// Timer data for scripting (shared across all game items).
    /// See [`TimerData`] for details.
    pub timer: TimerData,

    // these are shared between all items
    pub is_locked: bool,
    pub editor_layer: Option<u32>,
    pub editor_layer_name: Option<String>,
    // default "Layer_{editor_layer + 1}"
    pub editor_layer_visibility: Option<bool>,
    /// Added in 10.8.1
    pub part_group_name: Option<String>,

    pub drag_points: Vec<DragPoint>,
}
impl_shared_attributes!(Trigger);

#[derive(Serialize, Deserialize)]
struct TriggerJson {
    center: Vertex2D,
    radius: f32,
    rotation: f32,
    wire_thickness: Option<f32>,
    scale_x: f32,
    scale_y: f32,
    #[serde(flatten)]
    pub timer: TimerData,
    material: String,
    surface: String,
    is_visible: bool,
    is_enabled: bool,
    hit_height: f32,
    name: String,
    shape: TriggerShape,
    anim_speed: f32,
    is_reflection_enabled: Option<bool>,
    #[serde(skip_serializing_if = "Option::is_none")]
    part_group_name: Option<String>,
    drag_points: Vec<DragPoint>,
}

impl TriggerJson {
    pub fn from_trigger(trigger: &Trigger) -> Self {
        Self {
            center: trigger.center,
            radius: trigger.radius,
            rotation: trigger.rotation,
            wire_thickness: trigger.wire_thickness,
            scale_x: trigger.scale_x,
            scale_y: trigger.scale_y,
            timer: trigger.timer.clone(),
            material: trigger.material.clone(),
            surface: trigger.surface.clone(),
            is_visible: trigger.is_visible,
            is_enabled: trigger.is_enabled,
            hit_height: trigger.hit_height,
            name: trigger.name.clone(),
            shape: trigger.shape.clone(),
            anim_speed: trigger.anim_speed,
            is_reflection_enabled: trigger.is_reflection_enabled,
            part_group_name: trigger.part_group_name.clone(),
            drag_points: trigger.drag_points.clone(),
        }
    }
    pub fn to_trigger(&self) -> Trigger {
        Trigger {
            center: self.center,
            radius: self.radius,
            rotation: self.rotation,
            wire_thickness: self.wire_thickness,
            scale_x: self.scale_x,
            scale_y: self.scale_y,
            timer: self.timer.clone(),
            material: self.material.clone(),
            surface: self.surface.clone(),
            is_visible: self.is_visible,
            is_enabled: self.is_enabled,
            hit_height: self.hit_height,
            name: self.name.clone(),
            shape: self.shape.clone(),
            anim_speed: self.anim_speed,
            is_reflection_enabled: self.is_reflection_enabled,
            // this is populated from a different file
            is_locked: false,
            // this is populated from a different file
            editor_layer: None,
            // this is populated from a different file
            editor_layer_name: None,
            // this is populated from a different file
            editor_layer_visibility: None,
            part_group_name: self.part_group_name.clone(),
            drag_points: self.drag_points.clone(),
        }
    }
}

impl Serialize for Trigger {
    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: Serializer,
    {
        TriggerJson::from_trigger(self).serialize(serializer)
    }
}

impl<'de> Deserialize<'de> for Trigger {
    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
    where
        D: Deserializer<'de>,
    {
        let trigger_json = TriggerJson::deserialize(deserializer)?;
        Ok(trigger_json.to_trigger())
    }
}

impl Default for Trigger {
    fn default() -> Self {
        Trigger {
            center: Default::default(),
            radius: 25.0,
            rotation: Default::default(),
            wire_thickness: Default::default(),
            scale_x: Default::default(),
            scale_y: Default::default(),
            timer: TimerData::default(),
            material: Default::default(),
            surface: Default::default(),
            is_visible: true,
            is_enabled: true,
            hit_height: 50.0,
            name: Default::default(),
            shape: TriggerShape::WireA,
            anim_speed: Default::default(),
            is_reflection_enabled: None, //true,
            is_locked: false,
            editor_layer: Default::default(),
            editor_layer_name: None,
            editor_layer_visibility: None,
            part_group_name: None,
            drag_points: Default::default(),
        }
    }
}

impl BiffRead for Trigger {
    fn biff_read(reader: &mut BiffReader<'_>) -> Trigger {
        let mut trigger = Trigger::default();
        loop {
            reader.next(biff::WARN);
            if reader.is_eof() {
                break;
            }
            let tag = reader.tag();
            let tag_str = tag.as_str();
            match tag_str {
                // tag_str: SHAP
                // tag_str: ANSP
                // tag_str: REEN
                "VCEN" => {
                    trigger.center = Vertex2D::biff_read(reader);
                }
                "RADI" => {
                    trigger.radius = reader.get_f32();
                }
                "ROTA" => {
                    trigger.rotation = reader.get_f32();
                }
                "WITI" => {
                    trigger.wire_thickness = Some(reader.get_f32());
                }
                "SCAX" => {
                    trigger.scale_x = reader.get_f32();
                }
                "SCAY" => {
                    trigger.scale_y = reader.get_f32();
                }
                "MATR" => {
                    trigger.material = reader.get_string();
                }
                "SURF" => {
                    trigger.surface = reader.get_string();
                }
                "VSBL" => {
                    trigger.is_visible = reader.get_bool();
                }
                "EBLD" => {
                    trigger.is_enabled = reader.get_bool();
                }
                "THOT" => {
                    trigger.hit_height = reader.get_f32();
                }
                "NAME" => {
                    trigger.name = reader.get_wide_string();
                }
                "SHAP" => {
                    trigger.shape = reader.get_u32().into();
                }
                "ANSP" => {
                    trigger.anim_speed = reader.get_f32();
                }
                "REEN" => {
                    trigger.is_reflection_enabled = Some(reader.get_bool());
                }
                "DPNT" => {
                    let point = DragPoint::biff_read(reader);
                    trigger.drag_points.push(point);
                }
                _ => {
                    if !trigger.timer.biff_read_tag(tag_str, reader)
                        && !trigger.read_shared_attribute(tag_str, reader)
                    {
                        warn!(
                            "Unknown tag {} for {}",
                            tag_str,
                            std::any::type_name::<Self>()
                        );
                        reader.skip_tag();
                    }
                }
            }
        }
        trigger
    }
}

impl BiffWrite for Trigger {
    fn biff_write(&self, writer: &mut biff::BiffWriter) {
        writer.write_tagged("VCEN", &self.center);
        writer.write_tagged_f32("RADI", self.radius);
        writer.write_tagged_f32("ROTA", self.rotation);
        if let Some(wire_thickness) = self.wire_thickness {
            writer.write_tagged_f32("WITI", wire_thickness);
        }
        writer.write_tagged_f32("SCAX", self.scale_x);
        writer.write_tagged_f32("SCAY", self.scale_y);
        self.timer.biff_write(writer);
        writer.write_tagged_string("SURF", &self.surface);
        writer.write_tagged_string("MATR", &self.material);
        writer.write_tagged_bool("EBLD", self.is_enabled);
        writer.write_tagged_bool("VSBL", self.is_visible);
        writer.write_tagged_f32("THOT", self.hit_height);
        writer.write_tagged_wide_string("NAME", &self.name);
        writer.write_tagged_u32("SHAP", (&self.shape).into());
        writer.write_tagged_f32("ANSP", self.anim_speed);
        if let Some(is_reflection_enabled) = self.is_reflection_enabled {
            writer.write_tagged_bool("REEN", is_reflection_enabled);
        }

        self.write_shared_attributes(writer);

        // many of these
        for point in &self.drag_points {
            writer.write_tagged("DPNT", point)
        }

        writer.close(true);
    }
}

#[cfg(test)]
mod tests {
    use crate::vpx::biff::BiffWriter;
    use fake::{Fake, Faker};

    use super::*;
    use pretty_assertions::assert_eq;

    #[test]
    fn test_write_read() {
        // values not equal to the defaults
        let trigger = Trigger {
            center: Vertex2D::new(1.0, 2.0),
            radius: 25.0,
            rotation: 3.0,
            wire_thickness: Some(4.0),
            scale_x: 5.0,
            scale_y: 6.0,
            timer: TimerData {
                is_enabled: true,
                interval: 7,
            },
            material: "test material".to_string(),
            surface: "test surface".to_string(),
            is_visible: false,
            is_enabled: false,
            hit_height: 8.0,
            name: "test name".to_string(),
            shape: Faker.fake(),
            anim_speed: 10.0,
            is_reflection_enabled: Some(false),
            is_locked: true,
            editor_layer: Some(11),
            editor_layer_name: Some("test layer name".to_string()),
            editor_layer_visibility: Some(false),
            part_group_name: Some("test group name".to_string()),
            drag_points: vec![DragPoint::default()],
        };
        let mut writer = BiffWriter::new();
        Trigger::biff_write(&trigger, &mut writer);
        let trigger_read = Trigger::biff_read(&mut BiffReader::new(writer.get_data()));
        assert_eq!(trigger, trigger_read);
    }

    #[test]
    fn test_trigger_shape_json() {
        let sizing_type = TriggerShape::Inder;
        let json = serde_json::to_string(&sizing_type).unwrap();
        assert_eq!(json, "\"inder\"");
        let sizing_type_read: TriggerShape = serde_json::from_str(&json).unwrap();
        assert_eq!(sizing_type, sizing_type_read);
        let json = serde_json::Value::from(2);
        let sizing_type_read: TriggerShape = serde_json::from_value(json).unwrap();
        assert_eq!(TriggerShape::Star, sizing_type_read);
    }

    #[test]
    #[should_panic = "Error(\"unknown variant `foo`, expected one of `none`, `wire_a`, `star`, `wire_b`, `button`, `wire_c`, `wire_d`, `inder`\", line: 0, column: 0)"]
    fn test_trigger_shape_json_fail_string() {
        let json = serde_json::Value::from("foo");
        let _: TriggerShape = serde_json::from_value(json).unwrap();
    }
}