@rbxts/types 1.0.844 → 1.0.845

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -797,18 +797,24 @@ interface ConfigSnapshot extends RBXObject {
797
797
  * - **ThreadSafety**: Unsafe
798
798
  *
799
799
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ConfigSnapshot#GetValue)
800
+ * @param this
801
+ * @param key
802
+ * @param defaultValue
800
803
  */
801
804
  GetValue(this: ConfigSnapshot, key: string, defaultValue: unknown): unknown;
802
805
  /**
803
806
  * - **ThreadSafety**: Unsafe
804
807
  *
805
808
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ConfigSnapshot#GetValueChangedSignal)
809
+ * @param this
810
+ * @param key
806
811
  */
807
812
  GetValueChangedSignal(this: ConfigSnapshot, key: string): RBXScriptSignal;
808
813
  /**
809
814
  * - **ThreadSafety**: Unsafe
810
815
  *
811
816
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ConfigSnapshot#Refresh)
817
+ * @param this
812
818
  */
813
819
  Refresh(this: ConfigSnapshot): void;
814
820
  /**
@@ -1230,13 +1236,37 @@ interface EditableMesh extends RBXObject {
1230
1236
  * Returns a list of faces that use a given attribute ID.
1231
1237
  *
1232
1238
  * - **ThreadSafety**: Unsafe
1239
+ * - **Tags**:
1233
1240
  *
1234
1241
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetFacesWithAttribute)
1235
1242
  * @param this Instance which allows for the runtime creation and manipulation of meshes.
1236
1243
  * @param id Attribute ID for which to find faces that use it.
1237
1244
  * @returns List of face IDs which use the given attribute ID.
1245
+ *
1246
+ * @deprecated
1238
1247
  */
1239
1248
  GetFacesWithAttribute(this: EditableMesh, id: number): Array<unknown>;
1249
+ /**
1250
+ * - **ThreadSafety**: Unsafe
1251
+ * - **Tags**: CustomLuaState
1252
+ *
1253
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetFacesWithColor)
1254
+ */
1255
+ GetFacesWithColor(this: EditableMesh, colorId: number): Array<unknown>;
1256
+ /**
1257
+ * - **ThreadSafety**: Unsafe
1258
+ * - **Tags**: CustomLuaState
1259
+ *
1260
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetFacesWithNormal)
1261
+ */
1262
+ GetFacesWithNormal(this: EditableMesh, normalId: number): Array<unknown>;
1263
+ /**
1264
+ * - **ThreadSafety**: Unsafe
1265
+ * - **Tags**: CustomLuaState
1266
+ *
1267
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetFacesWithUV)
1268
+ */
1269
+ GetFacesWithUV(this: EditableMesh, uvId: number): Array<unknown>;
1240
1270
  /**
1241
1271
  * Returns the normal vector for the given normal ID.
1242
1272
  *
@@ -1300,6 +1330,52 @@ interface EditableMesh extends RBXObject {
1300
1330
  * @returns List of stable UV IDs.
1301
1331
  */
1302
1332
  GetUVs(this: EditableMesh): Array<unknown>;
1333
+ /**
1334
+ * - **ThreadSafety**: Unsafe
1335
+ * - **Tags**: CustomLuaState
1336
+ *
1337
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetVertexColors)
1338
+ */
1339
+ GetVertexColors(this: EditableMesh, vertexId: number): Array<unknown>;
1340
+ /**
1341
+ * - **ThreadSafety**: Unsafe
1342
+ *
1343
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetVertexFaceColor)
1344
+ */
1345
+ GetVertexFaceColor(this: EditableMesh, vertexId: number, faceId: number): number;
1346
+ /**
1347
+ * - **ThreadSafety**: Unsafe
1348
+ *
1349
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetVertexFaceNormal)
1350
+ */
1351
+ GetVertexFaceNormal(this: EditableMesh, vertexId: number, faceId: number): number;
1352
+ /**
1353
+ * - **ThreadSafety**: Unsafe
1354
+ *
1355
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetVertexFaceUV)
1356
+ */
1357
+ GetVertexFaceUV(this: EditableMesh, vertexId: number, faceId: number): number;
1358
+ /**
1359
+ * - **ThreadSafety**: Unsafe
1360
+ * - **Tags**: CustomLuaState
1361
+ *
1362
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetVertexFaces)
1363
+ */
1364
+ GetVertexFaces(this: EditableMesh, vertexId: number): Array<unknown>;
1365
+ /**
1366
+ * - **ThreadSafety**: Unsafe
1367
+ * - **Tags**: CustomLuaState
1368
+ *
1369
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetVertexNormals)
1370
+ */
1371
+ GetVertexNormals(this: EditableMesh, vertexId: number): Array<unknown>;
1372
+ /**
1373
+ * - **ThreadSafety**: Unsafe
1374
+ * - **Tags**: CustomLuaState
1375
+ *
1376
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetVertexUVs)
1377
+ */
1378
+ GetVertexUVs(this: EditableMesh, vertexId: number): Array<unknown>;
1303
1379
  /**
1304
1380
  * Returns all vertices as a list of stable vertex IDs.
1305
1381
  *
@@ -1314,13 +1390,37 @@ interface EditableMesh extends RBXObject {
1314
1390
  * Returns a list of vertices that use a given attribute ID.
1315
1391
  *
1316
1392
  * - **ThreadSafety**: Unsafe
1393
+ * - **Tags**:
1317
1394
  *
1318
1395
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetVerticesWithAttribute)
1319
1396
  * @param this Instance which allows for the runtime creation and manipulation of meshes.
1320
1397
  * @param id Attribute ID for which to find vertices that use it.
1321
1398
  * @returns List of vertex IDs which use the given attribute ID.
1399
+ *
1400
+ * @deprecated
1322
1401
  */
1323
1402
  GetVerticesWithAttribute(this: EditableMesh, id: number): Array<unknown>;
1403
+ /**
1404
+ * - **ThreadSafety**: Unsafe
1405
+ * - **Tags**: CustomLuaState
1406
+ *
1407
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetVerticesWithColor)
1408
+ */
1409
+ GetVerticesWithColor(this: EditableMesh, colorId: number): Array<unknown>;
1410
+ /**
1411
+ * - **ThreadSafety**: Unsafe
1412
+ * - **Tags**: CustomLuaState
1413
+ *
1414
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetVerticesWithNormal)
1415
+ */
1416
+ GetVerticesWithNormal(this: EditableMesh, normalId: number): Array<unknown>;
1417
+ /**
1418
+ * - **ThreadSafety**: Unsafe
1419
+ * - **Tags**: CustomLuaState
1420
+ *
1421
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetVerticesWithUV)
1422
+ */
1423
+ GetVerticesWithUV(this: EditableMesh, uvId: number): Array<unknown>;
1324
1424
  /**
1325
1425
  * Returns a string describing a stable ID, useful for debugging purposes.
1326
1426
  *
@@ -1490,6 +1590,24 @@ interface EditableMesh extends RBXObject {
1490
1590
  * @param uv UV coordinates.
1491
1591
  */
1492
1592
  SetUV(this: EditableMesh, uvId: number, uv: Vector2): void;
1593
+ /**
1594
+ * - **ThreadSafety**: Unsafe
1595
+ *
1596
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#SetVertexFaceColor)
1597
+ */
1598
+ SetVertexFaceColor(this: EditableMesh, vertexId: number, faceId: number, colorId: number): void;
1599
+ /**
1600
+ * - **ThreadSafety**: Unsafe
1601
+ *
1602
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#SetVertexFaceNormal)
1603
+ */
1604
+ SetVertexFaceNormal(this: EditableMesh, vertexId: number, faceId: number, normalId: number): void;
1605
+ /**
1606
+ * - **ThreadSafety**: Unsafe
1607
+ *
1608
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#SetVertexFaceUV)
1609
+ */
1610
+ SetVertexFaceUV(this: EditableMesh, vertexId: number, faceId: number, uvId: number): void;
1493
1611
  /**
1494
1612
  * Splits all faces on the mesh to be triangles.
1495
1613
  *
@@ -3321,7 +3439,7 @@ interface AssetService extends Instance {
3321
3439
  */
3322
3440
  CreateEditableMesh(this: AssetService, editableMeshOptions?: object): EditableMesh;
3323
3441
  /**
3324
- * Creates a new asset from the given object.
3442
+ * Uploads a new asset to Roblox from the given object.
3325
3443
  *
3326
3444
  * - **ThreadSafety**: Unsafe
3327
3445
  * - **Tags**: Yields
@@ -3346,7 +3464,7 @@ interface AssetService extends Instance {
3346
3464
  */
3347
3465
  CreateAssetAsync(this: AssetService, object: RBXObject, assetType: CastsToEnum<Enum.AssetType>, requestParameters?: object): unknown;
3348
3466
  /**
3349
- * Creates a new version for an existing asset from the given object.
3467
+ * Uploads a new version for an existing asset from the given object.
3350
3468
  *
3351
3469
  * - **ThreadSafety**: Unsafe
3352
3470
  * - **Tags**: Yields
@@ -3964,7 +4082,7 @@ interface AudioAnalyzer extends Instance {
3964
4082
  readonly WiringChanged: RBXScriptSignal<(connected: boolean, pin: string, wire: Wire, instance: Instance) => void>;
3965
4083
  }
3966
4084
  /**
3967
- * - **Tags**: NotBrowsable
4085
+ * Combines multiple audio streams into a single, multichannel audio stream.
3968
4086
  *
3969
4087
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioChannelMixer)
3970
4088
  */
@@ -3978,34 +4096,44 @@ interface AudioChannelMixer extends Instance {
3978
4096
  */
3979
4097
  readonly _nominal_AudioChannelMixer: unique symbol;
3980
4098
  /**
4099
+ * Controls the output channel layout to be mixed to.
4100
+ *
3981
4101
  * - **ThreadSafety**: ReadSafe
3982
4102
  *
3983
4103
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioChannelMixer#Layout)
3984
4104
  */
3985
4105
  Layout: Enum.AudioChannelLayout;
3986
4106
  /**
4107
+ * Returns an array of `Wires` that are connected to the specified pin.
4108
+ *
3987
4109
  * - **ThreadSafety**: Unsafe
3988
4110
  *
3989
4111
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioChannelMixer#GetConnectedWires)
3990
- * @param this
4112
+ * @param this Combines multiple audio streams into a single, multichannel audio stream.
3991
4113
  * @param pin
3992
4114
  */
3993
4115
  GetConnectedWires(this: AudioChannelMixer, pin: string): Array<Instance>;
3994
4116
  /**
4117
+ * Returns the input pins that can be selected by `Wire.TargetName`.
4118
+ *
3995
4119
  * - **ThreadSafety**: Unsafe
3996
4120
  *
3997
4121
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioChannelMixer#GetInputPins)
3998
- * @param this
4122
+ * @param this Combines multiple audio streams into a single, multichannel audio stream.
3999
4123
  */
4000
4124
  GetInputPins(this: AudioChannelMixer): Array<unknown>;
4001
4125
  /**
4126
+ * Returns the output pin available for `Wire.SourceName`.
4127
+ *
4002
4128
  * - **ThreadSafety**: Unsafe
4003
4129
  *
4004
4130
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioChannelMixer#GetOutputPins)
4005
- * @param this
4131
+ * @param this Combines multiple audio streams into a single, multichannel audio stream.
4006
4132
  */
4007
4133
  GetOutputPins(this: AudioChannelMixer): Array<unknown>;
4008
4134
  /**
4135
+ * Fires when another instance is connected to or disconnected from the `AudioChannelMixer` via a `Wire`.
4136
+ *
4009
4137
  * - **ThreadSafety**: Unsafe
4010
4138
  *
4011
4139
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioChannelMixer#WiringChanged)
@@ -4013,7 +4141,7 @@ interface AudioChannelMixer extends Instance {
4013
4141
  readonly WiringChanged: RBXScriptSignal<(connected: boolean, pin: string, wire: Wire, instance: Instance) => void>;
4014
4142
  }
4015
4143
  /**
4016
- * - **Tags**: NotBrowsable
4144
+ * Splits an audio stream into component channels so that each can be processed independently.
4017
4145
  *
4018
4146
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioChannelSplitter)
4019
4147
  */
@@ -4027,34 +4155,44 @@ interface AudioChannelSplitter extends Instance {
4027
4155
  */
4028
4156
  readonly _nominal_AudioChannelSplitter: unique symbol;
4029
4157
  /**
4158
+ * Controls the input channel layout to be split from.
4159
+ *
4030
4160
  * - **ThreadSafety**: ReadSafe
4031
4161
  *
4032
4162
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioChannelSplitter#Layout)
4033
4163
  */
4034
4164
  Layout: Enum.AudioChannelLayout;
4035
4165
  /**
4166
+ * Returns an array of `Wires` that are connected to the specified pin.
4167
+ *
4036
4168
  * - **ThreadSafety**: Unsafe
4037
4169
  *
4038
4170
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioChannelSplitter#GetConnectedWires)
4039
- * @param this
4171
+ * @param this Splits an audio stream into component channels so that each can be processed independently.
4040
4172
  * @param pin
4041
4173
  */
4042
4174
  GetConnectedWires(this: AudioChannelSplitter, pin: string): Array<Instance>;
4043
4175
  /**
4176
+ * Returns the input pin available for `Wire.TargetName`.
4177
+ *
4044
4178
  * - **ThreadSafety**: Unsafe
4045
4179
  *
4046
4180
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioChannelSplitter#GetInputPins)
4047
- * @param this
4181
+ * @param this Splits an audio stream into component channels so that each can be processed independently.
4048
4182
  */
4049
4183
  GetInputPins(this: AudioChannelSplitter): Array<unknown>;
4050
4184
  /**
4185
+ * Returns the output pins that can be selected by `Wire.SourceName`.
4186
+ *
4051
4187
  * - **ThreadSafety**: Unsafe
4052
4188
  *
4053
4189
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioChannelSplitter#GetOutputPins)
4054
- * @param this
4190
+ * @param this Splits an audio stream into component channels so that each can be processed independently.
4055
4191
  */
4056
4192
  GetOutputPins(this: AudioChannelSplitter): Array<unknown>;
4057
4193
  /**
4194
+ * Fires when another instance is connected to or disconnected from the `AudioChannelSplitter` via a `Wire`.
4195
+ *
4058
4196
  * - **ThreadSafety**: Unsafe
4059
4197
  *
4060
4198
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioChannelSplitter#WiringChanged)
@@ -6129,7 +6267,7 @@ interface AvatarCreationService extends Instance {
6129
6267
  *
6130
6268
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AvatarCreationService#PromptCreateAvatarAsync)
6131
6269
  * @param this A service to support developer avatar creators.
6132
- * @param tokenId The ID of an avatar creation token. The token must be valid in that the universe the method is called from is the same universe the token was created for. Furthermore, the token creator must maintain ID verification and [Roblox Premium](https://www.roblox.com/premium/membership).
6270
+ * @param tokenId The ID of an avatar creation token. The token must be valid in that the universe the method is called from is the same universe the token was created for. Furthermore, the token creator must maintain ID verification and [Roblox Premium](https://www.roblox.com/premium/membership). To create a token for utilization in this API, follow the [token creation](../../../production/monetization/avatar-creation-token.md) process.
6133
6271
  * @param player The `Player` intended to be presented with the creation prompt.
6134
6272
  * @param humanoidDescription The `HumanoidDescription` of the avatar intended for creation.
6135
6273
  * @returns A tuple containing, in order: - An `PromptCreateAvatarResult` indicating the result of the creation prompt.
@@ -8546,366 +8684,6 @@ interface CalloutService extends Instance {
8546
8684
  */
8547
8685
  readonly _nominal_CalloutService: unique symbol;
8548
8686
  }
8549
- /**
8550
- * A class which defines a view of the 3D world.
8551
- *
8552
- * - **Tags**: NotReplicated
8553
- *
8554
- * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Camera)
8555
- */
8556
- interface Camera extends Instance {
8557
- /**
8558
- * **DO NOT USE!**
8559
- *
8560
- * This field exists to force TypeScript to recognize this as a nominal type
8561
- * @hidden
8562
- * @deprecated
8563
- */
8564
- readonly _nominal_Camera: unique symbol;
8565
- /**
8566
- * The `CFrame` of the `Camera`, defining its position and orientation in the 3D world.
8567
- *
8568
- * - **ThreadSafety**: ReadSafe
8569
- *
8570
- * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Camera#CFrame)
8571
- */
8572
- CFrame: CFrame;
8573
- /**
8574
- * The `Humanoid` or `BasePart` that is the `Camera` subject.
8575
- *
8576
- * - **ThreadSafety**: ReadSafe
8577
- *
8578
- * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Camera#CameraSubject)
8579
- */
8580
- CameraSubject: Humanoid | BasePart | undefined;
8581
- /**
8582
- * Specifies the `CameraType` to be read by the camera scripts.
8583
- *
8584
- * - **ThreadSafety**: ReadSafe
8585
- *
8586
- * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Camera#CameraType)
8587
- */
8588
- CameraType: Enum.CameraType;
8589
- /**
8590
- * **Deprecated:** This item has been superseded by `Camera.CFrame` which should be used in all new work.
8591
- *
8592
- * - **ThreadSafety**: ReadSafe
8593
- * - **Tags**: Hidden, NotReplicated
8594
- *
8595
- * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Camera#CoordinateFrame)
8596
- *
8597
- * @deprecated CFrame
8598
- */
8599
- CoordinateFrame: CFrame;
8600
- /**
8601
- * Sets the angle of the camera's diagonal field of view.
8602
- *
8603
- * - **ThreadSafety**: ReadSafe
8604
- * - **Tags**: NotReplicated
8605
- *
8606
- * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Camera#DiagonalFieldOfView)
8607
- */
8608
- DiagonalFieldOfView: number;
8609
- /**
8610
- * Sets the angle of the camera's vertical field of view.
8611
- *
8612
- * - **ThreadSafety**: ReadSafe
8613
- *
8614
- * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Camera#FieldOfView)
8615
- */
8616
- FieldOfView: number;
8617
- /**
8618
- * Determines the FOV value of the `Camera` that's invariant under viewport size changes.
8619
- *
8620
- * - **ThreadSafety**: ReadSafe
8621
- *
8622
- * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Camera#FieldOfViewMode)
8623
- */
8624
- FieldOfViewMode: Enum.FieldOfViewMode;
8625
- /**
8626
- * Sets the area in 3D space that is prioritized by Roblox's graphical systems.
8627
- *
8628
- * - **ThreadSafety**: ReadSafe
8629
- *
8630
- * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Camera#Focus)
8631
- */
8632
- Focus: CFrame;
8633
- /**
8634
- * Toggles whether the camera will automatically track the head motion of a player using a VR device.
8635
- *
8636
- * - **ThreadSafety**: ReadSafe
8637
- *
8638
- * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Camera#HeadLocked)
8639
- */
8640
- HeadLocked: boolean;
8641
- /**
8642
- * Sets the scale of the user's perspective of the world when using VR.
8643
- *
8644
- * - **ThreadSafety**: ReadSafe
8645
- *
8646
- * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Camera#HeadScale)
8647
- */
8648
- HeadScale: number;
8649
- /**
8650
- * Sets the angle of the camera's field of view along the longest viewport axis.
8651
- *
8652
- * - **ThreadSafety**: ReadSafe
8653
- * - **Tags**: NotReplicated
8654
- *
8655
- * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Camera#MaxAxisFieldOfView)
8656
- */
8657
- MaxAxisFieldOfView: number;
8658
- /**
8659
- * Describes the negative **Z** offset, in studs, of the camera's near clipping plane.
8660
- *
8661
- * - **ThreadSafety**: ReadSafe
8662
- * - **Tags**: NotReplicated
8663
- *
8664
- * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Camera#NearPlaneZ)
8665
- */
8666
- readonly NearPlaneZ: number;
8667
- /**
8668
- * Toggles whether to apply tilt and roll from the `CFrame` property while the player is using a VR device.
8669
- *
8670
- * - **ThreadSafety**: ReadSafe
8671
- *
8672
- * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Camera#VRTiltAndRollEnabled)
8673
- */
8674
- VRTiltAndRollEnabled: boolean;
8675
- /**
8676
- * The dimensions of the device safe area on a Roblox client.
8677
- *
8678
- * - **ThreadSafety**: ReadSafe
8679
- * - **Tags**: NotReplicated
8680
- *
8681
- * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Camera#ViewportSize)
8682
- */
8683
- readonly ViewportSize: Vector2;
8684
- /**
8685
- * **Deprecated:**
8686
- *
8687
- * Returns how much the `Camera` needs to be pushed towards its `Focus` in order to make sure there is no obstructions between the `Focus` and `CFrame`.
8688
- *
8689
- * - **ThreadSafety**: Unsafe
8690
- * - **Tags**:
8691
- *
8692
- * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Camera#GetLargestCutoffDistance)
8693
- * @param this A class which defines a view of the 3D world.
8694
- * @param ignoreList An array of `Instances` to ignore. Descendants of these instances will also be ignored.
8695
- * @returns The distance, in studs, that the `Camera` needs to be pushed towards its `Focus` to ensure there are no obstructions between the `Focus` and `CFrame` of the `Camera`.
8696
- *
8697
- * @deprecated
8698
- */
8699
- GetLargestCutoffDistance(this: Camera, ignoreList: Array<Instance>): number;
8700
- /**
8701
- * **Deprecated:** This method has been deprecated and no longer works. It should not be used in new work.
8702
- *
8703
- * Returns the current 'pan' speed of the `Camera`.
8704
- *
8705
- * - **ThreadSafety**: Unsafe
8706
- * - **Tags**:
8707
- *
8708
- * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Camera#GetPanSpeed)
8709
- * @param this A class which defines a view of the 3D world.
8710
- * @returns The speed at which the `Camera` is rotating around its `Focus` on the **Y** axis.
8711
- *
8712
- * @deprecated
8713
- */
8714
- GetPanSpeed(this: Camera): number;
8715
- /**
8716
- * Returns an array of `BaseParts` that are obscuring the lines of sight between the camera's `CFrame` and the cast points.
8717
- *
8718
- * - **ThreadSafety**: Unsafe
8719
- *
8720
- * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Camera#GetPartsObscuringTarget)
8721
- * @param this A class which defines a view of the 3D world.
8722
- * @param castPoints An array of `Vector3` positions of cast points.
8723
- * @param ignoreList An array of `Instances` that should be ignored, along with their descendants.
8724
- * @returns An array of `BaseParts` that obscure the lines of sight between the camera's `CFrame` and the `castPoints`.
8725
- */
8726
- GetPartsObscuringTarget(this: Camera, castPoints: Array<Vector3>, ignoreList: Array<Instance>): Array<Instance>;
8727
- /**
8728
- * Returns the actual `CFrame`where the `Camera` is being rendered, accounting for any roll applied and the impact of VR devices.
8729
- *
8730
- * - **ThreadSafety**: Unsafe
8731
- *
8732
- * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Camera#GetRenderCFrame)
8733
- * @param this A class which defines a view of the 3D world.
8734
- * @returns The `CFrame` the `Camera` is being rendered at.
8735
- */
8736
- GetRenderCFrame(this: Camera): CFrame;
8737
- /**
8738
- * Returns in radians the current roll, or rotation around the camera's Z-axis, applied to the `Camera` using `SetRoll()`.
8739
- *
8740
- * - **ThreadSafety**: Unsafe
8741
- *
8742
- * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Camera#GetRoll)
8743
- * @param this A class which defines a view of the 3D world.
8744
- * @returns The current roll applied by `SetRoll()`, in radians.
8745
- */
8746
- GetRoll(this: Camera): number;
8747
- /**
8748
- * **Deprecated:** This method has been deprecated and no longer works.
8749
- *
8750
- * Returns the current tilt speed of the `Camera`.
8751
- *
8752
- * - **ThreadSafety**: Unsafe
8753
- * - **Tags**:
8754
- *
8755
- * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Camera#GetTiltSpeed)
8756
- * @param this A class which defines a view of the 3D world.
8757
- * @returns The speed at which the `Camera` is rotating around its `Focus` around the camera's **X** axis.
8758
- *
8759
- * @deprecated
8760
- */
8761
- GetTiltSpeed(this: Camera): number;
8762
- /**
8763
- * **Deprecated:** This method has been deprecated. Instead use `TweenService` to smoothly animate the `Camera`, see the code snippets below for an example.
8764
- *
8765
- * Tweens the `Camera` in a linear fashion towards a new `CFrame` and `Focus` over a given duration.
8766
- *
8767
- * - **ThreadSafety**: Unsafe
8768
- * - **Tags**:
8769
- *
8770
- * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Camera#Interpolate)
8771
- * @param this A class which defines a view of the 3D world.
8772
- * @param endPos The `CFrame` for the `Camera` to tween to.
8773
- * @param endFocus The `CFrame` for the camera's `Focus` to tween to.
8774
- * @param duration The duration, in seconds, of the tween.
8775
- *
8776
- * @deprecated
8777
- */
8778
- Interpolate(this: Camera, endPos: CFrame, endFocus: CFrame, duration: number): void;
8779
- /**
8780
- * **Deprecated:** This method was used for legacy camera controls and has since been deprecated. Do not use in new work.
8781
- *
8782
- * Pans the `Camera` around the `Focus` in 45 degree increments around the **Y** axis.
8783
- *
8784
- * - **ThreadSafety**: Unsafe
8785
- * - **Tags**:
8786
- *
8787
- * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Camera#PanUnits)
8788
- * @param this A class which defines a view of the 3D world.
8789
- * @param units The number of 45 degree increments by which to pan the `Camera`.
8790
- *
8791
- * @deprecated
8792
- */
8793
- PanUnits(this: Camera, units: number): void;
8794
- /**
8795
- * Creates a unit `Ray` from a position on the screen (in pixels), at a set depth from the `Camera` orientated in the camera's direction. Accounts for the GUI inset.
8796
- *
8797
- * - **ThreadSafety**: Safe
8798
- *
8799
- * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Camera#ScreenPointToRay)
8800
- * @param this A class which defines a view of the 3D world.
8801
- * @param x The position on the **X** axis, in pixels, of the screen point at which to originate the `Ray`. This position accounts for the GUI inset.
8802
- * @param y The position on the **Y** axis, in pixels, of the screen point at which to originate the `Ray`. This position accounts for the GUI inset.
8803
- * @param depth The depth from the `Camera`, in studs, from which to offset the origin of the `Ray`.
8804
- * @returns A unit `Ray`, originating from the equivalent `Vector3` world position of the given screen coordinates at the given depth away from the `Camera`. This ray is orientated in the direction of the `Camera`.
8805
- */
8806
- ScreenPointToRay(this: Camera, x: number, y: number, depth?: number): Ray;
8807
- /**
8808
- * **Deprecated:** This method has been deprecated and should not be used in new work.
8809
- *
8810
- * Sets the `CameraPanMode` to be used by the `Camera` on mobile devices.
8811
- *
8812
- * - **ThreadSafety**: Unsafe
8813
- * - **Tags**:
8814
- *
8815
- * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Camera#SetCameraPanMode)
8816
- * @param this A class which defines a view of the 3D world.
8817
- * @param mode The `CameraPanMode` to set the `Camera` to.
8818
- *
8819
- * @deprecated
8820
- */
8821
- SetCameraPanMode(this: Camera, mode?: CastsToEnum<Enum.CameraPanMode>): void;
8822
- /**
8823
- * Sets the current rotation applied around the camera's Z-axis.
8824
- *
8825
- * - **ThreadSafety**: Unsafe
8826
- *
8827
- * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Camera#SetRoll)
8828
- * @param this A class which defines a view of the 3D world.
8829
- * @param rollAngle The roll angle, in radians, to be applied to the `Camera`.
8830
- */
8831
- SetRoll(this: Camera, rollAngle: number): void;
8832
- /**
8833
- * **Deprecated:** This method was used for legacy camera controls and has been deprecated. Do not use in new work.
8834
- *
8835
- * Tilts the `Camera` around its `Focus` in 10 degree increments around the camera's **X** axis.
8836
- *
8837
- * - **ThreadSafety**: Unsafe
8838
- * - **Tags**:
8839
- *
8840
- * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Camera#TiltUnits)
8841
- * @param this A class which defines a view of the 3D world.
8842
- * @param units The number of 10 degree units by which to tilt the `Camera`.
8843
- * @returns Whether the `Camera` tilt applied was constrained.
8844
- *
8845
- * @deprecated
8846
- */
8847
- TiltUnits(this: Camera, units: number): boolean;
8848
- /**
8849
- * Creates a unit `Ray` from a position on the viewport (in pixels), at a given depth from the `Camera`, orientated in the camera's direction. Does not account for the `CoreUISafeInsets` inset.
8850
- *
8851
- * - **ThreadSafety**: Safe
8852
- *
8853
- * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Camera#ViewportPointToRay)
8854
- * @param this A class which defines a view of the 3D world.
8855
- * @param x The position on the **X** axis, in pixels, of the viewport point at which to originate the `Ray`, in device safe area coordinates.
8856
- * @param y The position on the **Y** axis, in pixels, of the viewport point at which to originate the `Ray`, in device safe area coordinates.
8857
- * @param depth The depth from the `Camera`, in studs, from which to offset the origin of the `Ray`.
8858
- * @returns A unit `Ray`, originating from the equivalent `Vector3` world position of the given viewport coordinates at the given depth away from the `Camera`. This ray is orientated in the direction of the `Camera`.
8859
- */
8860
- ViewportPointToRay(this: Camera, x: number, y: number, depth?: number): Ray;
8861
- /**
8862
- * Returns the screen location and depth of a `Vector3` `worldPoint` and whether this point is within the bounds of the screen. Accounts for the GUI inset.
8863
- *
8864
- * - **ThreadSafety**: Safe
8865
- *
8866
- * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Camera#WorldToScreenPoint)
8867
- * @param this A class which defines a view of the 3D world.
8868
- * @param worldPoint The `Vector3` world position.
8869
- * @returns A tuple containing, in order: - A `Vector3` whose **X** and **Y** components represent the offset of the `worldPoint` from the top left corner of the screen, in pixels. The `Vector3` **Z** component represents the depth of the `worldPoint` from the screen (in studs).
8870
- * - A boolean indicating if the `worldPoint` is within the bounds of the screen.
8871
- */
8872
- WorldToScreenPoint(this: Camera, worldPoint: Vector3): LuaTuple<[
8873
- Vector3,
8874
- boolean
8875
- ]>;
8876
- /**
8877
- * Returns the screen location and depth of a `Vector3` `worldPoint` and whether this point is within the bounds of the screen. Does not account for the GUI inset.
8878
- *
8879
- * - **ThreadSafety**: Safe
8880
- *
8881
- * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Camera#WorldToViewportPoint)
8882
- * @param this A class which defines a view of the 3D world.
8883
- * @param worldPoint The `Vector3` world position.
8884
- * @returns A tuple containing, in order: - A `Vector3` whose **X** and **Y** components represent the offset of the `worldPoint` from the top left corner of the viewport, in pixels. The `Vector3` **Z** component represents the depth of the `worldPoint` from the screen (in studs).
8885
- * - A boolean indicating if the `worldPoint` is within the bounds of the screen.
8886
- */
8887
- WorldToViewportPoint(this: Camera, worldPoint: Vector3): LuaTuple<[
8888
- Vector3,
8889
- boolean
8890
- ]>;
8891
- /**
8892
- * - **ThreadSafety**: Unsafe
8893
- *
8894
- * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Camera#ZoomToExtents)
8895
- * @param this A class which defines a view of the 3D world.
8896
- * @param boundingBoxCFrame
8897
- * @param boundingBoxSize
8898
- */
8899
- ZoomToExtents(this: Camera, boundingBoxCFrame: CFrame, boundingBoxSize: Vector3): void;
8900
- /**
8901
- * Fired when the `Camera` has finished interpolating using`Interpolate()`.
8902
- *
8903
- * - **ThreadSafety**: Unsafe
8904
- *
8905
- * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Camera#InterpolationFinished)
8906
- */
8907
- readonly InterpolationFinished: RBXScriptSignal<() => void>;
8908
- }
8909
8687
  /**
8910
8688
  * A service which provides control over screenshot capture features.
8911
8689
  *
@@ -9279,7 +9057,7 @@ interface ShirtGraphic extends CharacterAppearance {
9279
9057
  Graphic: ContentId;
9280
9058
  }
9281
9059
  /**
9282
- * Houses the Lua code responsible for running the legacy chat system.
9060
+ * Houses the Luau code responsible for running the legacy chat system.
9283
9061
  *
9284
9062
  * - **Tags**: NotCreatable, Service, NotReplicated
9285
9063
  *
@@ -9316,19 +9094,19 @@ interface Chat extends Instance {
9316
9094
  * - **ThreadSafety**: Unsafe
9317
9095
  *
9318
9096
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Chat#Chat)
9319
- * @param this Houses the Lua code responsible for running the legacy chat system.
9097
+ * @param this Houses the Luau code responsible for running the legacy chat system.
9320
9098
  * @param partOrCharacter An instance that is the part or character which the *BubbleChat* dialog should appear above.
9321
9099
  * @param message The message string being chatted.
9322
9100
  * @param color An `ChatColor` specifying the color of the chatted message.
9323
9101
  */
9324
9102
  Chat(this: Chat, partOrCharacter: Instance, message: string, color?: CastsToEnum<Enum.ChatColor>): void;
9325
9103
  /**
9326
- * Invoke a chat callback function registered by `RegisterChatCallback`. Used by the Lua Chat System.
9104
+ * Invoke a chat callback function registered by `RegisterChatCallback`. Used by the Luau Chat System.
9327
9105
  *
9328
9106
  * - **ThreadSafety**: Unsafe
9329
9107
  *
9330
9108
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Chat#InvokeChatCallback)
9331
- * @param this Houses the Lua code responsible for running the legacy chat system.
9109
+ * @param this Houses the Luau code responsible for running the legacy chat system.
9332
9110
  * @param callbackType The type of callback to invoke.
9333
9111
  * @param callbackArguments The arguments that will be sent to the registered callback function.
9334
9112
  * @returns The values returned by the function registered to the given ChatCallbackType.
@@ -9340,7 +9118,7 @@ interface Chat extends Instance {
9340
9118
  * - **ThreadSafety**: Unsafe
9341
9119
  *
9342
9120
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Chat#RegisterChatCallback)
9343
- * @param this Houses the Lua code responsible for running the legacy chat system.
9121
+ * @param this Houses the Luau code responsible for running the legacy chat system.
9344
9122
  * @param callbackType The callback to which the function shall be registered (this determines in what way the function is called).
9345
9123
  * @param callbackFunction The function to call when the callback is invoked using Chat:InvokeChatCallback.
9346
9124
  */
@@ -9351,7 +9129,7 @@ interface Chat extends Instance {
9351
9129
  * - **ThreadSafety**: Unsafe
9352
9130
  *
9353
9131
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Chat#SetBubbleChatSettings)
9354
- * @param this Houses the Lua code responsible for running the legacy chat system.
9132
+ * @param this Houses the Luau code responsible for running the legacy chat system.
9355
9133
  * @param settings A settings table.
9356
9134
  */
9357
9135
  SetBubbleChatSettings(this: Chat, settings: unknown): void;
@@ -9362,7 +9140,7 @@ interface Chat extends Instance {
9362
9140
  * - **Tags**: Yields
9363
9141
  *
9364
9142
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Chat#CanUserChatAsync)
9365
- * @param this Houses the Lua code responsible for running the legacy chat system.
9143
+ * @param this Houses the Luau code responsible for running the legacy chat system.
9366
9144
  * @param userId
9367
9145
  */
9368
9146
  CanUserChatAsync(this: Chat, userId: number): boolean;
@@ -9373,7 +9151,7 @@ interface Chat extends Instance {
9373
9151
  * - **Tags**: Yields
9374
9152
  *
9375
9153
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Chat#CanUsersChatAsync)
9376
- * @param this Houses the Lua code responsible for running the legacy chat system.
9154
+ * @param this Houses the Luau code responsible for running the legacy chat system.
9377
9155
  * @param userIdFrom
9378
9156
  * @param userIdTo
9379
9157
  */
@@ -9385,7 +9163,7 @@ interface Chat extends Instance {
9385
9163
  * - **Tags**: Yields
9386
9164
  *
9387
9165
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Chat#FilterStringAsync)
9388
- * @param this Houses the Lua code responsible for running the legacy chat system.
9166
+ * @param this Houses the Luau code responsible for running the legacy chat system.
9389
9167
  * @param stringToFilter The raw string to be filtered, exactly as entered by the player.
9390
9168
  * @param playerFrom The author of the text.
9391
9169
  * @param playerTo The intended recipient of the provided text; use the author if the text is persistent (see description).
@@ -9398,7 +9176,7 @@ interface Chat extends Instance {
9398
9176
  * - **Tags**: Yields
9399
9177
  *
9400
9178
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Chat#FilterStringForBroadcast)
9401
- * @param this Houses the Lua code responsible for running the legacy chat system.
9179
+ * @param this Houses the Luau code responsible for running the legacy chat system.
9402
9180
  * @param stringToFilter Message string being filtered.
9403
9181
  * @param playerFrom Instance of the player sending the message.
9404
9182
  * @returns Filtered message string.
@@ -9413,7 +9191,7 @@ interface Chat extends Instance {
9413
9191
  * - **Tags**: Yields
9414
9192
  *
9415
9193
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Chat#FilterStringForPlayerAsync)
9416
- * @param this Houses the Lua code responsible for running the legacy chat system.
9194
+ * @param this Houses the Luau code responsible for running the legacy chat system.
9417
9195
  * @param stringToFilter String being filtered.
9418
9196
  * @param playerToFilterFor Player that the string is being filtered for.
9419
9197
  * @returns Filtered string result.
@@ -10275,6 +10053,7 @@ interface ConfigService extends Instance {
10275
10053
  * - **Tags**: Yields
10276
10054
  *
10277
10055
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ConfigService#GetConfigAsync)
10056
+ * @param this
10278
10057
  */
10279
10058
  GetConfigAsync(this: ConfigService): ConfigSnapshot;
10280
10059
  /**
@@ -10282,6 +10061,8 @@ interface ConfigService extends Instance {
10282
10061
  * - **Tags**: Yields
10283
10062
  *
10284
10063
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ConfigService#GetConfigForPlayerAsync)
10064
+ * @param this
10065
+ * @param player
10285
10066
  */
10286
10067
  GetConfigForPlayerAsync(this: ConfigService, player: Player): ConfigSnapshot;
10287
10068
  }
@@ -13423,7 +13204,7 @@ interface DataStoreOptions extends Instance {
13423
13204
  *
13424
13205
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DataStoreOptions#SetExperimentalFeatures)
13425
13206
  * @param this Object used to provide additional parameters to `DataStoreService:GetDataStore()`.
13426
- * @param experimentalFeatures Lua table in `key = value` format where the key is the experimental feature name and the value is a boolean which specifies whether to enable.
13207
+ * @param experimentalFeatures Luau table in `key = value` format where the key is the experimental feature name and the value is a boolean which specifies whether to enable.
13427
13208
  */
13428
13209
  SetExperimentalFeatures(this: DataStoreOptions, experimentalFeatures: object): void;
13429
13210
  }
@@ -14883,7 +14664,7 @@ interface FloatCurve extends Instance {
14883
14664
  after: number
14884
14665
  ];
14885
14666
  /**
14886
- * Returns a copy of all the keys in the FloatCurve as a Lua array of `FloatCurveKeys`.
14667
+ * Returns a copy of all the keys in the FloatCurve as a Luau array of `FloatCurveKeys`.
14887
14668
  *
14888
14669
  * - **ThreadSafety**: Unsafe
14889
14670
  *
@@ -15085,7 +14866,7 @@ interface GenerationService extends Instance {
15085
14866
  * @param player The `Player` requesting the generation.
15086
14867
  * @param options Additional generation options. Currently, no options are supported.
15087
14868
  * @param intermediateResultCallback A callback function triggered with intermediate generation results. Useful for retrieving early mesh versions (e.g. before textures are applied).
15088
- * @returns A tuple of generation ID and context ID. - Generation ID: A unique ID returned for each invocation of `GenerateMeshAsync()`.
14869
+ * @returns A tuple of generation ID and context ID. - Generation ID: A unique ID returned for each invocation of `GenerateMeshAsync()`.
15089
14870
  * - Context ID: Not currently used.
15090
14871
  */
15091
14872
  GenerateMeshAsync(this: GenerationService, inputs: object, player: Player, options: object, intermediateResultCallback?: Callback): unknown;
@@ -20052,7 +19833,7 @@ interface HttpService extends Instance {
20052
19833
  */
20053
19834
  GetSecret(this: HttpService, key: string): Secret;
20054
19835
  /**
20055
- * Decodes a JSON string into a Lua table.
19836
+ * Decodes a JSON string into a Luau table.
20056
19837
  *
20057
19838
  * - **ThreadSafety**: Safe
20058
19839
  * - **Tags**: CustomLuaState
@@ -20060,18 +19841,18 @@ interface HttpService extends Instance {
20060
19841
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HttpService#JSONDecode)
20061
19842
  * @param this Allows sending HTTP requests and provides various web-related and JSON methods.
20062
19843
  * @param input The JSON object being decoded.
20063
- * @returns The decoded JSON object as a Lua table.
19844
+ * @returns The decoded JSON object as a Luau table.
20064
19845
  */
20065
19846
  JSONDecode(this: HttpService, input: string): unknown;
20066
19847
  /**
20067
- * Generate a JSON string from a Lua table.
19848
+ * Generate a JSON string from a Luau table.
20068
19849
  *
20069
19850
  * - **ThreadSafety**: Safe
20070
19851
  * - **Tags**: CustomLuaState
20071
19852
  *
20072
19853
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HttpService#JSONEncode)
20073
19854
  * @param this Allows sending HTTP requests and provides various web-related and JSON methods.
20074
- * @param input The input Lua table.
19855
+ * @param input The input Luau table.
20075
19856
  * @returns The returned JSON string.
20076
19857
  */
20077
19858
  JSONEncode(this: HttpService, input: unknown): string;
@@ -22478,12 +22259,24 @@ interface InputBinding extends Instance {
22478
22259
  * @deprecated
22479
22260
  */
22480
22261
  readonly _nominal_InputBinding: unique symbol;
22262
+ /**
22263
+ * - **ThreadSafety**: ReadSafe
22264
+ *
22265
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputBinding#Down)
22266
+ */
22267
+ Down: Enum.KeyCode;
22481
22268
  /**
22482
22269
  * - **ThreadSafety**: ReadSafe
22483
22270
  *
22484
22271
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputBinding#KeyCode)
22485
22272
  */
22486
22273
  KeyCode: Enum.KeyCode;
22274
+ /**
22275
+ * - **ThreadSafety**: ReadSafe
22276
+ *
22277
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputBinding#Left)
22278
+ */
22279
+ Left: Enum.KeyCode;
22487
22280
  /**
22488
22281
  * - **ThreadSafety**: ReadSafe
22489
22282
  *
@@ -22496,6 +22289,12 @@ interface InputBinding extends Instance {
22496
22289
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputBinding#ReleasedThreshold)
22497
22290
  */
22498
22291
  ReleasedThreshold: number;
22292
+ /**
22293
+ * - **ThreadSafety**: ReadSafe
22294
+ *
22295
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputBinding#Right)
22296
+ */
22297
+ Right: Enum.KeyCode;
22499
22298
  /**
22500
22299
  * - **ThreadSafety**: ReadSafe
22501
22300
  *
@@ -22508,6 +22307,18 @@ interface InputBinding extends Instance {
22508
22307
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputBinding#UIButton)
22509
22308
  */
22510
22309
  UIButton: GuiButton | undefined;
22310
+ /**
22311
+ * - **ThreadSafety**: ReadSafe
22312
+ *
22313
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputBinding#Up)
22314
+ */
22315
+ Up: Enum.KeyCode;
22316
+ /**
22317
+ * - **ThreadSafety**: ReadSafe
22318
+ *
22319
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputBinding#Vector2Scale)
22320
+ */
22321
+ Vector2Scale: Vector2;
22511
22322
  }
22512
22323
  /**
22513
22324
  * - **Tags**: NotBrowsable
@@ -24466,7 +24277,7 @@ interface LogService extends Instance {
24466
24277
  readonly MessageOut: RBXScriptSignal<(message: string, messageType: Enum.MessageType) => void>;
24467
24278
  }
24468
24279
  /**
24469
- * The base class for all objects which contain Lua code.
24280
+ * The base class for all objects which contain Luau code.
24470
24281
  *
24471
24282
  * - **Tags**: NotCreatable, NotBrowsable
24472
24283
  *
@@ -24504,6 +24315,24 @@ interface AuroraScript extends LuaSourceContainer {
24504
24315
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraScript#Tag)
24505
24316
  */
24506
24317
  get Tag(): string;
24318
+ /**
24319
+ * - **ThreadSafety**: Unsafe
24320
+ *
24321
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraScript#AddTo)
24322
+ */
24323
+ AddTo(this: AuroraScript, instance: Instance): void;
24324
+ /**
24325
+ * - **ThreadSafety**: Unsafe
24326
+ *
24327
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraScript#IsOnInstance)
24328
+ */
24329
+ IsOnInstance(this: AuroraScript, instance: Instance): boolean;
24330
+ /**
24331
+ * - **ThreadSafety**: Unsafe
24332
+ *
24333
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraScript#RemoveFrom)
24334
+ */
24335
+ RemoveFrom(this: AuroraScript, instance: Instance): void;
24507
24336
  }
24508
24337
  /**
24509
24338
  * The base class for all script objects which run automatically.
@@ -24561,7 +24390,7 @@ interface BaseScript extends LuaSourceContainer {
24561
24390
  get RunContext(): Enum.RunContext;
24562
24391
  }
24563
24392
  /**
24564
- * An object that contains and runs Lua code on the server.
24393
+ * An object that contains and runs Luau code on the server.
24565
24394
  *
24566
24395
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Script)
24567
24396
  */
@@ -24584,7 +24413,7 @@ interface Script extends BaseScript {
24584
24413
  Source: ProtectedString;
24585
24414
  }
24586
24415
  /**
24587
- * An object that contains and runs Lua code on the client (player's device) instead of the server.
24416
+ * An object that contains and runs Luau code on the client (player's device) instead of the server.
24588
24417
  *
24589
24418
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/LocalScript)
24590
24419
  */
@@ -28275,6 +28104,366 @@ interface VehicleSeat extends BasePart {
28275
28104
  */
28276
28105
  readonly RemoteDestroySeatWeld: RBXScriptSignal<() => void>;
28277
28106
  }
28107
+ /**
28108
+ * A class which defines a view of the 3D world.
28109
+ *
28110
+ * - **Tags**: NotReplicated
28111
+ *
28112
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Camera)
28113
+ */
28114
+ interface Camera extends Instance {
28115
+ /**
28116
+ * **DO NOT USE!**
28117
+ *
28118
+ * This field exists to force TypeScript to recognize this as a nominal type
28119
+ * @hidden
28120
+ * @deprecated
28121
+ */
28122
+ readonly _nominal_Camera: unique symbol;
28123
+ /**
28124
+ * The `CFrame` of the `Camera`, defining its position and orientation in the 3D world.
28125
+ *
28126
+ * - **ThreadSafety**: ReadSafe
28127
+ *
28128
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Camera#CFrame)
28129
+ */
28130
+ CFrame: CFrame;
28131
+ /**
28132
+ * The `Humanoid` or `BasePart` that is the `Camera` subject.
28133
+ *
28134
+ * - **ThreadSafety**: ReadSafe
28135
+ *
28136
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Camera#CameraSubject)
28137
+ */
28138
+ CameraSubject: Humanoid | BasePart | undefined;
28139
+ /**
28140
+ * Specifies the `CameraType` to be read by the camera scripts.
28141
+ *
28142
+ * - **ThreadSafety**: ReadSafe
28143
+ *
28144
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Camera#CameraType)
28145
+ */
28146
+ CameraType: Enum.CameraType;
28147
+ /**
28148
+ * **Deprecated:** This item has been superseded by `Camera.CFrame` which should be used in all new work.
28149
+ *
28150
+ * - **ThreadSafety**: ReadSafe
28151
+ * - **Tags**: Hidden, NotReplicated
28152
+ *
28153
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Camera#CoordinateFrame)
28154
+ *
28155
+ * @deprecated CFrame
28156
+ */
28157
+ CoordinateFrame: CFrame;
28158
+ /**
28159
+ * Sets the angle of the camera's diagonal field of view.
28160
+ *
28161
+ * - **ThreadSafety**: ReadSafe
28162
+ * - **Tags**: NotReplicated
28163
+ *
28164
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Camera#DiagonalFieldOfView)
28165
+ */
28166
+ DiagonalFieldOfView: number;
28167
+ /**
28168
+ * Sets the angle of the camera's vertical field of view.
28169
+ *
28170
+ * - **ThreadSafety**: ReadSafe
28171
+ *
28172
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Camera#FieldOfView)
28173
+ */
28174
+ FieldOfView: number;
28175
+ /**
28176
+ * Determines the FOV value of the `Camera` that's invariant under viewport size changes.
28177
+ *
28178
+ * - **ThreadSafety**: ReadSafe
28179
+ *
28180
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Camera#FieldOfViewMode)
28181
+ */
28182
+ FieldOfViewMode: Enum.FieldOfViewMode;
28183
+ /**
28184
+ * Sets the area in 3D space that is prioritized by Roblox's graphical systems.
28185
+ *
28186
+ * - **ThreadSafety**: ReadSafe
28187
+ *
28188
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Camera#Focus)
28189
+ */
28190
+ Focus: CFrame;
28191
+ /**
28192
+ * Toggles whether the camera will automatically track the head motion of a player using a VR device.
28193
+ *
28194
+ * - **ThreadSafety**: ReadSafe
28195
+ *
28196
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Camera#HeadLocked)
28197
+ */
28198
+ HeadLocked: boolean;
28199
+ /**
28200
+ * Sets the scale of the user's perspective of the world when using VR.
28201
+ *
28202
+ * - **ThreadSafety**: ReadSafe
28203
+ *
28204
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Camera#HeadScale)
28205
+ */
28206
+ HeadScale: number;
28207
+ /**
28208
+ * Sets the angle of the camera's field of view along the longest viewport axis.
28209
+ *
28210
+ * - **ThreadSafety**: ReadSafe
28211
+ * - **Tags**: NotReplicated
28212
+ *
28213
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Camera#MaxAxisFieldOfView)
28214
+ */
28215
+ MaxAxisFieldOfView: number;
28216
+ /**
28217
+ * Describes the negative **Z** offset, in studs, of the camera's near clipping plane.
28218
+ *
28219
+ * - **ThreadSafety**: ReadSafe
28220
+ * - **Tags**: NotReplicated
28221
+ *
28222
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Camera#NearPlaneZ)
28223
+ */
28224
+ readonly NearPlaneZ: number;
28225
+ /**
28226
+ * Toggles whether to apply tilt and roll from the `CFrame` property while the player is using a VR device.
28227
+ *
28228
+ * - **ThreadSafety**: ReadSafe
28229
+ *
28230
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Camera#VRTiltAndRollEnabled)
28231
+ */
28232
+ VRTiltAndRollEnabled: boolean;
28233
+ /**
28234
+ * The dimensions of the device safe area on a Roblox client.
28235
+ *
28236
+ * - **ThreadSafety**: ReadSafe
28237
+ * - **Tags**: NotReplicated
28238
+ *
28239
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Camera#ViewportSize)
28240
+ */
28241
+ readonly ViewportSize: Vector2;
28242
+ /**
28243
+ * **Deprecated:**
28244
+ *
28245
+ * Returns how much the `Camera` needs to be pushed towards its `Focus` in order to make sure there is no obstructions between the `Focus` and `CFrame`.
28246
+ *
28247
+ * - **ThreadSafety**: Unsafe
28248
+ * - **Tags**:
28249
+ *
28250
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Camera#GetLargestCutoffDistance)
28251
+ * @param this A class which defines a view of the 3D world.
28252
+ * @param ignoreList An array of `Instances` to ignore. Descendants of these instances will also be ignored.
28253
+ * @returns The distance, in studs, that the `Camera` needs to be pushed towards its `Focus` to ensure there are no obstructions between the `Focus` and `CFrame` of the `Camera`.
28254
+ *
28255
+ * @deprecated
28256
+ */
28257
+ GetLargestCutoffDistance(this: Camera, ignoreList: Array<Instance>): number;
28258
+ /**
28259
+ * **Deprecated:** This method has been deprecated and no longer works. It should not be used in new work.
28260
+ *
28261
+ * Returns the current 'pan' speed of the `Camera`.
28262
+ *
28263
+ * - **ThreadSafety**: Unsafe
28264
+ * - **Tags**:
28265
+ *
28266
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Camera#GetPanSpeed)
28267
+ * @param this A class which defines a view of the 3D world.
28268
+ * @returns The speed at which the `Camera` is rotating around its `Focus` on the **Y** axis.
28269
+ *
28270
+ * @deprecated
28271
+ */
28272
+ GetPanSpeed(this: Camera): number;
28273
+ /**
28274
+ * Returns an array of `BaseParts` that are obscuring the lines of sight between the camera's `CFrame` and the cast points.
28275
+ *
28276
+ * - **ThreadSafety**: Unsafe
28277
+ *
28278
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Camera#GetPartsObscuringTarget)
28279
+ * @param this A class which defines a view of the 3D world.
28280
+ * @param castPoints An array of `Vector3` positions of cast points.
28281
+ * @param ignoreList An array of `Instances` that should be ignored, along with their descendants.
28282
+ * @returns An array of `BaseParts` that obscure the lines of sight between the camera's `CFrame` and the `castPoints`.
28283
+ */
28284
+ GetPartsObscuringTarget(this: Camera, castPoints: Array<Vector3>, ignoreList: Array<Instance>): Array<Instance>;
28285
+ /**
28286
+ * Returns the actual `CFrame`where the `Camera` is being rendered, accounting for any roll applied and the impact of VR devices.
28287
+ *
28288
+ * - **ThreadSafety**: Unsafe
28289
+ *
28290
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Camera#GetRenderCFrame)
28291
+ * @param this A class which defines a view of the 3D world.
28292
+ * @returns The `CFrame` the `Camera` is being rendered at.
28293
+ */
28294
+ GetRenderCFrame(this: Camera): CFrame;
28295
+ /**
28296
+ * Returns in radians the current roll, or rotation around the camera's Z-axis, applied to the `Camera` using `SetRoll()`.
28297
+ *
28298
+ * - **ThreadSafety**: Unsafe
28299
+ *
28300
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Camera#GetRoll)
28301
+ * @param this A class which defines a view of the 3D world.
28302
+ * @returns The current roll applied by `SetRoll()`, in radians.
28303
+ */
28304
+ GetRoll(this: Camera): number;
28305
+ /**
28306
+ * **Deprecated:** This method has been deprecated and no longer works.
28307
+ *
28308
+ * Returns the current tilt speed of the `Camera`.
28309
+ *
28310
+ * - **ThreadSafety**: Unsafe
28311
+ * - **Tags**:
28312
+ *
28313
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Camera#GetTiltSpeed)
28314
+ * @param this A class which defines a view of the 3D world.
28315
+ * @returns The speed at which the `Camera` is rotating around its `Focus` around the camera's **X** axis.
28316
+ *
28317
+ * @deprecated
28318
+ */
28319
+ GetTiltSpeed(this: Camera): number;
28320
+ /**
28321
+ * **Deprecated:** This method has been deprecated. Instead use `TweenService` to smoothly animate the `Camera`, see the code snippets below for an example.
28322
+ *
28323
+ * Tweens the `Camera` in a linear fashion towards a new `CFrame` and `Focus` over a given duration.
28324
+ *
28325
+ * - **ThreadSafety**: Unsafe
28326
+ * - **Tags**:
28327
+ *
28328
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Camera#Interpolate)
28329
+ * @param this A class which defines a view of the 3D world.
28330
+ * @param endPos The `CFrame` for the `Camera` to tween to.
28331
+ * @param endFocus The `CFrame` for the camera's `Focus` to tween to.
28332
+ * @param duration The duration, in seconds, of the tween.
28333
+ *
28334
+ * @deprecated
28335
+ */
28336
+ Interpolate(this: Camera, endPos: CFrame, endFocus: CFrame, duration: number): void;
28337
+ /**
28338
+ * **Deprecated:** This method was used for legacy camera controls and has since been deprecated. Do not use in new work.
28339
+ *
28340
+ * Pans the `Camera` around the `Focus` in 45 degree increments around the **Y** axis.
28341
+ *
28342
+ * - **ThreadSafety**: Unsafe
28343
+ * - **Tags**:
28344
+ *
28345
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Camera#PanUnits)
28346
+ * @param this A class which defines a view of the 3D world.
28347
+ * @param units The number of 45 degree increments by which to pan the `Camera`.
28348
+ *
28349
+ * @deprecated
28350
+ */
28351
+ PanUnits(this: Camera, units: number): void;
28352
+ /**
28353
+ * Creates a unit `Ray` from a position on the screen (in pixels), at a set depth from the `Camera` orientated in the camera's direction. Accounts for the GUI inset.
28354
+ *
28355
+ * - **ThreadSafety**: Safe
28356
+ *
28357
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Camera#ScreenPointToRay)
28358
+ * @param this A class which defines a view of the 3D world.
28359
+ * @param x The position on the **X** axis, in pixels, of the screen point at which to originate the `Ray`. This position accounts for the GUI inset.
28360
+ * @param y The position on the **Y** axis, in pixels, of the screen point at which to originate the `Ray`. This position accounts for the GUI inset.
28361
+ * @param depth The depth from the `Camera`, in studs, from which to offset the origin of the `Ray`.
28362
+ * @returns A unit `Ray`, originating from the equivalent `Vector3` world position of the given screen coordinates at the given depth away from the `Camera`. This ray is orientated in the direction of the `Camera`.
28363
+ */
28364
+ ScreenPointToRay(this: Camera, x: number, y: number, depth?: number): Ray;
28365
+ /**
28366
+ * **Deprecated:** This method has been deprecated and should not be used in new work.
28367
+ *
28368
+ * Sets the `CameraPanMode` to be used by the `Camera` on mobile devices.
28369
+ *
28370
+ * - **ThreadSafety**: Unsafe
28371
+ * - **Tags**:
28372
+ *
28373
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Camera#SetCameraPanMode)
28374
+ * @param this A class which defines a view of the 3D world.
28375
+ * @param mode The `CameraPanMode` to set the `Camera` to.
28376
+ *
28377
+ * @deprecated
28378
+ */
28379
+ SetCameraPanMode(this: Camera, mode?: CastsToEnum<Enum.CameraPanMode>): void;
28380
+ /**
28381
+ * Sets the current rotation applied around the camera's Z-axis.
28382
+ *
28383
+ * - **ThreadSafety**: Unsafe
28384
+ *
28385
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Camera#SetRoll)
28386
+ * @param this A class which defines a view of the 3D world.
28387
+ * @param rollAngle The roll angle, in radians, to be applied to the `Camera`.
28388
+ */
28389
+ SetRoll(this: Camera, rollAngle: number): void;
28390
+ /**
28391
+ * **Deprecated:** This method was used for legacy camera controls and has been deprecated. Do not use in new work.
28392
+ *
28393
+ * Tilts the `Camera` around its `Focus` in 10 degree increments around the camera's **X** axis.
28394
+ *
28395
+ * - **ThreadSafety**: Unsafe
28396
+ * - **Tags**:
28397
+ *
28398
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Camera#TiltUnits)
28399
+ * @param this A class which defines a view of the 3D world.
28400
+ * @param units The number of 10 degree units by which to tilt the `Camera`.
28401
+ * @returns Whether the `Camera` tilt applied was constrained.
28402
+ *
28403
+ * @deprecated
28404
+ */
28405
+ TiltUnits(this: Camera, units: number): boolean;
28406
+ /**
28407
+ * Creates a unit `Ray` from a position on the viewport (in pixels), at a given depth from the `Camera`, orientated in the camera's direction. Does not account for the `CoreUISafeInsets` inset.
28408
+ *
28409
+ * - **ThreadSafety**: Safe
28410
+ *
28411
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Camera#ViewportPointToRay)
28412
+ * @param this A class which defines a view of the 3D world.
28413
+ * @param x The position on the **X** axis, in pixels, of the viewport point at which to originate the `Ray`, in device safe area coordinates.
28414
+ * @param y The position on the **Y** axis, in pixels, of the viewport point at which to originate the `Ray`, in device safe area coordinates.
28415
+ * @param depth The depth from the `Camera`, in studs, from which to offset the origin of the `Ray`.
28416
+ * @returns A unit `Ray`, originating from the equivalent `Vector3` world position of the given viewport coordinates at the given depth away from the `Camera`. This ray is orientated in the direction of the `Camera`.
28417
+ */
28418
+ ViewportPointToRay(this: Camera, x: number, y: number, depth?: number): Ray;
28419
+ /**
28420
+ * Returns the screen location and depth of a `Vector3` `worldPoint` and whether this point is within the bounds of the screen. Accounts for the GUI inset.
28421
+ *
28422
+ * - **ThreadSafety**: Safe
28423
+ *
28424
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Camera#WorldToScreenPoint)
28425
+ * @param this A class which defines a view of the 3D world.
28426
+ * @param worldPoint The `Vector3` world position.
28427
+ * @returns A tuple containing, in order: - A `Vector3` whose **X** and **Y** components represent the offset of the `worldPoint` from the top left corner of the screen, in pixels. The `Vector3` **Z** component represents the depth of the `worldPoint` from the screen (in studs).
28428
+ * - A boolean indicating if the `worldPoint` is within the bounds of the screen.
28429
+ */
28430
+ WorldToScreenPoint(this: Camera, worldPoint: Vector3): LuaTuple<[
28431
+ Vector3,
28432
+ boolean
28433
+ ]>;
28434
+ /**
28435
+ * Returns the screen location and depth of a `Vector3` `worldPoint` and whether this point is within the bounds of the screen. Does not account for the GUI inset.
28436
+ *
28437
+ * - **ThreadSafety**: Safe
28438
+ *
28439
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Camera#WorldToViewportPoint)
28440
+ * @param this A class which defines a view of the 3D world.
28441
+ * @param worldPoint The `Vector3` world position.
28442
+ * @returns A tuple containing, in order: - A `Vector3` whose **X** and **Y** components represent the offset of the `worldPoint` from the top left corner of the viewport, in pixels. The `Vector3` **Z** component represents the depth of the `worldPoint` from the screen (in studs).
28443
+ * - A boolean indicating if the `worldPoint` is within the bounds of the screen.
28444
+ */
28445
+ WorldToViewportPoint(this: Camera, worldPoint: Vector3): LuaTuple<[
28446
+ Vector3,
28447
+ boolean
28448
+ ]>;
28449
+ /**
28450
+ * - **ThreadSafety**: Unsafe
28451
+ *
28452
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Camera#ZoomToExtents)
28453
+ * @param this A class which defines a view of the 3D world.
28454
+ * @param boundingBoxCFrame
28455
+ * @param boundingBoxSize
28456
+ */
28457
+ ZoomToExtents(this: Camera, boundingBoxCFrame: CFrame, boundingBoxSize: Vector3): void;
28458
+ /**
28459
+ * Fired when the `Camera` has finished interpolating using`Interpolate()`.
28460
+ *
28461
+ * - **ThreadSafety**: Unsafe
28462
+ *
28463
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Camera#InterpolationFinished)
28464
+ */
28465
+ readonly InterpolationFinished: RBXScriptSignal<() => void>;
28466
+ }
28278
28467
  /**
28279
28468
  * Models are container objects, meaning they group objects together. They are best used to hold collections of `BaseParts` and have a number of functions that extend their functionality.
28280
28469
  *
@@ -30181,7 +30370,7 @@ interface PathfindingService extends Instance {
30181
30370
  *
30182
30371
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PathfindingService#CreatePath)
30183
30372
  * @param this Used to find logical paths between two points.
30184
- * @param agentParameters Lua table which lets you fine-tune the path for the size of the agent (the humanoid that will move along the path). See above for valid keys, types, and descriptions.
30373
+ * @param agentParameters Luau table which lets you fine-tune the path for the size of the agent (the humanoid that will move along the path). See above for valid keys, types, and descriptions.
30185
30374
  * @returns A `Path` object.
30186
30375
  */
30187
30376
  CreatePath(this: PathfindingService, agentParameters?: AgentParameters): Path;
@@ -33109,7 +33298,7 @@ interface RotationCurve extends Instance {
33109
33298
  */
33110
33299
  GetKeyIndicesAtTime(this: RotationCurve, time: number): Array<unknown>;
33111
33300
  /**
33112
- * Returns a copy of all the keys in the rotation curve as a Lua array of `RotationCurveKeys`.
33301
+ * Returns a copy of all the keys in the rotation curve as a Luau array of `RotationCurveKeys`.
33113
33302
  *
33114
33303
  * - **ThreadSafety**: Unsafe
33115
33304
  *
@@ -39286,7 +39475,7 @@ interface Translator extends Instance {
39286
39475
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Translator#FormatByKey)
39287
39476
  * @param this The role of a Translator is to manufacture/return strings localized for the viewing player.
39288
39477
  * @param key The **Key** value to look up and translate.
39289
- * @param args To be provided if the **Source** text and translations contain format strings. Will be a Lua table of values **or** key-value pairs, depending on whether the format strings are numbered or named.
39478
+ * @param args To be provided if the **Source** text and translations contain format strings. Will be a Luau table of values **or** key-value pairs, depending on whether the format strings are numbered or named.
39290
39479
  */
39291
39480
  FormatByKey(this: Translator, key: string, args: unknown): string;
39292
39481
  /**
@@ -42354,6 +42543,8 @@ interface VideoPlayer extends Instance {
42354
42543
  readonly DidLoop: RBXScriptSignal<() => void>;
42355
42544
  }
42356
42545
  /**
42546
+ * An internal service that offers no functionality to developers.
42547
+ *
42357
42548
  * - **Tags**: NotCreatable, Service
42358
42549
  *
42359
42550
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VideoService)