@rbxts/types 1.0.859 → 1.0.861

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.
@@ -111,12 +111,14 @@ interface Services {
111
111
  MessageBusService: MessageBusService;
112
112
  MessagingService: MessagingService;
113
113
  MetaBreakpointManager: MetaBreakpointManager;
114
+ MicroProfilerService: MicroProfilerService;
114
115
  MLModelDeliveryService: MLModelDeliveryService;
115
116
  MLService: MLService;
116
- Moderation: Moderation;
117
+ ModerationService: ModerationService;
117
118
  OmniRecommendationsService: OmniRecommendationsService;
118
119
  OpenCloudService: OpenCloudService;
119
120
  PackageUIService: PackageUIService;
121
+ PartyEmulatorService: PartyEmulatorService;
120
122
  PatchBundlerFileWatch: PatchBundlerFileWatch;
121
123
  PathfindingService: PathfindingService;
122
124
  PerformanceControlService: PerformanceControlService;
@@ -161,6 +163,7 @@ interface Services {
161
163
  ServerScriptService: ServerScriptService;
162
164
  ServerStorage: ServerStorage;
163
165
  ServiceVisibilityService: ServiceVisibilityService;
166
+ SessionCheckService: SessionCheckService;
164
167
  SessionService: SessionService;
165
168
  SharedTableRegistry: SharedTableRegistry;
166
169
  SlimContentProvider: SlimContentProvider;
@@ -256,6 +259,7 @@ interface CreatableInstances {
256
259
  AudioFader: AudioFader;
257
260
  AudioFilter: AudioFilter;
258
261
  AudioFlanger: AudioFlanger;
262
+ AudioGate: AudioGate;
259
263
  AudioLimiter: AudioLimiter;
260
264
  AudioListener: AudioListener;
261
265
  AudioPitchShifter: AudioPitchShifter;
@@ -482,6 +486,7 @@ interface CreatableInstances {
482
486
  TremoloSoundEffect: TremoloSoundEffect;
483
487
  TrussPart: TrussPart;
484
488
  UIAspectRatioConstraint: UIAspectRatioConstraint;
489
+ UIContainerQuery: UIContainerQuery;
485
490
  UICorner: UICorner;
486
491
  UIDragDetector: UIDragDetector;
487
492
  UIFlexItem: UIFlexItem;
@@ -607,7 +612,6 @@ interface Instances extends Services, CreatableInstances {
607
612
  LodDataEntity: LodDataEntity;
608
613
  LuaSourceContainer: LuaSourceContainer;
609
614
  ManualSurfaceJointInstance: ManualSurfaceJointInstance;
610
- MaterialGenerationSession: MaterialGenerationSession;
611
615
  MaterialImportData: MaterialImportData;
612
616
  MemoryStoreHashMap: MemoryStoreHashMap;
613
617
  MemoryStoreHashMapPages: MemoryStoreHashMapPages;
@@ -1054,9 +1058,19 @@ interface EditableMesh extends RBXObject {
1054
1058
  */
1055
1059
  SkinningEnabled: boolean;
1056
1060
  /**
1061
+ * Adds a new bone and returns a stable bone ID.
1062
+ *
1057
1063
  * - **ThreadSafety**: Unsafe
1058
1064
  *
1059
1065
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#AddBone)
1066
+ * @param this Instance which allows for the runtime creation and manipulation of meshes.
1067
+ * @param boneProperties Options table containing bone parameters: - `Name` — A string that specifies the bone name. Note that all bone names in a mesh must be unique.
1068
+ * - `ParentId` — Optional bone ID of the new bone's parent.
1069
+ * - `CFrame` — Initial `CFrame` of the bone in the bind pose of the mesh, in the mesh's local space.
1070
+ * - `Virtual` — Boolean that specifies whether this bone is virtual. Virtual bones can only be bound to a `FaceControls` instance.
1071
+ *
1072
+ *
1073
+ * @returns Stable bone ID of the new bone.
1060
1074
  */
1061
1075
  AddBone(this: EditableMesh, boneProperties: object): number;
1062
1076
  /**
@@ -1187,39 +1201,68 @@ interface EditableMesh extends RBXObject {
1187
1201
  */
1188
1202
  GetAdjacentVertices(this: EditableMesh, vertexId: number): Array<number>;
1189
1203
  /**
1204
+ * Finds the bone ID of the bone with the given name.
1205
+ *
1190
1206
  * - **ThreadSafety**: Unsafe
1191
1207
  *
1192
1208
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetBoneByName)
1209
+ * @param this Instance which allows for the runtime creation and manipulation of meshes.
1210
+ * @param boneName Bone name to search for.
1211
+ * @returns Bone ID of the bone with the given name.
1193
1212
  */
1194
1213
  GetBoneByName(this: EditableMesh, boneName: string): number;
1195
1214
  /**
1215
+ * Returns the initial `CFrame` of the bone in the bind pose of the mesh.
1216
+ *
1196
1217
  * - **ThreadSafety**: Unsafe
1197
1218
  *
1198
1219
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetBoneCFrame)
1220
+ * @param this Instance which allows for the runtime creation and manipulation of meshes.
1221
+ * @param boneId Bone ID for which to get the `CFrame`.
1222
+ * @returns Initial `CFrame` of the bone in the bind pose of the mesh, in the mesh's local space.
1199
1223
  */
1200
1224
  GetBoneCFrame(this: EditableMesh, boneId: number): CFrame;
1201
1225
  /**
1226
+ * Returns `true` if the bone is virtual.
1227
+ *
1202
1228
  * - **ThreadSafety**: Unsafe
1203
1229
  *
1204
1230
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetBoneIsVirtual)
1231
+ * @param this Instance which allows for the runtime creation and manipulation of meshes.
1232
+ * @param boneId Bone ID for which to get whether the bone is virtual.
1233
+ * @returns Whether the bone with the given bone ID is virtual. Virtual bones can only be bound to a `FaceControls` instance.
1205
1234
  */
1206
1235
  GetBoneIsVirtual(this: EditableMesh, boneId: number): boolean;
1207
1236
  /**
1237
+ * Returns the bone name.
1238
+ *
1208
1239
  * - **ThreadSafety**: Unsafe
1209
1240
  *
1210
1241
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetBoneName)
1242
+ * @param this Instance which allows for the runtime creation and manipulation of meshes.
1243
+ * @param boneId Bone ID for which to get the name.
1244
+ * @returns Name of the bone with the given bone ID.
1211
1245
  */
1212
1246
  GetBoneName(this: EditableMesh, boneId: number): string;
1213
1247
  /**
1248
+ * Returns the parent bone ID, if any.
1249
+ *
1214
1250
  * - **ThreadSafety**: Unsafe
1215
1251
  *
1216
1252
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetBoneParent)
1253
+ * @param this Instance which allows for the runtime creation and manipulation of meshes.
1254
+ * @param boneId Bone ID for which to get the parent.
1255
+ * @returns Bone ID for the parent of the bone with the given bone ID. If there is no parent, returns `0`.
1217
1256
  */
1218
1257
  GetBoneParent(this: EditableMesh, boneId: number): number;
1219
1258
  /**
1259
+ * Returns all bones of the mesh.
1260
+ *
1220
1261
  * - **ThreadSafety**: Unsafe
1221
1262
  *
1222
1263
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetBones)
1264
+ * @param this Instance which allows for the runtime creation and manipulation of meshes.
1265
+ * @returns List of stable bone IDs.
1223
1266
  */
1224
1267
  GetBones(this: EditableMesh): Array<unknown>;
1225
1268
  /**
@@ -1360,27 +1403,45 @@ interface EditableMesh extends RBXObject {
1360
1403
  */
1361
1404
  GetFacesWithUV(this: EditableMesh, uvId: number): Array<unknown>;
1362
1405
  /**
1406
+ * Returns bone IDs and bone `CFrames` for all bones in a specific FACS corrective pose.
1407
+ *
1363
1408
  * - **ThreadSafety**: Unsafe
1364
1409
  *
1365
1410
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetFacsCorrectivePose)
1411
+ * @param this Instance which allows for the runtime creation and manipulation of meshes.
1412
+ * @param actions Array or 2 or 3 `FacsActionUnit` values that specify a corrective pose.
1413
+ * @returns Array of bone IDs and corresponding array of bone `CFrames`.
1366
1414
  */
1367
1415
  GetFacsCorrectivePose(this: EditableMesh, actions: Array<unknown>): unknown;
1368
1416
  /**
1417
+ * Returns all FACS corrective poses that are in use.
1418
+ *
1369
1419
  * - **ThreadSafety**: Unsafe
1370
1420
  *
1371
1421
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetFacsCorrectivePoses)
1422
+ * @param this Instance which allows for the runtime creation and manipulation of meshes.
1423
+ * @returns Array of corrective poses. Each corrective pose is specified by a small array of 2 or 3 `FacsActionUnit` values.
1372
1424
  */
1373
1425
  GetFacsCorrectivePoses(this: EditableMesh): Array<unknown>;
1374
1426
  /**
1427
+ * Returns bone IDs and bone `CFrames` for all bones in a specific FACS action unit.
1428
+ *
1375
1429
  * - **ThreadSafety**: Unsafe
1376
1430
  *
1377
1431
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetFacsPose)
1432
+ * @param this Instance which allows for the runtime creation and manipulation of meshes.
1433
+ * @param action FACS action unit for which to get the pose.
1434
+ * @returns Array of bone IDs and corresponding array of bone `CFrame`.
1378
1435
  */
1379
1436
  GetFacsPose(this: EditableMesh, action: CastsToEnum<Enum.FacsActionUnit>): unknown;
1380
1437
  /**
1438
+ * Returns all FACS action units that have poses defined.
1439
+ *
1381
1440
  * - **ThreadSafety**: Unsafe
1382
1441
  *
1383
1442
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetFacsPoses)
1443
+ * @param this Instance which allows for the runtime creation and manipulation of meshes.
1444
+ * @returns Array of `FacsActionUnit`, one for each FACS action unit that has a pose defined.
1384
1445
  */
1385
1446
  GetFacsPoses(this: EditableMesh): Array<unknown>;
1386
1447
  /**
@@ -1447,15 +1508,25 @@ interface EditableMesh extends RBXObject {
1447
1508
  */
1448
1509
  GetUVs(this: EditableMesh): Array<unknown>;
1449
1510
  /**
1511
+ * Returns skinning blend weights for each bone that is associated with the vertex.
1512
+ *
1450
1513
  * - **ThreadSafety**: Unsafe
1451
1514
  *
1452
1515
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetVertexBoneWeights)
1516
+ * @param this Instance which allows for the runtime creation and manipulation of meshes.
1517
+ * @param vertexId Vertex ID for which to get the associated bone weights.
1518
+ * @returns Skinning blend weights for each bone that is associated with the vertex.
1453
1519
  */
1454
1520
  GetVertexBoneWeights(this: EditableMesh, vertexId: number): Array<unknown>;
1455
1521
  /**
1522
+ * Returns all bone IDs that are associated with the vertex for skinning.
1523
+ *
1456
1524
  * - **ThreadSafety**: Unsafe
1457
1525
  *
1458
1526
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetVertexBones)
1527
+ * @param this Instance which allows for the runtime creation and manipulation of meshes.
1528
+ * @param vertexId Vertex ID for which to get the associated bones.
1529
+ * @returns Bone IDs associated with the vertex for skinning.
1459
1530
  */
1460
1531
  GetVertexBones(this: EditableMesh, vertexId: number): Array<unknown>;
1461
1532
  /**
@@ -1588,9 +1659,13 @@ interface EditableMesh extends RBXObject {
1588
1659
  Vector3
1589
1660
  ]>;
1590
1661
  /**
1662
+ * Removes a bone using its stable bone ID.
1663
+ *
1591
1664
  * - **ThreadSafety**: Unsafe
1592
1665
  *
1593
1666
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#RemoveBone)
1667
+ * @param this Instance which allows for the runtime creation and manipulation of meshes.
1668
+ * @param boneId
1594
1669
  */
1595
1670
  RemoveBone(this: EditableMesh, boneId: number): void;
1596
1671
  /**
@@ -1624,27 +1699,47 @@ interface EditableMesh extends RBXObject {
1624
1699
  */
1625
1700
  ResetNormal(this: EditableMesh, normalId: number): void;
1626
1701
  /**
1702
+ * Set the initial `CFrame` for a bone in the mesh's bind pose.
1703
+ *
1627
1704
  * - **ThreadSafety**: Unsafe
1628
1705
  *
1629
1706
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#SetBoneCFrame)
1707
+ * @param this Instance which allows for the runtime creation and manipulation of meshes.
1708
+ * @param boneId Bone ID for which to set the initial `CFrame`.
1709
+ * @param cframe Initial `CFrame` for the bone in the mesh's bind pose, in the mesh's local space.
1630
1710
  */
1631
1711
  SetBoneCFrame(this: EditableMesh, boneId: number, cframe: CFrame): void;
1632
1712
  /**
1713
+ * Set whether a bone is virtual.
1714
+ *
1633
1715
  * - **ThreadSafety**: Unsafe
1634
1716
  *
1635
1717
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#SetBoneIsVirtual)
1718
+ * @param this Instance which allows for the runtime creation and manipulation of meshes.
1719
+ * @param boneId Bone ID for which to set whether the bone is virtual.
1720
+ * @param virtual Whether the bone should be virtual.
1636
1721
  */
1637
1722
  SetBoneIsVirtual(this: EditableMesh, boneId: number, virtual: boolean): void;
1638
1723
  /**
1724
+ * Sets the name for a bone.
1725
+ *
1639
1726
  * - **ThreadSafety**: Unsafe
1640
1727
  *
1641
1728
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#SetBoneName)
1729
+ * @param this Instance which allows for the runtime creation and manipulation of meshes.
1730
+ * @param boneId Bone ID for which to set the name.
1731
+ * @param name Bone name to set.
1642
1732
  */
1643
1733
  SetBoneName(this: EditableMesh, boneId: number, name: string): void;
1644
1734
  /**
1735
+ * Set a parent for a bone.
1736
+ *
1645
1737
  * - **ThreadSafety**: Unsafe
1646
1738
  *
1647
1739
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#SetBoneParent)
1740
+ * @param this Instance which allows for the runtime creation and manipulation of meshes.
1741
+ * @param boneId Bone ID for which to set the parent.
1742
+ * @param parentBoneId Parent bone ID.
1648
1743
  */
1649
1744
  SetBoneParent(this: EditableMesh, boneId: number, parentBoneId: number): void;
1650
1745
  /**
@@ -1718,21 +1813,39 @@ interface EditableMesh extends RBXObject {
1718
1813
  */
1719
1814
  SetFaceVertices(this: EditableMesh, faceId: number, ids: Array<unknown>): void;
1720
1815
  /**
1816
+ * Set `CFrame` for an individual bone in a specific FACS action unit.
1817
+ *
1721
1818
  * - **ThreadSafety**: Unsafe
1722
1819
  *
1723
1820
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#SetFacsBonePose)
1821
+ * @param this Instance which allows for the runtime creation and manipulation of meshes.
1822
+ * @param action FACS action unit for which to set the pose.
1823
+ * @param boneId Bone to set a `CFrame` for this pose.
1824
+ * @param cframe `CFrame` which transforms the bone from the initial bone `CFrame` in the bind pose of the mesh to the combined bone `CFrame` for this pose. All `CFrames` are in the mesh's local space.
1724
1825
  */
1725
1826
  SetFacsBonePose(this: EditableMesh, action: CastsToEnum<Enum.FacsActionUnit>, boneId: number, cframe: CFrame): void;
1726
1827
  /**
1828
+ * Set pose for all bones in a specific FACS corrective pose.
1829
+ *
1727
1830
  * - **ThreadSafety**: Unsafe
1728
1831
  *
1729
1832
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#SetFacsCorrectivePose)
1833
+ * @param this Instance which allows for the runtime creation and manipulation of meshes.
1834
+ * @param actions Array or 2 or 3 `FacsActionUnit` values to apply as a corrective pose.
1835
+ * @param boneIds Bones to set a `CFrame` for this pose.
1836
+ * @param cframes `CFrame` transforms for the bones in this corrective pose. Each bone `CFrame` transforms the bone from the initial bone `CFrame` in the bind pose of the mesh to the combined bone `CFrame` for this pose. All `CFrames` are in the mesh's local space.
1730
1837
  */
1731
1838
  SetFacsCorrectivePose(this: EditableMesh, actions: Array<unknown>, boneIds: Array<unknown>, cframes: Array<unknown>): void;
1732
1839
  /**
1840
+ * Set pose for all bones in a specific FACS action unit.
1841
+ *
1733
1842
  * - **ThreadSafety**: Unsafe
1734
1843
  *
1735
1844
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#SetFacsPose)
1845
+ * @param this Instance which allows for the runtime creation and manipulation of meshes.
1846
+ * @param action FACS action unit to set the pose for.
1847
+ * @param boneIds Bones for which to set a `CFrame` for this pose.
1848
+ * @param cframes `CFrame` transforms for the bones in this pose. Each bone `CFrame` transforms the bone from the initial bone `CFrame` in the bind pose of the mesh to the combined bone `CFrame` for this pose. All `CFrames` are in the mesh's local space.
1736
1849
  */
1737
1850
  SetFacsPose(this: EditableMesh, action: CastsToEnum<Enum.FacsActionUnit>, boneIds: Array<unknown>, cframes: Array<unknown>): void;
1738
1851
  /**
@@ -1769,15 +1882,25 @@ interface EditableMesh extends RBXObject {
1769
1882
  */
1770
1883
  SetUV(this: EditableMesh, uvId: number, uv: Vector2): void;
1771
1884
  /**
1885
+ * Sets skinning blend weights for each bone associated with the vertex.
1886
+ *
1772
1887
  * - **ThreadSafety**: Unsafe
1773
1888
  *
1774
1889
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#SetVertexBoneWeights)
1890
+ * @param this Instance which allows for the runtime creation and manipulation of meshes.
1891
+ * @param vertexId Vertex ID on which to set skinning blend weights.
1892
+ * @param boneWeights Skinning blend weights to set on the vertex.
1775
1893
  */
1776
1894
  SetVertexBoneWeights(this: EditableMesh, vertexId: number, boneWeights: Array<unknown>): void;
1777
1895
  /**
1896
+ * Assign a list of bones with the vertex for skinning.
1897
+ *
1778
1898
  * - **ThreadSafety**: Unsafe
1779
1899
  *
1780
1900
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#SetVertexBones)
1901
+ * @param this Instance which allows for the runtime creation and manipulation of meshes.
1902
+ * @param vertexId Vertex ID to set vertex skinning bones.
1903
+ * @param boneIDs Bone IDs to use with this vertex for skinning.
1781
1904
  */
1782
1905
  SetVertexBones(this: EditableMesh, vertexId: number, boneIDs: Array<unknown>): void;
1783
1906
  /**
@@ -3126,7 +3249,7 @@ interface AnimationTrack extends Instance {
3126
3249
  */
3127
3250
  readonly Animation: Animation | undefined;
3128
3251
  /**
3129
- * A read only property that returns true when the `AnimationTrack` is playing.
3252
+ * A read-only property that returns true when the `AnimationTrack` is playing.
3130
3253
  *
3131
3254
  * - **ThreadSafety**: ReadSafe
3132
3255
  * - **Tags**: NotReplicated
@@ -3135,7 +3258,7 @@ interface AnimationTrack extends Instance {
3135
3258
  */
3136
3259
  readonly IsPlaying: boolean;
3137
3260
  /**
3138
- * A read only property that returns the length (in seconds) of an `AnimationTrack`. This will return 0 until the animation has fully loaded and thus may not be immediately available.
3261
+ * A read-only property that returns the length (in seconds) of an `AnimationTrack`. This will return `0` until the animation has fully loaded and thus may not be immediately available.
3139
3262
  *
3140
3263
  * - **ThreadSafety**: ReadSafe
3141
3264
  * - **Tags**: NotReplicated
@@ -3160,7 +3283,7 @@ interface AnimationTrack extends Instance {
3160
3283
  */
3161
3284
  Priority: Enum.AnimationPriority;
3162
3285
  /**
3163
- * The Speed of an `AnimationTrack` is a read only property that gives the current playback speed of the `AnimationTrack`. This has a default value of 1. When speed is equal to 1, the amount of time an animation takes to complete is equal to `AnimationTrack.Length` (in seconds).
3286
+ * Read-only property that gives the current playback speed of the `AnimationTrack`.
3164
3287
  *
3165
3288
  * - **ThreadSafety**: ReadSafe
3166
3289
  * - **Tags**: NotReplicated
@@ -3178,7 +3301,7 @@ interface AnimationTrack extends Instance {
3178
3301
  */
3179
3302
  TimePosition: number;
3180
3303
  /**
3181
- * Read-only property that gives the current weight of the `AnimationTrack`. It has a default value of 1.
3304
+ * Read-only property that gives the current weight of the `AnimationTrack`.
3182
3305
  *
3183
3306
  * - **ThreadSafety**: ReadSafe
3184
3307
  * - **Tags**: NotReplicated
@@ -3196,7 +3319,7 @@ interface AnimationTrack extends Instance {
3196
3319
  */
3197
3320
  readonly WeightTarget: number;
3198
3321
  /**
3199
- * Changes the `AnimationTrack.Speed` of an animation. A positive value for speed plays the animation forward, a negative one plays it backwards, and 0 pauses it.
3322
+ * Changes the `AnimationTrack.Speed` of an animation. A positive value for speed plays the animation forward, a negative one plays it backwards, and `0` pauses it.
3200
3323
  *
3201
3324
  * - **ThreadSafety**: Unsafe
3202
3325
  * - **Tags**: CustomLuaState
@@ -3207,7 +3330,7 @@ interface AnimationTrack extends Instance {
3207
3330
  */
3208
3331
  AdjustSpeed(this: AnimationTrack, speed?: number): void;
3209
3332
  /**
3210
- * Changes the weight of an animation, with the optional fadeTime parameter determining how long it takes for `AnimationTrack.WeightCurrent` to reach `AnimationTrack.WeightTarget`.
3333
+ * Changes the weight of an animation, with the optional `fadeTime` parameter determining how long it takes for `AnimationTrack.WeightCurrent` to reach `AnimationTrack.WeightTarget`.
3211
3334
  *
3212
3335
  * - **ThreadSafety**: Unsafe
3213
3336
  * - **Tags**: CustomLuaState
@@ -3256,7 +3379,7 @@ interface AnimationTrack extends Instance {
3256
3379
  */
3257
3380
  GetTimeOfKeyframe(this: AnimationTrack, keyframeName: string): number;
3258
3381
  /**
3259
- * Plays the `AnimationTrack`. Once called an `AnimationTrack` will play with the specified fadeTime, weight and speed.
3382
+ * Plays the `AnimationTrack`. Once called an `AnimationTrack` will play with the specified `fadeTime`, weight and speed.
3260
3383
  *
3261
3384
  * - **ThreadSafety**: Unsafe
3262
3385
  * - **Tags**: CustomLuaState
@@ -3297,7 +3420,7 @@ interface AnimationTrack extends Instance {
3297
3420
  */
3298
3421
  readonly DidLoop: RBXScriptSignal<() => void>;
3299
3422
  /**
3300
- * Fires when the `AnimationTrack` is completely done moving anything in the world. The animation has finished playing, the "fade out" is finished, and the subject is in a neutral pose.
3423
+ * Fires when the `AnimationTrack` is completely done moving anything in the world.
3301
3424
  *
3302
3425
  * - **ThreadSafety**: Unsafe
3303
3426
  *
@@ -3305,7 +3428,7 @@ interface AnimationTrack extends Instance {
3305
3428
  */
3306
3429
  readonly Ended: RBXScriptSignal<() => void>;
3307
3430
  /**
3308
- * Fires every time playback of an `AnimationTrack` reaches a `Keyframe` that does not have the default name - "Keyframe.".
3431
+ * Fires every time playback of an `AnimationTrack` reaches a `Keyframe` that does not have the default name of `Keyframe`.
3309
3432
  *
3310
3433
  * - **ThreadSafety**: Unsafe
3311
3434
  *
@@ -3337,7 +3460,7 @@ interface Animator extends Instance {
3337
3460
  readonly _nominal_Animator: unique symbol;
3338
3461
  /**
3339
3462
  * - **ThreadSafety**: Safe
3340
- * - **Tags**: NotReplicated, NotBrowsable
3463
+ * - **Tags**: NotReplicated
3341
3464
  *
3342
3465
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Animator#EvaluationThrottled)
3343
3466
  */
@@ -3630,6 +3753,8 @@ interface AssetService extends Instance {
3630
3753
  * - **ThreadSafety**: Unsafe
3631
3754
  *
3632
3755
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AssetService#CreateSurfaceAppearance)
3756
+ * @param this A non-replicated service that handles asset-related queries to the Roblox web API.
3757
+ * @param content
3633
3758
  */
3634
3759
  CreateSurfaceAppearance(this: AssetService, content: object): SurfaceAppearance;
3635
3760
  /**
@@ -5351,6 +5476,69 @@ interface AudioFocusService extends Instance {
5351
5476
  */
5352
5477
  readonly _nominal_AudioFocusService: unique symbol;
5353
5478
  }
5479
+ /**
5480
+ * - **Tags**: NotBrowsable
5481
+ *
5482
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioGate)
5483
+ */
5484
+ interface AudioGate extends Instance {
5485
+ /**
5486
+ * **DO NOT USE!**
5487
+ *
5488
+ * This field exists to force TypeScript to recognize this as a nominal type
5489
+ * @hidden
5490
+ * @deprecated
5491
+ */
5492
+ readonly _nominal_AudioGate: unique symbol;
5493
+ /**
5494
+ * - **ThreadSafety**: ReadSafe
5495
+ *
5496
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioGate#Attack)
5497
+ */
5498
+ Attack: number;
5499
+ /**
5500
+ * - **ThreadSafety**: ReadSafe
5501
+ *
5502
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioGate#Bypass)
5503
+ */
5504
+ Bypass: boolean;
5505
+ /**
5506
+ * - **ThreadSafety**: ReadSafe
5507
+ *
5508
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioGate#Release)
5509
+ */
5510
+ Release: number;
5511
+ /**
5512
+ * - **ThreadSafety**: ReadSafe
5513
+ *
5514
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioGate#Threshold)
5515
+ */
5516
+ Threshold: NumberRange;
5517
+ /**
5518
+ * - **ThreadSafety**: Unsafe
5519
+ *
5520
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioGate#GetConnectedWires)
5521
+ */
5522
+ GetConnectedWires(this: AudioGate, pin: string): Array<Instance>;
5523
+ /**
5524
+ * - **ThreadSafety**: Unsafe
5525
+ *
5526
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioGate#GetInputPins)
5527
+ */
5528
+ GetInputPins(this: AudioGate): Array<unknown>;
5529
+ /**
5530
+ * - **ThreadSafety**: Unsafe
5531
+ *
5532
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioGate#GetOutputPins)
5533
+ */
5534
+ GetOutputPins(this: AudioGate): Array<unknown>;
5535
+ /**
5536
+ * - **ThreadSafety**: Unsafe
5537
+ *
5538
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioGate#WiringChanged)
5539
+ */
5540
+ readonly WiringChanged: RBXScriptSignal<(connected: boolean, pin: string, wire: Wire, instance: Instance) => void>;
5541
+ }
5354
5542
  /**
5355
5543
  * Limits how loud audio streams are allowed to be.
5356
5544
  *
@@ -6207,8 +6395,6 @@ interface AudioSpeechToText extends Instance {
6207
6395
  /**
6208
6396
  * Plays text as speech audio.
6209
6397
  *
6210
- * - **Tags**: NotBrowsable
6211
- *
6212
6398
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioTextToSpeech)
6213
6399
  */
6214
6400
  interface AudioTextToSpeech extends Instance {
@@ -17712,7 +17898,7 @@ interface TextBox extends GuiObject {
17712
17898
  */
17713
17899
  readonly _nominal_TextBox: unique symbol;
17714
17900
  /**
17715
- * Determines whether clicking on the TextBox will clear its `TextBox.Text` property.
17901
+ * Determines whether clicking on the `TextBox` will clear its `TextBox.Text` property.
17716
17902
  *
17717
17903
  * - **ThreadSafety**: ReadSafe
17718
17904
  *
@@ -17781,7 +17967,7 @@ interface TextBox extends GuiObject {
17781
17967
  */
17782
17968
  MaxVisibleGraphemes: number;
17783
17969
  /**
17784
- * When set to true, text inside a TextBox is able to move onto multiple lines. This also enables players to use the enter key to move onto a new line.
17970
+ * When set to `true`, text inside a `TextBox` is able to move onto multiple lines. This also enables players to use the enter key to move onto a new line.
17785
17971
  *
17786
17972
  * - **ThreadSafety**: ReadSafe
17787
17973
  *
@@ -17802,7 +17988,7 @@ interface TextBox extends GuiObject {
17802
17988
  */
17803
17989
  readonly OpenTypeFeaturesError: string;
17804
17990
  /**
17805
- * Sets the text color that gets used when no text has been entered into the TextBox yet.
17991
+ * Sets the text color that gets used when no text has been entered into the `TextBox` yet.
17806
17992
  *
17807
17993
  * - **ThreadSafety**: ReadSafe
17808
17994
  *
@@ -17810,7 +17996,7 @@ interface TextBox extends GuiObject {
17810
17996
  */
17811
17997
  PlaceholderColor3: Color3;
17812
17998
  /**
17813
- * Sets the text that gets displayed when no text has been entered into the TextBox yet.
17999
+ * Sets the text that gets displayed when no text has been entered into the `TextBox` yet.
17814
18000
  *
17815
18001
  * - **ThreadSafety**: ReadSafe
17816
18002
  *
@@ -17818,7 +18004,7 @@ interface TextBox extends GuiObject {
17818
18004
  */
17819
18005
  PlaceholderText: string;
17820
18006
  /**
17821
- * Determines whether the TextBox renders the `TextBox.Text` string using rich text formatting.
18007
+ * Determines whether the `TextBox` renders the `TextBox.Text` string using rich text formatting.
17822
18008
  *
17823
18009
  * - **ThreadSafety**: ReadSafe
17824
18010
  *
@@ -17993,7 +18179,7 @@ interface TextBox extends GuiObject {
17993
18179
  */
17994
18180
  CaptureFocus(this: TextBox): void;
17995
18181
  /**
17996
- * Returns true if the textbox is focused, or false if it is not.
18182
+ * Returns `true` if the `TextBox` is focused or `false` if it is not.
17997
18183
  *
17998
18184
  * - **ThreadSafety**: Unsafe
17999
18185
  *
@@ -20968,6 +21154,8 @@ interface Humanoid extends Instance {
20968
21154
  */
20969
21155
  DisplayName: string;
20970
21156
  /**
21157
+ * Used to disable the internal physics and state machine of the Humanoid.
21158
+ *
20971
21159
  * - **ThreadSafety**: ReadSafe
20972
21160
  *
20973
21161
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Humanoid#EvaluateStateMachine)
@@ -23305,6 +23493,8 @@ interface InputBinding extends Instance {
23305
23493
  */
23306
23494
  readonly _nominal_InputBinding: unique symbol;
23307
23495
  /**
23496
+ * Specifies an alternate `KeyCode` for dispatching directionally "backward" inputs to the parent `InputAction`.
23497
+ *
23308
23498
  * - **ThreadSafety**: ReadSafe
23309
23499
  *
23310
23500
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputBinding#Backward)
@@ -23319,6 +23509,8 @@ interface InputBinding extends Instance {
23319
23509
  */
23320
23510
  Down: Enum.KeyCode;
23321
23511
  /**
23512
+ * Specifies an alternate `KeyCode` for dispatching directionally "forward" inputs to the parent `InputAction`.
23513
+ *
23322
23514
  * - **ThreadSafety**: ReadSafe
23323
23515
  *
23324
23516
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputBinding#Forward)
@@ -23455,7 +23647,7 @@ interface InputObject extends Instance {
23455
23647
  */
23456
23648
  readonly _nominal_InputObject: unique symbol;
23457
23649
  /**
23458
- * A Vector3 describing the Delta between mouse/joystick movements.
23650
+ * A `Vector3` describing the delta between input movements.
23459
23651
  *
23460
23652
  * - **ThreadSafety**: ReadSafe
23461
23653
  *
@@ -23471,7 +23663,7 @@ interface InputObject extends Instance {
23471
23663
  */
23472
23664
  KeyCode: Enum.KeyCode;
23473
23665
  /**
23474
- * Describes a positional value of this input.
23666
+ * A `Vector3` describing the positional value of this input.
23475
23667
  *
23476
23668
  * - **ThreadSafety**: ReadSafe
23477
23669
  *
@@ -23487,7 +23679,7 @@ interface InputObject extends Instance {
23487
23679
  */
23488
23680
  UserInputState: Enum.UserInputState;
23489
23681
  /**
23490
- * Describes the kind of input being performed (mouse, keyboard, gamepad, touch, etc).
23682
+ * Describes the kind of input being performed (mouse, keyboard, gamepad, touch, etc.).
23491
23683
  *
23492
23684
  * - **ThreadSafety**: ReadSafe
23493
23685
  *
@@ -23495,11 +23687,14 @@ interface InputObject extends Instance {
23495
23687
  */
23496
23688
  UserInputType: Enum.UserInputType;
23497
23689
  /**
23690
+ * Returns whether the passed in modifier key is down.
23691
+ *
23498
23692
  * - **ThreadSafety**: Unsafe
23499
23693
  *
23500
23694
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputObject#IsModifierKeyDown)
23501
23695
  * @param this An object created when an input begins that describes a particular user input.
23502
23696
  * @param modifierKey
23697
+ * @returns `true` if the passed in `modifierKey` is being held down; `false` otherwise.
23503
23698
  */
23504
23699
  IsModifierKeyDown(this: InputObject, modifierKey: CastsToEnum<Enum.ModifierKey>): boolean;
23505
23700
  }
@@ -25868,6 +26063,15 @@ interface MarketplaceService extends Instance {
25868
26063
  * @param subscriptionId The ID of the subscription to check for.
25869
26064
  */
25870
26065
  GetUserSubscriptionStatusAsync(this: MarketplaceService, user: Player, subscriptionId: string): UserSubscriptionStatus;
26066
+ /**
26067
+ * - **ThreadSafety**: Unsafe
26068
+ * - **Tags**: Yields
26069
+ *
26070
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MarketplaceService#GetUsersPriceLevelsAsync)
26071
+ * @param this The service responsible for in-experience transactions.
26072
+ * @param userIds
26073
+ */
26074
+ GetUsersPriceLevelsAsync(this: MarketplaceService, userIds: Array<unknown>): Array<unknown>;
25871
26075
  /**
25872
26076
  * Returns whether the given user has the given asset.
25873
26077
  *
@@ -26049,21 +26253,6 @@ interface MaterialGenerationService extends Instance {
26049
26253
  */
26050
26254
  readonly _nominal_MaterialGenerationService: unique symbol;
26051
26255
  }
26052
- /**
26053
- * - **Tags**: NotCreatable, NotReplicated
26054
- *
26055
- * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MaterialGenerationSession)
26056
- */
26057
- interface MaterialGenerationSession extends Instance {
26058
- /**
26059
- * **DO NOT USE!**
26060
- *
26061
- * This field exists to force TypeScript to recognize this as a nominal type
26062
- * @hidden
26063
- * @deprecated
26064
- */
26065
- readonly _nominal_MaterialGenerationSession: unique symbol;
26066
- }
26067
26256
  /**
26068
26257
  * The game service responsible for managing materials.
26069
26258
  *
@@ -26589,9 +26778,24 @@ interface MetaBreakpointManager extends Instance {
26589
26778
  /**
26590
26779
  * - **Tags**: NotCreatable, Service, NotReplicated
26591
26780
  *
26592
- * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Moderation)
26781
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MicroProfilerService)
26782
+ */
26783
+ interface MicroProfilerService extends Instance {
26784
+ /**
26785
+ * **DO NOT USE!**
26786
+ *
26787
+ * This field exists to force TypeScript to recognize this as a nominal type
26788
+ * @hidden
26789
+ * @deprecated
26790
+ */
26791
+ readonly _nominal_MicroProfilerService: unique symbol;
26792
+ }
26793
+ /**
26794
+ * - **Tags**: NotCreatable, Service, NotReplicated
26795
+ *
26796
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ModerationService)
26593
26797
  */
26594
- interface Moderation extends Instance {
26798
+ interface ModerationService extends Instance {
26595
26799
  /**
26596
26800
  * **DO NOT USE!**
26597
26801
  *
@@ -26599,29 +26803,29 @@ interface Moderation extends Instance {
26599
26803
  * @hidden
26600
26804
  * @deprecated
26601
26805
  */
26602
- readonly _nominal_Moderation: unique symbol;
26806
+ readonly _nominal_ModerationService: unique symbol;
26603
26807
  /**
26604
26808
  * - **ThreadSafety**: Unsafe
26605
26809
  * - **Tags**: Yields
26606
26810
  *
26607
- * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Moderation#InternalCreateReviewableContentAsync)
26811
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ModerationService#InternalCreateReviewableContentAsync)
26608
26812
  * @param this
26609
26813
  * @param config
26610
26814
  */
26611
- InternalCreateReviewableContentAsync(this: Moderation, config: object): string;
26815
+ InternalCreateReviewableContentAsync(this: ModerationService, config: object): string;
26612
26816
  /**
26613
26817
  * - **ThreadSafety**: Unsafe
26614
26818
  * - **Tags**: Yields
26615
26819
  *
26616
- * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Moderation#InternalRequestReviewableContentReviewAsync)
26820
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ModerationService#InternalRequestReviewableContentReviewAsync)
26617
26821
  * @param this
26618
26822
  * @param config
26619
26823
  */
26620
- InternalRequestReviewableContentReviewAsync(this: Moderation, config: object): void;
26824
+ InternalRequestReviewableContentReviewAsync(this: ModerationService, config: object): void;
26621
26825
  /**
26622
26826
  * - **ThreadSafety**: Unsafe
26623
26827
  *
26624
- * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Moderation#InternalProcessReviewableContentEvent)
26828
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ModerationService#InternalProcessReviewableContentEvent)
26625
26829
  * @param event
26626
26830
  */
26627
26831
  InternalProcessReviewableContentEvent: ((event: object) => boolean) | undefined;
@@ -30098,7 +30302,7 @@ interface Tool extends BackpackItem {
30098
30302
  */
30099
30303
  GripUp: Vector3;
30100
30304
  /**
30101
- * The ManualActivationOnly property controls whether the `Tool` can be activated without executing `Tool:Activate()`.
30305
+ * Controls whether the `Tool` can be activated without executing `Tool:Activate()`.
30102
30306
  *
30103
30307
  * - **ThreadSafety**: ReadSafe
30104
30308
  *
@@ -31374,6 +31578,21 @@ interface ParticleEmitter extends Instance {
31374
31578
  */
31375
31579
  readonly OnEmitRequested: RBXScriptSignal<(particleCount: number) => void>;
31376
31580
  }
31581
+ /**
31582
+ * - **Tags**: NotCreatable, Service, NotReplicated
31583
+ *
31584
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PartyEmulatorService)
31585
+ */
31586
+ interface PartyEmulatorService extends Instance {
31587
+ /**
31588
+ * **DO NOT USE!**
31589
+ *
31590
+ * This field exists to force TypeScript to recognize this as a nominal type
31591
+ * @hidden
31592
+ * @deprecated
31593
+ */
31594
+ readonly _nominal_PartyEmulatorService: unique symbol;
31595
+ }
31377
31596
  /**
31378
31597
  * - **Tags**: NotCreatable, Service, NotReplicated
31379
31598
  *
@@ -32018,7 +32237,7 @@ interface PlatformFriendsService extends Instance {
32018
32237
  readonly _nominal_PlatformFriendsService: unique symbol;
32019
32238
  }
32020
32239
  /**
32021
- * An object that represents a presently connected client to the game.
32240
+ * An object that represents a presently connected client to the experience.
32022
32241
  *
32023
32242
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player)
32024
32243
  */
@@ -32073,7 +32292,7 @@ interface Player extends Instance {
32073
32292
  */
32074
32293
  CameraMode: Enum.CameraMode;
32075
32294
  /**
32076
- * Determines whether the character's appearance will be loaded when the player spawns. If false, the player will spawn with a default appearance.
32295
+ * Determines whether the character's appearance will be loaded when the player spawns. If `false`, the player will spawn with a default appearance.
32077
32296
  *
32078
32297
  * - **ThreadSafety**: ReadSafe
32079
32298
  *
@@ -32102,7 +32321,7 @@ interface Player extends Instance {
32102
32321
  */
32103
32322
  CharacterAppearance: string;
32104
32323
  /**
32105
- * Determines the user ID of the account whose character appearance is used for a player's `character`.
32324
+ * Determines the user ID of the account whose character appearance is used for a player's `Character`.
32106
32325
  *
32107
32326
  * - **ThreadSafety**: ReadSafe
32108
32327
  *
@@ -32144,7 +32363,7 @@ interface Player extends Instance {
32144
32363
  */
32145
32364
  DevCameraOcclusionMode: Enum.DevCameraOcclusionMode;
32146
32365
  /**
32147
- * Determines player's camera movement mode when using a desktop version of Roblox.
32366
+ * Determines player's camera movement mode when using a device with a mouse and keyboard.
32148
32367
  *
32149
32368
  * - **ThreadSafety**: ReadSafe
32150
32369
  *
@@ -32152,7 +32371,7 @@ interface Player extends Instance {
32152
32371
  */
32153
32372
  DevComputerCameraMode: Enum.DevComputerCameraMovementMode;
32154
32373
  /**
32155
- * Determines player's character movement mode when using a desktop version of Roblox.
32374
+ * Determines player's character movement mode when using a device with a mouse and keyboard.
32156
32375
  *
32157
32376
  * - **ThreadSafety**: ReadSafe
32158
32377
  *
@@ -32168,7 +32387,7 @@ interface Player extends Instance {
32168
32387
  */
32169
32388
  DevEnableMouseLock: boolean;
32170
32389
  /**
32171
- * Determines player's camera movement mode when using a touch device.
32390
+ * Determines player's camera movement mode when using a touch-enabled device.
32172
32391
  *
32173
32392
  * - **ThreadSafety**: ReadSafe
32174
32393
  *
@@ -32176,7 +32395,7 @@ interface Player extends Instance {
32176
32395
  */
32177
32396
  DevTouchCameraMode: Enum.DevTouchCameraMovementMode;
32178
32397
  /**
32179
- * Determines player's character movement mode when using a touch device.
32398
+ * Determines player's character movement mode when using a touch-enabled device.
32180
32399
  *
32181
32400
  * - **ThreadSafety**: ReadSafe
32182
32401
  *
@@ -32184,7 +32403,7 @@ interface Player extends Instance {
32184
32403
  */
32185
32404
  DevTouchMovementMode: Enum.DevTouchMovementMode;
32186
32405
  /**
32187
- * The DisplayName of the UserId associated with the Player.
32406
+ * The display name of the authenticated user associated with the `Player`.
32188
32407
  *
32189
32408
  * - **ThreadSafety**: ReadSafe
32190
32409
  *
@@ -32192,7 +32411,7 @@ interface Player extends Instance {
32192
32411
  */
32193
32412
  DisplayName: string;
32194
32413
  /**
32195
- * Describes the user ID of the player who was followed into a game by a player.
32414
+ * Describes the user ID of the player who was followed into an experience by a player.
32196
32415
  *
32197
32416
  * - **ThreadSafety**: ReadSafe
32198
32417
  * - **Tags**: NotReplicated
@@ -32209,7 +32428,7 @@ interface Player extends Instance {
32209
32428
  */
32210
32429
  get GameplayPaused(): boolean;
32211
32430
  /**
32212
- * Indicates if a player has a Verified Badge.
32431
+ * Indicates if a player has a **Verified** badge.
32213
32432
  *
32214
32433
  * - **ThreadSafety**: ReadSafe
32215
32434
  *
@@ -32217,7 +32436,7 @@ interface Player extends Instance {
32217
32436
  */
32218
32437
  HasVerifiedBadge: boolean;
32219
32438
  /**
32220
- * Sets the distance at which this player will see other Humanoid's health bars. If set to 0, the health bars will not be displayed.
32439
+ * Sets the distance at which this player will see other players' health bars.
32221
32440
  *
32222
32441
  * - **ThreadSafety**: ReadSafe
32223
32442
  *
@@ -32225,7 +32444,7 @@ interface Player extends Instance {
32225
32444
  */
32226
32445
  HealthDisplayDistance: number;
32227
32446
  /**
32228
- * This property shows the locale id that the local player has set for their Roblox account.
32447
+ * This property shows the locale ID that the local player has set for their Roblox account.
32229
32448
  *
32230
32449
  * - **ThreadSafety**: ReadSafe
32231
32450
  * - **Tags**: Hidden, NotReplicated
@@ -32243,7 +32462,7 @@ interface Player extends Instance {
32243
32462
  */
32244
32463
  readonly MembershipType: Enum.MembershipType;
32245
32464
  /**
32246
- * Sets the distance at which this player will see other Humanoid's names. If set to 0, names are hidden.
32465
+ * Sets the distance at which this player will see other players' names.
32247
32466
  *
32248
32467
  * - **ThreadSafety**: ReadSafe
32249
32468
  *
@@ -32284,7 +32503,7 @@ interface Player extends Instance {
32284
32503
  */
32285
32504
  RespawnLocation: SpawnLocation | undefined;
32286
32505
  /**
32287
- * Determines the Team with which a Player is associated.
32506
+ * Determines the `Team` with which the player is associated.
32288
32507
  *
32289
32508
  * - **ThreadSafety**: ReadSafe
32290
32509
  * - **Tags**: NotReplicated
@@ -32293,7 +32512,7 @@ interface Player extends Instance {
32293
32512
  */
32294
32513
  Team: Team | undefined;
32295
32514
  /**
32296
- * Determines the Team with which a Player is associated.
32515
+ * Determines the `Team` with which the player is associated with according to that team's `Team.TeamColor`.
32297
32516
  *
32298
32517
  * - **ThreadSafety**: ReadSafe
32299
32518
  *
@@ -32312,26 +32531,26 @@ interface Player extends Instance {
32312
32531
  * - **ThreadSafety**: Unsafe
32313
32532
  *
32314
32533
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#AddReplicationFocus)
32315
- * @param this An object that represents a presently connected client to the game.
32534
+ * @param this An object that represents a presently connected client to the experience.
32316
32535
  * @param part
32317
32536
  */
32318
32537
  AddReplicationFocus(this: Player, part: BasePart): void;
32319
32538
  /**
32320
- * Removes all accessories and other character appearance objects from a player's Character.
32539
+ * Removes all accessories and other character appearance objects from a player's `Character`.
32321
32540
  *
32322
32541
  * - **ThreadSafety**: Unsafe
32323
32542
  *
32324
32543
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#ClearCharacterAppearance)
32325
- * @param this An object that represents a presently connected client to the game.
32544
+ * @param this An object that represents a presently connected client to the experience.
32326
32545
  */
32327
32546
  ClearCharacterAppearance(this: Player): void;
32328
32547
  /**
32329
- * Returns the distance between the character's head and the given Vector3 point. Returns 0 if the player has no character.
32548
+ * Returns the distance between the character's head and the given `Vector3`, or `0` if the player has no character.
32330
32549
  *
32331
32550
  * - **ThreadSafety**: Unsafe
32332
32551
  *
32333
32552
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#DistanceFromCharacter)
32334
- * @param this An object that represents a presently connected client to the game.
32553
+ * @param this An object that represents a presently connected client to the experience.
32335
32554
  * @param point The location from which player's distance to is being measured.
32336
32555
  * @returns The distance in studs between the player and the location.
32337
32556
  */
@@ -32343,13 +32562,13 @@ interface Player extends Instance {
32343
32562
  */
32344
32563
  GetData(this: Player): PlayerData;
32345
32564
  /**
32346
- * Returns a dictionary containing information describing how the `Player` joins the experience.
32565
+ * Returns a dictionary containing information describing how the player joins the experience.
32347
32566
  *
32348
32567
  * - **ThreadSafety**: Unsafe
32349
32568
  * - **Tags**: CustomLuaState
32350
32569
  *
32351
32570
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#GetJoinData)
32352
- * @param this An object that represents a presently connected client to the game.
32571
+ * @param this An object that represents a presently connected client to the experience.
32353
32572
  * @returns A dictionary containing PlaceId and UserId values (see table in description).
32354
32573
  */
32355
32574
  GetJoinData(this: Player): PlayerJoinInfo;
@@ -32359,7 +32578,7 @@ interface Player extends Instance {
32359
32578
  * - **ThreadSafety**: Unsafe
32360
32579
  *
32361
32580
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#GetMouse)
32362
- * @param this An object that represents a presently connected client to the game.
32581
+ * @param this An object that represents a presently connected client to the experience.
32363
32582
  */
32364
32583
  GetMouse(this: Player): PlayerMouse;
32365
32584
  /**
@@ -32368,7 +32587,7 @@ interface Player extends Instance {
32368
32587
  * - **ThreadSafety**: Safe
32369
32588
  *
32370
32589
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#GetNetworkPing)
32371
- * @param this An object that represents a presently connected client to the game.
32590
+ * @param this An object that represents a presently connected client to the experience.
32372
32591
  */
32373
32592
  GetNetworkPing(this: Player): number;
32374
32593
  /**
@@ -32377,7 +32596,7 @@ interface Player extends Instance {
32377
32596
  * - **ThreadSafety**: Unsafe
32378
32597
  *
32379
32598
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#HasAppearanceLoaded)
32380
- * @param this An object that represents a presently connected client to the game.
32599
+ * @param this An object that represents a presently connected client to the experience.
32381
32600
  * @returns A boolean indicating whether or not the appearance of the player's character has loaded.
32382
32601
  */
32383
32602
  HasAppearanceLoaded(this: Player): boolean;
@@ -32387,17 +32606,17 @@ interface Player extends Instance {
32387
32606
  * - **ThreadSafety**: Unsafe
32388
32607
  *
32389
32608
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#IsVerified)
32390
- * @param this An object that represents a presently connected client to the game.
32609
+ * @param this An object that represents a presently connected client to the experience.
32391
32610
  * @returns A boolean indicating whether the player is verified.
32392
32611
  */
32393
32612
  IsVerified(this: Player): boolean;
32394
32613
  /**
32395
- * Forcibly disconnect a player from the game, optionally providing a message.
32614
+ * Forcibly disconnect a player from the experience, optionally providing a message.
32396
32615
  *
32397
32616
  * - **ThreadSafety**: Unsafe
32398
32617
  *
32399
32618
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#Kick)
32400
- * @param this An object that represents a presently connected client to the game.
32619
+ * @param this An object that represents a presently connected client to the experience.
32401
32620
  * @param message The message to show the user upon kicking.
32402
32621
  */
32403
32622
  Kick(this: Player, message?: string): void;
@@ -32410,7 +32629,7 @@ interface Player extends Instance {
32410
32629
  * - **Tags**:
32411
32630
  *
32412
32631
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#LoadBoolean)
32413
- * @param this An object that represents a presently connected client to the game.
32632
+ * @param this An object that represents a presently connected client to the experience.
32414
32633
  * @param key
32415
32634
  *
32416
32635
  * @deprecated
@@ -32425,7 +32644,7 @@ interface Player extends Instance {
32425
32644
  * - **Tags**:
32426
32645
  *
32427
32646
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#LoadCharacterAppearance)
32428
- * @param this An object that represents a presently connected client to the game.
32647
+ * @param this An object that represents a presently connected client to the experience.
32429
32648
  * @param assetInstance An instance of the asset being loaded, which can be obtained using the `InsertService:LoadAsset()` function.
32430
32649
  *
32431
32650
  * @deprecated
@@ -32440,7 +32659,7 @@ interface Player extends Instance {
32440
32659
  * - **Tags**:
32441
32660
  *
32442
32661
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#LoadInstance)
32443
- * @param this An object that represents a presently connected client to the game.
32662
+ * @param this An object that represents a presently connected client to the experience.
32444
32663
  * @param key
32445
32664
  *
32446
32665
  * @deprecated
@@ -32455,7 +32674,7 @@ interface Player extends Instance {
32455
32674
  * - **Tags**:
32456
32675
  *
32457
32676
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#LoadNumber)
32458
- * @param this An object that represents a presently connected client to the game.
32677
+ * @param this An object that represents a presently connected client to the experience.
32459
32678
  * @param key
32460
32679
  *
32461
32680
  * @deprecated
@@ -32470,7 +32689,7 @@ interface Player extends Instance {
32470
32689
  * - **Tags**:
32471
32690
  *
32472
32691
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#LoadString)
32473
- * @param this An object that represents a presently connected client to the game.
32692
+ * @param this An object that represents a presently connected client to the experience.
32474
32693
  * @param key
32475
32694
  *
32476
32695
  * @deprecated
@@ -32482,7 +32701,7 @@ interface Player extends Instance {
32482
32701
  * - **ThreadSafety**: Unsafe
32483
32702
  *
32484
32703
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#Move)
32485
- * @param this An object that represents a presently connected client to the game.
32704
+ * @param this An object that represents a presently connected client to the experience.
32486
32705
  * @param walkDirection The Vector3 direction that the player should move.
32487
32706
  * @param relativeToCamera A boolean indicating whether the player should move relative to the player's camera.
32488
32707
  */
@@ -32491,7 +32710,7 @@ interface Player extends Instance {
32491
32710
  * - **ThreadSafety**: Unsafe
32492
32711
  *
32493
32712
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#RemoveReplicationFocus)
32494
- * @param this An object that represents a presently connected client to the game.
32713
+ * @param this An object that represents a presently connected client to the experience.
32495
32714
  * @param part
32496
32715
  */
32497
32716
  RemoveReplicationFocus(this: Player, part: BasePart): void;
@@ -32504,7 +32723,7 @@ interface Player extends Instance {
32504
32723
  * - **Tags**:
32505
32724
  *
32506
32725
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#SaveBoolean)
32507
- * @param this An object that represents a presently connected client to the game.
32726
+ * @param this An object that represents a presently connected client to the experience.
32508
32727
  * @param key
32509
32728
  * @param value
32510
32729
  *
@@ -32520,7 +32739,7 @@ interface Player extends Instance {
32520
32739
  * - **Tags**:
32521
32740
  *
32522
32741
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#SaveInstance)
32523
- * @param this An object that represents a presently connected client to the game.
32742
+ * @param this An object that represents a presently connected client to the experience.
32524
32743
  * @param key
32525
32744
  * @param value
32526
32745
  *
@@ -32536,7 +32755,7 @@ interface Player extends Instance {
32536
32755
  * - **Tags**:
32537
32756
  *
32538
32757
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#SaveNumber)
32539
- * @param this An object that represents a presently connected client to the game.
32758
+ * @param this An object that represents a presently connected client to the experience.
32540
32759
  * @param key
32541
32760
  * @param value
32542
32761
  *
@@ -32552,7 +32771,7 @@ interface Player extends Instance {
32552
32771
  * - **Tags**:
32553
32772
  *
32554
32773
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#SaveString)
32555
- * @param this An object that represents a presently connected client to the game.
32774
+ * @param this An object that represents a presently connected client to the experience.
32556
32775
  * @param key
32557
32776
  * @param value
32558
32777
  *
@@ -32566,33 +32785,33 @@ interface Player extends Instance {
32566
32785
  * - **Tags**: Yields
32567
32786
  *
32568
32787
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#GetFriendsOnline)
32569
- * @param this An object that represents a presently connected client to the game.
32788
+ * @param this An object that represents a presently connected client to the experience.
32570
32789
  * @param maxFriends The maximum number of online friends to return.
32571
32790
  * @returns A dictionary of online friends (see the table above).
32572
32791
  */
32573
32792
  GetFriendsOnline(this: Player, maxFriends?: number): Array<FriendOnlineInfo>;
32574
32793
  /**
32575
- * Returns the player's rank in the group as an integer between 0 and 255, where 0 is a non-member and 255 is the group's owner.
32794
+ * Returns the player's rank in the group as an integer.
32576
32795
  *
32577
32796
  * - **ThreadSafety**: Unsafe
32578
32797
  * - **Tags**: Yields
32579
32798
  *
32580
32799
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#GetRankInGroup)
32581
- * @param this An object that represents a presently connected client to the game.
32800
+ * @param this An object that represents a presently connected client to the experience.
32582
32801
  * @param groupId The `groupId` of the specified group.
32583
32802
  * @returns The player's rank in the group.
32584
32803
  */
32585
32804
  GetRankInGroup(this: Player, groupId: number): number;
32586
32805
  /**
32587
- * Returns the player's role in the group as a string, or "Guest" if the player isn't part of the group.
32806
+ * Returns the player's role in the group as a string, or `Guest` if the player isn't part of the group.
32588
32807
  *
32589
32808
  * - **ThreadSafety**: Unsafe
32590
32809
  * - **Tags**: Yields
32591
32810
  *
32592
32811
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#GetRoleInGroup)
32593
- * @param this An object that represents a presently connected client to the game.
32594
- * @param groupId The *groupId* of the specified group.
32595
- * @returns The player's role in the specified group, or *Guest* if the player is not a member.
32812
+ * @param this An object that represents a presently connected client to the experience.
32813
+ * @param groupId The group ID of the specified group.
32814
+ * @returns The player's role in the specified group, or `Guest` if the player is not a member.
32596
32815
  */
32597
32816
  GetRoleInGroup(this: Player, groupId: number): string;
32598
32817
  /**
@@ -32604,7 +32823,7 @@ interface Player extends Instance {
32604
32823
  * - **Tags**: Yields
32605
32824
  *
32606
32825
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#IsBestFriendsWith)
32607
- * @param this An object that represents a presently connected client to the game.
32826
+ * @param this An object that represents a presently connected client to the experience.
32608
32827
  * @param userId
32609
32828
  *
32610
32829
  * @deprecated
@@ -32617,7 +32836,7 @@ interface Player extends Instance {
32617
32836
  * - **Tags**: Yields
32618
32837
  *
32619
32838
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#IsFriendsWith)
32620
- * @param this An object that represents a presently connected client to the game.
32839
+ * @param this An object that represents a presently connected client to the experience.
32621
32840
  * @param userId The `Player.UserId` of the specified player.
32622
32841
  * @returns A boolean indicating whether a player is a friend of the specified user.
32623
32842
  */
@@ -32629,8 +32848,8 @@ interface Player extends Instance {
32629
32848
  * - **Tags**: Yields
32630
32849
  *
32631
32850
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#IsInGroup)
32632
- * @param this An object that represents a presently connected client to the game.
32633
- * @param groupId The *groupId* of the specified group.
32851
+ * @param this An object that represents a presently connected client to the experience.
32852
+ * @param groupId The group ID of the specified group.
32634
32853
  * @returns A boolean indicating whether the player is in the specified group.
32635
32854
  */
32636
32855
  IsInGroup(this: Player, groupId: number): boolean;
@@ -32641,17 +32860,17 @@ interface Player extends Instance {
32641
32860
  * - **Tags**: Yields
32642
32861
  *
32643
32862
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#LoadCharacter)
32644
- * @param this An object that represents a presently connected client to the game.
32863
+ * @param this An object that represents a presently connected client to the experience.
32645
32864
  */
32646
32865
  LoadCharacter(this: Player): void;
32647
32866
  /**
32648
- * Spawns an avatar so it has everything equipped in the passed in `HumanoidDescription`.
32867
+ * Spawns a player character with everything equipped in the passed in `HumanoidDescription`.
32649
32868
  *
32650
32869
  * - **ThreadSafety**: Unsafe
32651
32870
  * - **Tags**: Yields
32652
32871
  *
32653
32872
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#LoadCharacterWithHumanoidDescription)
32654
- * @param this An object that represents a presently connected client to the game.
32873
+ * @param this An object that represents a presently connected client to the experience.
32655
32874
  * @param humanoidDescription A `HumanoidDescription` containing traits like body parts/colors, body scaling, accessories, clothing, and animations that will be equipped to the loaded character.
32656
32875
  */
32657
32876
  LoadCharacterWithHumanoidDescription(this: Player, humanoidDescription: HumanoidDescription): void;
@@ -32662,7 +32881,7 @@ interface Player extends Instance {
32662
32881
  * - **Tags**: Yields
32663
32882
  *
32664
32883
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#RequestStreamAroundAsync)
32665
- * @param this An object that represents a presently connected client to the game.
32884
+ * @param this An object that represents a presently connected client to the experience.
32666
32885
  * @param position World location where streaming is requested.
32667
32886
  * @param timeOut Optional timeout for the request, the maximum duration that the engine attempts to stream regions around the `position` parameter before abandoning the request. If you don't specify a value, the timeout is effectively infinite. However, if the client is low on memory, the engine abandons all streaming requests, even those that are still within the timeout duration.
32668
32887
  */
@@ -32676,13 +32895,13 @@ interface Player extends Instance {
32676
32895
  * - **Tags**: Yields
32677
32896
  *
32678
32897
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#WaitForDataReady)
32679
- * @param this An object that represents a presently connected client to the game.
32898
+ * @param this An object that represents a presently connected client to the experience.
32680
32899
  *
32681
32900
  * @deprecated
32682
32901
  */
32683
32902
  WaitForDataReady(this: Player): boolean;
32684
32903
  /**
32685
- * Fired when a player's character spawns or respawns.
32904
+ * Fires when a player's character spawns or respawns.
32686
32905
  *
32687
32906
  * - **ThreadSafety**: Unsafe
32688
32907
  *
@@ -32690,7 +32909,7 @@ interface Player extends Instance {
32690
32909
  */
32691
32910
  readonly CharacterAdded: RBXScriptSignal<(character: Model) => void>;
32692
32911
  /**
32693
- * Fires when the full appearance of a `Player.Character` has been inserted.
32912
+ * Fires when the full appearance of a `Character` has been inserted.
32694
32913
  *
32695
32914
  * - **ThreadSafety**: Unsafe
32696
32915
  *
@@ -32698,7 +32917,7 @@ interface Player extends Instance {
32698
32917
  */
32699
32918
  readonly CharacterAppearanceLoaded: RBXScriptSignal<(character: Model) => void>;
32700
32919
  /**
32701
- * Fired right before a player's character is removed.
32920
+ * Fires right before a player's character is removed.
32702
32921
  *
32703
32922
  * - **ThreadSafety**: Unsafe
32704
32923
  *
@@ -32706,7 +32925,7 @@ interface Player extends Instance {
32706
32925
  */
32707
32926
  readonly CharacterRemoving: RBXScriptSignal<(character: Model) => void>;
32708
32927
  /**
32709
- * Fires when a player chats in-game using Roblox's provided chat bar.
32928
+ * Fires when a player chats in experience using Roblox's provided chat bar.
32710
32929
  *
32711
32930
  * - **ThreadSafety**: Unsafe
32712
32931
  *
@@ -32714,7 +32933,7 @@ interface Player extends Instance {
32714
32933
  */
32715
32934
  readonly Chatted: RBXScriptSignal<(message: string, recipient?: Player) => void>;
32716
32935
  /**
32717
- * This event fires approximately two minutes after the game engine classifies the `player` as idle. Time is the number of seconds that have elapsed since that point.
32936
+ * This event fires approximately two minutes after the engine classifies the player as idle. Time is the number of seconds that have elapsed since that point.
32718
32937
  *
32719
32938
  * - **ThreadSafety**: Unsafe
32720
32939
  *
@@ -32722,7 +32941,7 @@ interface Player extends Instance {
32722
32941
  */
32723
32942
  readonly Idled: RBXScriptSignal<(time: number) => void>;
32724
32943
  /**
32725
- * Fired when the TeleportState of a player changes.
32944
+ * Fires when the teleport state of a player changes.
32726
32945
  *
32727
32946
  * - **ThreadSafety**: Unsafe
32728
32947
  *
@@ -34284,12 +34503,22 @@ interface RecommendationService extends Instance {
34284
34503
  * - **ThreadSafety**: Unsafe
34285
34504
  *
34286
34505
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RecommendationService#LogActionEvent)
34506
+ * @param this
34507
+ * @param actionType
34508
+ * @param itemId
34509
+ * @param tracingId
34510
+ * @param actionEventDetails
34287
34511
  */
34288
34512
  LogActionEvent(this: RecommendationService, actionType: CastsToEnum<Enum.RecommendationActionType>, itemId: string, tracingId: string, actionEventDetails?: object): void;
34289
34513
  /**
34290
34514
  * - **ThreadSafety**: Unsafe
34291
34515
  *
34292
34516
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RecommendationService#LogImpressionEvent)
34517
+ * @param this
34518
+ * @param impressionType
34519
+ * @param itemId
34520
+ * @param tracingId
34521
+ * @param impressionEventDetails
34293
34522
  */
34294
34523
  LogImpressionEvent(this: RecommendationService, impressionType: CastsToEnum<Enum.RecommendationImpressionType>, itemId: string, tracingId: string, impressionEventDetails?: object): void;
34295
34524
  /**
@@ -34297,6 +34526,8 @@ interface RecommendationService extends Instance {
34297
34526
  * - **Tags**: Yields
34298
34527
  *
34299
34528
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RecommendationService#GenerateItemListAsync)
34529
+ * @param this
34530
+ * @param generateRecommendationItemListRequest
34300
34531
  */
34301
34532
  GenerateItemListAsync(this: RecommendationService, generateRecommendationItemListRequest: object): RecommendationPages;
34302
34533
  /**
@@ -34304,6 +34535,8 @@ interface RecommendationService extends Instance {
34304
34535
  * - **Tags**: Yields
34305
34536
  *
34306
34537
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RecommendationService#RegisterItemAsync)
34538
+ * @param this
34539
+ * @param registerRecommendationItemsRequest
34307
34540
  */
34308
34541
  RegisterItemAsync(this: RecommendationService, registerRecommendationItemsRequest: object): object;
34309
34542
  /**
@@ -34311,6 +34544,8 @@ interface RecommendationService extends Instance {
34311
34544
  * - **Tags**: Yields
34312
34545
  *
34313
34546
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RecommendationService#RemoveItemAsync)
34547
+ * @param this
34548
+ * @param itemId
34314
34549
  */
34315
34550
  RemoveItemAsync(this: RecommendationService, itemId: string): void;
34316
34551
  /**
@@ -34318,6 +34553,8 @@ interface RecommendationService extends Instance {
34318
34553
  * - **Tags**: Yields
34319
34554
  *
34320
34555
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RecommendationService#UpdateItemAsync)
34556
+ * @param this
34557
+ * @param updateRecommendationItemRequest
34321
34558
  */
34322
34559
  UpdateItemAsync(this: RecommendationService, updateRecommendationItemRequest: object): void;
34323
34560
  }
@@ -35921,6 +36158,21 @@ interface ServiceVisibilityService extends Instance {
35921
36158
  */
35922
36159
  readonly _nominal_ServiceVisibilityService: unique symbol;
35923
36160
  }
36161
+ /**
36162
+ * - **Tags**: NotCreatable, Service
36163
+ *
36164
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SessionCheckService)
36165
+ */
36166
+ interface SessionCheckService extends Instance {
36167
+ /**
36168
+ * **DO NOT USE!**
36169
+ *
36170
+ * This field exists to force TypeScript to recognize this as a nominal type
36171
+ * @hidden
36172
+ * @deprecated
36173
+ */
36174
+ readonly _nominal_SessionCheckService: unique symbol;
36175
+ }
35924
36176
  /**
35925
36177
  * - **Tags**: NotCreatable, Service
35926
36178
  *
@@ -36305,12 +36557,15 @@ interface SocialService extends Instance {
36305
36557
  */
36306
36558
  CanSendGameInviteAsync(this: SocialService, player: Player, recipientId?: number): boolean;
36307
36559
  /**
36560
+ * Returns the local player's RSVP status for the given event.
36561
+ *
36308
36562
  * - **ThreadSafety**: Unsafe
36309
36563
  * - **Tags**: Yields
36310
36564
  *
36311
36565
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SocialService#GetEventRsvpStatusAsync)
36312
36566
  * @param this Facilitates social functions that impact relationships made on the Roblox platform.
36313
- * @param eventId
36567
+ * @param eventId The event ID of the event to prompt the player to change their RSVP status for. This must be a valid event ID that exists in the current experience, represented as a string (not a number).
36568
+ * @returns Returns an `RsvpStatus` indicating the player's current RSVP status for the event. If the player has not RSVP'd to the event, this will return `RsvpStatus.None`.
36314
36569
  */
36315
36570
  GetEventRsvpStatusAsync(this: SocialService, eventId: string): Enum.RsvpStatus;
36316
36571
  /**
@@ -36326,12 +36581,22 @@ interface SocialService extends Instance {
36326
36581
  */
36327
36582
  GetPartyAsync(this: SocialService, partyId: string): Array<unknown>;
36328
36583
  /**
36584
+ * - **ThreadSafety**: Unsafe
36585
+ * - **Tags**: Yields
36586
+ *
36587
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SocialService#PromptLinkSharing)
36588
+ */
36589
+ PromptLinkSharing(this: SocialService, player: Player, options?: object): unknown;
36590
+ /**
36591
+ * Prompts the local `Player` with a prompt to change their RSVP status to the given event.
36592
+ *
36329
36593
  * - **ThreadSafety**: Unsafe
36330
36594
  * - **Tags**: Yields
36331
36595
  *
36332
36596
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SocialService#PromptRsvpToEventAsync)
36333
36597
  * @param this Facilitates social functions that impact relationships made on the Roblox platform.
36334
- * @param eventId
36598
+ * @param eventId The event ID of the event to prompt the player to change their RSVP status for. This must be a valid event ID that exists in the current experience, represented as a string (not a number).
36599
+ * @returns Returns a `RsvpStatus` indicating the player's new RSVP status after the prompt is closed. If the player closes the prompt without changing their RSVP status, this will return `RsvpStatus.None` or their old `RsvpStatus` if they had already selected a status.
36335
36600
  */
36336
36601
  PromptRsvpToEventAsync(this: SocialService, eventId: string): Enum.RsvpStatus;
36337
36602
  /**
@@ -36358,6 +36623,12 @@ interface SocialService extends Instance {
36358
36623
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SocialService#PhoneBookPromptClosed)
36359
36624
  */
36360
36625
  readonly PhoneBookPromptClosed: RBXScriptSignal<(player: Player) => void>;
36626
+ /**
36627
+ * - **ThreadSafety**: Unsafe
36628
+ *
36629
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SocialService#ShareSheetClosed)
36630
+ */
36631
+ readonly ShareSheetClosed: RBXScriptSignal<(player: Player) => void>;
36361
36632
  /**
36362
36633
  * Callback for when a call is placed from the phone book.
36363
36634
  *
@@ -37499,7 +37770,7 @@ interface StarterPlayer extends Instance {
37499
37770
  */
37500
37771
  DevCameraOcclusionMode: Enum.DevCameraOcclusionMode;
37501
37772
  /**
37502
- * Lets developer overwrite the default camera mode for each player if the player is on a computer.
37773
+ * Lets you overwrite the player's camera mode on a computer.
37503
37774
  *
37504
37775
  * - **ThreadSafety**: ReadSafe
37505
37776
  *
@@ -37507,7 +37778,7 @@ interface StarterPlayer extends Instance {
37507
37778
  */
37508
37779
  DevComputerCameraMovementMode: Enum.DevComputerCameraMovementMode;
37509
37780
  /**
37510
- * Lets developer overwrite the player's movement mode if the player is on a computer.
37781
+ * Lets you overwrite the player's movement mode on a computer.
37511
37782
  *
37512
37783
  * - **ThreadSafety**: ReadSafe
37513
37784
  *
@@ -37515,7 +37786,7 @@ interface StarterPlayer extends Instance {
37515
37786
  */
37516
37787
  DevComputerMovementMode: Enum.DevComputerMovementMode;
37517
37788
  /**
37518
- * Lets developer overwrite the default camera movement mode for each player if the player is on a mobile device.
37789
+ * Lets you overwrite the player's camera mode on a touch-enabled device.
37519
37790
  *
37520
37791
  * - **ThreadSafety**: ReadSafe
37521
37792
  *
@@ -37523,7 +37794,7 @@ interface StarterPlayer extends Instance {
37523
37794
  */
37524
37795
  DevTouchCameraMovementMode: Enum.DevTouchCameraMovementMode;
37525
37796
  /**
37526
- * Lets developer overwrite the player's movement mode if the player is on a touch device.
37797
+ * Lets you overwrite the player's movement mode on a touch-enabled device.
37527
37798
  *
37528
37799
  * - **ThreadSafety**: ReadSafe
37529
37800
  *
@@ -39285,6 +39556,14 @@ interface TestService extends Instance {
39285
39556
  * @param this A service used by Roblox to run controlled tests of the engine. It is available for developers to use, to a limited degree.
39286
39557
  */
39287
39558
  ScopeTime(this: TestService): object;
39559
+ /**
39560
+ * - **ThreadSafety**: Unsafe
39561
+ *
39562
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TestService#TakeSnapshot)
39563
+ * @param this A service used by Roblox to run controlled tests of the engine. It is available for developers to use, to a limited degree.
39564
+ * @param snapshotname
39565
+ */
39566
+ TakeSnapshot(this: TestService, snapshotname: string): void;
39288
39567
  /**
39289
39568
  * Prints if a condition is true, otherwise prints a warning.
39290
39569
  *
@@ -41416,6 +41695,45 @@ interface UITextSizeConstraint extends UIConstraint {
41416
41695
  */
41417
41696
  MinTextSize: number;
41418
41697
  }
41698
+ /**
41699
+ * - **Tags**: NotReplicated, NotBrowsable
41700
+ *
41701
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UIContainerQuery)
41702
+ */
41703
+ interface UIContainerQuery extends UIComponent {
41704
+ /**
41705
+ * **DO NOT USE!**
41706
+ *
41707
+ * This field exists to force TypeScript to recognize this as a nominal type
41708
+ * @hidden
41709
+ * @deprecated
41710
+ */
41711
+ readonly _nominal_UIContainerQuery: unique symbol;
41712
+ /**
41713
+ * - **ThreadSafety**: ReadSafe
41714
+ *
41715
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UIContainerQuery#Active)
41716
+ */
41717
+ Active: boolean;
41718
+ /**
41719
+ * - **ThreadSafety**: ReadSafe
41720
+ *
41721
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UIContainerQuery#AspectRatioRange)
41722
+ */
41723
+ AspectRatioRange: NumberRange;
41724
+ /**
41725
+ * - **ThreadSafety**: ReadSafe
41726
+ *
41727
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UIContainerQuery#MaxSize)
41728
+ */
41729
+ MaxSize: Vector2;
41730
+ /**
41731
+ * - **ThreadSafety**: ReadSafe
41732
+ *
41733
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UIContainerQuery#MinSize)
41734
+ */
41735
+ MinSize: Vector2;
41736
+ }
41419
41737
  /**
41420
41738
  * UI modifier which applies deformation to corners of its parent `GuiObject`.
41421
41739
  *
@@ -42588,7 +42906,7 @@ interface UserGameSettings extends Instance {
42588
42906
  readonly StudioModeChanged: RBXScriptSignal<(isStudioMode: boolean) => void>;
42589
42907
  }
42590
42908
  /**
42591
- * `UserInputService` is a service used to detect the type of input available on a user's device via the use of a `LocalScript`. The service is also used to detect input events.
42909
+ * `UserInputService` is primarily used to detect the input types available on a user's device, as well as detect input events.
42592
42910
  *
42593
42911
  * - **Tags**: NotCreatable, Service, NotReplicated
42594
42912
  *
@@ -42613,7 +42931,7 @@ interface UserInputService extends Instance {
42613
42931
  */
42614
42932
  readonly AccelerometerEnabled: boolean;
42615
42933
  /**
42616
- * Describes whether the device being used by a user has an available gamepad.
42934
+ * Describes whether the user's device has an available gamepad.
42617
42935
  *
42618
42936
  * - **ThreadSafety**: ReadSafe
42619
42937
  * - **Tags**: NotReplicated
@@ -42679,7 +42997,7 @@ interface UserInputService extends Instance {
42679
42997
  */
42680
42998
  readonly MouseEnabled: boolean;
42681
42999
  /**
42682
- * The content ID of the image used as the user mouse icon.
43000
+ * The content ID of the image for the user's mouse icon.
42683
43001
  *
42684
43002
  * - **ThreadSafety**: ReadSafe
42685
43003
  *
@@ -42687,7 +43005,7 @@ interface UserInputService extends Instance {
42687
43005
  */
42688
43006
  MouseIcon: ContentId;
42689
43007
  /**
42690
- * Determines whether the `Mouse` icon is visible.
43008
+ * Determines whether the mouse icon is visible.
42691
43009
  *
42692
43010
  * - **ThreadSafety**: ReadSafe
42693
43011
  *
@@ -42722,6 +43040,8 @@ interface UserInputService extends Instance {
42722
43040
  */
42723
43041
  readonly OnScreenKeyboardVisible: boolean;
42724
43042
  /**
43043
+ * Queries the primary input type a player is using, based on anticipated user behavior.
43044
+ *
42725
43045
  * - **ThreadSafety**: ReadSafe
42726
43046
  * - **Tags**: NotReplicated
42727
43047
  *
@@ -42729,7 +43049,7 @@ interface UserInputService extends Instance {
42729
43049
  */
42730
43050
  readonly PreferredInput: Enum.PreferredInput;
42731
43051
  /**
42732
- * Describes whether the user's current device has a touch-screen available.
43052
+ * Describes whether the user's device has a touch screen available.
42733
43053
  *
42734
43054
  * - **ThreadSafety**: ReadSafe
42735
43055
  * - **Tags**: NotReplicated
@@ -42765,7 +43085,7 @@ interface UserInputService extends Instance {
42765
43085
  * - **ThreadSafety**: Unsafe
42766
43086
  *
42767
43087
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UserInputService#GamepadSupports)
42768
- * @param this `UserInputService` is a service used to detect the type of input available on a user's device via the use of a `LocalScript`. The service is also used to detect input events.
43088
+ * @param this `UserInputService` is primarily used to detect the input types available on a user's device, as well as detect input events.
42769
43089
  * @param gamepadNum The `UserInputType` of the gamepad.
42770
43090
  * @param gamepadKeyCode The `KeyCode` of the button in question.
42771
43091
  * @returns Whether the given gamepad supports a button corresponding with the given `KeyCode`.
@@ -42777,7 +43097,7 @@ interface UserInputService extends Instance {
42777
43097
  * - **ThreadSafety**: Unsafe
42778
43098
  *
42779
43099
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UserInputService#GetConnectedGamepads)
42780
- * @param this `UserInputService` is a service used to detect the type of input available on a user's device via the use of a `LocalScript`. The service is also used to detect input events.
43100
+ * @param this `UserInputService` is primarily used to detect the input types available on a user's device, as well as detect input events.
42781
43101
  * @returns An array of `UserInputTypes` corresponding with the gamepads connected to the user's device.
42782
43102
  */
42783
43103
  GetConnectedGamepads(this: UserInputService): Array<Enum.UserInputType>;
@@ -42787,7 +43107,7 @@ interface UserInputService extends Instance {
42787
43107
  * - **ThreadSafety**: Unsafe
42788
43108
  *
42789
43109
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UserInputService#GetDeviceAcceleration)
42790
- * @param this `UserInputService` is a service used to detect the type of input available on a user's device via the use of a `LocalScript`. The service is also used to detect input events.
43110
+ * @param this `UserInputService` is primarily used to detect the input types available on a user's device, as well as detect input events.
42791
43111
  */
42792
43112
  GetDeviceAcceleration(this: UserInputService): InputObject;
42793
43113
  /**
@@ -42796,18 +43116,17 @@ interface UserInputService extends Instance {
42796
43116
  * - **ThreadSafety**: Unsafe
42797
43117
  *
42798
43118
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UserInputService#GetDeviceGravity)
42799
- * @param this `UserInputService` is a service used to detect the type of input available on a user's device via the use of a `LocalScript`. The service is also used to detect input events.
43119
+ * @param this `UserInputService` is primarily used to detect the input types available on a user's device, as well as detect input events.
42800
43120
  */
42801
43121
  GetDeviceGravity(this: UserInputService): InputObject;
42802
43122
  /**
42803
- * Returns an `InputObject` and a `CFrame`,describing the device's current rotation vector.
43123
+ * Returns an `InputObject` and a `CFrame` describing the device's current rotation vector.
42804
43124
  *
42805
43125
  * - **ThreadSafety**: Unsafe
42806
43126
  *
42807
43127
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UserInputService#GetDeviceRotation)
42808
- * @param this `UserInputService` is a service used to detect the type of input available on a user's device via the use of a `LocalScript`. The service is also used to detect input events.
42809
- * @returns A tuple containing two properties: 1. The delta property describes the amount of rotation that last happened
42810
- * 2. The CFrame is the device's current rotation relative to its default reference frame.
43128
+ * @param this `UserInputService` is primarily used to detect the input types available on a user's device, as well as detect input events.
43129
+ * @returns A tuple containing two properties: The delta describing the amount of rotation that last happened, and the `CFrame` of the device's current rotation relative to its default reference frame.
42811
43130
  */
42812
43131
  GetDeviceRotation(this: UserInputService): LuaTuple<[
42813
43132
  InputObject,
@@ -42819,16 +43138,16 @@ interface UserInputService extends Instance {
42819
43138
  * - **ThreadSafety**: Unsafe
42820
43139
  *
42821
43140
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UserInputService#GetFocusedTextBox)
42822
- * @param this `UserInputService` is a service used to detect the type of input available on a user's device via the use of a `LocalScript`. The service is also used to detect input events.
43141
+ * @param this `UserInputService` is primarily used to detect the input types available on a user's device, as well as detect input events.
42823
43142
  */
42824
43143
  GetFocusedTextBox(this: UserInputService): TextBox | undefined;
42825
43144
  /**
42826
- * Returns whether a gamepad with the given `UserInputType`''gamepadNum'' is connected.
43145
+ * Returns whether a gamepad with the given `UserInputType` is connected.
42827
43146
  *
42828
43147
  * - **ThreadSafety**: Unsafe
42829
43148
  *
42830
43149
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UserInputService#GetGamepadConnected)
42831
- * @param this `UserInputService` is a service used to detect the type of input available on a user's device via the use of a `LocalScript`. The service is also used to detect input events.
43150
+ * @param this `UserInputService` is primarily used to detect the input types available on a user's device, as well as detect input events.
42832
43151
  * @param gamepadNum The `UserInputType` of the gamepad in question.
42833
43152
  * @returns Whether a gamepad associated with `UserInputType` is connected.
42834
43153
  */
@@ -42839,7 +43158,7 @@ interface UserInputService extends Instance {
42839
43158
  * - **ThreadSafety**: Unsafe
42840
43159
  *
42841
43160
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UserInputService#GetGamepadState)
42842
- * @param this `UserInputService` is a service used to detect the type of input available on a user's device via the use of a `LocalScript`. The service is also used to detect input events.
43161
+ * @param this `UserInputService` is primarily used to detect the input types available on a user's device, as well as detect input events.
42843
43162
  * @param gamepadNum The `UserInputType` corresponding with the gamepad in question.
42844
43163
  * @returns An array of `InputObjects` representing the current state of all available inputs for the given gamepad.
42845
43164
  */
@@ -42850,7 +43169,7 @@ interface UserInputService extends Instance {
42850
43169
  * - **ThreadSafety**: Unsafe
42851
43170
  *
42852
43171
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UserInputService#GetImageForKeyCode)
42853
- * @param this `UserInputService` is a service used to detect the type of input available on a user's device via the use of a `LocalScript`. The service is also used to detect input events.
43172
+ * @param this `UserInputService` is primarily used to detect the input types available on a user's device, as well as detect input events.
42854
43173
  * @param keyCode The `KeyCode` for which to fetch the associated image.
42855
43174
  * @returns The returned image asset ID.
42856
43175
  */
@@ -42861,7 +43180,7 @@ interface UserInputService extends Instance {
42861
43180
  * - **ThreadSafety**: Unsafe
42862
43181
  *
42863
43182
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UserInputService#GetKeysPressed)
42864
- * @param this `UserInputService` is a service used to detect the type of input available on a user's device via the use of a `LocalScript`. The service is also used to detect input events.
43183
+ * @param this `UserInputService` is primarily used to detect the input types available on a user's device, as well as detect input events.
42865
43184
  * @returns An array of `InputObjects` associated with the keys currently being pressed.
42866
43185
  */
42867
43186
  GetKeysPressed(this: UserInputService): Array<InputObject>;
@@ -42871,17 +43190,17 @@ interface UserInputService extends Instance {
42871
43190
  * - **ThreadSafety**: Unsafe
42872
43191
  *
42873
43192
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UserInputService#GetLastInputType)
42874
- * @param this `UserInputService` is a service used to detect the type of input available on a user's device via the use of a `LocalScript`. The service is also used to detect input events.
43193
+ * @param this `UserInputService` is primarily used to detect the input types available on a user's device, as well as detect input events.
42875
43194
  * @returns The `UserInputType` associated with the user's most recent input.
42876
43195
  */
42877
43196
  GetLastInputType(this: UserInputService): Enum.UserInputType;
42878
43197
  /**
42879
- * Returns an array of `InputObjects` corresponding with the mouse buttons currently being held down.
43198
+ * Returns an array of `InputObjects` associated with the mouse buttons currently being held down.
42880
43199
  *
42881
43200
  * - **ThreadSafety**: Unsafe
42882
43201
  *
42883
43202
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UserInputService#GetMouseButtonsPressed)
42884
- * @param this `UserInputService` is a service used to detect the type of input available on a user's device via the use of a `LocalScript`. The service is also used to detect input events.
43203
+ * @param this `UserInputService` is primarily used to detect the input types available on a user's device, as well as detect input events.
42885
43204
  * @returns An array of `InputObjects` corresponding to the mouse buttons currently being currently held down.
42886
43205
  */
42887
43206
  GetMouseButtonsPressed(this: UserInputService): Array<InputObject>;
@@ -42891,28 +43210,28 @@ interface UserInputService extends Instance {
42891
43210
  * - **ThreadSafety**: Unsafe
42892
43211
  *
42893
43212
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UserInputService#GetMouseDelta)
42894
- * @param this `UserInputService` is a service used to detect the type of input available on a user's device via the use of a `LocalScript`. The service is also used to detect input events.
43213
+ * @param this `UserInputService` is primarily used to detect the input types available on a user's device, as well as detect input events.
42895
43214
  * @returns Change in movement of the mouse.
42896
43215
  */
42897
43216
  GetMouseDelta(this: UserInputService): Vector2;
42898
43217
  /**
42899
- * Returns the current screen location of the player's `Mouse` relative to the top left corner of the screen.
43218
+ * Returns the current screen location of the player's `Mouse` relative to the top-left corner of the screen.
42900
43219
  *
42901
43220
  * - **ThreadSafety**: Unsafe
42902
43221
  *
42903
43222
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UserInputService#GetMouseLocation)
42904
- * @param this `UserInputService` is a service used to detect the type of input available on a user's device via the use of a `LocalScript`. The service is also used to detect input events.
43223
+ * @param this `UserInputService` is primarily used to detect the input types available on a user's device, as well as detect input events.
42905
43224
  * @returns A `Vector2` representing the current screen location of the mouse, in pixels.
42906
43225
  */
42907
43226
  GetMouseLocation(this: UserInputService): Vector2;
42908
43227
  /**
42909
- * Returns an array of `gamepads` connected and enabled for GUI navigation in descending order of priority.
43228
+ * Returns an array of gamepads connected and enabled for `GuiObject` navigation in descending order of priority.
42910
43229
  *
42911
43230
  * - **ThreadSafety**: Unsafe
42912
43231
  *
42913
43232
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UserInputService#GetNavigationGamepads)
42914
- * @param this `UserInputService` is a service used to detect the type of input available on a user's device via the use of a `LocalScript`. The service is also used to detect input events.
42915
- * @returns An array of `UserInputTypes` that can be used for GUI navigation, in descending order of priority.
43233
+ * @param this `UserInputService` is primarily used to detect the input types available on a user's device, as well as detect input events.
43234
+ * @returns An array of `UserInputTypes` that can be used for navigation, in descending order of priority.
42916
43235
  */
42917
43236
  GetNavigationGamepads(this: UserInputService): Array<Enum.UserInputType>;
42918
43237
  /**
@@ -42921,7 +43240,7 @@ interface UserInputService extends Instance {
42921
43240
  * - **ThreadSafety**: Unsafe
42922
43241
  *
42923
43242
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UserInputService#GetStringForKeyCode)
42924
- * @param this `UserInputService` is a service used to detect the type of input available on a user's device via the use of a `LocalScript`. The service is also used to detect input events.
43243
+ * @param this `UserInputService` is primarily used to detect the input types available on a user's device, as well as detect input events.
42925
43244
  * @param keyCode
42926
43245
  */
42927
43246
  GetStringForKeyCode(this: UserInputService, keyCode: CastsToEnum<Enum.KeyCode>): string;
@@ -42931,7 +43250,7 @@ interface UserInputService extends Instance {
42931
43250
  * - **ThreadSafety**: Unsafe
42932
43251
  *
42933
43252
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UserInputService#GetSupportedGamepadKeyCodes)
42934
- * @param this `UserInputService` is a service used to detect the type of input available on a user's device via the use of a `LocalScript`. The service is also used to detect input events.
43253
+ * @param this `UserInputService` is primarily used to detect the input types available on a user's device, as well as detect input events.
42935
43254
  * @param gamepadNum The `UserInputType` of the gamepad.
42936
43255
  * @returns An array of `KeyCodes` supported by the given gamepad.
42937
43256
  */
@@ -42945,7 +43264,7 @@ interface UserInputService extends Instance {
42945
43264
  * - **Tags**:
42946
43265
  *
42947
43266
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UserInputService#GetUserCFrame)
42948
- * @param this `UserInputService` is a service used to detect the type of input available on a user's device via the use of a `LocalScript`. The service is also used to detect input events.
43267
+ * @param this `UserInputService` is primarily used to detect the input types available on a user's device, as well as detect input events.
42949
43268
  * @param type The `UserCFrame` corresponding to the VR device.
42950
43269
  * @returns A `CFrame` describing the position and orientation of the specified VR device.
42951
43270
  *
@@ -42953,15 +43272,15 @@ interface UserInputService extends Instance {
42953
43272
  */
42954
43273
  GetUserCFrame(this: UserInputService, type: CastsToEnum<Enum.UserCFrame>): CFrame;
42955
43274
  /**
42956
- * Determines whether a particular button is pressed on a particular gamepad.
43275
+ * Determines whether a particular button is pressed on a gamepad.
42957
43276
  *
42958
43277
  * - **ThreadSafety**: Unsafe
42959
43278
  *
42960
43279
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UserInputService#IsGamepadButtonDown)
42961
- * @param this `UserInputService` is a service used to detect the type of input available on a user's device via the use of a `LocalScript`. The service is also used to detect input events.
43280
+ * @param this `UserInputService` is primarily used to detect the input types available on a user's device, as well as detect input events.
42962
43281
  * @param gamepadNum The `UserInputType` of the given gamepad.
42963
- * @param gamepadKeyCode The `KeyCode` of the specified button.
42964
- * @returns Whether the specified gamepad button on the given gamepad is pressed is pressed.
43282
+ * @param gamepadKeyCode The `KeyCode` of the specified gamepad button.
43283
+ * @returns Whether the specified button on the given gamepad is pressed is pressed.
42965
43284
  */
42966
43285
  IsGamepadButtonDown(this: UserInputService, gamepadNum: CastsToEnum<Enum.UserInputType>, gamepadKeyCode: CastsToEnum<Enum.KeyCode>): boolean;
42967
43286
  /**
@@ -42970,29 +43289,29 @@ interface UserInputService extends Instance {
42970
43289
  * - **ThreadSafety**: Unsafe
42971
43290
  *
42972
43291
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UserInputService#IsKeyDown)
42973
- * @param this `UserInputService` is a service used to detect the type of input available on a user's device via the use of a `LocalScript`. The service is also used to detect input events.
43292
+ * @param this `UserInputService` is primarily used to detect the input types available on a user's device, as well as detect input events.
42974
43293
  * @param keyCode The `KeyCode` of the key.
42975
43294
  * @returns Whether the specified key is being held down.
42976
43295
  */
42977
43296
  IsKeyDown(this: UserInputService, keyCode: CastsToEnum<Enum.KeyCode>): boolean;
42978
43297
  /**
42979
- * Returns whether the given `mouse button` is currently held down.
43298
+ * Returns whether the given mouse button is currently held down.
42980
43299
  *
42981
43300
  * - **ThreadSafety**: Unsafe
42982
43301
  *
42983
43302
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UserInputService#IsMouseButtonPressed)
42984
- * @param this `UserInputService` is a service used to detect the type of input available on a user's device via the use of a `LocalScript`. The service is also used to detect input events.
43303
+ * @param this `UserInputService` is primarily used to detect the input types available on a user's device, as well as detect input events.
42985
43304
  * @param mouseButton The `UserInputType` of the mouse button.
42986
43305
  * @returns Whether the given mouse button is currently held down.
42987
43306
  */
42988
43307
  IsMouseButtonPressed(this: UserInputService, mouseButton: CastsToEnum<Enum.UserInputType>): boolean;
42989
43308
  /**
42990
- * Returns true if the specified `UserInputType` gamepad is allowed to control the navigation `GuiObjects`.
43309
+ * Returns `true` if the specified gamepad is allowed to control navigation and selection `GuiObjects`.
42991
43310
  *
42992
43311
  * - **ThreadSafety**: Unsafe
42993
43312
  *
42994
43313
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UserInputService#IsNavigationGamepad)
42995
- * @param this `UserInputService` is a service used to detect the type of input available on a user's device via the use of a `LocalScript`. The service is also used to detect input events.
43314
+ * @param this `UserInputService` is primarily used to detect the input types available on a user's device, as well as detect input events.
42996
43315
  * @param gamepadEnum The `UserInputType` of the specified gamepad.
42997
43316
  * @returns Whether the specified gamepad is a navigation gamepad.
42998
43317
  */
@@ -43003,22 +43322,22 @@ interface UserInputService extends Instance {
43003
43322
  * - **ThreadSafety**: Unsafe
43004
43323
  *
43005
43324
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UserInputService#RecenterUserHeadCFrame)
43006
- * @param this `UserInputService` is a service used to detect the type of input available on a user's device via the use of a `LocalScript`. The service is also used to detect input events.
43325
+ * @param this `UserInputService` is primarily used to detect the input types available on a user's device, as well as detect input events.
43007
43326
  */
43008
43327
  RecenterUserHeadCFrame(this: UserInputService): void;
43009
43328
  /**
43010
- * Sets whether or not the specified `Gamepad` can move the `GuiObject` navigator.
43329
+ * Sets whether or not the specified gamepad can move the `GuiObject` navigator.
43011
43330
  *
43012
43331
  * - **ThreadSafety**: Unsafe
43013
43332
  *
43014
43333
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UserInputService#SetNavigationGamepad)
43015
- * @param this `UserInputService` is a service used to detect the type of input available on a user's device via the use of a `LocalScript`. The service is also used to detect input events.
43334
+ * @param this `UserInputService` is primarily used to detect the input types available on a user's device, as well as detect input events.
43016
43335
  * @param gamepadEnum The `UserInputType` of the specified gamepad.
43017
43336
  * @param enabled Whether the specified gamepad can move the GUI navigator.
43018
43337
  */
43019
43338
  SetNavigationGamepad(this: UserInputService, gamepadEnum: CastsToEnum<Enum.UserInputType>, enabled: boolean): void;
43020
43339
  /**
43021
- * Fired when a user moves a device that has an accelerometer. Used to track real-world device movement within a Roblox game.
43340
+ * Fires when a user moves a device that has an accelerometer.
43022
43341
  *
43023
43342
  * - **ThreadSafety**: Unsafe
43024
43343
  *
@@ -43026,7 +43345,7 @@ interface UserInputService extends Instance {
43026
43345
  */
43027
43346
  readonly DeviceAccelerationChanged: RBXScriptSignal<(acceleration: InputObject) => void>;
43028
43347
  /**
43029
- * Fired when the force of gravity changes on a device that has an enabled accelerometer - such as a mobile device.
43348
+ * Fires when the force of gravity changes on a device that has an enabled accelerometer.
43030
43349
  *
43031
43350
  * - **ThreadSafety**: Unsafe
43032
43351
  *
@@ -43034,7 +43353,7 @@ interface UserInputService extends Instance {
43034
43353
  */
43035
43354
  readonly DeviceGravityChanged: RBXScriptSignal<(gravity: InputObject) => void>;
43036
43355
  /**
43037
- * Fired when a user rotates a device that has a gyroscope.
43356
+ * Fires when a user rotates a device that has a gyroscope.
43038
43357
  *
43039
43358
  * - **ThreadSafety**: Unsafe
43040
43359
  *
@@ -43042,7 +43361,7 @@ interface UserInputService extends Instance {
43042
43361
  */
43043
43362
  readonly DeviceRotationChanged: RBXScriptSignal<(rotation: InputObject, cframe: CFrame) => void>;
43044
43363
  /**
43045
- * Fires when a gamepad is connected to the client. Passes the ''gamepadNum'' of the gamepad that was connected.
43364
+ * Fires when a gamepad is connected to the client.
43046
43365
  *
43047
43366
  * - **ThreadSafety**: Unsafe
43048
43367
  *
@@ -43050,7 +43369,7 @@ interface UserInputService extends Instance {
43050
43369
  */
43051
43370
  readonly GamepadConnected: RBXScriptSignal<(gamepadNum: Enum.UserInputType) => void>;
43052
43371
  /**
43053
- * Fires when a gamepad is disconnected from the client. Passes the `UserInputType` of the gamepad that was disconnected.
43372
+ * Fires when a gamepad is disconnected from the client.
43054
43373
  *
43055
43374
  * - **ThreadSafety**: Unsafe
43056
43375
  *
@@ -43058,7 +43377,7 @@ interface UserInputService extends Instance {
43058
43377
  */
43059
43378
  readonly GamepadDisconnected: RBXScriptSignal<(gamepadNum: Enum.UserInputType) => void>;
43060
43379
  /**
43061
- * Fired when a user begins interacting via a Human-Computer Interface device - such as a mouse or gamepad.
43380
+ * Fires when a user begins interacting with an input device such as a mouse or gamepad.
43062
43381
  *
43063
43382
  * - **ThreadSafety**: Unsafe
43064
43383
  *
@@ -43066,7 +43385,7 @@ interface UserInputService extends Instance {
43066
43385
  */
43067
43386
  readonly InputBegan: RBXScriptSignal<(input: InputObject, gameProcessedEvent: boolean) => void>;
43068
43387
  /**
43069
- * Fired when a user changes how they're interacting via a Human-Computer Interface device.
43388
+ * Fires when a user changes how they're interacting with an input device such as a mouse or gamepad.
43070
43389
  *
43071
43390
  * - **ThreadSafety**: Unsafe
43072
43391
  *
@@ -43074,7 +43393,7 @@ interface UserInputService extends Instance {
43074
43393
  */
43075
43394
  readonly InputChanged: RBXScriptSignal<(input: InputObject, gameProcessedEvent: boolean) => void>;
43076
43395
  /**
43077
- * Fires when a user stops interacting via a Human-Computer Interface device.
43396
+ * Fires when a user stops interacting with an input device such as a mouse or gamepad.
43078
43397
  *
43079
43398
  * - **ThreadSafety**: Unsafe
43080
43399
  *
@@ -43090,7 +43409,7 @@ interface UserInputService extends Instance {
43090
43409
  */
43091
43410
  readonly JumpRequest: RBXScriptSignal<() => void>;
43092
43411
  /**
43093
- * Fires when the client's `UserInputType` is changed.
43412
+ * Fires whenever the client's `UserInputType` is changed.
43094
43413
  *
43095
43414
  * - **ThreadSafety**: Unsafe
43096
43415
  *
@@ -43098,7 +43417,7 @@ interface UserInputService extends Instance {
43098
43417
  */
43099
43418
  readonly LastInputTypeChanged: RBXScriptSignal<(lastInputType: Enum.UserInputType) => void>;
43100
43419
  /**
43101
- * Fires when the user performs a specific pointer action (wheel, pinch, pan).
43420
+ * Fires when the user performs a specific pointer action.
43102
43421
  *
43103
43422
  * - **ThreadSafety**: Unsafe
43104
43423
  *
@@ -43106,7 +43425,7 @@ interface UserInputService extends Instance {
43106
43425
  */
43107
43426
  readonly PointerAction: RBXScriptSignal<(wheel: number, pan: Vector2, pinch: number, gameProcessedEvent: boolean) => void>;
43108
43427
  /**
43109
- * Fired when the client loses focus on a `TextBox`.
43428
+ * Fires when the client loses focus on a `TextBox`.
43110
43429
  *
43111
43430
  * - **ThreadSafety**: Unsafe
43112
43431
  *
@@ -43114,7 +43433,7 @@ interface UserInputService extends Instance {
43114
43433
  */
43115
43434
  readonly TextBoxFocusReleased: RBXScriptSignal<(textboxReleased: TextBox) => void>;
43116
43435
  /**
43117
- * Fired when the client focuses on a `TextBox`.
43436
+ * Fires when the client focuses on a `TextBox`.
43118
43437
  *
43119
43438
  * - **ThreadSafety**: Unsafe
43120
43439
  *
@@ -43122,13 +43441,15 @@ interface UserInputService extends Instance {
43122
43441
  */
43123
43442
  readonly TextBoxFocused: RBXScriptSignal<(textboxFocused: TextBox) => void>;
43124
43443
  /**
43444
+ * Fires when the user drags on the screen of a `TouchEnabled` device.
43445
+ *
43125
43446
  * - **ThreadSafety**: Unsafe
43126
43447
  *
43127
43448
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UserInputService#TouchDrag)
43128
43449
  */
43129
43450
  readonly TouchDrag: RBXScriptSignal<(dragDirection: Enum.SwipeDirection, numberOfTouches: number, gameProcessedEvent: boolean) => void>;
43130
43451
  /**
43131
- * Fired when a user releases their finger from the screen on a TouchEnabled device - such as the screen of a mobile device.
43452
+ * Fires when a user releases their finger from the screen of a `TouchEnabled` device.
43132
43453
  *
43133
43454
  * - **ThreadSafety**: Unsafe
43134
43455
  *
@@ -43136,7 +43457,7 @@ interface UserInputService extends Instance {
43136
43457
  */
43137
43458
  readonly TouchEnded: RBXScriptSignal<(touch: InputObject, gameProcessedEvent: boolean) => void>;
43138
43459
  /**
43139
- * Fired when a user holds at least one finger for a short amount of time on the same screen position on a TouchEnabled device - such as the screen of a mobile device.
43460
+ * Fires when a user holds at least one finger for a short amount of time on the screen of a `TouchEnabled` device.
43140
43461
  *
43141
43462
  * - **ThreadSafety**: Unsafe
43142
43463
  *
@@ -43144,7 +43465,7 @@ interface UserInputService extends Instance {
43144
43465
  */
43145
43466
  readonly TouchLongPress: RBXScriptSignal<(touchPositions: Array<Vector2>, state: Enum.UserInputState, gameProcessedEvent: boolean) => void>;
43146
43467
  /**
43147
- * Fires when a user moves their finger on a `TouchEnabled` device, such as a tablet or smartphone.
43468
+ * Fires when a user moves their finger on the screen of a `TouchEnabled` device.
43148
43469
  *
43149
43470
  * - **ThreadSafety**: Unsafe
43150
43471
  *
@@ -43152,7 +43473,7 @@ interface UserInputService extends Instance {
43152
43473
  */
43153
43474
  readonly TouchMoved: RBXScriptSignal<(touch: InputObject, gameProcessedEvent: boolean) => void>;
43154
43475
  /**
43155
- * Fired when a user drags at least one finger on a `TouchEnabled` device - such as the screen of a mobile device.
43476
+ * Fires when the user drags at least one finger on the screen of a `TouchEnabled` device.
43156
43477
  *
43157
43478
  * - **ThreadSafety**: Unsafe
43158
43479
  *
@@ -43160,7 +43481,7 @@ interface UserInputService extends Instance {
43160
43481
  */
43161
43482
  readonly TouchPan: RBXScriptSignal<(touchPositions: Array<Vector2>, totalTranslation: Vector2, velocity: Vector2, state: Enum.UserInputState, gameProcessedEvent: boolean) => void>;
43162
43483
  /**
43163
- * Fired when a user pinches their fingers on a `TouchEnabled` device - such as the screen of a mobile device.
43484
+ * Fires when a user performs a pinch gesture on the screen of a `TouchEnabled` device.
43164
43485
  *
43165
43486
  * - **ThreadSafety**: Unsafe
43166
43487
  *
@@ -43168,7 +43489,7 @@ interface UserInputService extends Instance {
43168
43489
  */
43169
43490
  readonly TouchPinch: RBXScriptSignal<(touchPositions: Array<Vector2>, scale: number, velocity: number, state: Enum.UserInputState, gameProcessedEvent: boolean) => void>;
43170
43491
  /**
43171
- * Fires when a user rotates two fingers on a `TouchEnabled` device - such as the screen of a mobile device.
43492
+ * Fires when a user rotates two fingers on the screen of a `TouchEnabled` device.
43172
43493
  *
43173
43494
  * - **ThreadSafety**: Unsafe
43174
43495
  *
@@ -43176,7 +43497,7 @@ interface UserInputService extends Instance {
43176
43497
  */
43177
43498
  readonly TouchRotate: RBXScriptSignal<(touchPositions: Array<Vector2>, rotation: number, velocity: number, state: Enum.UserInputState, gameProcessedEvent: boolean) => void>;
43178
43499
  /**
43179
- * Fired when a user places their finger on a TouchEnabled device - such as the screen of an Apple iPad or iPhone or a Google Android phone.
43500
+ * Fires when a user places their finger on the screen of a `TouchEnabled` device.
43180
43501
  *
43181
43502
  * - **ThreadSafety**: Unsafe
43182
43503
  *
@@ -43184,7 +43505,7 @@ interface UserInputService extends Instance {
43184
43505
  */
43185
43506
  readonly TouchStarted: RBXScriptSignal<(touch: InputObject, gameProcessedEvent: boolean) => void>;
43186
43507
  /**
43187
- * Fires on a `TouchEnabled` device when a user places their finger(s) down on the screen, pans across the screen, and lifts their finger off with a certain speed of movement.
43508
+ * Fires on a `TouchEnabled` device when a user places their finger(s) down on the screen, pans across the screen, and lifts their finger(s) off with a certain speed of movement.
43188
43509
  *
43189
43510
  * - **ThreadSafety**: Unsafe
43190
43511
  *
@@ -43192,7 +43513,7 @@ interface UserInputService extends Instance {
43192
43513
  */
43193
43514
  readonly TouchSwipe: RBXScriptSignal<(swipeDirection: Enum.SwipeDirection, numberOfTouches: number, gameProcessedEvent: boolean) => void>;
43194
43515
  /**
43195
- * Fired when a user taps their finger on a `TouchEnabled` device - such as the screen of a mobile device.
43516
+ * Fires when a user taps their finger on the screen of a `TouchEnabled` device.
43196
43517
  *
43197
43518
  * - **ThreadSafety**: Unsafe
43198
43519
  *
@@ -43200,7 +43521,7 @@ interface UserInputService extends Instance {
43200
43521
  */
43201
43522
  readonly TouchTap: RBXScriptSignal<(touchPositions: Array<Vector2>, gameProcessedEvent: boolean) => void>;
43202
43523
  /**
43203
- * Fires when a user taps the game world on a `TouchEnabled` device - such as the screen of a mobile device.
43524
+ * Fires when a user taps their finger on the screen of a `TouchEnabled` device and the tap location is in the 3D world.
43204
43525
  *
43205
43526
  * - **ThreadSafety**: Unsafe
43206
43527
  *