luau 0.732.0

Safe lifetime-bound Rust embedding API for the Luau runtime
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

use core::fmt;

use luau_vm::Thread as VmThread;
use luau_vm::types::LUA_VECTOR_SIZE;

use crate::error::Error;
use crate::thread::Thread;
use crate::value::{FromLua, IntoLua, LuaType, Value};

#[cfg(feature = "vector4")]
const _: () = assert!(
    LUA_VECTOR_SIZE == 4,
    "`luau/vector4` is enabled but `luau-vm/vector4` is not"
);

#[cfg(not(feature = "vector4"))]
const _: () = assert!(
    LUA_VECTOR_SIZE == 3,
    "`luau-vm/vector4` is enabled without `luau/vector4`; enable `luau/vector4` instead"
);

/// A Luau vector value.
#[derive(Debug, Default, Clone, Copy, PartialEq, PartialOrd)]
pub struct Vector(pub(crate) [f32; Self::SIZE]);

impl Vector {
    pub(crate) const SIZE: usize = LUA_VECTOR_SIZE;

    #[cfg(not(feature = "vector4"))]
    /// Creates a three-component vector.
    pub const fn new(x: f32, y: f32, z: f32) -> Self {
        let mut components = [0.0; Self::SIZE];
        components[0] = x;
        components[1] = y;
        components[2] = z;
        Self(components)
    }

    #[cfg(feature = "vector4")]
    /// Creates a four-component vector.
    pub const fn new(x: f32, y: f32, z: f32, w: f32) -> Self {
        Self([x, y, z, w])
    }

    /// Creates a vector with every component set to zero.
    pub const fn zero() -> Self {
        Self([0.0; Self::SIZE])
    }

    /// Returns the x component.
    pub const fn x(&self) -> f32 {
        self.0[0]
    }

    /// Returns the y component.
    pub const fn y(&self) -> f32 {
        self.0[1]
    }

    /// Returns the z component.
    pub const fn z(&self) -> f32 {
        self.0[2]
    }

    #[cfg(feature = "vector4")]
    /// Returns the w component.
    pub const fn w(&self) -> f32 {
        self.0[3]
    }
}

impl fmt::Display for Vector {
    fn fmt(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result {
        #[cfg(not(feature = "vector4"))]
        return write!(
            formatter,
            "vector({}, {}, {})",
            self.x(),
            self.y(),
            self.z()
        );
        #[cfg(feature = "vector4")]
        return write!(
            formatter,
            "vector({}, {}, {}, {})",
            self.x(),
            self.y(),
            self.z(),
            self.w()
        );
    }
}

impl PartialEq<[f32; Self::SIZE]> for Vector {
    fn eq(&self, other: &[f32; Self::SIZE]) -> bool {
        self.0 == *other
    }
}

impl LuaType for Vector {
    fn push_type_key(thread: impl AsRef<VmThread>) -> Result<(), Error> {
        let thread = thread.as_ref();
        unsafe {
            thread
                .push_vector(Self::zero().0)
                .map_err(|exit| Error::from_thread_exit(thread, exit))
        }
    }
}

impl<'lua> IntoLua<'lua> for Vector {
    fn into_lua(self, _: crate::LuaRef<'lua>) -> Result<Value<'lua>, Error> {
        Ok(Value::Vector(self))
    }

    unsafe fn push_into_stack(self, thread: &Thread<'lua>) -> Result<(), Error> {
        unsafe {
            thread
                .as_vm()
                .push_vector(self.0)
                .map_err(|exit| Error::from_thread_exit(thread, exit))?;
        }
        Ok(())
    }
}

impl<'lua> FromLua<'lua> for Vector {
    fn from_lua(value: Value<'lua>, _: crate::LuaRef<'lua>) -> Result<Self, Error> {
        match value {
            Value::Vector(value) => Ok(value),
            value => Err(Error::from_lua_conversion(
                value.type_name(),
                "vector",
                None,
            )),
        }
    }

    unsafe fn from_stack(thread: &Thread<'lua>, index: i32) -> Result<Self, Error> {
        unsafe { thread.as_vm().to_vector(index) }
            .map(Vector)
            .ok_or_else(|| {
                Error::from_lua_conversion(thread.stack_type_name(index).as_str(), "vector", None)
            })
    }
}