@rbxts/types 1.0.843 → 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.
@@ -38,6 +38,7 @@ interface Services {
38
38
  CollectionService: CollectionService;
39
39
  CommandService: CommandService;
40
40
  CommerceService: CommerceService;
41
+ ConfigService: ConfigService;
41
42
  ConfigureServerService: ConfigureServerService;
42
43
  ConnectivityService: ConnectivityService;
43
44
  ContentProvider: ContentProvider;
@@ -670,6 +671,7 @@ interface Instances extends Services, CreatableInstances {
670
671
  }
671
672
  interface Objects extends Instances {
672
673
  Capture: Capture;
674
+ ConfigSnapshot: ConfigSnapshot;
673
675
  EditableImage: EditableImage;
674
676
  EditableMesh: EditableMesh;
675
677
  Object: RBXObject;
@@ -763,6 +765,65 @@ interface ScreenshotCapture extends Capture {
763
765
  */
764
766
  readonly _nominal_ScreenshotCapture: unique symbol;
765
767
  }
768
+ /**
769
+ * - **Tags**: NotCreatable, NotReplicated
770
+ *
771
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ConfigSnapshot)
772
+ */
773
+ interface ConfigSnapshot extends RBXObject {
774
+ /**
775
+ * **DO NOT USE!**
776
+ *
777
+ * This field exists to force TypeScript to recognize this as a nominal type
778
+ * @hidden
779
+ * @deprecated
780
+ */
781
+ readonly _nominal_ConfigSnapshot: unique symbol;
782
+ /**
783
+ * - **ThreadSafety**: ReadSafe
784
+ * - **Tags**: NotReplicated
785
+ *
786
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ConfigSnapshot#Error)
787
+ */
788
+ readonly Error: Enum.ConfigSnapshotErrorState;
789
+ /**
790
+ * - **ThreadSafety**: ReadSafe
791
+ * - **Tags**: NotReplicated
792
+ *
793
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ConfigSnapshot#Outdated)
794
+ */
795
+ readonly Outdated: boolean;
796
+ /**
797
+ * - **ThreadSafety**: Unsafe
798
+ *
799
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ConfigSnapshot#GetValue)
800
+ * @param this
801
+ * @param key
802
+ * @param defaultValue
803
+ */
804
+ GetValue(this: ConfigSnapshot, key: string, defaultValue: unknown): unknown;
805
+ /**
806
+ * - **ThreadSafety**: Unsafe
807
+ *
808
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ConfigSnapshot#GetValueChangedSignal)
809
+ * @param this
810
+ * @param key
811
+ */
812
+ GetValueChangedSignal(this: ConfigSnapshot, key: string): RBXScriptSignal;
813
+ /**
814
+ * - **ThreadSafety**: Unsafe
815
+ *
816
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ConfigSnapshot#Refresh)
817
+ * @param this
818
+ */
819
+ Refresh(this: ConfigSnapshot): void;
820
+ /**
821
+ * - **ThreadSafety**: Unsafe
822
+ *
823
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ConfigSnapshot#UpdateAvailable)
824
+ */
825
+ readonly UpdateAvailable: RBXScriptSignal<() => void>;
826
+ }
766
827
  /**
767
828
  * Instance which allows for the runtime creation and manipulation of images.
768
829
  *
@@ -1175,13 +1236,37 @@ interface EditableMesh extends RBXObject {
1175
1236
  * Returns a list of faces that use a given attribute ID.
1176
1237
  *
1177
1238
  * - **ThreadSafety**: Unsafe
1239
+ * - **Tags**:
1178
1240
  *
1179
1241
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetFacesWithAttribute)
1180
1242
  * @param this Instance which allows for the runtime creation and manipulation of meshes.
1181
1243
  * @param id Attribute ID for which to find faces that use it.
1182
1244
  * @returns List of face IDs which use the given attribute ID.
1245
+ *
1246
+ * @deprecated
1183
1247
  */
1184
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>;
1185
1270
  /**
1186
1271
  * Returns the normal vector for the given normal ID.
1187
1272
  *
@@ -1245,6 +1330,52 @@ interface EditableMesh extends RBXObject {
1245
1330
  * @returns List of stable UV IDs.
1246
1331
  */
1247
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>;
1248
1379
  /**
1249
1380
  * Returns all vertices as a list of stable vertex IDs.
1250
1381
  *
@@ -1259,13 +1390,37 @@ interface EditableMesh extends RBXObject {
1259
1390
  * Returns a list of vertices that use a given attribute ID.
1260
1391
  *
1261
1392
  * - **ThreadSafety**: Unsafe
1393
+ * - **Tags**:
1262
1394
  *
1263
1395
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetVerticesWithAttribute)
1264
1396
  * @param this Instance which allows for the runtime creation and manipulation of meshes.
1265
1397
  * @param id Attribute ID for which to find vertices that use it.
1266
1398
  * @returns List of vertex IDs which use the given attribute ID.
1399
+ *
1400
+ * @deprecated
1267
1401
  */
1268
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>;
1269
1424
  /**
1270
1425
  * Returns a string describing a stable ID, useful for debugging purposes.
1271
1426
  *
@@ -1435,6 +1590,24 @@ interface EditableMesh extends RBXObject {
1435
1590
  * @param uv UV coordinates.
1436
1591
  */
1437
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;
1438
1611
  /**
1439
1612
  * Splits all faces on the mesh to be triangles.
1440
1613
  *
@@ -2845,12 +3018,15 @@ interface AnimationTrack extends Instance {
2845
3018
  * - **ThreadSafety**: Unsafe
2846
3019
  *
2847
3020
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AnimationTrack#GetTargetInstance)
3021
+ * @param this Controls the playback of an animation on an `Animator`.
3022
+ * @param name
2848
3023
  */
2849
3024
  GetTargetInstance(this: AnimationTrack, name: string): Instance | undefined;
2850
3025
  /**
2851
3026
  * - **ThreadSafety**: Unsafe
2852
3027
  *
2853
3028
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AnimationTrack#GetTargetNames)
3029
+ * @param this Controls the playback of an animation on an `Animator`.
2854
3030
  */
2855
3031
  GetTargetNames(this: AnimationTrack): Array<unknown>;
2856
3032
  /**
@@ -2881,6 +3057,9 @@ interface AnimationTrack extends Instance {
2881
3057
  * - **ThreadSafety**: Unsafe
2882
3058
  *
2883
3059
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AnimationTrack#SetTargetInstance)
3060
+ * @param this Controls the playback of an animation on an `Animator`.
3061
+ * @param name
3062
+ * @param target
2884
3063
  */
2885
3064
  SetTargetInstance(this: AnimationTrack, name: string, target: Instance): void;
2886
3065
  /**
@@ -3260,7 +3439,7 @@ interface AssetService extends Instance {
3260
3439
  */
3261
3440
  CreateEditableMesh(this: AssetService, editableMeshOptions?: object): EditableMesh;
3262
3441
  /**
3263
- * Creates a new asset from the given object.
3442
+ * Uploads a new asset to Roblox from the given object.
3264
3443
  *
3265
3444
  * - **ThreadSafety**: Unsafe
3266
3445
  * - **Tags**: Yields
@@ -3285,7 +3464,7 @@ interface AssetService extends Instance {
3285
3464
  */
3286
3465
  CreateAssetAsync(this: AssetService, object: RBXObject, assetType: CastsToEnum<Enum.AssetType>, requestParameters?: object): unknown;
3287
3466
  /**
3288
- * 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.
3289
3468
  *
3290
3469
  * - **ThreadSafety**: Unsafe
3291
3470
  * - **Tags**: Yields
@@ -3903,7 +4082,7 @@ interface AudioAnalyzer extends Instance {
3903
4082
  readonly WiringChanged: RBXScriptSignal<(connected: boolean, pin: string, wire: Wire, instance: Instance) => void>;
3904
4083
  }
3905
4084
  /**
3906
- * - **Tags**: NotBrowsable
4085
+ * Combines multiple audio streams into a single, multichannel audio stream.
3907
4086
  *
3908
4087
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioChannelMixer)
3909
4088
  */
@@ -3917,34 +4096,44 @@ interface AudioChannelMixer extends Instance {
3917
4096
  */
3918
4097
  readonly _nominal_AudioChannelMixer: unique symbol;
3919
4098
  /**
4099
+ * Controls the output channel layout to be mixed to.
4100
+ *
3920
4101
  * - **ThreadSafety**: ReadSafe
3921
4102
  *
3922
4103
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioChannelMixer#Layout)
3923
4104
  */
3924
4105
  Layout: Enum.AudioChannelLayout;
3925
4106
  /**
4107
+ * Returns an array of `Wires` that are connected to the specified pin.
4108
+ *
3926
4109
  * - **ThreadSafety**: Unsafe
3927
4110
  *
3928
4111
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioChannelMixer#GetConnectedWires)
3929
- * @param this
4112
+ * @param this Combines multiple audio streams into a single, multichannel audio stream.
3930
4113
  * @param pin
3931
4114
  */
3932
4115
  GetConnectedWires(this: AudioChannelMixer, pin: string): Array<Instance>;
3933
4116
  /**
4117
+ * Returns the input pins that can be selected by `Wire.TargetName`.
4118
+ *
3934
4119
  * - **ThreadSafety**: Unsafe
3935
4120
  *
3936
4121
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioChannelMixer#GetInputPins)
3937
- * @param this
4122
+ * @param this Combines multiple audio streams into a single, multichannel audio stream.
3938
4123
  */
3939
4124
  GetInputPins(this: AudioChannelMixer): Array<unknown>;
3940
4125
  /**
4126
+ * Returns the output pin available for `Wire.SourceName`.
4127
+ *
3941
4128
  * - **ThreadSafety**: Unsafe
3942
4129
  *
3943
4130
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioChannelMixer#GetOutputPins)
3944
- * @param this
4131
+ * @param this Combines multiple audio streams into a single, multichannel audio stream.
3945
4132
  */
3946
4133
  GetOutputPins(this: AudioChannelMixer): Array<unknown>;
3947
4134
  /**
4135
+ * Fires when another instance is connected to or disconnected from the `AudioChannelMixer` via a `Wire`.
4136
+ *
3948
4137
  * - **ThreadSafety**: Unsafe
3949
4138
  *
3950
4139
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioChannelMixer#WiringChanged)
@@ -3952,7 +4141,7 @@ interface AudioChannelMixer extends Instance {
3952
4141
  readonly WiringChanged: RBXScriptSignal<(connected: boolean, pin: string, wire: Wire, instance: Instance) => void>;
3953
4142
  }
3954
4143
  /**
3955
- * - **Tags**: NotBrowsable
4144
+ * Splits an audio stream into component channels so that each can be processed independently.
3956
4145
  *
3957
4146
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioChannelSplitter)
3958
4147
  */
@@ -3966,34 +4155,44 @@ interface AudioChannelSplitter extends Instance {
3966
4155
  */
3967
4156
  readonly _nominal_AudioChannelSplitter: unique symbol;
3968
4157
  /**
4158
+ * Controls the input channel layout to be split from.
4159
+ *
3969
4160
  * - **ThreadSafety**: ReadSafe
3970
4161
  *
3971
4162
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioChannelSplitter#Layout)
3972
4163
  */
3973
4164
  Layout: Enum.AudioChannelLayout;
3974
4165
  /**
4166
+ * Returns an array of `Wires` that are connected to the specified pin.
4167
+ *
3975
4168
  * - **ThreadSafety**: Unsafe
3976
4169
  *
3977
4170
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioChannelSplitter#GetConnectedWires)
3978
- * @param this
4171
+ * @param this Splits an audio stream into component channels so that each can be processed independently.
3979
4172
  * @param pin
3980
4173
  */
3981
4174
  GetConnectedWires(this: AudioChannelSplitter, pin: string): Array<Instance>;
3982
4175
  /**
4176
+ * Returns the input pin available for `Wire.TargetName`.
4177
+ *
3983
4178
  * - **ThreadSafety**: Unsafe
3984
4179
  *
3985
4180
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioChannelSplitter#GetInputPins)
3986
- * @param this
4181
+ * @param this Splits an audio stream into component channels so that each can be processed independently.
3987
4182
  */
3988
4183
  GetInputPins(this: AudioChannelSplitter): Array<unknown>;
3989
4184
  /**
4185
+ * Returns the output pins that can be selected by `Wire.SourceName`.
4186
+ *
3990
4187
  * - **ThreadSafety**: Unsafe
3991
4188
  *
3992
4189
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioChannelSplitter#GetOutputPins)
3993
- * @param this
4190
+ * @param this Splits an audio stream into component channels so that each can be processed independently.
3994
4191
  */
3995
4192
  GetOutputPins(this: AudioChannelSplitter): Array<unknown>;
3996
4193
  /**
4194
+ * Fires when another instance is connected to or disconnected from the `AudioChannelSplitter` via a `Wire`.
4195
+ *
3997
4196
  * - **ThreadSafety**: Unsafe
3998
4197
  *
3999
4198
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioChannelSplitter#WiringChanged)
@@ -5868,9 +6067,9 @@ interface AuroraService extends Instance {
5868
6067
  /**
5869
6068
  * - **ThreadSafety**: Unsafe
5870
6069
  *
5871
- * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService#GetDesyncedInstances)
6070
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService#GetPredictedInstances)
5872
6071
  */
5873
- GetDesyncedInstances(this: AuroraService): Array<unknown>;
6072
+ GetPredictedInstances(this: AuroraService): Array<unknown>;
5874
6073
  /**
5875
6074
  * - **ThreadSafety**: Unsafe
5876
6075
  *
@@ -5892,9 +6091,9 @@ interface AuroraService extends Instance {
5892
6091
  /**
5893
6092
  * - **ThreadSafety**: Unsafe
5894
6093
  *
5895
- * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService#IsDesynced)
6094
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService#IsPredicted)
5896
6095
  */
5897
- IsDesynced(this: AuroraService, target: Instance): boolean;
6096
+ IsPredicted(this: AuroraService, target: Instance): boolean;
5898
6097
  /**
5899
6098
  * - **ThreadSafety**: Unsafe
5900
6099
  *
@@ -5931,12 +6130,6 @@ interface AuroraService extends Instance {
5931
6130
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService#UpdateProperties)
5932
6131
  */
5933
6132
  UpdateProperties(this: AuroraService, target: Instance): void;
5934
- /**
5935
- * - **ThreadSafety**: Unsafe
5936
- *
5937
- * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService#Desynced)
5938
- */
5939
- readonly Desynced: RBXScriptSignal<(target: Instance) => void>;
5940
6133
  /**
5941
6134
  * - **ThreadSafety**: Unsafe
5942
6135
  *
@@ -5955,12 +6148,6 @@ interface AuroraService extends Instance {
5955
6148
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService#Step)
5956
6149
  */
5957
6150
  readonly Step: RBXScriptSignal<() => void>;
5958
- /**
5959
- * - **ThreadSafety**: Unsafe
5960
- *
5961
- * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService#Synced)
5962
- */
5963
- readonly Synced: RBXScriptSignal<(target: Instance) => void>;
5964
6151
  }
5965
6152
  /**
5966
6153
  * - **Tags**: NotCreatable, Service
@@ -6080,7 +6267,7 @@ interface AvatarCreationService extends Instance {
6080
6267
  *
6081
6268
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AvatarCreationService#PromptCreateAvatarAsync)
6082
6269
  * @param this A service to support developer avatar creators.
6083
- * @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.
6084
6271
  * @param player The `Player` intended to be presented with the creation prompt.
6085
6272
  * @param humanoidDescription The `HumanoidDescription` of the avatar intended for creation.
6086
6273
  * @returns A tuple containing, in order: - An `PromptCreateAvatarResult` indicating the result of the creation prompt.
@@ -8497,366 +8684,6 @@ interface CalloutService extends Instance {
8497
8684
  */
8498
8685
  readonly _nominal_CalloutService: unique symbol;
8499
8686
  }
8500
- /**
8501
- * A class which defines a view of the 3D world.
8502
- *
8503
- * - **Tags**: NotReplicated
8504
- *
8505
- * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Camera)
8506
- */
8507
- interface Camera extends Instance {
8508
- /**
8509
- * **DO NOT USE!**
8510
- *
8511
- * This field exists to force TypeScript to recognize this as a nominal type
8512
- * @hidden
8513
- * @deprecated
8514
- */
8515
- readonly _nominal_Camera: unique symbol;
8516
- /**
8517
- * The `CFrame` of the `Camera`, defining its position and orientation in the 3D world.
8518
- *
8519
- * - **ThreadSafety**: ReadSafe
8520
- *
8521
- * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Camera#CFrame)
8522
- */
8523
- CFrame: CFrame;
8524
- /**
8525
- * The `Humanoid` or `BasePart` that is the `Camera` subject.
8526
- *
8527
- * - **ThreadSafety**: ReadSafe
8528
- *
8529
- * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Camera#CameraSubject)
8530
- */
8531
- CameraSubject: Humanoid | BasePart | undefined;
8532
- /**
8533
- * Specifies the `CameraType` to be read by the camera scripts.
8534
- *
8535
- * - **ThreadSafety**: ReadSafe
8536
- *
8537
- * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Camera#CameraType)
8538
- */
8539
- CameraType: Enum.CameraType;
8540
- /**
8541
- * **Deprecated:** This item has been superseded by `Camera.CFrame` which should be used in all new work.
8542
- *
8543
- * - **ThreadSafety**: ReadSafe
8544
- * - **Tags**: Hidden, NotReplicated
8545
- *
8546
- * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Camera#CoordinateFrame)
8547
- *
8548
- * @deprecated CFrame
8549
- */
8550
- CoordinateFrame: CFrame;
8551
- /**
8552
- * Sets the angle of the camera's diagonal field of view.
8553
- *
8554
- * - **ThreadSafety**: ReadSafe
8555
- * - **Tags**: NotReplicated
8556
- *
8557
- * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Camera#DiagonalFieldOfView)
8558
- */
8559
- DiagonalFieldOfView: number;
8560
- /**
8561
- * Sets the angle of the camera's vertical field of view.
8562
- *
8563
- * - **ThreadSafety**: ReadSafe
8564
- *
8565
- * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Camera#FieldOfView)
8566
- */
8567
- FieldOfView: number;
8568
- /**
8569
- * Determines the FOV value of the `Camera` that's invariant under viewport size changes.
8570
- *
8571
- * - **ThreadSafety**: ReadSafe
8572
- *
8573
- * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Camera#FieldOfViewMode)
8574
- */
8575
- FieldOfViewMode: Enum.FieldOfViewMode;
8576
- /**
8577
- * Sets the area in 3D space that is prioritized by Roblox's graphical systems.
8578
- *
8579
- * - **ThreadSafety**: ReadSafe
8580
- *
8581
- * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Camera#Focus)
8582
- */
8583
- Focus: CFrame;
8584
- /**
8585
- * Toggles whether the camera will automatically track the head motion of a player using a VR device.
8586
- *
8587
- * - **ThreadSafety**: ReadSafe
8588
- *
8589
- * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Camera#HeadLocked)
8590
- */
8591
- HeadLocked: boolean;
8592
- /**
8593
- * Sets the scale of the user's perspective of the world when using VR.
8594
- *
8595
- * - **ThreadSafety**: ReadSafe
8596
- *
8597
- * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Camera#HeadScale)
8598
- */
8599
- HeadScale: number;
8600
- /**
8601
- * Sets the angle of the camera's field of view along the longest viewport axis.
8602
- *
8603
- * - **ThreadSafety**: ReadSafe
8604
- * - **Tags**: NotReplicated
8605
- *
8606
- * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Camera#MaxAxisFieldOfView)
8607
- */
8608
- MaxAxisFieldOfView: number;
8609
- /**
8610
- * Describes the negative **Z** offset, in studs, of the camera's near clipping plane.
8611
- *
8612
- * - **ThreadSafety**: ReadSafe
8613
- * - **Tags**: NotReplicated
8614
- *
8615
- * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Camera#NearPlaneZ)
8616
- */
8617
- readonly NearPlaneZ: number;
8618
- /**
8619
- * Toggles whether to apply tilt and roll from the `CFrame` property while the player is using a VR device.
8620
- *
8621
- * - **ThreadSafety**: ReadSafe
8622
- *
8623
- * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Camera#VRTiltAndRollEnabled)
8624
- */
8625
- VRTiltAndRollEnabled: boolean;
8626
- /**
8627
- * The dimensions of the device safe area on a Roblox client.
8628
- *
8629
- * - **ThreadSafety**: ReadSafe
8630
- * - **Tags**: NotReplicated
8631
- *
8632
- * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Camera#ViewportSize)
8633
- */
8634
- readonly ViewportSize: Vector2;
8635
- /**
8636
- * **Deprecated:**
8637
- *
8638
- * 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`.
8639
- *
8640
- * - **ThreadSafety**: Unsafe
8641
- * - **Tags**:
8642
- *
8643
- * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Camera#GetLargestCutoffDistance)
8644
- * @param this A class which defines a view of the 3D world.
8645
- * @param ignoreList An array of `Instances` to ignore. Descendants of these instances will also be ignored.
8646
- * @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`.
8647
- *
8648
- * @deprecated
8649
- */
8650
- GetLargestCutoffDistance(this: Camera, ignoreList: Array<Instance>): number;
8651
- /**
8652
- * **Deprecated:** This method has been deprecated and no longer works. It should not be used in new work.
8653
- *
8654
- * Returns the current 'pan' speed of the `Camera`.
8655
- *
8656
- * - **ThreadSafety**: Unsafe
8657
- * - **Tags**:
8658
- *
8659
- * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Camera#GetPanSpeed)
8660
- * @param this A class which defines a view of the 3D world.
8661
- * @returns The speed at which the `Camera` is rotating around its `Focus` on the **Y** axis.
8662
- *
8663
- * @deprecated
8664
- */
8665
- GetPanSpeed(this: Camera): number;
8666
- /**
8667
- * Returns an array of `BaseParts` that are obscuring the lines of sight between the camera's `CFrame` and the cast points.
8668
- *
8669
- * - **ThreadSafety**: Unsafe
8670
- *
8671
- * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Camera#GetPartsObscuringTarget)
8672
- * @param this A class which defines a view of the 3D world.
8673
- * @param castPoints An array of `Vector3` positions of cast points.
8674
- * @param ignoreList An array of `Instances` that should be ignored, along with their descendants.
8675
- * @returns An array of `BaseParts` that obscure the lines of sight between the camera's `CFrame` and the `castPoints`.
8676
- */
8677
- GetPartsObscuringTarget(this: Camera, castPoints: Array<Vector3>, ignoreList: Array<Instance>): Array<Instance>;
8678
- /**
8679
- * Returns the actual `CFrame`where the `Camera` is being rendered, accounting for any roll applied and the impact of VR devices.
8680
- *
8681
- * - **ThreadSafety**: Unsafe
8682
- *
8683
- * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Camera#GetRenderCFrame)
8684
- * @param this A class which defines a view of the 3D world.
8685
- * @returns The `CFrame` the `Camera` is being rendered at.
8686
- */
8687
- GetRenderCFrame(this: Camera): CFrame;
8688
- /**
8689
- * Returns in radians the current roll, or rotation around the camera's Z-axis, applied to the `Camera` using `SetRoll()`.
8690
- *
8691
- * - **ThreadSafety**: Unsafe
8692
- *
8693
- * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Camera#GetRoll)
8694
- * @param this A class which defines a view of the 3D world.
8695
- * @returns The current roll applied by `SetRoll()`, in radians.
8696
- */
8697
- GetRoll(this: Camera): number;
8698
- /**
8699
- * **Deprecated:** This method has been deprecated and no longer works.
8700
- *
8701
- * Returns the current tilt speed of the `Camera`.
8702
- *
8703
- * - **ThreadSafety**: Unsafe
8704
- * - **Tags**:
8705
- *
8706
- * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Camera#GetTiltSpeed)
8707
- * @param this A class which defines a view of the 3D world.
8708
- * @returns The speed at which the `Camera` is rotating around its `Focus` around the camera's **X** axis.
8709
- *
8710
- * @deprecated
8711
- */
8712
- GetTiltSpeed(this: Camera): number;
8713
- /**
8714
- * **Deprecated:** This method has been deprecated. Instead use `TweenService` to smoothly animate the `Camera`, see the code snippets below for an example.
8715
- *
8716
- * Tweens the `Camera` in a linear fashion towards a new `CFrame` and `Focus` over a given duration.
8717
- *
8718
- * - **ThreadSafety**: Unsafe
8719
- * - **Tags**:
8720
- *
8721
- * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Camera#Interpolate)
8722
- * @param this A class which defines a view of the 3D world.
8723
- * @param endPos The `CFrame` for the `Camera` to tween to.
8724
- * @param endFocus The `CFrame` for the camera's `Focus` to tween to.
8725
- * @param duration The duration, in seconds, of the tween.
8726
- *
8727
- * @deprecated
8728
- */
8729
- Interpolate(this: Camera, endPos: CFrame, endFocus: CFrame, duration: number): void;
8730
- /**
8731
- * **Deprecated:** This method was used for legacy camera controls and has since been deprecated. Do not use in new work.
8732
- *
8733
- * Pans the `Camera` around the `Focus` in 45 degree increments around the **Y** axis.
8734
- *
8735
- * - **ThreadSafety**: Unsafe
8736
- * - **Tags**:
8737
- *
8738
- * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Camera#PanUnits)
8739
- * @param this A class which defines a view of the 3D world.
8740
- * @param units The number of 45 degree increments by which to pan the `Camera`.
8741
- *
8742
- * @deprecated
8743
- */
8744
- PanUnits(this: Camera, units: number): void;
8745
- /**
8746
- * 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.
8747
- *
8748
- * - **ThreadSafety**: Safe
8749
- *
8750
- * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Camera#ScreenPointToRay)
8751
- * @param this A class which defines a view of the 3D world.
8752
- * @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.
8753
- * @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.
8754
- * @param depth The depth from the `Camera`, in studs, from which to offset the origin of the `Ray`.
8755
- * @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`.
8756
- */
8757
- ScreenPointToRay(this: Camera, x: number, y: number, depth?: number): Ray;
8758
- /**
8759
- * **Deprecated:** This method has been deprecated and should not be used in new work.
8760
- *
8761
- * Sets the `CameraPanMode` to be used by the `Camera` on mobile devices.
8762
- *
8763
- * - **ThreadSafety**: Unsafe
8764
- * - **Tags**:
8765
- *
8766
- * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Camera#SetCameraPanMode)
8767
- * @param this A class which defines a view of the 3D world.
8768
- * @param mode The `CameraPanMode` to set the `Camera` to.
8769
- *
8770
- * @deprecated
8771
- */
8772
- SetCameraPanMode(this: Camera, mode?: CastsToEnum<Enum.CameraPanMode>): void;
8773
- /**
8774
- * Sets the current rotation applied around the camera's Z-axis.
8775
- *
8776
- * - **ThreadSafety**: Unsafe
8777
- *
8778
- * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Camera#SetRoll)
8779
- * @param this A class which defines a view of the 3D world.
8780
- * @param rollAngle The roll angle, in radians, to be applied to the `Camera`.
8781
- */
8782
- SetRoll(this: Camera, rollAngle: number): void;
8783
- /**
8784
- * **Deprecated:** This method was used for legacy camera controls and has been deprecated. Do not use in new work.
8785
- *
8786
- * Tilts the `Camera` around its `Focus` in 10 degree increments around the camera's **X** axis.
8787
- *
8788
- * - **ThreadSafety**: Unsafe
8789
- * - **Tags**:
8790
- *
8791
- * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Camera#TiltUnits)
8792
- * @param this A class which defines a view of the 3D world.
8793
- * @param units The number of 10 degree units by which to tilt the `Camera`.
8794
- * @returns Whether the `Camera` tilt applied was constrained.
8795
- *
8796
- * @deprecated
8797
- */
8798
- TiltUnits(this: Camera, units: number): boolean;
8799
- /**
8800
- * 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.
8801
- *
8802
- * - **ThreadSafety**: Safe
8803
- *
8804
- * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Camera#ViewportPointToRay)
8805
- * @param this A class which defines a view of the 3D world.
8806
- * @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.
8807
- * @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.
8808
- * @param depth The depth from the `Camera`, in studs, from which to offset the origin of the `Ray`.
8809
- * @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`.
8810
- */
8811
- ViewportPointToRay(this: Camera, x: number, y: number, depth?: number): Ray;
8812
- /**
8813
- * 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.
8814
- *
8815
- * - **ThreadSafety**: Safe
8816
- *
8817
- * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Camera#WorldToScreenPoint)
8818
- * @param this A class which defines a view of the 3D world.
8819
- * @param worldPoint The `Vector3` world position.
8820
- * @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).
8821
- * - A boolean indicating if the `worldPoint` is within the bounds of the screen.
8822
- */
8823
- WorldToScreenPoint(this: Camera, worldPoint: Vector3): LuaTuple<[
8824
- Vector3,
8825
- boolean
8826
- ]>;
8827
- /**
8828
- * 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.
8829
- *
8830
- * - **ThreadSafety**: Safe
8831
- *
8832
- * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Camera#WorldToViewportPoint)
8833
- * @param this A class which defines a view of the 3D world.
8834
- * @param worldPoint The `Vector3` world position.
8835
- * @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).
8836
- * - A boolean indicating if the `worldPoint` is within the bounds of the screen.
8837
- */
8838
- WorldToViewportPoint(this: Camera, worldPoint: Vector3): LuaTuple<[
8839
- Vector3,
8840
- boolean
8841
- ]>;
8842
- /**
8843
- * - **ThreadSafety**: Unsafe
8844
- *
8845
- * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Camera#ZoomToExtents)
8846
- * @param this A class which defines a view of the 3D world.
8847
- * @param boundingBoxCFrame
8848
- * @param boundingBoxSize
8849
- */
8850
- ZoomToExtents(this: Camera, boundingBoxCFrame: CFrame, boundingBoxSize: Vector3): void;
8851
- /**
8852
- * Fired when the `Camera` has finished interpolating using`Interpolate()`.
8853
- *
8854
- * - **ThreadSafety**: Unsafe
8855
- *
8856
- * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Camera#InterpolationFinished)
8857
- */
8858
- readonly InterpolationFinished: RBXScriptSignal<() => void>;
8859
- }
8860
8687
  /**
8861
8688
  * A service which provides control over screenshot capture features.
8862
8689
  *
@@ -9230,7 +9057,7 @@ interface ShirtGraphic extends CharacterAppearance {
9230
9057
  Graphic: ContentId;
9231
9058
  }
9232
9059
  /**
9233
- * Houses the Lua code responsible for running the legacy chat system.
9060
+ * Houses the Luau code responsible for running the legacy chat system.
9234
9061
  *
9235
9062
  * - **Tags**: NotCreatable, Service, NotReplicated
9236
9063
  *
@@ -9267,19 +9094,19 @@ interface Chat extends Instance {
9267
9094
  * - **ThreadSafety**: Unsafe
9268
9095
  *
9269
9096
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Chat#Chat)
9270
- * @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.
9271
9098
  * @param partOrCharacter An instance that is the part or character which the *BubbleChat* dialog should appear above.
9272
9099
  * @param message The message string being chatted.
9273
9100
  * @param color An `ChatColor` specifying the color of the chatted message.
9274
9101
  */
9275
9102
  Chat(this: Chat, partOrCharacter: Instance, message: string, color?: CastsToEnum<Enum.ChatColor>): void;
9276
9103
  /**
9277
- * 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.
9278
9105
  *
9279
9106
  * - **ThreadSafety**: Unsafe
9280
9107
  *
9281
9108
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Chat#InvokeChatCallback)
9282
- * @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.
9283
9110
  * @param callbackType The type of callback to invoke.
9284
9111
  * @param callbackArguments The arguments that will be sent to the registered callback function.
9285
9112
  * @returns The values returned by the function registered to the given ChatCallbackType.
@@ -9291,7 +9118,7 @@ interface Chat extends Instance {
9291
9118
  * - **ThreadSafety**: Unsafe
9292
9119
  *
9293
9120
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Chat#RegisterChatCallback)
9294
- * @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.
9295
9122
  * @param callbackType The callback to which the function shall be registered (this determines in what way the function is called).
9296
9123
  * @param callbackFunction The function to call when the callback is invoked using Chat:InvokeChatCallback.
9297
9124
  */
@@ -9302,7 +9129,7 @@ interface Chat extends Instance {
9302
9129
  * - **ThreadSafety**: Unsafe
9303
9130
  *
9304
9131
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Chat#SetBubbleChatSettings)
9305
- * @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.
9306
9133
  * @param settings A settings table.
9307
9134
  */
9308
9135
  SetBubbleChatSettings(this: Chat, settings: unknown): void;
@@ -9313,7 +9140,7 @@ interface Chat extends Instance {
9313
9140
  * - **Tags**: Yields
9314
9141
  *
9315
9142
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Chat#CanUserChatAsync)
9316
- * @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.
9317
9144
  * @param userId
9318
9145
  */
9319
9146
  CanUserChatAsync(this: Chat, userId: number): boolean;
@@ -9324,7 +9151,7 @@ interface Chat extends Instance {
9324
9151
  * - **Tags**: Yields
9325
9152
  *
9326
9153
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Chat#CanUsersChatAsync)
9327
- * @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.
9328
9155
  * @param userIdFrom
9329
9156
  * @param userIdTo
9330
9157
  */
@@ -9336,7 +9163,7 @@ interface Chat extends Instance {
9336
9163
  * - **Tags**: Yields
9337
9164
  *
9338
9165
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Chat#FilterStringAsync)
9339
- * @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.
9340
9167
  * @param stringToFilter The raw string to be filtered, exactly as entered by the player.
9341
9168
  * @param playerFrom The author of the text.
9342
9169
  * @param playerTo The intended recipient of the provided text; use the author if the text is persistent (see description).
@@ -9349,7 +9176,7 @@ interface Chat extends Instance {
9349
9176
  * - **Tags**: Yields
9350
9177
  *
9351
9178
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Chat#FilterStringForBroadcast)
9352
- * @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.
9353
9180
  * @param stringToFilter Message string being filtered.
9354
9181
  * @param playerFrom Instance of the player sending the message.
9355
9182
  * @returns Filtered message string.
@@ -9364,7 +9191,7 @@ interface Chat extends Instance {
9364
9191
  * - **Tags**: Yields
9365
9192
  *
9366
9193
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Chat#FilterStringForPlayerAsync)
9367
- * @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.
9368
9195
  * @param stringToFilter String being filtered.
9369
9196
  * @param playerToFilterFor Player that the string is being filtered for.
9370
9197
  * @returns Filtered string result.
@@ -10207,6 +10034,38 @@ interface CommerceService extends Instance {
10207
10034
  */
10208
10035
  readonly PromptCommerceProductPurchaseFinished: RBXScriptSignal<(user: Player, productId: string) => void>;
10209
10036
  }
10037
+ /**
10038
+ * - **Tags**: NotCreatable, Service, NotReplicated
10039
+ *
10040
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ConfigService)
10041
+ */
10042
+ interface ConfigService extends Instance {
10043
+ /**
10044
+ * **DO NOT USE!**
10045
+ *
10046
+ * This field exists to force TypeScript to recognize this as a nominal type
10047
+ * @hidden
10048
+ * @deprecated
10049
+ */
10050
+ readonly _nominal_ConfigService: unique symbol;
10051
+ /**
10052
+ * - **ThreadSafety**: Unsafe
10053
+ * - **Tags**: Yields
10054
+ *
10055
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ConfigService#GetConfigAsync)
10056
+ * @param this
10057
+ */
10058
+ GetConfigAsync(this: ConfigService): ConfigSnapshot;
10059
+ /**
10060
+ * - **ThreadSafety**: Unsafe
10061
+ * - **Tags**: Yields
10062
+ *
10063
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ConfigService#GetConfigForPlayerAsync)
10064
+ * @param this
10065
+ * @param player
10066
+ */
10067
+ GetConfigForPlayerAsync(this: ConfigService, player: Player): ConfigSnapshot;
10068
+ }
10210
10069
  /**
10211
10070
  * The Configuration object is a container object that is designed to hold value objects to make values used in `Tools` or any model using `Scripts` more accessible.
10212
10071
  *
@@ -13345,7 +13204,7 @@ interface DataStoreOptions extends Instance {
13345
13204
  *
13346
13205
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DataStoreOptions#SetExperimentalFeatures)
13347
13206
  * @param this Object used to provide additional parameters to `DataStoreService:GetDataStore()`.
13348
- * @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.
13349
13208
  */
13350
13209
  SetExperimentalFeatures(this: DataStoreOptions, experimentalFeatures: object): void;
13351
13210
  }
@@ -14805,7 +14664,7 @@ interface FloatCurve extends Instance {
14805
14664
  after: number
14806
14665
  ];
14807
14666
  /**
14808
- * 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`.
14809
14668
  *
14810
14669
  * - **ThreadSafety**: Unsafe
14811
14670
  *
@@ -14980,6 +14839,8 @@ interface GamepadService extends Instance {
14980
14839
  EnableGamepadCursor(this: GamepadService, guiObject: GuiObject | undefined): void;
14981
14840
  }
14982
14841
  /**
14842
+ * `GenerationService` is a service that allows developers to generate 3D objects from text prompts utilizing Roblox's [Cube 3D foundation model](https://corp.roblox.com/newsroom/2025/03/introducing-roblox-cube).
14843
+ *
14983
14844
  * - **Tags**: NotCreatable, Service
14984
14845
  *
14985
14846
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GenerationService)
@@ -14994,24 +14855,31 @@ interface GenerationService extends Instance {
14994
14855
  */
14995
14856
  readonly _nominal_GenerationService: unique symbol;
14996
14857
  /**
14858
+ * Starts the generation of a new 3D mesh from a text prompt and returns unique IDs used to track and retrieve the result. After the generation is complete, use `LoadGeneratedMeshAsync()` to load and display the generated mesh.
14859
+ *
14997
14860
  * - **ThreadSafety**: Unsafe
14998
14861
  * - **Tags**: Yields
14999
14862
  *
15000
14863
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GenerationService#GenerateMeshAsync)
15001
- * @param this
15002
- * @param inputs
15003
- * @param player
15004
- * @param options
15005
- * @param intermediateResultCallback
14864
+ * @param this `GenerationService` is a service that allows developers to generate 3D objects from text prompts utilizing Roblox's [Cube 3D foundation model](https://corp.roblox.com/newsroom/2025/03/introducing-roblox-cube).
14865
+ * @param inputs A dictionary containing the mesh generation prompts. Currently, the only supported key is the `Prompt` (string) that describes the mesh to generate.
14866
+ * @param player The `Player` requesting the generation.
14867
+ * @param options Additional generation options. Currently, no options are supported.
14868
+ * @param intermediateResultCallback A callback function triggered with intermediate generation results. Useful for retrieving early mesh versions (e.g. before textures are applied).
14869
+ * @returns A tuple of generation ID and context ID. - Generation ID: A unique ID returned for each invocation of `GenerateMeshAsync()`.
14870
+ * - Context ID: Not currently used.
15006
14871
  */
15007
14872
  GenerateMeshAsync(this: GenerationService, inputs: object, player: Player, options: object, intermediateResultCallback?: Callback): unknown;
15008
14873
  /**
14874
+ * Retrieves and loads a mesh generated by `GenerationService:GenerateMeshAsync()` using the provided `generationId`. The mesh is returned as a `MeshPart` with `EditableMesh` content.
14875
+ *
15009
14876
  * - **ThreadSafety**: Unsafe
15010
14877
  * - **Tags**: Yields
15011
14878
  *
15012
14879
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GenerationService#LoadGeneratedMeshAsync)
15013
- * @param this
15014
- * @param generationId
14880
+ * @param this `GenerationService` is a service that allows developers to generate 3D objects from text prompts utilizing Roblox's [Cube 3D foundation model](https://corp.roblox.com/newsroom/2025/03/introducing-roblox-cube).
14881
+ * @param generationId The unique ID returned by `GenerateMeshAsync()`. Identifies the mesh to load.
14882
+ * @returns The generated mesh, returned as a `MeshPart` containing an `EditableMesh`.
15015
14883
  */
15016
14884
  LoadGeneratedMeshAsync(this: GenerationService, generationId: string): MeshPart;
15017
14885
  }
@@ -19965,7 +19833,7 @@ interface HttpService extends Instance {
19965
19833
  */
19966
19834
  GetSecret(this: HttpService, key: string): Secret;
19967
19835
  /**
19968
- * Decodes a JSON string into a Lua table.
19836
+ * Decodes a JSON string into a Luau table.
19969
19837
  *
19970
19838
  * - **ThreadSafety**: Safe
19971
19839
  * - **Tags**: CustomLuaState
@@ -19973,18 +19841,18 @@ interface HttpService extends Instance {
19973
19841
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HttpService#JSONDecode)
19974
19842
  * @param this Allows sending HTTP requests and provides various web-related and JSON methods.
19975
19843
  * @param input The JSON object being decoded.
19976
- * @returns The decoded JSON object as a Lua table.
19844
+ * @returns The decoded JSON object as a Luau table.
19977
19845
  */
19978
19846
  JSONDecode(this: HttpService, input: string): unknown;
19979
19847
  /**
19980
- * Generate a JSON string from a Lua table.
19848
+ * Generate a JSON string from a Luau table.
19981
19849
  *
19982
19850
  * - **ThreadSafety**: Safe
19983
19851
  * - **Tags**: CustomLuaState
19984
19852
  *
19985
19853
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HttpService#JSONEncode)
19986
19854
  * @param this Allows sending HTTP requests and provides various web-related and JSON methods.
19987
- * @param input The input Lua table.
19855
+ * @param input The input Luau table.
19988
19856
  * @returns The returned JSON string.
19989
19857
  */
19990
19858
  JSONEncode(this: HttpService, input: unknown): string;
@@ -22391,12 +22259,24 @@ interface InputBinding extends Instance {
22391
22259
  * @deprecated
22392
22260
  */
22393
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;
22394
22268
  /**
22395
22269
  * - **ThreadSafety**: ReadSafe
22396
22270
  *
22397
22271
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputBinding#KeyCode)
22398
22272
  */
22399
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;
22400
22280
  /**
22401
22281
  * - **ThreadSafety**: ReadSafe
22402
22282
  *
@@ -22409,6 +22289,12 @@ interface InputBinding extends Instance {
22409
22289
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputBinding#ReleasedThreshold)
22410
22290
  */
22411
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;
22412
22298
  /**
22413
22299
  * - **ThreadSafety**: ReadSafe
22414
22300
  *
@@ -22421,6 +22307,18 @@ interface InputBinding extends Instance {
22421
22307
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputBinding#UIButton)
22422
22308
  */
22423
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;
22424
22322
  }
22425
22323
  /**
22426
22324
  * - **Tags**: NotBrowsable
@@ -24379,7 +24277,7 @@ interface LogService extends Instance {
24379
24277
  readonly MessageOut: RBXScriptSignal<(message: string, messageType: Enum.MessageType) => void>;
24380
24278
  }
24381
24279
  /**
24382
- * The base class for all objects which contain Lua code.
24280
+ * The base class for all objects which contain Luau code.
24383
24281
  *
24384
24282
  * - **Tags**: NotCreatable, NotBrowsable
24385
24283
  *
@@ -24417,6 +24315,24 @@ interface AuroraScript extends LuaSourceContainer {
24417
24315
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraScript#Tag)
24418
24316
  */
24419
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;
24420
24336
  }
24421
24337
  /**
24422
24338
  * The base class for all script objects which run automatically.
@@ -24474,7 +24390,7 @@ interface BaseScript extends LuaSourceContainer {
24474
24390
  get RunContext(): Enum.RunContext;
24475
24391
  }
24476
24392
  /**
24477
- * An object that contains and runs Lua code on the server.
24393
+ * An object that contains and runs Luau code on the server.
24478
24394
  *
24479
24395
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Script)
24480
24396
  */
@@ -24497,7 +24413,7 @@ interface Script extends BaseScript {
24497
24413
  Source: ProtectedString;
24498
24414
  }
24499
24415
  /**
24500
- * 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.
24501
24417
  *
24502
24418
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/LocalScript)
24503
24419
  */
@@ -28188,6 +28104,366 @@ interface VehicleSeat extends BasePart {
28188
28104
  */
28189
28105
  readonly RemoteDestroySeatWeld: RBXScriptSignal<() => void>;
28190
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
+ }
28191
28467
  /**
28192
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.
28193
28469
  *
@@ -30094,7 +30370,7 @@ interface PathfindingService extends Instance {
30094
30370
  *
30095
30371
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PathfindingService#CreatePath)
30096
30372
  * @param this Used to find logical paths between two points.
30097
- * @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.
30098
30374
  * @returns A `Path` object.
30099
30375
  */
30100
30376
  CreatePath(this: PathfindingService, agentParameters?: AgentParameters): Path;
@@ -33022,7 +33298,7 @@ interface RotationCurve extends Instance {
33022
33298
  */
33023
33299
  GetKeyIndicesAtTime(this: RotationCurve, time: number): Array<unknown>;
33024
33300
  /**
33025
- * 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`.
33026
33302
  *
33027
33303
  * - **ThreadSafety**: Unsafe
33028
33304
  *
@@ -34559,6 +34835,8 @@ interface SocialService extends Instance {
34559
34835
  * - **ThreadSafety**: Unsafe
34560
34836
  *
34561
34837
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SocialService#GetPlayersByPartyId)
34838
+ * @param this Facilitates social functions that impact relationships made on the Roblox platform.
34839
+ * @param partyId
34562
34840
  */
34563
34841
  GetPlayersByPartyId(this: SocialService, partyId: string): Array<Instance>;
34564
34842
  /**
@@ -37579,8 +37857,8 @@ interface TextChannel extends Instance {
37579
37857
  * - **ThreadSafety**: Unsafe
37580
37858
  *
37581
37859
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TextChannel#ShouldDeliverCallback)
37582
- * @param message
37583
- * @param textSource
37860
+ * @param message The message being sent, which also contains the sender of the message.
37861
+ * @param textSource The `TextSource` of the user who will be receiving the message.
37584
37862
  */
37585
37863
  ShouldDeliverCallback: (message: TextChatMessage, textSource: TextSource) => boolean;
37586
37864
  }
@@ -39197,7 +39475,7 @@ interface Translator extends Instance {
39197
39475
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Translator#FormatByKey)
39198
39476
  * @param this The role of a Translator is to manufacture/return strings localized for the viewing player.
39199
39477
  * @param key The **Key** value to look up and translate.
39200
- * @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.
39201
39479
  */
39202
39480
  FormatByKey(this: Translator, key: string, args: unknown): string;
39203
39481
  /**
@@ -42265,6 +42543,8 @@ interface VideoPlayer extends Instance {
42265
42543
  readonly DidLoop: RBXScriptSignal<() => void>;
42266
42544
  }
42267
42545
  /**
42546
+ * An internal service that offers no functionality to developers.
42547
+ *
42268
42548
  * - **Tags**: NotCreatable, Service
42269
42549
  *
42270
42550
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VideoService)
@@ -42573,12 +42853,15 @@ interface WebSocketClient extends Instance {
42573
42853
  * - **ThreadSafety**: Unsafe
42574
42854
  *
42575
42855
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/WebSocketClient#Close)
42856
+ * @param this
42576
42857
  */
42577
42858
  Close(this: WebSocketClient): void;
42578
42859
  /**
42579
42860
  * - **ThreadSafety**: Unsafe
42580
42861
  *
42581
42862
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/WebSocketClient#Send)
42863
+ * @param this
42864
+ * @param data
42582
42865
  */
42583
42866
  Send(this: WebSocketClient, data: string): void;
42584
42867
  /**
@@ -42618,6 +42901,8 @@ interface WebSocketService extends Instance {
42618
42901
  * - **ThreadSafety**: Unsafe
42619
42902
  *
42620
42903
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/WebSocketService#CreateClient)
42904
+ * @param this
42905
+ * @param uri
42621
42906
  */
42622
42907
  CreateClient(this: WebSocketService, uri: string): WebSocketClient;
42623
42908
  }