spine_runtime 0.2.2

Unofficial native Rust port of the Spine 4.3 runtime. Renderer-agnostic.
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

// Spine Runtimes License Agreement
// Last updated April 5, 2025. Replaces all prior versions.
//
// Copyright (c) 2013-2025, Esoteric Software LLC
//
// Integration of the Spine Runtimes into software or otherwise creating
// derivative works of the Spine Runtimes is permitted under the terms and
// conditions of Section 2 of the Spine Editor License Agreement:
// http://esotericsoftware.com/spine-editor-license
//
// Otherwise, it is permitted to integrate the Spine Runtimes into software
// or otherwise create derivative works of the Spine Runtimes (collectively,
// "Products"), provided that each user of the Products must obtain their own
// Spine Editor license and redistribution of the Products in any form must
// include this license and copyright notice.
//
// THE SPINE RUNTIMES ARE PROVIDED BY ESOTERIC SOFTWARE LLC "AS IS" AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
// WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
// DISCLAIMED. IN NO EVENT SHALL ESOTERIC SOFTWARE LLC BE LIABLE FOR ANY
// DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
// (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES,
// BUSINESS INTERRUPTION, OR LOSS OF USE, DATA, OR PROFITS) HOWEVER CAUSED AND
// ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
// THE SPINE RUNTIMES, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

//! Event definitions. Event keys in animations reference one and may
//! override its values.

use crate::data::EventId;

/// A named event declared on the skeleton. The values are defaults that each
/// [`AnimationEvent`](crate::data::AnimationEvent) key may override.
#[derive(Debug, Clone, PartialEq)]
pub struct EventData {
    /// Position in [`SkeletonData::events`](crate::data::SkeletonData::events).
    pub index: EventId,
    pub name: String,
    pub int_value: i32,
    pub float_value: f32,
    pub string_value: String,
    /// Empty when the event has no audio.
    pub audio_path: String,
    /// Audio volume, 0..1.
    pub volume: f32,
    /// Audio stereo balance, -1 (left) to 1 (right).
    pub balance: f32,
}

impl EventData {
    /// An event with zeroed values and no audio.
    #[must_use]
    pub fn new(index: EventId, name: impl Into<String>) -> Self {
        Self {
            index,
            name: name.into(),
            int_value: 0,
            float_value: 0.0,
            string_value: String::new(),
            audio_path: String::new(),
            volume: 0.0,
            balance: 0.0,
        }
    }
}

#[cfg(test)]
#[allow(clippy::float_cmp)] // Literal default comparisons only.
mod tests {
    use super::*;

    #[test]
    fn new_event_defaults() {
        let e = EventData::new(EventId(0), "footstep");
        assert_eq!(e.volume, 0.0);
        assert_eq!(e.balance, 0.0);
    }
}