sl-types 0.8.0

Some basic types for Second Life related tools
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

//! LSL types and parsers/printers to use LSL format for them

use crate::serde_helpers::impl_bitfield_serde;

#[cfg(feature = "chumsky")]
use chumsky::{Parser, prelude::just, text::whitespace};

#[cfg(feature = "chumsky")]
use crate::utils::f32_parser;

/// LSL Vector of 3 float components
#[derive(Debug, Clone, PartialEq, serde::Serialize, serde::Deserialize)]
pub struct Vector {
    /// x component
    pub x: f32,
    /// y component
    pub y: f32,
    /// z component
    pub z: f32,
}

/// parse an LSL vector
///
/// "<1.234,3.456,4.567>"
///
/// # Errors
///
/// returns an error if the string could not be parsed
#[cfg(feature = "chumsky")]
#[must_use]
pub fn vector_parser<'src>()
-> impl Parser<'src, &'src str, Vector, chumsky::extra::Err<chumsky::error::Rich<'src, char>>> {
    just('<')
        .then(whitespace().or_not())
        .ignore_then(f32_parser())
        .then_ignore(whitespace().or_not())
        .then_ignore(just(','))
        .then_ignore(whitespace().or_not())
        .then(f32_parser())
        .then_ignore(whitespace().or_not())
        .then_ignore(just(','))
        .then_ignore(whitespace().or_not())
        .then(f32_parser())
        .then_ignore(whitespace().or_not())
        .then_ignore(just('>'))
        .map(|((x, y), z)| Vector { x, y, z })
}

impl From<crate::map::RegionCoordinates> for Vector {
    fn from(value: crate::map::RegionCoordinates) -> Self {
        Self {
            x: value.x(),
            y: value.y(),
            z: value.z(),
        }
    }
}

/// LSL Rotation (quaternion) of 4 float components
#[derive(Debug, Clone, PartialEq, serde::Serialize, serde::Deserialize)]
pub struct Rotation {
    /// x component
    pub x: f32,
    /// y component
    pub y: f32,
    /// z component
    pub z: f32,
    /// s component
    pub s: f32,
}

/// parse an LSL rotation
///
/// "<1.234,3.456,4.567,5.678>"
///
/// # Errors
///
/// returns an error if the string could not be parsed
#[cfg(feature = "chumsky")]
#[must_use]
pub fn rotation_parser<'src>()
-> impl Parser<'src, &'src str, Rotation, chumsky::extra::Err<chumsky::error::Rich<'src, char>>> {
    just('<')
        .then(whitespace().or_not())
        .ignore_then(f32_parser())
        .then_ignore(whitespace().or_not())
        .then_ignore(just(','))
        .then_ignore(whitespace().or_not())
        .then(f32_parser())
        .then_ignore(whitespace().or_not())
        .then_ignore(just(','))
        .then_ignore(whitespace().or_not())
        .then(f32_parser())
        .then_ignore(whitespace().or_not())
        .then_ignore(just(','))
        .then_ignore(whitespace().or_not())
        .then(f32_parser())
        .then_ignore(whitespace().or_not())
        .then_ignore(just('>'))
        .map(|(((x, y), z), s)| Rotation { x, y, z, s })
}

/// The permissions an in-world script may request via `llRequestPermissions`, a
/// bitfield shared by the `ScriptQuestion` (request) and `ScriptAnswerYes`
/// (grant) messages. The flag values match the LSL `PERMISSION_*` constants.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Default)]
pub struct ScriptPermissions(pub i32);

impl ScriptPermissions {
    /// Debit the agent's account (`PERMISSION_DEBIT`).
    pub const DEBIT: i32 = 1 << 1;
    /// Take control inputs (`PERMISSION_TAKE_CONTROLS`).
    pub const TAKE_CONTROLS: i32 = 1 << 2;
    /// Trigger animations on the agent (`PERMISSION_TRIGGER_ANIMATION`).
    pub const TRIGGER_ANIMATION: i32 = 1 << 4;
    /// Attach to the agent (`PERMISSION_ATTACH`).
    pub const ATTACH: i32 = 1 << 5;
    /// Change link-set membership (`PERMISSION_CHANGE_LINKS`).
    pub const CHANGE_LINKS: i32 = 1 << 7;
    /// Track the agent's camera (`PERMISSION_TRACK_CAMERA`).
    pub const TRACK_CAMERA: i32 = 1 << 10;
    /// Control the agent's camera (`PERMISSION_CONTROL_CAMERA`).
    pub const CONTROL_CAMERA: i32 = 1 << 11;
    /// Teleport the agent (`PERMISSION_TELEPORT`).
    pub const TELEPORT: i32 = 1 << 12;
    /// Participate in an experience (`PERMISSION_EXPERIENCE`).
    pub const EXPERIENCE: i32 = 1 << 13;
    /// Silently manage estate access (`PERMISSION_SILENT_ESTATE_MANAGEMENT`).
    pub const SILENT_ESTATE_MANAGEMENT: i32 = 1 << 14;
    /// Override the agent's animations (`PERMISSION_OVERRIDE_ANIMATIONS`).
    pub const OVERRIDE_ANIMATIONS: i32 = 1 << 15;
    /// Return objects (`PERMISSION_RETURN_OBJECTS`).
    pub const RETURN_OBJECTS: i32 = 1 << 16;

    /// Whether all of the bits in `mask` are granted/requested.
    #[must_use]
    pub const fn contains(self, mask: i32) -> bool {
        self.0 & mask == mask
    }
}

impl_bitfield_serde!(
    ScriptPermissions,
    i32,
    "DEBIT" => ScriptPermissions::DEBIT,
    "TAKE_CONTROLS" => ScriptPermissions::TAKE_CONTROLS,
    "TRIGGER_ANIMATION" => ScriptPermissions::TRIGGER_ANIMATION,
    "ATTACH" => ScriptPermissions::ATTACH,
    "CHANGE_LINKS" => ScriptPermissions::CHANGE_LINKS,
    "TRACK_CAMERA" => ScriptPermissions::TRACK_CAMERA,
    "CONTROL_CAMERA" => ScriptPermissions::CONTROL_CAMERA,
    "TELEPORT" => ScriptPermissions::TELEPORT,
    "EXPERIENCE" => ScriptPermissions::EXPERIENCE,
    "SILENT_ESTATE_MANAGEMENT" => ScriptPermissions::SILENT_ESTATE_MANAGEMENT,
    "OVERRIDE_ANIMATIONS" => ScriptPermissions::OVERRIDE_ANIMATIONS,
    "RETURN_OBJECTS" => ScriptPermissions::RETURN_OBJECTS,
);