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
/// Represents any Roblox enum value. /// /// Roblox enums are not strongly typed, so the meaning of a value depends on /// where they're assigned. /// /// A list of all enums and their values are available [on the Roblox Developer /// Hub](https://developer.roblox.com/en-us/api-reference/enum). #[derive(Debug, Clone, Copy, PartialEq, Eq)] #[cfg_attr( feature = "serde", derive(serde::Serialize, serde::Deserialize), serde(transparent) )] pub struct EnumValue { value: u32, } impl EnumValue { pub fn from_u32(value: u32) -> Self { Self { value } } pub fn to_u32(self) -> u32 { self.value } } /// The standard 2D vector type used in Roblox. /// /// ## See Also /// * [`Vector2int16`][struct.Vector2int16.html] /// * [Vector2 on Roblox Developer Hub](https://developer.roblox.com/en-us/api-reference/datatype/Vector2) #[derive(Debug, Clone, Copy, PartialEq)] pub struct Vector2 { pub x: f32, pub y: f32, } impl Vector2 { pub fn new(x: f32, y: f32) -> Self { Self { x, y } } } /// A version of [`Vector2`][Vector2] whose coordinates are signed 16-bit /// integers. /// /// ## See Also /// * [`Vector2`][Vector2], which is used for most values. /// * [Vector2int16 on Roblox Developer Hub](https://developer.roblox.com/en-us/api-reference/datatype/Vector2int16) /// /// [Vector2]: struct.Vector2.html #[derive(Debug, Clone, Copy, PartialEq, Eq)] pub struct Vector2int16 { pub x: i16, pub y: i16, } impl Vector2int16 { pub fn new(x: i16, y: i16) -> Self { Self { x, y } } } /// The standard 3D vector type used in Roblox. /// /// ## See Also /// * [`Vector3int16`][struct.Vector3int16.html] /// * [Vector3 on Roblox Developer Hub](https://developer.roblox.com/en-us/api-reference/datatype/Vector3) #[derive(Debug, Clone, Copy, PartialEq)] pub struct Vector3 { pub x: f32, pub y: f32, pub z: f32, } impl Vector3 { pub fn new(x: f32, y: f32, z: f32) -> Self { Self { x, y, z } } } /// A version of [`Vector3`][Vector3] whose coordinates are signed 16-bit /// integers. `Vector3int16` is often used when working with Terrain. /// /// ## See Also /// * [`Vector3`][Vector3], which is used for most values. /// * [Vector3int16 on Roblox Developer Hub](https://developer.roblox.com/en-us/api-reference/datatype/Vector3int16) /// /// [Vector3]: struct.Vector3.html #[derive(Debug, Clone, Copy, PartialEq, Eq)] pub struct Vector3int16 { pub x: i16, pub y: i16, pub z: i16, } impl Vector3int16 { pub fn new(x: i16, y: i16, z: i16) -> Self { Self { x, y, z } } } /// Represents a position and orientation in 3D space. /// /// ## See Also /// * [CFrame on Roblox Developer Hub](https://developer.roblox.com/en-us/api-reference/datatype/CFrame) #[derive(Debug, Clone, Copy, PartialEq)] #[cfg_attr( feature = "serde", derive(serde::Serialize, serde::Deserialize), serde(rename_all = "PascalCase") )] pub struct CFrame { pub position: Vector3, pub orientation: Matrix3, } impl CFrame { pub fn new(position: Vector3, orientation: Matrix3) -> Self { Self { position, orientation, } } } /// Used to represent the `orientation` field of `CFrame` and not a standalone /// type in Roblox. #[derive(Debug, Clone, Copy, PartialEq)] pub struct Matrix3 { pub x: Vector3, pub y: Vector3, pub z: Vector3, } impl Matrix3 { pub fn identity() -> Self { Self { x: Vector3::new(1.0, 0.0, 1.0), y: Vector3::new(0.0, 1.0, 0.0), z: Vector3::new(0.0, 0.0, 1.0), } } } /// Represents any color, including HDR colors. /// /// ## See Also /// * [`Color3uint8`](struct.Color3uint8.html), which is used instead of /// `Color3` on some types and does not represent HDR colors. /// * [Color3 on Roblox Developer Hub](https://developer.roblox.com/en-us/api-reference/datatype/Color3) #[derive(Debug, Clone, Copy, PartialEq)] pub struct Color3 { pub r: f32, pub g: f32, pub b: f32, } impl Color3 { pub fn new(r: f32, g: f32, b: f32) -> Self { Self { r, g, b } } } /// Represents non-HDR colors, i.e. those whose individual color channels do not /// exceed 1. This type is used for serializing properties like /// [`BasePart.Color`][BasePart.Color], but is not exposed as a distinct type to /// Lua code. /// /// ## See Also /// * [`Color3`](struct.Color3.html), which is more common and can represent HDR /// colors. /// /// [BasePart.Color]: https://developer.roblox.com/en-us/api-reference/property/BasePart/Color #[derive(Debug, Clone, Copy, PartialEq, Eq)] pub struct Color3uint8 { pub r: u8, pub g: u8, pub b: u8, } impl Color3uint8 { pub fn new(r: u8, g: u8, b: u8) -> Self { Self { r, g, b } } } /// Represents a ray in 3D space. Direction does not have to be a unit vector, /// and is used by APIs like [`Workspace:FindPartOnRay`][FindPartOnRay] to set a /// max distance. /// /// ## See Also /// * [Ray on Roblox Developer Hub](https://developer.roblox.com/en-us/api-reference/datatype/Ray) /// /// [FindPartOnRay]: https://developer.roblox.com/en-us/api-reference/function/WorldRoot/FindPartOnRay #[derive(Debug, Clone, Copy, PartialEq)] #[cfg_attr( feature = "serde", derive(serde::Serialize, serde::Deserialize), serde(rename_all = "PascalCase") )] pub struct Ray { pub origin: Vector3, pub direction: Vector3, } impl Ray { pub fn new(origin: Vector3, direction: Vector3) -> Self { Self { origin, direction } } } /// Represents a bounding box in 3D space. /// /// ## See Also /// * [`Region3int16`](struct.Region3int16.html) /// * [Region3 on Roblox Developer Hub](https://developer.roblox.com/en-us/api-reference/datatype/Region3) #[derive(Debug, Clone, Copy, PartialEq)] pub struct Region3 { pub min: Vector3, pub max: Vector3, } impl Region3 { pub fn new(min: Vector3, max: Vector3) -> Self { Self { min, max } } } /// A version of [`Region3`][Region3] that uses signed 16-bit integers instead /// of floats. `Region3int16` is generally used in Terrain APIs. /// /// ## See Also /// * [`Region`][Region3] /// * [Region3int16 on Roblox Developer Hub](https://developer.roblox.com/en-us/api-reference/datatype/Region3int16) /// /// [Region3]: struct.Region3.html #[derive(Debug, Clone, Copy, PartialEq, Eq)] pub struct Region3int16 { pub min: Vector3int16, pub max: Vector3int16, } impl Region3int16 { pub fn new(min: Vector3int16, max: Vector3int16) -> Self { Self { min, max } } } /// Represents a bounding rectangle in 2D space. /// /// ## See Also /// * [Rect on Roblox Developer Hub](https://developer.roblox.com/en-us/api-reference/datatype/Rect) #[derive(Debug, Clone, Copy, PartialEq)] pub struct Rect { pub min: Vector2, pub max: Vector2, } impl Rect { pub fn new(min: Vector2, max: Vector2) -> Self { Self { min, max } } } /// Standard unit for measuring UI given as `scale`, a fraction of the /// container's size and `offset`, display-indepdendent pixels. /// /// ## See Also /// * [UDim on Roblox Developer Hub](https://developer.roblox.com/en-us/api-reference/datatype/UDim) #[derive(Debug, Clone, Copy, PartialEq)] pub struct UDim { pub scale: f32, pub offset: i32, } impl UDim { pub fn new(scale: f32, offset: i32) -> Self { Self { scale, offset } } } /// Standard 2D unit for measuring UI given as `scale`, a fraction of the /// container's size and `offset`, display-indepdendent pixels. /// /// ## See Also /// * [UDim2 on Roblox Developer Hub](https://developer.roblox.com/en-us/api-reference/datatype/UDim2) #[derive(Debug, Clone, Copy, PartialEq)] pub struct UDim2 { pub x: UDim, pub y: UDim, } impl UDim2 { pub fn new(x: UDim, y: UDim) -> Self { Self { x, y } } } /// A range between two numbers. /// /// ## See Also /// * [NumberRange on Roblox Developer Hub](https://developer.roblox.com/en-us/api-reference/datatype/NumberRange) #[derive(Debug, Clone, Copy, PartialEq)] pub struct NumberRange { pub min: f32, pub max: f32, } impl NumberRange { pub fn new(min: f32, max: f32) -> Self { Self { min, max } } } /// A series of colors that can be tweened through. /// /// ## See Also /// * [ColorSequence on Roblox Developer Hub](https://developer.roblox.com/en-us/api-reference/datatype/ColorSequence) #[derive(Debug, Clone, PartialEq)] #[cfg_attr( feature = "serde", derive(serde::Serialize, serde::Deserialize), serde(rename_all = "PascalCase") )] pub struct ColorSequence { pub keypoints: Vec<ColorSequenceKeypoint>, } /// A single color and point in time of a [`ColorSequence`][ColorSequence] /// /// ## See Also /// * [ColorSequenceKeypoint on Roblox Developer Hub](https://developer.roblox.com/en-us/api-reference/datatype/ColorSequenceKeypoint) /// /// [ColorSequence]: struct.ColorSequence.html #[derive(Debug, Clone, Copy, PartialEq)] #[cfg_attr( feature = "serde", derive(serde::Serialize, serde::Deserialize), serde(rename_all = "PascalCase") )] pub struct ColorSequenceKeypoint { pub time: f32, pub color: Color3, } impl ColorSequenceKeypoint { pub fn new(time: f32, color: Color3) -> Self { Self { time, color } } } /// A sequence of numbers on a timeline. Each point contains a timestamp, a /// value, and a range that allows for randomized values. /// /// ## See Also /// * [NumberSequence on Roblox Developer Hub](https://developer.roblox.com/en-us/api-reference/datatype/NumberSequence) #[derive(Debug, Clone, PartialEq)] #[cfg_attr( feature = "serde", derive(serde::Serialize, serde::Deserialize), serde(rename_all = "PascalCase") )] pub struct NumberSequence { pub keypoints: Vec<NumberSequenceKeypoint>, } /// A single value, envelope, and point in time of a [`NumberSequence`][NumberSequence] /// /// ## See Also /// * [`NumberSequence`][NumberSequence] /// * [NumberSequenceKeypoint on Roblox Developer Hub](https://developer.roblox.com/en-us/api-reference/datatype/NumberSequenceKeypoint) /// /// [NumberSequence]: struct.NumberSequence.html #[derive(Debug, Clone, Copy, PartialEq)] #[cfg_attr( feature = "serde", derive(serde::Serialize, serde::Deserialize), serde(rename_all = "PascalCase") )] pub struct NumberSequenceKeypoint { pub time: f32, pub value: f32, pub envelope: f32, } impl NumberSequenceKeypoint { pub fn new(time: f32, value: f32, envelope: f32) -> Self { Self { time, value, envelope, } } } #[cfg(feature = "serde")] serde_tuple! { Vector2(x: f32, y: f32), Vector2int16(x: i16, y: i16), Vector3(x: f32, y: f32, z: f32), Vector3int16(x: i16, y: i16, z: i16), Color3(r: f32, g: f32, b: f32), Color3uint8(r: u8, g: u8, b: u8), UDim(scale: f32, offset: i32), UDim2(x: UDim, y: UDim), NumberRange(min: f32, max: f32), Rect(min: Vector2, max: Vector2), Region3(min: Vector3, max: Vector3), Region3int16(min: Vector3int16, max: Vector3int16), Matrix3(x: Vector3, y: Vector3, z: Vector3), } #[cfg(all(test, feature = "serde"))] mod serde_test { use super::*; #[test] fn vec2_json() { let out = serde_json::to_string(&Vector2 { x: 2.0, y: 3.5 }).unwrap(); assert_eq!(out, "[2.0,3.5]"); } }