@rbxts/types 1.0.844 → 1.0.846

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.
@@ -150,12 +150,12 @@ interface Services {
150
150
  ScriptProfilerService: ScriptProfilerService;
151
151
  ScriptRegistrationService: ScriptRegistrationService;
152
152
  SelectionHighlightManager: SelectionHighlightManager;
153
+ SerializationService: SerializationService;
153
154
  ServerScriptService: ServerScriptService;
154
155
  ServerStorage: ServerStorage;
155
156
  ServiceVisibilityService: ServiceVisibilityService;
156
157
  SessionService: SessionService;
157
158
  SharedTableRegistry: SharedTableRegistry;
158
- ShorelineUpgraderService: ShorelineUpgraderService;
159
159
  SmoothVoxelsUpgraderService: SmoothVoxelsUpgraderService;
160
160
  SnippetService: SnippetService;
161
161
  SocialService: SocialService;
@@ -574,6 +574,7 @@ interface Instances extends Services, CreatableInstances {
574
574
  GuiObject: GuiObject;
575
575
  HandleAdornment: HandleAdornment;
576
576
  HandlesBase: HandlesBase;
577
+ ImportSession: ImportSession;
577
578
  InputObject: InputObject;
578
579
  Instance: Instance;
579
580
  InstanceAdornment: InstanceAdornment;
@@ -797,18 +798,24 @@ interface ConfigSnapshot extends RBXObject {
797
798
  * - **ThreadSafety**: Unsafe
798
799
  *
799
800
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ConfigSnapshot#GetValue)
801
+ * @param this
802
+ * @param key
803
+ * @param defaultValue
800
804
  */
801
805
  GetValue(this: ConfigSnapshot, key: string, defaultValue: unknown): unknown;
802
806
  /**
803
807
  * - **ThreadSafety**: Unsafe
804
808
  *
805
809
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ConfigSnapshot#GetValueChangedSignal)
810
+ * @param this
811
+ * @param key
806
812
  */
807
813
  GetValueChangedSignal(this: ConfigSnapshot, key: string): RBXScriptSignal;
808
814
  /**
809
815
  * - **ThreadSafety**: Unsafe
810
816
  *
811
817
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ConfigSnapshot#Refresh)
818
+ * @param this
812
819
  */
813
820
  Refresh(this: ConfigSnapshot): void;
814
821
  /**
@@ -1230,13 +1237,37 @@ interface EditableMesh extends RBXObject {
1230
1237
  * Returns a list of faces that use a given attribute ID.
1231
1238
  *
1232
1239
  * - **ThreadSafety**: Unsafe
1240
+ * - **Tags**:
1233
1241
  *
1234
1242
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetFacesWithAttribute)
1235
1243
  * @param this Instance which allows for the runtime creation and manipulation of meshes.
1236
1244
  * @param id Attribute ID for which to find faces that use it.
1237
1245
  * @returns List of face IDs which use the given attribute ID.
1246
+ *
1247
+ * @deprecated
1238
1248
  */
1239
1249
  GetFacesWithAttribute(this: EditableMesh, id: number): Array<unknown>;
1250
+ /**
1251
+ * - **ThreadSafety**: Unsafe
1252
+ * - **Tags**: CustomLuaState
1253
+ *
1254
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetFacesWithColor)
1255
+ */
1256
+ GetFacesWithColor(this: EditableMesh, colorId: number): Array<unknown>;
1257
+ /**
1258
+ * - **ThreadSafety**: Unsafe
1259
+ * - **Tags**: CustomLuaState
1260
+ *
1261
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetFacesWithNormal)
1262
+ */
1263
+ GetFacesWithNormal(this: EditableMesh, normalId: number): Array<unknown>;
1264
+ /**
1265
+ * - **ThreadSafety**: Unsafe
1266
+ * - **Tags**: CustomLuaState
1267
+ *
1268
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetFacesWithUV)
1269
+ */
1270
+ GetFacesWithUV(this: EditableMesh, uvId: number): Array<unknown>;
1240
1271
  /**
1241
1272
  * Returns the normal vector for the given normal ID.
1242
1273
  *
@@ -1300,6 +1331,52 @@ interface EditableMesh extends RBXObject {
1300
1331
  * @returns List of stable UV IDs.
1301
1332
  */
1302
1333
  GetUVs(this: EditableMesh): Array<unknown>;
1334
+ /**
1335
+ * - **ThreadSafety**: Unsafe
1336
+ * - **Tags**: CustomLuaState
1337
+ *
1338
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetVertexColors)
1339
+ */
1340
+ GetVertexColors(this: EditableMesh, vertexId: number): Array<unknown>;
1341
+ /**
1342
+ * - **ThreadSafety**: Unsafe
1343
+ *
1344
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetVertexFaceColor)
1345
+ */
1346
+ GetVertexFaceColor(this: EditableMesh, vertexId: number, faceId: number): number;
1347
+ /**
1348
+ * - **ThreadSafety**: Unsafe
1349
+ *
1350
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetVertexFaceNormal)
1351
+ */
1352
+ GetVertexFaceNormal(this: EditableMesh, vertexId: number, faceId: number): number;
1353
+ /**
1354
+ * - **ThreadSafety**: Unsafe
1355
+ *
1356
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetVertexFaceUV)
1357
+ */
1358
+ GetVertexFaceUV(this: EditableMesh, vertexId: number, faceId: number): number;
1359
+ /**
1360
+ * - **ThreadSafety**: Unsafe
1361
+ * - **Tags**: CustomLuaState
1362
+ *
1363
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetVertexFaces)
1364
+ */
1365
+ GetVertexFaces(this: EditableMesh, vertexId: number): Array<unknown>;
1366
+ /**
1367
+ * - **ThreadSafety**: Unsafe
1368
+ * - **Tags**: CustomLuaState
1369
+ *
1370
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetVertexNormals)
1371
+ */
1372
+ GetVertexNormals(this: EditableMesh, vertexId: number): Array<unknown>;
1373
+ /**
1374
+ * - **ThreadSafety**: Unsafe
1375
+ * - **Tags**: CustomLuaState
1376
+ *
1377
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetVertexUVs)
1378
+ */
1379
+ GetVertexUVs(this: EditableMesh, vertexId: number): Array<unknown>;
1303
1380
  /**
1304
1381
  * Returns all vertices as a list of stable vertex IDs.
1305
1382
  *
@@ -1314,13 +1391,37 @@ interface EditableMesh extends RBXObject {
1314
1391
  * Returns a list of vertices that use a given attribute ID.
1315
1392
  *
1316
1393
  * - **ThreadSafety**: Unsafe
1394
+ * - **Tags**:
1317
1395
  *
1318
1396
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetVerticesWithAttribute)
1319
1397
  * @param this Instance which allows for the runtime creation and manipulation of meshes.
1320
1398
  * @param id Attribute ID for which to find vertices that use it.
1321
1399
  * @returns List of vertex IDs which use the given attribute ID.
1400
+ *
1401
+ * @deprecated
1322
1402
  */
1323
1403
  GetVerticesWithAttribute(this: EditableMesh, id: number): Array<unknown>;
1404
+ /**
1405
+ * - **ThreadSafety**: Unsafe
1406
+ * - **Tags**: CustomLuaState
1407
+ *
1408
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetVerticesWithColor)
1409
+ */
1410
+ GetVerticesWithColor(this: EditableMesh, colorId: number): Array<unknown>;
1411
+ /**
1412
+ * - **ThreadSafety**: Unsafe
1413
+ * - **Tags**: CustomLuaState
1414
+ *
1415
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetVerticesWithNormal)
1416
+ */
1417
+ GetVerticesWithNormal(this: EditableMesh, normalId: number): Array<unknown>;
1418
+ /**
1419
+ * - **ThreadSafety**: Unsafe
1420
+ * - **Tags**: CustomLuaState
1421
+ *
1422
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetVerticesWithUV)
1423
+ */
1424
+ GetVerticesWithUV(this: EditableMesh, uvId: number): Array<unknown>;
1324
1425
  /**
1325
1426
  * Returns a string describing a stable ID, useful for debugging purposes.
1326
1427
  *
@@ -1490,6 +1591,24 @@ interface EditableMesh extends RBXObject {
1490
1591
  * @param uv UV coordinates.
1491
1592
  */
1492
1593
  SetUV(this: EditableMesh, uvId: number, uv: Vector2): void;
1594
+ /**
1595
+ * - **ThreadSafety**: Unsafe
1596
+ *
1597
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#SetVertexFaceColor)
1598
+ */
1599
+ SetVertexFaceColor(this: EditableMesh, vertexId: number, faceId: number, colorId: number): void;
1600
+ /**
1601
+ * - **ThreadSafety**: Unsafe
1602
+ *
1603
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#SetVertexFaceNormal)
1604
+ */
1605
+ SetVertexFaceNormal(this: EditableMesh, vertexId: number, faceId: number, normalId: number): void;
1606
+ /**
1607
+ * - **ThreadSafety**: Unsafe
1608
+ *
1609
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#SetVertexFaceUV)
1610
+ */
1611
+ SetVertexFaceUV(this: EditableMesh, vertexId: number, faceId: number, uvId: number): void;
1493
1612
  /**
1494
1613
  * Splits all faces on the mesh to be triangles.
1495
1614
  *
@@ -3209,33 +3328,6 @@ interface AssetImportService extends Instance {
3209
3328
  */
3210
3329
  readonly _nominal_AssetImportService: unique symbol;
3211
3330
  }
3212
- /**
3213
- * - **Tags**: NotCreatable, NotReplicated
3214
- *
3215
- * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AssetImportSession)
3216
- */
3217
- interface AssetImportSession extends Instance {
3218
- /**
3219
- * **DO NOT USE!**
3220
- *
3221
- * This field exists to force TypeScript to recognize this as a nominal type
3222
- * @hidden
3223
- * @deprecated
3224
- */
3225
- readonly _nominal_AssetImportSession: unique symbol;
3226
- /**
3227
- * - **ThreadSafety**: Unsafe
3228
- *
3229
- * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AssetImportSession#UploadComplete)
3230
- */
3231
- readonly UploadComplete: RBXScriptSignal<(results: object) => void>;
3232
- /**
3233
- * - **ThreadSafety**: Unsafe
3234
- *
3235
- * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AssetImportSession#UploadProgress)
3236
- */
3237
- readonly UploadProgress: RBXScriptSignal<(progressRatio: number) => void>;
3238
- }
3239
3331
  /**
3240
3332
  * - **Tags**: NotCreatable, Service, NotReplicated
3241
3333
  *
@@ -3321,7 +3413,7 @@ interface AssetService extends Instance {
3321
3413
  */
3322
3414
  CreateEditableMesh(this: AssetService, editableMeshOptions?: object): EditableMesh;
3323
3415
  /**
3324
- * Creates a new asset from the given object.
3416
+ * Uploads a new asset to Roblox from the given object.
3325
3417
  *
3326
3418
  * - **ThreadSafety**: Unsafe
3327
3419
  * - **Tags**: Yields
@@ -3346,7 +3438,7 @@ interface AssetService extends Instance {
3346
3438
  */
3347
3439
  CreateAssetAsync(this: AssetService, object: RBXObject, assetType: CastsToEnum<Enum.AssetType>, requestParameters?: object): unknown;
3348
3440
  /**
3349
- * Creates a new version for an existing asset from the given object.
3441
+ * Uploads a new version for an existing asset from the given object.
3350
3442
  *
3351
3443
  * - **ThreadSafety**: Unsafe
3352
3444
  * - **Tags**: Yields
@@ -3964,7 +4056,7 @@ interface AudioAnalyzer extends Instance {
3964
4056
  readonly WiringChanged: RBXScriptSignal<(connected: boolean, pin: string, wire: Wire, instance: Instance) => void>;
3965
4057
  }
3966
4058
  /**
3967
- * - **Tags**: NotBrowsable
4059
+ * Combines multiple audio streams into a single, multichannel audio stream.
3968
4060
  *
3969
4061
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioChannelMixer)
3970
4062
  */
@@ -3978,34 +4070,44 @@ interface AudioChannelMixer extends Instance {
3978
4070
  */
3979
4071
  readonly _nominal_AudioChannelMixer: unique symbol;
3980
4072
  /**
4073
+ * Controls the output channel layout to be mixed to.
4074
+ *
3981
4075
  * - **ThreadSafety**: ReadSafe
3982
4076
  *
3983
4077
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioChannelMixer#Layout)
3984
4078
  */
3985
4079
  Layout: Enum.AudioChannelLayout;
3986
4080
  /**
4081
+ * Returns an array of `Wires` that are connected to the specified pin.
4082
+ *
3987
4083
  * - **ThreadSafety**: Unsafe
3988
4084
  *
3989
4085
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioChannelMixer#GetConnectedWires)
3990
- * @param this
4086
+ * @param this Combines multiple audio streams into a single, multichannel audio stream.
3991
4087
  * @param pin
3992
4088
  */
3993
4089
  GetConnectedWires(this: AudioChannelMixer, pin: string): Array<Instance>;
3994
4090
  /**
4091
+ * Returns the input pins that can be selected by `Wire.TargetName`.
4092
+ *
3995
4093
  * - **ThreadSafety**: Unsafe
3996
4094
  *
3997
4095
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioChannelMixer#GetInputPins)
3998
- * @param this
4096
+ * @param this Combines multiple audio streams into a single, multichannel audio stream.
3999
4097
  */
4000
4098
  GetInputPins(this: AudioChannelMixer): Array<unknown>;
4001
4099
  /**
4100
+ * Returns the output pin available for `Wire.SourceName`.
4101
+ *
4002
4102
  * - **ThreadSafety**: Unsafe
4003
4103
  *
4004
4104
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioChannelMixer#GetOutputPins)
4005
- * @param this
4105
+ * @param this Combines multiple audio streams into a single, multichannel audio stream.
4006
4106
  */
4007
4107
  GetOutputPins(this: AudioChannelMixer): Array<unknown>;
4008
4108
  /**
4109
+ * Fires when another instance is connected to or disconnected from the `AudioChannelMixer` via a `Wire`.
4110
+ *
4009
4111
  * - **ThreadSafety**: Unsafe
4010
4112
  *
4011
4113
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioChannelMixer#WiringChanged)
@@ -4013,7 +4115,7 @@ interface AudioChannelMixer extends Instance {
4013
4115
  readonly WiringChanged: RBXScriptSignal<(connected: boolean, pin: string, wire: Wire, instance: Instance) => void>;
4014
4116
  }
4015
4117
  /**
4016
- * - **Tags**: NotBrowsable
4118
+ * Splits an audio stream into component channels so that each can be processed independently.
4017
4119
  *
4018
4120
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioChannelSplitter)
4019
4121
  */
@@ -4027,34 +4129,44 @@ interface AudioChannelSplitter extends Instance {
4027
4129
  */
4028
4130
  readonly _nominal_AudioChannelSplitter: unique symbol;
4029
4131
  /**
4132
+ * Controls the input channel layout to be split from.
4133
+ *
4030
4134
  * - **ThreadSafety**: ReadSafe
4031
4135
  *
4032
4136
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioChannelSplitter#Layout)
4033
4137
  */
4034
4138
  Layout: Enum.AudioChannelLayout;
4035
4139
  /**
4140
+ * Returns an array of `Wires` that are connected to the specified pin.
4141
+ *
4036
4142
  * - **ThreadSafety**: Unsafe
4037
4143
  *
4038
4144
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioChannelSplitter#GetConnectedWires)
4039
- * @param this
4145
+ * @param this Splits an audio stream into component channels so that each can be processed independently.
4040
4146
  * @param pin
4041
4147
  */
4042
4148
  GetConnectedWires(this: AudioChannelSplitter, pin: string): Array<Instance>;
4043
4149
  /**
4150
+ * Returns the input pin available for `Wire.TargetName`.
4151
+ *
4044
4152
  * - **ThreadSafety**: Unsafe
4045
4153
  *
4046
4154
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioChannelSplitter#GetInputPins)
4047
- * @param this
4155
+ * @param this Splits an audio stream into component channels so that each can be processed independently.
4048
4156
  */
4049
4157
  GetInputPins(this: AudioChannelSplitter): Array<unknown>;
4050
4158
  /**
4159
+ * Returns the output pins that can be selected by `Wire.SourceName`.
4160
+ *
4051
4161
  * - **ThreadSafety**: Unsafe
4052
4162
  *
4053
4163
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioChannelSplitter#GetOutputPins)
4054
- * @param this
4164
+ * @param this Splits an audio stream into component channels so that each can be processed independently.
4055
4165
  */
4056
4166
  GetOutputPins(this: AudioChannelSplitter): Array<unknown>;
4057
4167
  /**
4168
+ * Fires when another instance is connected to or disconnected from the `AudioChannelSplitter` via a `Wire`.
4169
+ *
4058
4170
  * - **ThreadSafety**: Unsafe
4059
4171
  *
4060
4172
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioChannelSplitter#WiringChanged)
@@ -6129,7 +6241,7 @@ interface AvatarCreationService extends Instance {
6129
6241
  *
6130
6242
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AvatarCreationService#PromptCreateAvatarAsync)
6131
6243
  * @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).
6244
+ * @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
6245
  * @param player The `Player` intended to be presented with the creation prompt.
6134
6246
  * @param humanoidDescription The `HumanoidDescription` of the avatar intended for creation.
6135
6247
  * @returns A tuple containing, in order: - An `PromptCreateAvatarResult` indicating the result of the creation prompt.
@@ -8546,366 +8658,6 @@ interface CalloutService extends Instance {
8546
8658
  */
8547
8659
  readonly _nominal_CalloutService: unique symbol;
8548
8660
  }
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
8661
  /**
8910
8662
  * A service which provides control over screenshot capture features.
8911
8663
  *
@@ -9279,7 +9031,7 @@ interface ShirtGraphic extends CharacterAppearance {
9279
9031
  Graphic: ContentId;
9280
9032
  }
9281
9033
  /**
9282
- * Houses the Lua code responsible for running the legacy chat system.
9034
+ * Houses the Luau code responsible for running the legacy chat system.
9283
9035
  *
9284
9036
  * - **Tags**: NotCreatable, Service, NotReplicated
9285
9037
  *
@@ -9316,19 +9068,19 @@ interface Chat extends Instance {
9316
9068
  * - **ThreadSafety**: Unsafe
9317
9069
  *
9318
9070
  * [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.
9071
+ * @param this Houses the Luau code responsible for running the legacy chat system.
9320
9072
  * @param partOrCharacter An instance that is the part or character which the *BubbleChat* dialog should appear above.
9321
9073
  * @param message The message string being chatted.
9322
9074
  * @param color An `ChatColor` specifying the color of the chatted message.
9323
9075
  */
9324
9076
  Chat(this: Chat, partOrCharacter: Instance, message: string, color?: CastsToEnum<Enum.ChatColor>): void;
9325
9077
  /**
9326
- * Invoke a chat callback function registered by `RegisterChatCallback`. Used by the Lua Chat System.
9078
+ * Invoke a chat callback function registered by `RegisterChatCallback`. Used by the Luau Chat System.
9327
9079
  *
9328
9080
  * - **ThreadSafety**: Unsafe
9329
9081
  *
9330
9082
  * [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.
9083
+ * @param this Houses the Luau code responsible for running the legacy chat system.
9332
9084
  * @param callbackType The type of callback to invoke.
9333
9085
  * @param callbackArguments The arguments that will be sent to the registered callback function.
9334
9086
  * @returns The values returned by the function registered to the given ChatCallbackType.
@@ -9340,7 +9092,7 @@ interface Chat extends Instance {
9340
9092
  * - **ThreadSafety**: Unsafe
9341
9093
  *
9342
9094
  * [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.
9095
+ * @param this Houses the Luau code responsible for running the legacy chat system.
9344
9096
  * @param callbackType The callback to which the function shall be registered (this determines in what way the function is called).
9345
9097
  * @param callbackFunction The function to call when the callback is invoked using Chat:InvokeChatCallback.
9346
9098
  */
@@ -9351,7 +9103,7 @@ interface Chat extends Instance {
9351
9103
  * - **ThreadSafety**: Unsafe
9352
9104
  *
9353
9105
  * [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.
9106
+ * @param this Houses the Luau code responsible for running the legacy chat system.
9355
9107
  * @param settings A settings table.
9356
9108
  */
9357
9109
  SetBubbleChatSettings(this: Chat, settings: unknown): void;
@@ -9362,7 +9114,7 @@ interface Chat extends Instance {
9362
9114
  * - **Tags**: Yields
9363
9115
  *
9364
9116
  * [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.
9117
+ * @param this Houses the Luau code responsible for running the legacy chat system.
9366
9118
  * @param userId
9367
9119
  */
9368
9120
  CanUserChatAsync(this: Chat, userId: number): boolean;
@@ -9373,7 +9125,7 @@ interface Chat extends Instance {
9373
9125
  * - **Tags**: Yields
9374
9126
  *
9375
9127
  * [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.
9128
+ * @param this Houses the Luau code responsible for running the legacy chat system.
9377
9129
  * @param userIdFrom
9378
9130
  * @param userIdTo
9379
9131
  */
@@ -9385,7 +9137,7 @@ interface Chat extends Instance {
9385
9137
  * - **Tags**: Yields
9386
9138
  *
9387
9139
  * [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.
9140
+ * @param this Houses the Luau code responsible for running the legacy chat system.
9389
9141
  * @param stringToFilter The raw string to be filtered, exactly as entered by the player.
9390
9142
  * @param playerFrom The author of the text.
9391
9143
  * @param playerTo The intended recipient of the provided text; use the author if the text is persistent (see description).
@@ -9398,7 +9150,7 @@ interface Chat extends Instance {
9398
9150
  * - **Tags**: Yields
9399
9151
  *
9400
9152
  * [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.
9153
+ * @param this Houses the Luau code responsible for running the legacy chat system.
9402
9154
  * @param stringToFilter Message string being filtered.
9403
9155
  * @param playerFrom Instance of the player sending the message.
9404
9156
  * @returns Filtered message string.
@@ -9413,7 +9165,7 @@ interface Chat extends Instance {
9413
9165
  * - **Tags**: Yields
9414
9166
  *
9415
9167
  * [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.
9168
+ * @param this Houses the Luau code responsible for running the legacy chat system.
9417
9169
  * @param stringToFilter String being filtered.
9418
9170
  * @param playerToFilterFor Player that the string is being filtered for.
9419
9171
  * @returns Filtered string result.
@@ -10275,6 +10027,7 @@ interface ConfigService extends Instance {
10275
10027
  * - **Tags**: Yields
10276
10028
  *
10277
10029
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ConfigService#GetConfigAsync)
10030
+ * @param this
10278
10031
  */
10279
10032
  GetConfigAsync(this: ConfigService): ConfigSnapshot;
10280
10033
  /**
@@ -10282,6 +10035,8 @@ interface ConfigService extends Instance {
10282
10035
  * - **Tags**: Yields
10283
10036
  *
10284
10037
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ConfigService#GetConfigForPlayerAsync)
10038
+ * @param this
10039
+ * @param player
10285
10040
  */
10286
10041
  GetConfigForPlayerAsync(this: ConfigService, player: Player): ConfigSnapshot;
10287
10042
  }
@@ -13423,7 +13178,7 @@ interface DataStoreOptions extends Instance {
13423
13178
  *
13424
13179
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DataStoreOptions#SetExperimentalFeatures)
13425
13180
  * @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.
13181
+ * @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
13182
  */
13428
13183
  SetExperimentalFeatures(this: DataStoreOptions, experimentalFeatures: object): void;
13429
13184
  }
@@ -14883,7 +14638,7 @@ interface FloatCurve extends Instance {
14883
14638
  after: number
14884
14639
  ];
14885
14640
  /**
14886
- * Returns a copy of all the keys in the FloatCurve as a Lua array of `FloatCurveKeys`.
14641
+ * Returns a copy of all the keys in the FloatCurve as a Luau array of `FloatCurveKeys`.
14887
14642
  *
14888
14643
  * - **ThreadSafety**: Unsafe
14889
14644
  *
@@ -15085,7 +14840,7 @@ interface GenerationService extends Instance {
15085
14840
  * @param player The `Player` requesting the generation.
15086
14841
  * @param options Additional generation options. Currently, no options are supported.
15087
14842
  * @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()`.
14843
+ * @returns A tuple of generation ID and context ID. - Generation ID: A unique ID returned for each invocation of `GenerateMeshAsync()`.
15089
14844
  * - Context ID: Not currently used.
15090
14845
  */
15091
14846
  GenerateMeshAsync(this: GenerationService, inputs: object, player: Player, options: object, intermediateResultCallback?: Callback): unknown;
@@ -17674,6 +17429,18 @@ interface VideoDisplay extends GuiObject {
17674
17429
  * @param pin
17675
17430
  */
17676
17431
  GetConnectedWires(this: VideoDisplay, pin: string): Array<Instance>;
17432
+ /**
17433
+ * - **ThreadSafety**: Unsafe
17434
+ *
17435
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VideoDisplay#GetInputPins)
17436
+ */
17437
+ GetInputPins(this: VideoDisplay): Array<unknown>;
17438
+ /**
17439
+ * - **ThreadSafety**: Unsafe
17440
+ *
17441
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VideoDisplay#GetOutputPins)
17442
+ */
17443
+ GetOutputPins(this: VideoDisplay): Array<unknown>;
17677
17444
  /**
17678
17445
  * - **ThreadSafety**: Unsafe
17679
17446
  *
@@ -20052,7 +19819,7 @@ interface HttpService extends Instance {
20052
19819
  */
20053
19820
  GetSecret(this: HttpService, key: string): Secret;
20054
19821
  /**
20055
- * Decodes a JSON string into a Lua table.
19822
+ * Decodes a JSON string into a Luau table.
20056
19823
  *
20057
19824
  * - **ThreadSafety**: Safe
20058
19825
  * - **Tags**: CustomLuaState
@@ -20060,18 +19827,18 @@ interface HttpService extends Instance {
20060
19827
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HttpService#JSONDecode)
20061
19828
  * @param this Allows sending HTTP requests and provides various web-related and JSON methods.
20062
19829
  * @param input The JSON object being decoded.
20063
- * @returns The decoded JSON object as a Lua table.
19830
+ * @returns The decoded JSON object as a Luau table.
20064
19831
  */
20065
19832
  JSONDecode(this: HttpService, input: string): unknown;
20066
19833
  /**
20067
- * Generate a JSON string from a Lua table.
19834
+ * Generate a JSON string from a Luau table.
20068
19835
  *
20069
19836
  * - **ThreadSafety**: Safe
20070
19837
  * - **Tags**: CustomLuaState
20071
19838
  *
20072
19839
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HttpService#JSONEncode)
20073
19840
  * @param this Allows sending HTTP requests and provides various web-related and JSON methods.
20074
- * @param input The input Lua table.
19841
+ * @param input The input Luau table.
20075
19842
  * @returns The returned JSON string.
20076
19843
  */
20077
19844
  JSONEncode(this: HttpService, input: unknown): string;
@@ -22359,6 +22126,48 @@ interface IXPService extends Instance {
22359
22126
  */
22360
22127
  readonly _nominal_IXPService: unique symbol;
22361
22128
  }
22129
+ /**
22130
+ * - **Tags**: NotCreatable, NotReplicated
22131
+ *
22132
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ImportSession)
22133
+ */
22134
+ interface ImportSession extends Instance {
22135
+ /**
22136
+ * **DO NOT USE!**
22137
+ *
22138
+ * This field exists to force TypeScript to recognize this as a nominal type
22139
+ * @hidden
22140
+ * @deprecated
22141
+ */
22142
+ readonly _nominal_ImportSession: unique symbol;
22143
+ /**
22144
+ * - **ThreadSafety**: Unsafe
22145
+ *
22146
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ImportSession#UploadComplete)
22147
+ */
22148
+ readonly UploadComplete: RBXScriptSignal<(results: object) => void>;
22149
+ /**
22150
+ * - **ThreadSafety**: Unsafe
22151
+ *
22152
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ImportSession#UploadProgress)
22153
+ */
22154
+ readonly UploadProgress: RBXScriptSignal<(progressRatio: number) => void>;
22155
+ }
22156
+ /**
22157
+ * - **Tags**: NotCreatable, NotReplicated
22158
+ *
22159
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AssetImportSession)
22160
+ */
22161
+ interface AssetImportSession extends ImportSession {
22162
+ /**
22163
+ * **DO NOT USE!**
22164
+ *
22165
+ * This field exists to force TypeScript to recognize this as a nominal type
22166
+ * @hidden
22167
+ * @deprecated
22168
+ */
22169
+ readonly _nominal_AssetImportSession: unique symbol;
22170
+ }
22362
22171
  /**
22363
22172
  * - **Tags**: NotCreatable, Service, NotReplicated
22364
22173
  *
@@ -22478,12 +22287,24 @@ interface InputBinding extends Instance {
22478
22287
  * @deprecated
22479
22288
  */
22480
22289
  readonly _nominal_InputBinding: unique symbol;
22290
+ /**
22291
+ * - **ThreadSafety**: ReadSafe
22292
+ *
22293
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputBinding#Down)
22294
+ */
22295
+ Down: Enum.KeyCode;
22481
22296
  /**
22482
22297
  * - **ThreadSafety**: ReadSafe
22483
22298
  *
22484
22299
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputBinding#KeyCode)
22485
22300
  */
22486
22301
  KeyCode: Enum.KeyCode;
22302
+ /**
22303
+ * - **ThreadSafety**: ReadSafe
22304
+ *
22305
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputBinding#Left)
22306
+ */
22307
+ Left: Enum.KeyCode;
22487
22308
  /**
22488
22309
  * - **ThreadSafety**: ReadSafe
22489
22310
  *
@@ -22496,6 +22317,12 @@ interface InputBinding extends Instance {
22496
22317
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputBinding#ReleasedThreshold)
22497
22318
  */
22498
22319
  ReleasedThreshold: number;
22320
+ /**
22321
+ * - **ThreadSafety**: ReadSafe
22322
+ *
22323
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputBinding#Right)
22324
+ */
22325
+ Right: Enum.KeyCode;
22499
22326
  /**
22500
22327
  * - **ThreadSafety**: ReadSafe
22501
22328
  *
@@ -22508,6 +22335,18 @@ interface InputBinding extends Instance {
22508
22335
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputBinding#UIButton)
22509
22336
  */
22510
22337
  UIButton: GuiButton | undefined;
22338
+ /**
22339
+ * - **ThreadSafety**: ReadSafe
22340
+ *
22341
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputBinding#Up)
22342
+ */
22343
+ Up: Enum.KeyCode;
22344
+ /**
22345
+ * - **ThreadSafety**: ReadSafe
22346
+ *
22347
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputBinding#Vector2Scale)
22348
+ */
22349
+ Vector2Scale: Vector2;
22511
22350
  }
22512
22351
  /**
22513
22352
  * - **Tags**: NotBrowsable
@@ -24466,7 +24305,7 @@ interface LogService extends Instance {
24466
24305
  readonly MessageOut: RBXScriptSignal<(message: string, messageType: Enum.MessageType) => void>;
24467
24306
  }
24468
24307
  /**
24469
- * The base class for all objects which contain Lua code.
24308
+ * The base class for all objects which contain Luau code.
24470
24309
  *
24471
24310
  * - **Tags**: NotCreatable, NotBrowsable
24472
24311
  *
@@ -24504,6 +24343,24 @@ interface AuroraScript extends LuaSourceContainer {
24504
24343
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraScript#Tag)
24505
24344
  */
24506
24345
  get Tag(): string;
24346
+ /**
24347
+ * - **ThreadSafety**: Unsafe
24348
+ *
24349
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraScript#AddTo)
24350
+ */
24351
+ AddTo(this: AuroraScript, instance: Instance): void;
24352
+ /**
24353
+ * - **ThreadSafety**: Unsafe
24354
+ *
24355
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraScript#IsOnInstance)
24356
+ */
24357
+ IsOnInstance(this: AuroraScript, instance: Instance): boolean;
24358
+ /**
24359
+ * - **ThreadSafety**: Unsafe
24360
+ *
24361
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraScript#RemoveFrom)
24362
+ */
24363
+ RemoveFrom(this: AuroraScript, instance: Instance): void;
24507
24364
  }
24508
24365
  /**
24509
24366
  * The base class for all script objects which run automatically.
@@ -24561,7 +24418,7 @@ interface BaseScript extends LuaSourceContainer {
24561
24418
  get RunContext(): Enum.RunContext;
24562
24419
  }
24563
24420
  /**
24564
- * An object that contains and runs Lua code on the server.
24421
+ * An object that contains and runs Luau code on the server.
24565
24422
  *
24566
24423
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Script)
24567
24424
  */
@@ -24584,7 +24441,7 @@ interface Script extends BaseScript {
24584
24441
  Source: ProtectedString;
24585
24442
  }
24586
24443
  /**
24587
- * An object that contains and runs Lua code on the client (player's device) instead of the server.
24444
+ * An object that contains and runs Luau code on the client (player's device) instead of the server.
24588
24445
  *
24589
24446
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/LocalScript)
24590
24447
  */
@@ -28275,6 +28132,366 @@ interface VehicleSeat extends BasePart {
28275
28132
  */
28276
28133
  readonly RemoteDestroySeatWeld: RBXScriptSignal<() => void>;
28277
28134
  }
28135
+ /**
28136
+ * A class which defines a view of the 3D world.
28137
+ *
28138
+ * - **Tags**: NotReplicated
28139
+ *
28140
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Camera)
28141
+ */
28142
+ interface Camera extends Instance {
28143
+ /**
28144
+ * **DO NOT USE!**
28145
+ *
28146
+ * This field exists to force TypeScript to recognize this as a nominal type
28147
+ * @hidden
28148
+ * @deprecated
28149
+ */
28150
+ readonly _nominal_Camera: unique symbol;
28151
+ /**
28152
+ * The `CFrame` of the `Camera`, defining its position and orientation in the 3D world.
28153
+ *
28154
+ * - **ThreadSafety**: ReadSafe
28155
+ *
28156
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Camera#CFrame)
28157
+ */
28158
+ CFrame: CFrame;
28159
+ /**
28160
+ * The `Humanoid` or `BasePart` that is the `Camera` subject.
28161
+ *
28162
+ * - **ThreadSafety**: ReadSafe
28163
+ *
28164
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Camera#CameraSubject)
28165
+ */
28166
+ CameraSubject: Humanoid | BasePart | undefined;
28167
+ /**
28168
+ * Specifies the `CameraType` to be read by the camera scripts.
28169
+ *
28170
+ * - **ThreadSafety**: ReadSafe
28171
+ *
28172
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Camera#CameraType)
28173
+ */
28174
+ CameraType: Enum.CameraType;
28175
+ /**
28176
+ * **Deprecated:** This item has been superseded by `Camera.CFrame` which should be used in all new work.
28177
+ *
28178
+ * - **ThreadSafety**: ReadSafe
28179
+ * - **Tags**: Hidden, NotReplicated
28180
+ *
28181
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Camera#CoordinateFrame)
28182
+ *
28183
+ * @deprecated CFrame
28184
+ */
28185
+ CoordinateFrame: CFrame;
28186
+ /**
28187
+ * Sets the angle of the camera's diagonal field of view.
28188
+ *
28189
+ * - **ThreadSafety**: ReadSafe
28190
+ * - **Tags**: NotReplicated
28191
+ *
28192
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Camera#DiagonalFieldOfView)
28193
+ */
28194
+ DiagonalFieldOfView: number;
28195
+ /**
28196
+ * Sets the angle of the camera's vertical field of view.
28197
+ *
28198
+ * - **ThreadSafety**: ReadSafe
28199
+ *
28200
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Camera#FieldOfView)
28201
+ */
28202
+ FieldOfView: number;
28203
+ /**
28204
+ * Determines the FOV value of the `Camera` that's invariant under viewport size changes.
28205
+ *
28206
+ * - **ThreadSafety**: ReadSafe
28207
+ *
28208
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Camera#FieldOfViewMode)
28209
+ */
28210
+ FieldOfViewMode: Enum.FieldOfViewMode;
28211
+ /**
28212
+ * Sets the area in 3D space that is prioritized by Roblox's graphical systems.
28213
+ *
28214
+ * - **ThreadSafety**: ReadSafe
28215
+ *
28216
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Camera#Focus)
28217
+ */
28218
+ Focus: CFrame;
28219
+ /**
28220
+ * Toggles whether the camera will automatically track the head motion of a player using a VR device.
28221
+ *
28222
+ * - **ThreadSafety**: ReadSafe
28223
+ *
28224
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Camera#HeadLocked)
28225
+ */
28226
+ HeadLocked: boolean;
28227
+ /**
28228
+ * Sets the scale of the user's perspective of the world when using VR.
28229
+ *
28230
+ * - **ThreadSafety**: ReadSafe
28231
+ *
28232
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Camera#HeadScale)
28233
+ */
28234
+ HeadScale: number;
28235
+ /**
28236
+ * Sets the angle of the camera's field of view along the longest viewport axis.
28237
+ *
28238
+ * - **ThreadSafety**: ReadSafe
28239
+ * - **Tags**: NotReplicated
28240
+ *
28241
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Camera#MaxAxisFieldOfView)
28242
+ */
28243
+ MaxAxisFieldOfView: number;
28244
+ /**
28245
+ * Describes the negative **Z** offset, in studs, of the camera's near clipping plane.
28246
+ *
28247
+ * - **ThreadSafety**: ReadSafe
28248
+ * - **Tags**: NotReplicated
28249
+ *
28250
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Camera#NearPlaneZ)
28251
+ */
28252
+ readonly NearPlaneZ: number;
28253
+ /**
28254
+ * Toggles whether to apply tilt and roll from the `CFrame` property while the player is using a VR device.
28255
+ *
28256
+ * - **ThreadSafety**: ReadSafe
28257
+ *
28258
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Camera#VRTiltAndRollEnabled)
28259
+ */
28260
+ VRTiltAndRollEnabled: boolean;
28261
+ /**
28262
+ * The dimensions of the device safe area on a Roblox client.
28263
+ *
28264
+ * - **ThreadSafety**: ReadSafe
28265
+ * - **Tags**: NotReplicated
28266
+ *
28267
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Camera#ViewportSize)
28268
+ */
28269
+ readonly ViewportSize: Vector2;
28270
+ /**
28271
+ * **Deprecated:**
28272
+ *
28273
+ * 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`.
28274
+ *
28275
+ * - **ThreadSafety**: Unsafe
28276
+ * - **Tags**:
28277
+ *
28278
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Camera#GetLargestCutoffDistance)
28279
+ * @param this A class which defines a view of the 3D world.
28280
+ * @param ignoreList An array of `Instances` to ignore. Descendants of these instances will also be ignored.
28281
+ * @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`.
28282
+ *
28283
+ * @deprecated
28284
+ */
28285
+ GetLargestCutoffDistance(this: Camera, ignoreList: Array<Instance>): number;
28286
+ /**
28287
+ * **Deprecated:** This method has been deprecated and no longer works. It should not be used in new work.
28288
+ *
28289
+ * Returns the current 'pan' speed of the `Camera`.
28290
+ *
28291
+ * - **ThreadSafety**: Unsafe
28292
+ * - **Tags**:
28293
+ *
28294
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Camera#GetPanSpeed)
28295
+ * @param this A class which defines a view of the 3D world.
28296
+ * @returns The speed at which the `Camera` is rotating around its `Focus` on the **Y** axis.
28297
+ *
28298
+ * @deprecated
28299
+ */
28300
+ GetPanSpeed(this: Camera): number;
28301
+ /**
28302
+ * Returns an array of `BaseParts` that are obscuring the lines of sight between the camera's `CFrame` and the cast points.
28303
+ *
28304
+ * - **ThreadSafety**: Unsafe
28305
+ *
28306
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Camera#GetPartsObscuringTarget)
28307
+ * @param this A class which defines a view of the 3D world.
28308
+ * @param castPoints An array of `Vector3` positions of cast points.
28309
+ * @param ignoreList An array of `Instances` that should be ignored, along with their descendants.
28310
+ * @returns An array of `BaseParts` that obscure the lines of sight between the camera's `CFrame` and the `castPoints`.
28311
+ */
28312
+ GetPartsObscuringTarget(this: Camera, castPoints: Array<Vector3>, ignoreList: Array<Instance>): Array<Instance>;
28313
+ /**
28314
+ * Returns the actual `CFrame`where the `Camera` is being rendered, accounting for any roll applied and the impact of VR devices.
28315
+ *
28316
+ * - **ThreadSafety**: Unsafe
28317
+ *
28318
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Camera#GetRenderCFrame)
28319
+ * @param this A class which defines a view of the 3D world.
28320
+ * @returns The `CFrame` the `Camera` is being rendered at.
28321
+ */
28322
+ GetRenderCFrame(this: Camera): CFrame;
28323
+ /**
28324
+ * Returns in radians the current roll, or rotation around the camera's Z-axis, applied to the `Camera` using `SetRoll()`.
28325
+ *
28326
+ * - **ThreadSafety**: Unsafe
28327
+ *
28328
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Camera#GetRoll)
28329
+ * @param this A class which defines a view of the 3D world.
28330
+ * @returns The current roll applied by `SetRoll()`, in radians.
28331
+ */
28332
+ GetRoll(this: Camera): number;
28333
+ /**
28334
+ * **Deprecated:** This method has been deprecated and no longer works.
28335
+ *
28336
+ * Returns the current tilt speed of the `Camera`.
28337
+ *
28338
+ * - **ThreadSafety**: Unsafe
28339
+ * - **Tags**:
28340
+ *
28341
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Camera#GetTiltSpeed)
28342
+ * @param this A class which defines a view of the 3D world.
28343
+ * @returns The speed at which the `Camera` is rotating around its `Focus` around the camera's **X** axis.
28344
+ *
28345
+ * @deprecated
28346
+ */
28347
+ GetTiltSpeed(this: Camera): number;
28348
+ /**
28349
+ * **Deprecated:** This method has been deprecated. Instead use `TweenService` to smoothly animate the `Camera`, see the code snippets below for an example.
28350
+ *
28351
+ * Tweens the `Camera` in a linear fashion towards a new `CFrame` and `Focus` over a given duration.
28352
+ *
28353
+ * - **ThreadSafety**: Unsafe
28354
+ * - **Tags**:
28355
+ *
28356
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Camera#Interpolate)
28357
+ * @param this A class which defines a view of the 3D world.
28358
+ * @param endPos The `CFrame` for the `Camera` to tween to.
28359
+ * @param endFocus The `CFrame` for the camera's `Focus` to tween to.
28360
+ * @param duration The duration, in seconds, of the tween.
28361
+ *
28362
+ * @deprecated
28363
+ */
28364
+ Interpolate(this: Camera, endPos: CFrame, endFocus: CFrame, duration: number): void;
28365
+ /**
28366
+ * **Deprecated:** This method was used for legacy camera controls and has since been deprecated. Do not use in new work.
28367
+ *
28368
+ * Pans the `Camera` around the `Focus` in 45 degree increments around the **Y** axis.
28369
+ *
28370
+ * - **ThreadSafety**: Unsafe
28371
+ * - **Tags**:
28372
+ *
28373
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Camera#PanUnits)
28374
+ * @param this A class which defines a view of the 3D world.
28375
+ * @param units The number of 45 degree increments by which to pan the `Camera`.
28376
+ *
28377
+ * @deprecated
28378
+ */
28379
+ PanUnits(this: Camera, units: number): void;
28380
+ /**
28381
+ * 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.
28382
+ *
28383
+ * - **ThreadSafety**: Safe
28384
+ *
28385
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Camera#ScreenPointToRay)
28386
+ * @param this A class which defines a view of the 3D world.
28387
+ * @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.
28388
+ * @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.
28389
+ * @param depth The depth from the `Camera`, in studs, from which to offset the origin of the `Ray`.
28390
+ * @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`.
28391
+ */
28392
+ ScreenPointToRay(this: Camera, x: number, y: number, depth?: number): Ray;
28393
+ /**
28394
+ * **Deprecated:** This method has been deprecated and should not be used in new work.
28395
+ *
28396
+ * Sets the `CameraPanMode` to be used by the `Camera` on mobile devices.
28397
+ *
28398
+ * - **ThreadSafety**: Unsafe
28399
+ * - **Tags**:
28400
+ *
28401
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Camera#SetCameraPanMode)
28402
+ * @param this A class which defines a view of the 3D world.
28403
+ * @param mode The `CameraPanMode` to set the `Camera` to.
28404
+ *
28405
+ * @deprecated
28406
+ */
28407
+ SetCameraPanMode(this: Camera, mode?: CastsToEnum<Enum.CameraPanMode>): void;
28408
+ /**
28409
+ * Sets the current rotation applied around the camera's Z-axis.
28410
+ *
28411
+ * - **ThreadSafety**: Unsafe
28412
+ *
28413
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Camera#SetRoll)
28414
+ * @param this A class which defines a view of the 3D world.
28415
+ * @param rollAngle The roll angle, in radians, to be applied to the `Camera`.
28416
+ */
28417
+ SetRoll(this: Camera, rollAngle: number): void;
28418
+ /**
28419
+ * **Deprecated:** This method was used for legacy camera controls and has been deprecated. Do not use in new work.
28420
+ *
28421
+ * Tilts the `Camera` around its `Focus` in 10 degree increments around the camera's **X** axis.
28422
+ *
28423
+ * - **ThreadSafety**: Unsafe
28424
+ * - **Tags**:
28425
+ *
28426
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Camera#TiltUnits)
28427
+ * @param this A class which defines a view of the 3D world.
28428
+ * @param units The number of 10 degree units by which to tilt the `Camera`.
28429
+ * @returns Whether the `Camera` tilt applied was constrained.
28430
+ *
28431
+ * @deprecated
28432
+ */
28433
+ TiltUnits(this: Camera, units: number): boolean;
28434
+ /**
28435
+ * 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.
28436
+ *
28437
+ * - **ThreadSafety**: Safe
28438
+ *
28439
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Camera#ViewportPointToRay)
28440
+ * @param this A class which defines a view of the 3D world.
28441
+ * @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.
28442
+ * @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.
28443
+ * @param depth The depth from the `Camera`, in studs, from which to offset the origin of the `Ray`.
28444
+ * @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`.
28445
+ */
28446
+ ViewportPointToRay(this: Camera, x: number, y: number, depth?: number): Ray;
28447
+ /**
28448
+ * 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.
28449
+ *
28450
+ * - **ThreadSafety**: Safe
28451
+ *
28452
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Camera#WorldToScreenPoint)
28453
+ * @param this A class which defines a view of the 3D world.
28454
+ * @param worldPoint The `Vector3` world position.
28455
+ * @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).
28456
+ * - A boolean indicating if the `worldPoint` is within the bounds of the screen.
28457
+ */
28458
+ WorldToScreenPoint(this: Camera, worldPoint: Vector3): LuaTuple<[
28459
+ Vector3,
28460
+ boolean
28461
+ ]>;
28462
+ /**
28463
+ * 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.
28464
+ *
28465
+ * - **ThreadSafety**: Safe
28466
+ *
28467
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Camera#WorldToViewportPoint)
28468
+ * @param this A class which defines a view of the 3D world.
28469
+ * @param worldPoint The `Vector3` world position.
28470
+ * @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).
28471
+ * - A boolean indicating if the `worldPoint` is within the bounds of the screen.
28472
+ */
28473
+ WorldToViewportPoint(this: Camera, worldPoint: Vector3): LuaTuple<[
28474
+ Vector3,
28475
+ boolean
28476
+ ]>;
28477
+ /**
28478
+ * - **ThreadSafety**: Unsafe
28479
+ *
28480
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Camera#ZoomToExtents)
28481
+ * @param this A class which defines a view of the 3D world.
28482
+ * @param boundingBoxCFrame
28483
+ * @param boundingBoxSize
28484
+ */
28485
+ ZoomToExtents(this: Camera, boundingBoxCFrame: CFrame, boundingBoxSize: Vector3): void;
28486
+ /**
28487
+ * Fired when the `Camera` has finished interpolating using`Interpolate()`.
28488
+ *
28489
+ * - **ThreadSafety**: Unsafe
28490
+ *
28491
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Camera#InterpolationFinished)
28492
+ */
28493
+ readonly InterpolationFinished: RBXScriptSignal<() => void>;
28494
+ }
28278
28495
  /**
28279
28496
  * 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
28497
  *
@@ -30181,7 +30398,7 @@ interface PathfindingService extends Instance {
30181
30398
  *
30182
30399
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PathfindingService#CreatePath)
30183
30400
  * @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.
30401
+ * @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
30402
  * @returns A `Path` object.
30186
30403
  */
30187
30404
  CreatePath(this: PathfindingService, agentParameters?: AgentParameters): Path;
@@ -33109,7 +33326,7 @@ interface RotationCurve extends Instance {
33109
33326
  */
33110
33327
  GetKeyIndicesAtTime(this: RotationCurve, time: number): Array<unknown>;
33111
33328
  /**
33112
- * Returns a copy of all the keys in the rotation curve as a Lua array of `RotationCurveKeys`.
33329
+ * Returns a copy of all the keys in the rotation curve as a Luau array of `RotationCurveKeys`.
33113
33330
  *
33114
33331
  * - **ThreadSafety**: Unsafe
33115
33332
  *
@@ -33888,6 +34105,35 @@ interface FluidForceSensor extends SensorBase {
33888
34105
  */
33889
34106
  EvaluateAsync(this: FluidForceSensor, linearVelocity: Vector3, angularVelocity: Vector3, cframe: CFrame): unknown;
33890
34107
  }
34108
+ /**
34109
+ * - **Tags**: NotCreatable, Service
34110
+ *
34111
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SerializationService)
34112
+ */
34113
+ interface SerializationService extends Instance {
34114
+ /**
34115
+ * **DO NOT USE!**
34116
+ *
34117
+ * This field exists to force TypeScript to recognize this as a nominal type
34118
+ * @hidden
34119
+ * @deprecated
34120
+ */
34121
+ readonly _nominal_SerializationService: unique symbol;
34122
+ /**
34123
+ * - **ThreadSafety**: Unsafe
34124
+ * - **Tags**: Yields
34125
+ *
34126
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SerializationService#DeserializeInstancesAsync)
34127
+ */
34128
+ DeserializeInstancesAsync(this: SerializationService, buffer: buffer): Array<Instance>;
34129
+ /**
34130
+ * - **ThreadSafety**: Unsafe
34131
+ * - **Tags**: Yields
34132
+ *
34133
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SerializationService#SerializeInstancesAsync)
34134
+ */
34135
+ SerializeInstancesAsync(this: SerializationService, inputInstances: Array<Instance>): buffer;
34136
+ }
33891
34137
  /**
33892
34138
  * A container service for server-only `Script` objects.
33893
34139
  *
@@ -34397,21 +34643,6 @@ interface SharedTableRegistry extends Instance {
34397
34643
  */
34398
34644
  SetSharedTable(this: SharedTableRegistry, name: string, st?: SharedTable): void;
34399
34645
  }
34400
- /**
34401
- * - **Tags**: NotCreatable, Service, NotReplicated
34402
- *
34403
- * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ShorelineUpgraderService)
34404
- */
34405
- interface ShorelineUpgraderService extends Instance {
34406
- /**
34407
- * **DO NOT USE!**
34408
- *
34409
- * This field exists to force TypeScript to recognize this as a nominal type
34410
- * @hidden
34411
- * @deprecated
34412
- */
34413
- readonly _nominal_ShorelineUpgraderService: unique symbol;
34414
- }
34415
34646
  /**
34416
34647
  * Changes the default appearance of the experience's sky.
34417
34648
  *
@@ -36698,6 +36929,34 @@ interface SurfaceAppearance extends Instance {
36698
36929
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SurfaceAppearance#Color)
36699
36930
  */
36700
36931
  Color: Color3;
36932
+ /**
36933
+ * - **ThreadSafety**: ReadSafe
36934
+ * - **Tags**: Hidden
36935
+ *
36936
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SurfaceAppearance#ColorMapContent)
36937
+ */
36938
+ get ColorMapContent(): Content;
36939
+ /**
36940
+ * - **ThreadSafety**: ReadSafe
36941
+ * - **Tags**: Hidden
36942
+ *
36943
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SurfaceAppearance#MetalnessMapContent)
36944
+ */
36945
+ get MetalnessMapContent(): Content;
36946
+ /**
36947
+ * - **ThreadSafety**: ReadSafe
36948
+ * - **Tags**: Hidden
36949
+ *
36950
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SurfaceAppearance#NormalMapContent)
36951
+ */
36952
+ get NormalMapContent(): Content;
36953
+ /**
36954
+ * - **ThreadSafety**: ReadSafe
36955
+ * - **Tags**: Hidden
36956
+ *
36957
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SurfaceAppearance#RoughnessMapContent)
36958
+ */
36959
+ get RoughnessMapContent(): Content;
36701
36960
  }
36702
36961
  /**
36703
36962
  * The `Team` class represents a faction in a Roblox place. The only valid parent for a Team is in the `Teams` service.
@@ -39286,7 +39545,7 @@ interface Translator extends Instance {
39286
39545
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Translator#FormatByKey)
39287
39546
  * @param this The role of a Translator is to manufacture/return strings localized for the viewing player.
39288
39547
  * @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.
39548
+ * @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
39549
  */
39291
39550
  FormatByKey(this: Translator, key: string, args: unknown): string;
39292
39551
  /**
@@ -42257,23 +42516,18 @@ interface VideoPlayer extends Instance {
42257
42516
  Asset: ContentId;
42258
42517
  /**
42259
42518
  * - **ThreadSafety**: ReadSafe
42519
+ * - **Tags**: NotReplicated
42260
42520
  *
42261
- * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VideoPlayer#AutoLoad)
42262
- */
42263
- AutoLoad: boolean;
42264
- /**
42265
- * - **ThreadSafety**: ReadSafe
42266
- *
42267
- * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VideoPlayer#IsPlaying)
42521
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VideoPlayer#IsLoaded)
42268
42522
  */
42269
- get IsPlaying(): boolean;
42523
+ readonly IsLoaded: boolean;
42270
42524
  /**
42271
42525
  * - **ThreadSafety**: ReadSafe
42272
42526
  * - **Tags**: NotReplicated
42273
42527
  *
42274
- * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VideoPlayer#IsReady)
42528
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VideoPlayer#IsPlaying)
42275
42529
  */
42276
- readonly IsReady: boolean;
42530
+ readonly IsPlaying: boolean;
42277
42531
  /**
42278
42532
  * - **ThreadSafety**: ReadSafe
42279
42533
  *
@@ -42293,12 +42547,6 @@ interface VideoPlayer extends Instance {
42293
42547
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VideoPlayer#Resolution)
42294
42548
  */
42295
42549
  readonly Resolution: Vector2;
42296
- /**
42297
- * - **ThreadSafety**: ReadSafe
42298
- *
42299
- * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VideoPlayer#Thumbnail)
42300
- */
42301
- Thumbnail: ContentId;
42302
42550
  /**
42303
42551
  * - **ThreadSafety**: ReadSafe
42304
42552
  * - **Tags**: NotReplicated
@@ -42326,6 +42574,24 @@ interface VideoPlayer extends Instance {
42326
42574
  * @param pin
42327
42575
  */
42328
42576
  GetConnectedWires(this: VideoPlayer, pin: string): Array<Instance>;
42577
+ /**
42578
+ * - **ThreadSafety**: Unsafe
42579
+ *
42580
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VideoPlayer#GetInputPins)
42581
+ */
42582
+ GetInputPins(this: VideoPlayer): Array<unknown>;
42583
+ /**
42584
+ * - **ThreadSafety**: Unsafe
42585
+ *
42586
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VideoPlayer#GetOutputPins)
42587
+ */
42588
+ GetOutputPins(this: VideoPlayer): Array<unknown>;
42589
+ /**
42590
+ * - **ThreadSafety**: Unsafe
42591
+ *
42592
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VideoPlayer#Pause)
42593
+ */
42594
+ Pause(this: VideoPlayer): void;
42329
42595
  /**
42330
42596
  * - **ThreadSafety**: Unsafe
42331
42597
  *
@@ -42336,10 +42602,16 @@ interface VideoPlayer extends Instance {
42336
42602
  /**
42337
42603
  * - **ThreadSafety**: Unsafe
42338
42604
  *
42339
- * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VideoPlayer#Stop)
42340
- * @param this
42605
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VideoPlayer#Unload)
42606
+ */
42607
+ Unload(this: VideoPlayer): void;
42608
+ /**
42609
+ * - **ThreadSafety**: Unsafe
42610
+ * - **Tags**: Yields
42611
+ *
42612
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VideoPlayer#LoadAsync)
42341
42613
  */
42342
- Stop(this: VideoPlayer): void;
42614
+ LoadAsync(this: VideoPlayer): Enum.AssetFetchStatus;
42343
42615
  /**
42344
42616
  * - **ThreadSafety**: Unsafe
42345
42617
  *
@@ -42352,8 +42624,22 @@ interface VideoPlayer extends Instance {
42352
42624
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VideoPlayer#DidLoop)
42353
42625
  */
42354
42626
  readonly DidLoop: RBXScriptSignal<() => void>;
42627
+ /**
42628
+ * - **ThreadSafety**: Unsafe
42629
+ *
42630
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VideoPlayer#PlayFailed)
42631
+ */
42632
+ readonly PlayFailed: RBXScriptSignal<(error: Enum.AssetFetchStatus) => void>;
42633
+ /**
42634
+ * - **ThreadSafety**: Unsafe
42635
+ *
42636
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VideoPlayer#WiringChanged)
42637
+ */
42638
+ readonly WiringChanged: RBXScriptSignal<(connected: boolean, pin: string, wire: Wire, instance: Instance) => void>;
42355
42639
  }
42356
42640
  /**
42641
+ * An internal service that offers no functionality to developers.
42642
+ *
42357
42643
  * - **Tags**: NotCreatable, Service
42358
42644
  *
42359
42645
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VideoService)