@rbxts/types 1.0.859 → 1.0.860
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.
- package/include/generated/None.d.ts +312 -111
- package/include/generated/PluginSecurity.d.ts +53 -21
- package/include/generated/enums.d.ts +58 -21
- package/package.json +1 -1
|
@@ -111,9 +111,10 @@ 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
|
-
|
|
117
|
+
ModerationService: ModerationService;
|
|
117
118
|
OmniRecommendationsService: OmniRecommendationsService;
|
|
118
119
|
OpenCloudService: OpenCloudService;
|
|
119
120
|
PackageUIService: PackageUIService;
|
|
@@ -161,6 +162,7 @@ interface Services {
|
|
|
161
162
|
ServerScriptService: ServerScriptService;
|
|
162
163
|
ServerStorage: ServerStorage;
|
|
163
164
|
ServiceVisibilityService: ServiceVisibilityService;
|
|
165
|
+
SessionCheckService: SessionCheckService;
|
|
164
166
|
SessionService: SessionService;
|
|
165
167
|
SharedTableRegistry: SharedTableRegistry;
|
|
166
168
|
SlimContentProvider: SlimContentProvider;
|
|
@@ -482,6 +484,7 @@ interface CreatableInstances {
|
|
|
482
484
|
TremoloSoundEffect: TremoloSoundEffect;
|
|
483
485
|
TrussPart: TrussPart;
|
|
484
486
|
UIAspectRatioConstraint: UIAspectRatioConstraint;
|
|
487
|
+
UIContainerQuery: UIContainerQuery;
|
|
485
488
|
UICorner: UICorner;
|
|
486
489
|
UIDragDetector: UIDragDetector;
|
|
487
490
|
UIFlexItem: UIFlexItem;
|
|
@@ -607,7 +610,6 @@ interface Instances extends Services, CreatableInstances {
|
|
|
607
610
|
LodDataEntity: LodDataEntity;
|
|
608
611
|
LuaSourceContainer: LuaSourceContainer;
|
|
609
612
|
ManualSurfaceJointInstance: ManualSurfaceJointInstance;
|
|
610
|
-
MaterialGenerationSession: MaterialGenerationSession;
|
|
611
613
|
MaterialImportData: MaterialImportData;
|
|
612
614
|
MemoryStoreHashMap: MemoryStoreHashMap;
|
|
613
615
|
MemoryStoreHashMapPages: MemoryStoreHashMapPages;
|
|
@@ -1054,9 +1056,19 @@ interface EditableMesh extends RBXObject {
|
|
|
1054
1056
|
*/
|
|
1055
1057
|
SkinningEnabled: boolean;
|
|
1056
1058
|
/**
|
|
1059
|
+
* Adds a new bone and returns a stable bone ID.
|
|
1060
|
+
*
|
|
1057
1061
|
* - **ThreadSafety**: Unsafe
|
|
1058
1062
|
*
|
|
1059
1063
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#AddBone)
|
|
1064
|
+
* @param this Instance which allows for the runtime creation and manipulation of meshes.
|
|
1065
|
+
* @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.
|
|
1066
|
+
* - `ParentId` — Optional bone ID of the new bone's parent.
|
|
1067
|
+
* - `CFrame` — Initial `CFrame` of the bone in the bind pose of the mesh, in the mesh's local space.
|
|
1068
|
+
* - `Virtual` — Boolean that specifies whether this bone is virtual. Virtual bones can only be bound to a `FaceControls` instance.
|
|
1069
|
+
*
|
|
1070
|
+
*
|
|
1071
|
+
* @returns Stable bone ID of the new bone.
|
|
1060
1072
|
*/
|
|
1061
1073
|
AddBone(this: EditableMesh, boneProperties: object): number;
|
|
1062
1074
|
/**
|
|
@@ -1187,39 +1199,68 @@ interface EditableMesh extends RBXObject {
|
|
|
1187
1199
|
*/
|
|
1188
1200
|
GetAdjacentVertices(this: EditableMesh, vertexId: number): Array<number>;
|
|
1189
1201
|
/**
|
|
1202
|
+
* Finds the bone ID of the bone with the given name.
|
|
1203
|
+
*
|
|
1190
1204
|
* - **ThreadSafety**: Unsafe
|
|
1191
1205
|
*
|
|
1192
1206
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetBoneByName)
|
|
1207
|
+
* @param this Instance which allows for the runtime creation and manipulation of meshes.
|
|
1208
|
+
* @param boneName Bone name to search for.
|
|
1209
|
+
* @returns Bone ID of the bone with the given name.
|
|
1193
1210
|
*/
|
|
1194
1211
|
GetBoneByName(this: EditableMesh, boneName: string): number;
|
|
1195
1212
|
/**
|
|
1213
|
+
* Returns the initial `CFrame` of the bone in the bind pose of the mesh.
|
|
1214
|
+
*
|
|
1196
1215
|
* - **ThreadSafety**: Unsafe
|
|
1197
1216
|
*
|
|
1198
1217
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetBoneCFrame)
|
|
1218
|
+
* @param this Instance which allows for the runtime creation and manipulation of meshes.
|
|
1219
|
+
* @param boneId Bone ID for which to get the `CFrame`.
|
|
1220
|
+
* @returns Initial `CFrame` of the bone in the bind pose of the mesh, in the mesh's local space.
|
|
1199
1221
|
*/
|
|
1200
1222
|
GetBoneCFrame(this: EditableMesh, boneId: number): CFrame;
|
|
1201
1223
|
/**
|
|
1224
|
+
* Returns `true` if the bone is virtual.
|
|
1225
|
+
*
|
|
1202
1226
|
* - **ThreadSafety**: Unsafe
|
|
1203
1227
|
*
|
|
1204
1228
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetBoneIsVirtual)
|
|
1229
|
+
* @param this Instance which allows for the runtime creation and manipulation of meshes.
|
|
1230
|
+
* @param boneId Bone ID for which to get whether the bone is virtual.
|
|
1231
|
+
* @returns Whether the bone with the given bone ID is virtual. Virtual bones can only be bound to a `FaceControls` instance.
|
|
1205
1232
|
*/
|
|
1206
1233
|
GetBoneIsVirtual(this: EditableMesh, boneId: number): boolean;
|
|
1207
1234
|
/**
|
|
1235
|
+
* Returns the bone name.
|
|
1236
|
+
*
|
|
1208
1237
|
* - **ThreadSafety**: Unsafe
|
|
1209
1238
|
*
|
|
1210
1239
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetBoneName)
|
|
1240
|
+
* @param this Instance which allows for the runtime creation and manipulation of meshes.
|
|
1241
|
+
* @param boneId Bone ID for which to get the name.
|
|
1242
|
+
* @returns Name of the bone with the given bone ID.
|
|
1211
1243
|
*/
|
|
1212
1244
|
GetBoneName(this: EditableMesh, boneId: number): string;
|
|
1213
1245
|
/**
|
|
1246
|
+
* Returns the parent bone ID, if any.
|
|
1247
|
+
*
|
|
1214
1248
|
* - **ThreadSafety**: Unsafe
|
|
1215
1249
|
*
|
|
1216
1250
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetBoneParent)
|
|
1251
|
+
* @param this Instance which allows for the runtime creation and manipulation of meshes.
|
|
1252
|
+
* @param boneId Bone ID for which to get the parent.
|
|
1253
|
+
* @returns Bone ID for the parent of the bone with the given bone ID. If there is no parent, returns `0`.
|
|
1217
1254
|
*/
|
|
1218
1255
|
GetBoneParent(this: EditableMesh, boneId: number): number;
|
|
1219
1256
|
/**
|
|
1257
|
+
* Returns all bones of the mesh.
|
|
1258
|
+
*
|
|
1220
1259
|
* - **ThreadSafety**: Unsafe
|
|
1221
1260
|
*
|
|
1222
1261
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetBones)
|
|
1262
|
+
* @param this Instance which allows for the runtime creation and manipulation of meshes.
|
|
1263
|
+
* @returns List of stable bone IDs.
|
|
1223
1264
|
*/
|
|
1224
1265
|
GetBones(this: EditableMesh): Array<unknown>;
|
|
1225
1266
|
/**
|
|
@@ -1360,27 +1401,45 @@ interface EditableMesh extends RBXObject {
|
|
|
1360
1401
|
*/
|
|
1361
1402
|
GetFacesWithUV(this: EditableMesh, uvId: number): Array<unknown>;
|
|
1362
1403
|
/**
|
|
1404
|
+
* Returns bone IDs and bone `CFrames` for all bones in a specific FACS corrective pose.
|
|
1405
|
+
*
|
|
1363
1406
|
* - **ThreadSafety**: Unsafe
|
|
1364
1407
|
*
|
|
1365
1408
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetFacsCorrectivePose)
|
|
1409
|
+
* @param this Instance which allows for the runtime creation and manipulation of meshes.
|
|
1410
|
+
* @param actions Array or 2 or 3 `FacsActionUnit` values that specify a corrective pose.
|
|
1411
|
+
* @returns Array of bone IDs and corresponding array of bone `CFrames`.
|
|
1366
1412
|
*/
|
|
1367
1413
|
GetFacsCorrectivePose(this: EditableMesh, actions: Array<unknown>): unknown;
|
|
1368
1414
|
/**
|
|
1415
|
+
* Returns all FACS corrective poses that are in use.
|
|
1416
|
+
*
|
|
1369
1417
|
* - **ThreadSafety**: Unsafe
|
|
1370
1418
|
*
|
|
1371
1419
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetFacsCorrectivePoses)
|
|
1420
|
+
* @param this Instance which allows for the runtime creation and manipulation of meshes.
|
|
1421
|
+
* @returns Array of corrective poses. Each corrective pose is specified by a small array of 2 or 3 `FacsActionUnit` values.
|
|
1372
1422
|
*/
|
|
1373
1423
|
GetFacsCorrectivePoses(this: EditableMesh): Array<unknown>;
|
|
1374
1424
|
/**
|
|
1425
|
+
* Returns bone IDs and bone `CFrames` for all bones in a specific FACS action unit.
|
|
1426
|
+
*
|
|
1375
1427
|
* - **ThreadSafety**: Unsafe
|
|
1376
1428
|
*
|
|
1377
1429
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetFacsPose)
|
|
1430
|
+
* @param this Instance which allows for the runtime creation and manipulation of meshes.
|
|
1431
|
+
* @param action FACS action unit for which to get the pose.
|
|
1432
|
+
* @returns Array of bone IDs and corresponding array of bone `CFrame`.
|
|
1378
1433
|
*/
|
|
1379
1434
|
GetFacsPose(this: EditableMesh, action: CastsToEnum<Enum.FacsActionUnit>): unknown;
|
|
1380
1435
|
/**
|
|
1436
|
+
* Returns all FACS action units that have poses defined.
|
|
1437
|
+
*
|
|
1381
1438
|
* - **ThreadSafety**: Unsafe
|
|
1382
1439
|
*
|
|
1383
1440
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetFacsPoses)
|
|
1441
|
+
* @param this Instance which allows for the runtime creation and manipulation of meshes.
|
|
1442
|
+
* @returns Array of `FacsActionUnit`, one for each FACS action unit that has a pose defined.
|
|
1384
1443
|
*/
|
|
1385
1444
|
GetFacsPoses(this: EditableMesh): Array<unknown>;
|
|
1386
1445
|
/**
|
|
@@ -1447,15 +1506,25 @@ interface EditableMesh extends RBXObject {
|
|
|
1447
1506
|
*/
|
|
1448
1507
|
GetUVs(this: EditableMesh): Array<unknown>;
|
|
1449
1508
|
/**
|
|
1509
|
+
* Returns skinning blend weights for each bone that is associated with the vertex.
|
|
1510
|
+
*
|
|
1450
1511
|
* - **ThreadSafety**: Unsafe
|
|
1451
1512
|
*
|
|
1452
1513
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetVertexBoneWeights)
|
|
1514
|
+
* @param this Instance which allows for the runtime creation and manipulation of meshes.
|
|
1515
|
+
* @param vertexId Vertex ID for which to get the associated bone weights.
|
|
1516
|
+
* @returns Skinning blend weights for each bone that is associated with the vertex.
|
|
1453
1517
|
*/
|
|
1454
1518
|
GetVertexBoneWeights(this: EditableMesh, vertexId: number): Array<unknown>;
|
|
1455
1519
|
/**
|
|
1520
|
+
* Returns all bone IDs that are associated with the vertex for skinning.
|
|
1521
|
+
*
|
|
1456
1522
|
* - **ThreadSafety**: Unsafe
|
|
1457
1523
|
*
|
|
1458
1524
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetVertexBones)
|
|
1525
|
+
* @param this Instance which allows for the runtime creation and manipulation of meshes.
|
|
1526
|
+
* @param vertexId Vertex ID for which to get the associated bones.
|
|
1527
|
+
* @returns Bone IDs associated with the vertex for skinning.
|
|
1459
1528
|
*/
|
|
1460
1529
|
GetVertexBones(this: EditableMesh, vertexId: number): Array<unknown>;
|
|
1461
1530
|
/**
|
|
@@ -1588,9 +1657,13 @@ interface EditableMesh extends RBXObject {
|
|
|
1588
1657
|
Vector3
|
|
1589
1658
|
]>;
|
|
1590
1659
|
/**
|
|
1660
|
+
* Removes a bone using its stable bone ID.
|
|
1661
|
+
*
|
|
1591
1662
|
* - **ThreadSafety**: Unsafe
|
|
1592
1663
|
*
|
|
1593
1664
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#RemoveBone)
|
|
1665
|
+
* @param this Instance which allows for the runtime creation and manipulation of meshes.
|
|
1666
|
+
* @param boneId
|
|
1594
1667
|
*/
|
|
1595
1668
|
RemoveBone(this: EditableMesh, boneId: number): void;
|
|
1596
1669
|
/**
|
|
@@ -1624,27 +1697,47 @@ interface EditableMesh extends RBXObject {
|
|
|
1624
1697
|
*/
|
|
1625
1698
|
ResetNormal(this: EditableMesh, normalId: number): void;
|
|
1626
1699
|
/**
|
|
1700
|
+
* Set the initial `CFrame` for a bone in the mesh's bind pose.
|
|
1701
|
+
*
|
|
1627
1702
|
* - **ThreadSafety**: Unsafe
|
|
1628
1703
|
*
|
|
1629
1704
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#SetBoneCFrame)
|
|
1705
|
+
* @param this Instance which allows for the runtime creation and manipulation of meshes.
|
|
1706
|
+
* @param boneId Bone ID for which to set the initial `CFrame`.
|
|
1707
|
+
* @param cframe Initial `CFrame` for the bone in the mesh's bind pose, in the mesh's local space.
|
|
1630
1708
|
*/
|
|
1631
1709
|
SetBoneCFrame(this: EditableMesh, boneId: number, cframe: CFrame): void;
|
|
1632
1710
|
/**
|
|
1711
|
+
* Set whether a bone is virtual.
|
|
1712
|
+
*
|
|
1633
1713
|
* - **ThreadSafety**: Unsafe
|
|
1634
1714
|
*
|
|
1635
1715
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#SetBoneIsVirtual)
|
|
1716
|
+
* @param this Instance which allows for the runtime creation and manipulation of meshes.
|
|
1717
|
+
* @param boneId Bone ID for which to set whether the bone is virtual.
|
|
1718
|
+
* @param virtual Whether the bone should be virtual.
|
|
1636
1719
|
*/
|
|
1637
1720
|
SetBoneIsVirtual(this: EditableMesh, boneId: number, virtual: boolean): void;
|
|
1638
1721
|
/**
|
|
1722
|
+
* Sets the name for a bone.
|
|
1723
|
+
*
|
|
1639
1724
|
* - **ThreadSafety**: Unsafe
|
|
1640
1725
|
*
|
|
1641
1726
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#SetBoneName)
|
|
1727
|
+
* @param this Instance which allows for the runtime creation and manipulation of meshes.
|
|
1728
|
+
* @param boneId Bone ID for which to set the name.
|
|
1729
|
+
* @param name Bone name to set.
|
|
1642
1730
|
*/
|
|
1643
1731
|
SetBoneName(this: EditableMesh, boneId: number, name: string): void;
|
|
1644
1732
|
/**
|
|
1733
|
+
* Set a parent for a bone.
|
|
1734
|
+
*
|
|
1645
1735
|
* - **ThreadSafety**: Unsafe
|
|
1646
1736
|
*
|
|
1647
1737
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#SetBoneParent)
|
|
1738
|
+
* @param this Instance which allows for the runtime creation and manipulation of meshes.
|
|
1739
|
+
* @param boneId Bone ID for which to set the parent.
|
|
1740
|
+
* @param parentBoneId Parent bone ID.
|
|
1648
1741
|
*/
|
|
1649
1742
|
SetBoneParent(this: EditableMesh, boneId: number, parentBoneId: number): void;
|
|
1650
1743
|
/**
|
|
@@ -1718,21 +1811,39 @@ interface EditableMesh extends RBXObject {
|
|
|
1718
1811
|
*/
|
|
1719
1812
|
SetFaceVertices(this: EditableMesh, faceId: number, ids: Array<unknown>): void;
|
|
1720
1813
|
/**
|
|
1814
|
+
* Set `CFrame` for an individual bone in a specific FACS action unit.
|
|
1815
|
+
*
|
|
1721
1816
|
* - **ThreadSafety**: Unsafe
|
|
1722
1817
|
*
|
|
1723
1818
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#SetFacsBonePose)
|
|
1819
|
+
* @param this Instance which allows for the runtime creation and manipulation of meshes.
|
|
1820
|
+
* @param action FACS action unit for which to set the pose.
|
|
1821
|
+
* @param boneId Bone to set a `CFrame` for this pose.
|
|
1822
|
+
* @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
1823
|
*/
|
|
1725
1824
|
SetFacsBonePose(this: EditableMesh, action: CastsToEnum<Enum.FacsActionUnit>, boneId: number, cframe: CFrame): void;
|
|
1726
1825
|
/**
|
|
1826
|
+
* Set pose for all bones in a specific FACS corrective pose.
|
|
1827
|
+
*
|
|
1727
1828
|
* - **ThreadSafety**: Unsafe
|
|
1728
1829
|
*
|
|
1729
1830
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#SetFacsCorrectivePose)
|
|
1831
|
+
* @param this Instance which allows for the runtime creation and manipulation of meshes.
|
|
1832
|
+
* @param actions Array or 2 or 3 `FacsActionUnit` values to apply as a corrective pose.
|
|
1833
|
+
* @param boneIds Bones to set a `CFrame` for this pose.
|
|
1834
|
+
* @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
1835
|
*/
|
|
1731
1836
|
SetFacsCorrectivePose(this: EditableMesh, actions: Array<unknown>, boneIds: Array<unknown>, cframes: Array<unknown>): void;
|
|
1732
1837
|
/**
|
|
1838
|
+
* Set pose for all bones in a specific FACS action unit.
|
|
1839
|
+
*
|
|
1733
1840
|
* - **ThreadSafety**: Unsafe
|
|
1734
1841
|
*
|
|
1735
1842
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#SetFacsPose)
|
|
1843
|
+
* @param this Instance which allows for the runtime creation and manipulation of meshes.
|
|
1844
|
+
* @param action FACS action unit to set the pose for.
|
|
1845
|
+
* @param boneIds Bones for which to set a `CFrame` for this pose.
|
|
1846
|
+
* @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
1847
|
*/
|
|
1737
1848
|
SetFacsPose(this: EditableMesh, action: CastsToEnum<Enum.FacsActionUnit>, boneIds: Array<unknown>, cframes: Array<unknown>): void;
|
|
1738
1849
|
/**
|
|
@@ -1769,15 +1880,25 @@ interface EditableMesh extends RBXObject {
|
|
|
1769
1880
|
*/
|
|
1770
1881
|
SetUV(this: EditableMesh, uvId: number, uv: Vector2): void;
|
|
1771
1882
|
/**
|
|
1883
|
+
* Sets skinning blend weights for each bone associated with the vertex.
|
|
1884
|
+
*
|
|
1772
1885
|
* - **ThreadSafety**: Unsafe
|
|
1773
1886
|
*
|
|
1774
1887
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#SetVertexBoneWeights)
|
|
1888
|
+
* @param this Instance which allows for the runtime creation and manipulation of meshes.
|
|
1889
|
+
* @param vertexId Vertex ID on which to set skinning blend weights.
|
|
1890
|
+
* @param boneWeights Skinning blend weights to set on the vertex.
|
|
1775
1891
|
*/
|
|
1776
1892
|
SetVertexBoneWeights(this: EditableMesh, vertexId: number, boneWeights: Array<unknown>): void;
|
|
1777
1893
|
/**
|
|
1894
|
+
* Assign a list of bones with the vertex for skinning.
|
|
1895
|
+
*
|
|
1778
1896
|
* - **ThreadSafety**: Unsafe
|
|
1779
1897
|
*
|
|
1780
1898
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#SetVertexBones)
|
|
1899
|
+
* @param this Instance which allows for the runtime creation and manipulation of meshes.
|
|
1900
|
+
* @param vertexId Vertex ID to set vertex skinning bones.
|
|
1901
|
+
* @param boneIDs Bone IDs to use with this vertex for skinning.
|
|
1781
1902
|
*/
|
|
1782
1903
|
SetVertexBones(this: EditableMesh, vertexId: number, boneIDs: Array<unknown>): void;
|
|
1783
1904
|
/**
|
|
@@ -17712,7 +17833,7 @@ interface TextBox extends GuiObject {
|
|
|
17712
17833
|
*/
|
|
17713
17834
|
readonly _nominal_TextBox: unique symbol;
|
|
17714
17835
|
/**
|
|
17715
|
-
* Determines whether clicking on the TextBox will clear its `TextBox.Text` property.
|
|
17836
|
+
* Determines whether clicking on the `TextBox` will clear its `TextBox.Text` property.
|
|
17716
17837
|
*
|
|
17717
17838
|
* - **ThreadSafety**: ReadSafe
|
|
17718
17839
|
*
|
|
@@ -17781,7 +17902,7 @@ interface TextBox extends GuiObject {
|
|
|
17781
17902
|
*/
|
|
17782
17903
|
MaxVisibleGraphemes: number;
|
|
17783
17904
|
/**
|
|
17784
|
-
* When set to true
|
|
17905
|
+
* 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
17906
|
*
|
|
17786
17907
|
* - **ThreadSafety**: ReadSafe
|
|
17787
17908
|
*
|
|
@@ -17802,7 +17923,7 @@ interface TextBox extends GuiObject {
|
|
|
17802
17923
|
*/
|
|
17803
17924
|
readonly OpenTypeFeaturesError: string;
|
|
17804
17925
|
/**
|
|
17805
|
-
* Sets the text color that gets used when no text has been entered into the TextBox yet.
|
|
17926
|
+
* Sets the text color that gets used when no text has been entered into the `TextBox` yet.
|
|
17806
17927
|
*
|
|
17807
17928
|
* - **ThreadSafety**: ReadSafe
|
|
17808
17929
|
*
|
|
@@ -17810,7 +17931,7 @@ interface TextBox extends GuiObject {
|
|
|
17810
17931
|
*/
|
|
17811
17932
|
PlaceholderColor3: Color3;
|
|
17812
17933
|
/**
|
|
17813
|
-
* Sets the text that gets displayed when no text has been entered into the TextBox yet.
|
|
17934
|
+
* Sets the text that gets displayed when no text has been entered into the `TextBox` yet.
|
|
17814
17935
|
*
|
|
17815
17936
|
* - **ThreadSafety**: ReadSafe
|
|
17816
17937
|
*
|
|
@@ -17818,7 +17939,7 @@ interface TextBox extends GuiObject {
|
|
|
17818
17939
|
*/
|
|
17819
17940
|
PlaceholderText: string;
|
|
17820
17941
|
/**
|
|
17821
|
-
* Determines whether the TextBox renders the `TextBox.Text` string using rich text formatting.
|
|
17942
|
+
* Determines whether the `TextBox` renders the `TextBox.Text` string using rich text formatting.
|
|
17822
17943
|
*
|
|
17823
17944
|
* - **ThreadSafety**: ReadSafe
|
|
17824
17945
|
*
|
|
@@ -17993,7 +18114,7 @@ interface TextBox extends GuiObject {
|
|
|
17993
18114
|
*/
|
|
17994
18115
|
CaptureFocus(this: TextBox): void;
|
|
17995
18116
|
/**
|
|
17996
|
-
* Returns true if the
|
|
18117
|
+
* Returns `true` if the `TextBox` is focused or `false` if it is not.
|
|
17997
18118
|
*
|
|
17998
18119
|
* - **ThreadSafety**: Unsafe
|
|
17999
18120
|
*
|
|
@@ -20968,6 +21089,8 @@ interface Humanoid extends Instance {
|
|
|
20968
21089
|
*/
|
|
20969
21090
|
DisplayName: string;
|
|
20970
21091
|
/**
|
|
21092
|
+
* Used to disable the internal physics and state machine of the Humanoid.
|
|
21093
|
+
*
|
|
20971
21094
|
* - **ThreadSafety**: ReadSafe
|
|
20972
21095
|
*
|
|
20973
21096
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Humanoid#EvaluateStateMachine)
|
|
@@ -23305,6 +23428,8 @@ interface InputBinding extends Instance {
|
|
|
23305
23428
|
*/
|
|
23306
23429
|
readonly _nominal_InputBinding: unique symbol;
|
|
23307
23430
|
/**
|
|
23431
|
+
* Specifies an alternate `KeyCode` for dispatching directionally "backward" inputs to the parent `InputAction`.
|
|
23432
|
+
*
|
|
23308
23433
|
* - **ThreadSafety**: ReadSafe
|
|
23309
23434
|
*
|
|
23310
23435
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputBinding#Backward)
|
|
@@ -23319,6 +23444,8 @@ interface InputBinding extends Instance {
|
|
|
23319
23444
|
*/
|
|
23320
23445
|
Down: Enum.KeyCode;
|
|
23321
23446
|
/**
|
|
23447
|
+
* Specifies an alternate `KeyCode` for dispatching directionally "forward" inputs to the parent `InputAction`.
|
|
23448
|
+
*
|
|
23322
23449
|
* - **ThreadSafety**: ReadSafe
|
|
23323
23450
|
*
|
|
23324
23451
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputBinding#Forward)
|
|
@@ -23455,7 +23582,7 @@ interface InputObject extends Instance {
|
|
|
23455
23582
|
*/
|
|
23456
23583
|
readonly _nominal_InputObject: unique symbol;
|
|
23457
23584
|
/**
|
|
23458
|
-
* A Vector3 describing the
|
|
23585
|
+
* A `Vector3` describing the delta between input movements.
|
|
23459
23586
|
*
|
|
23460
23587
|
* - **ThreadSafety**: ReadSafe
|
|
23461
23588
|
*
|
|
@@ -23471,7 +23598,7 @@ interface InputObject extends Instance {
|
|
|
23471
23598
|
*/
|
|
23472
23599
|
KeyCode: Enum.KeyCode;
|
|
23473
23600
|
/**
|
|
23474
|
-
*
|
|
23601
|
+
* A `Vector3` describing the positional value of this input.
|
|
23475
23602
|
*
|
|
23476
23603
|
* - **ThreadSafety**: ReadSafe
|
|
23477
23604
|
*
|
|
@@ -23487,7 +23614,7 @@ interface InputObject extends Instance {
|
|
|
23487
23614
|
*/
|
|
23488
23615
|
UserInputState: Enum.UserInputState;
|
|
23489
23616
|
/**
|
|
23490
|
-
* Describes the kind of input being performed (mouse, keyboard, gamepad, touch, etc).
|
|
23617
|
+
* Describes the kind of input being performed (mouse, keyboard, gamepad, touch, etc.).
|
|
23491
23618
|
*
|
|
23492
23619
|
* - **ThreadSafety**: ReadSafe
|
|
23493
23620
|
*
|
|
@@ -23495,11 +23622,14 @@ interface InputObject extends Instance {
|
|
|
23495
23622
|
*/
|
|
23496
23623
|
UserInputType: Enum.UserInputType;
|
|
23497
23624
|
/**
|
|
23625
|
+
* Returns whether the passed in modifier key is down.
|
|
23626
|
+
*
|
|
23498
23627
|
* - **ThreadSafety**: Unsafe
|
|
23499
23628
|
*
|
|
23500
23629
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputObject#IsModifierKeyDown)
|
|
23501
23630
|
* @param this An object created when an input begins that describes a particular user input.
|
|
23502
23631
|
* @param modifierKey
|
|
23632
|
+
* @returns `true` if the passed in `modifierKey` is being held down; `false` otherwise.
|
|
23503
23633
|
*/
|
|
23504
23634
|
IsModifierKeyDown(this: InputObject, modifierKey: CastsToEnum<Enum.ModifierKey>): boolean;
|
|
23505
23635
|
}
|
|
@@ -25868,6 +25998,13 @@ interface MarketplaceService extends Instance {
|
|
|
25868
25998
|
* @param subscriptionId The ID of the subscription to check for.
|
|
25869
25999
|
*/
|
|
25870
26000
|
GetUserSubscriptionStatusAsync(this: MarketplaceService, user: Player, subscriptionId: string): UserSubscriptionStatus;
|
|
26001
|
+
/**
|
|
26002
|
+
* - **ThreadSafety**: Unsafe
|
|
26003
|
+
* - **Tags**: Yields
|
|
26004
|
+
*
|
|
26005
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MarketplaceService#GetUsersPriceLevelsAsync)
|
|
26006
|
+
*/
|
|
26007
|
+
GetUsersPriceLevelsAsync(this: MarketplaceService, userIds: Array<unknown>): Array<unknown>;
|
|
25871
26008
|
/**
|
|
25872
26009
|
* Returns whether the given user has the given asset.
|
|
25873
26010
|
*
|
|
@@ -26049,21 +26186,6 @@ interface MaterialGenerationService extends Instance {
|
|
|
26049
26186
|
*/
|
|
26050
26187
|
readonly _nominal_MaterialGenerationService: unique symbol;
|
|
26051
26188
|
}
|
|
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
26189
|
/**
|
|
26068
26190
|
* The game service responsible for managing materials.
|
|
26069
26191
|
*
|
|
@@ -26589,9 +26711,9 @@ interface MetaBreakpointManager extends Instance {
|
|
|
26589
26711
|
/**
|
|
26590
26712
|
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
26591
26713
|
*
|
|
26592
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/
|
|
26714
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MicroProfilerService)
|
|
26593
26715
|
*/
|
|
26594
|
-
interface
|
|
26716
|
+
interface MicroProfilerService extends Instance {
|
|
26595
26717
|
/**
|
|
26596
26718
|
* **DO NOT USE!**
|
|
26597
26719
|
*
|
|
@@ -26599,30 +26721,40 @@ interface Moderation extends Instance {
|
|
|
26599
26721
|
* @hidden
|
|
26600
26722
|
* @deprecated
|
|
26601
26723
|
*/
|
|
26602
|
-
readonly
|
|
26724
|
+
readonly _nominal_MicroProfilerService: unique symbol;
|
|
26725
|
+
}
|
|
26726
|
+
/**
|
|
26727
|
+
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
26728
|
+
*
|
|
26729
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ModerationService)
|
|
26730
|
+
*/
|
|
26731
|
+
interface ModerationService extends Instance {
|
|
26732
|
+
/**
|
|
26733
|
+
* **DO NOT USE!**
|
|
26734
|
+
*
|
|
26735
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
26736
|
+
* @hidden
|
|
26737
|
+
* @deprecated
|
|
26738
|
+
*/
|
|
26739
|
+
readonly _nominal_ModerationService: unique symbol;
|
|
26603
26740
|
/**
|
|
26604
26741
|
* - **ThreadSafety**: Unsafe
|
|
26605
26742
|
* - **Tags**: Yields
|
|
26606
26743
|
*
|
|
26607
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/
|
|
26608
|
-
* @param this
|
|
26609
|
-
* @param config
|
|
26744
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ModerationService#InternalCreateReviewableContentAsync)
|
|
26610
26745
|
*/
|
|
26611
|
-
InternalCreateReviewableContentAsync(this:
|
|
26746
|
+
InternalCreateReviewableContentAsync(this: ModerationService, config: object): string;
|
|
26612
26747
|
/**
|
|
26613
26748
|
* - **ThreadSafety**: Unsafe
|
|
26614
26749
|
* - **Tags**: Yields
|
|
26615
26750
|
*
|
|
26616
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/
|
|
26617
|
-
* @param this
|
|
26618
|
-
* @param config
|
|
26751
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ModerationService#InternalRequestReviewableContentReviewAsync)
|
|
26619
26752
|
*/
|
|
26620
|
-
InternalRequestReviewableContentReviewAsync(this:
|
|
26753
|
+
InternalRequestReviewableContentReviewAsync(this: ModerationService, config: object): void;
|
|
26621
26754
|
/**
|
|
26622
26755
|
* - **ThreadSafety**: Unsafe
|
|
26623
26756
|
*
|
|
26624
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/
|
|
26625
|
-
* @param event
|
|
26757
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ModerationService#InternalProcessReviewableContentEvent)
|
|
26626
26758
|
*/
|
|
26627
26759
|
InternalProcessReviewableContentEvent: ((event: object) => boolean) | undefined;
|
|
26628
26760
|
}
|
|
@@ -30098,7 +30230,7 @@ interface Tool extends BackpackItem {
|
|
|
30098
30230
|
*/
|
|
30099
30231
|
GripUp: Vector3;
|
|
30100
30232
|
/**
|
|
30101
|
-
*
|
|
30233
|
+
* Controls whether the `Tool` can be activated without executing `Tool:Activate()`.
|
|
30102
30234
|
*
|
|
30103
30235
|
* - **ThreadSafety**: ReadSafe
|
|
30104
30236
|
*
|
|
@@ -35921,6 +36053,21 @@ interface ServiceVisibilityService extends Instance {
|
|
|
35921
36053
|
*/
|
|
35922
36054
|
readonly _nominal_ServiceVisibilityService: unique symbol;
|
|
35923
36055
|
}
|
|
36056
|
+
/**
|
|
36057
|
+
* - **Tags**: NotCreatable, Service
|
|
36058
|
+
*
|
|
36059
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SessionCheckService)
|
|
36060
|
+
*/
|
|
36061
|
+
interface SessionCheckService extends Instance {
|
|
36062
|
+
/**
|
|
36063
|
+
* **DO NOT USE!**
|
|
36064
|
+
*
|
|
36065
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
36066
|
+
* @hidden
|
|
36067
|
+
* @deprecated
|
|
36068
|
+
*/
|
|
36069
|
+
readonly _nominal_SessionCheckService: unique symbol;
|
|
36070
|
+
}
|
|
35924
36071
|
/**
|
|
35925
36072
|
* - **Tags**: NotCreatable, Service
|
|
35926
36073
|
*
|
|
@@ -36305,12 +36452,15 @@ interface SocialService extends Instance {
|
|
|
36305
36452
|
*/
|
|
36306
36453
|
CanSendGameInviteAsync(this: SocialService, player: Player, recipientId?: number): boolean;
|
|
36307
36454
|
/**
|
|
36455
|
+
* Returns the local player's RSVP status for the given event.
|
|
36456
|
+
*
|
|
36308
36457
|
* - **ThreadSafety**: Unsafe
|
|
36309
36458
|
* - **Tags**: Yields
|
|
36310
36459
|
*
|
|
36311
36460
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SocialService#GetEventRsvpStatusAsync)
|
|
36312
36461
|
* @param this Facilitates social functions that impact relationships made on the Roblox platform.
|
|
36313
|
-
* @param eventId
|
|
36462
|
+
* @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).
|
|
36463
|
+
* @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
36464
|
*/
|
|
36315
36465
|
GetEventRsvpStatusAsync(this: SocialService, eventId: string): Enum.RsvpStatus;
|
|
36316
36466
|
/**
|
|
@@ -36326,12 +36476,15 @@ interface SocialService extends Instance {
|
|
|
36326
36476
|
*/
|
|
36327
36477
|
GetPartyAsync(this: SocialService, partyId: string): Array<unknown>;
|
|
36328
36478
|
/**
|
|
36479
|
+
* Prompts the local `Player` with a prompt to change their RSVP status to the given event.
|
|
36480
|
+
*
|
|
36329
36481
|
* - **ThreadSafety**: Unsafe
|
|
36330
36482
|
* - **Tags**: Yields
|
|
36331
36483
|
*
|
|
36332
36484
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SocialService#PromptRsvpToEventAsync)
|
|
36333
36485
|
* @param this Facilitates social functions that impact relationships made on the Roblox platform.
|
|
36334
|
-
* @param eventId
|
|
36486
|
+
* @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).
|
|
36487
|
+
* @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
36488
|
*/
|
|
36336
36489
|
PromptRsvpToEventAsync(this: SocialService, eventId: string): Enum.RsvpStatus;
|
|
36337
36490
|
/**
|
|
@@ -37499,7 +37652,7 @@ interface StarterPlayer extends Instance {
|
|
|
37499
37652
|
*/
|
|
37500
37653
|
DevCameraOcclusionMode: Enum.DevCameraOcclusionMode;
|
|
37501
37654
|
/**
|
|
37502
|
-
* Lets
|
|
37655
|
+
* Lets you overwrite the player's camera mode on a computer.
|
|
37503
37656
|
*
|
|
37504
37657
|
* - **ThreadSafety**: ReadSafe
|
|
37505
37658
|
*
|
|
@@ -37507,7 +37660,7 @@ interface StarterPlayer extends Instance {
|
|
|
37507
37660
|
*/
|
|
37508
37661
|
DevComputerCameraMovementMode: Enum.DevComputerCameraMovementMode;
|
|
37509
37662
|
/**
|
|
37510
|
-
* Lets
|
|
37663
|
+
* Lets you overwrite the player's movement mode on a computer.
|
|
37511
37664
|
*
|
|
37512
37665
|
* - **ThreadSafety**: ReadSafe
|
|
37513
37666
|
*
|
|
@@ -37515,7 +37668,7 @@ interface StarterPlayer extends Instance {
|
|
|
37515
37668
|
*/
|
|
37516
37669
|
DevComputerMovementMode: Enum.DevComputerMovementMode;
|
|
37517
37670
|
/**
|
|
37518
|
-
* Lets
|
|
37671
|
+
* Lets you overwrite the player's camera mode on a touch-enabled device.
|
|
37519
37672
|
*
|
|
37520
37673
|
* - **ThreadSafety**: ReadSafe
|
|
37521
37674
|
*
|
|
@@ -37523,7 +37676,7 @@ interface StarterPlayer extends Instance {
|
|
|
37523
37676
|
*/
|
|
37524
37677
|
DevTouchCameraMovementMode: Enum.DevTouchCameraMovementMode;
|
|
37525
37678
|
/**
|
|
37526
|
-
* Lets
|
|
37679
|
+
* Lets you overwrite the player's movement mode on a touch-enabled device.
|
|
37527
37680
|
*
|
|
37528
37681
|
* - **ThreadSafety**: ReadSafe
|
|
37529
37682
|
*
|
|
@@ -39285,6 +39438,12 @@ interface TestService extends Instance {
|
|
|
39285
39438
|
* @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
39439
|
*/
|
|
39287
39440
|
ScopeTime(this: TestService): object;
|
|
39441
|
+
/**
|
|
39442
|
+
* - **ThreadSafety**: Unsafe
|
|
39443
|
+
*
|
|
39444
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TestService#TakeSnapshot)
|
|
39445
|
+
*/
|
|
39446
|
+
TakeSnapshot(this: TestService, snapshotname: string): void;
|
|
39288
39447
|
/**
|
|
39289
39448
|
* Prints if a condition is true, otherwise prints a warning.
|
|
39290
39449
|
*
|
|
@@ -41416,6 +41575,45 @@ interface UITextSizeConstraint extends UIConstraint {
|
|
|
41416
41575
|
*/
|
|
41417
41576
|
MinTextSize: number;
|
|
41418
41577
|
}
|
|
41578
|
+
/**
|
|
41579
|
+
* - **Tags**: NotReplicated, NotBrowsable
|
|
41580
|
+
*
|
|
41581
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UIContainerQuery)
|
|
41582
|
+
*/
|
|
41583
|
+
interface UIContainerQuery extends UIComponent {
|
|
41584
|
+
/**
|
|
41585
|
+
* **DO NOT USE!**
|
|
41586
|
+
*
|
|
41587
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
41588
|
+
* @hidden
|
|
41589
|
+
* @deprecated
|
|
41590
|
+
*/
|
|
41591
|
+
readonly _nominal_UIContainerQuery: unique symbol;
|
|
41592
|
+
/**
|
|
41593
|
+
* - **ThreadSafety**: ReadSafe
|
|
41594
|
+
*
|
|
41595
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UIContainerQuery#Active)
|
|
41596
|
+
*/
|
|
41597
|
+
Active: boolean;
|
|
41598
|
+
/**
|
|
41599
|
+
* - **ThreadSafety**: ReadSafe
|
|
41600
|
+
*
|
|
41601
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UIContainerQuery#AspectRatioRange)
|
|
41602
|
+
*/
|
|
41603
|
+
AspectRatioRange: NumberRange;
|
|
41604
|
+
/**
|
|
41605
|
+
* - **ThreadSafety**: ReadSafe
|
|
41606
|
+
*
|
|
41607
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UIContainerQuery#MaxSize)
|
|
41608
|
+
*/
|
|
41609
|
+
MaxSize: Vector2;
|
|
41610
|
+
/**
|
|
41611
|
+
* - **ThreadSafety**: ReadSafe
|
|
41612
|
+
*
|
|
41613
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UIContainerQuery#MinSize)
|
|
41614
|
+
*/
|
|
41615
|
+
MinSize: Vector2;
|
|
41616
|
+
}
|
|
41419
41617
|
/**
|
|
41420
41618
|
* UI modifier which applies deformation to corners of its parent `GuiObject`.
|
|
41421
41619
|
*
|
|
@@ -42588,7 +42786,7 @@ interface UserGameSettings extends Instance {
|
|
|
42588
42786
|
readonly StudioModeChanged: RBXScriptSignal<(isStudioMode: boolean) => void>;
|
|
42589
42787
|
}
|
|
42590
42788
|
/**
|
|
42591
|
-
* `UserInputService` is
|
|
42789
|
+
* `UserInputService` is primarily used to detect the input types available on a user's device, as well as detect input events.
|
|
42592
42790
|
*
|
|
42593
42791
|
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
42594
42792
|
*
|
|
@@ -42613,7 +42811,7 @@ interface UserInputService extends Instance {
|
|
|
42613
42811
|
*/
|
|
42614
42812
|
readonly AccelerometerEnabled: boolean;
|
|
42615
42813
|
/**
|
|
42616
|
-
* Describes whether the device
|
|
42814
|
+
* Describes whether the user's device has an available gamepad.
|
|
42617
42815
|
*
|
|
42618
42816
|
* - **ThreadSafety**: ReadSafe
|
|
42619
42817
|
* - **Tags**: NotReplicated
|
|
@@ -42679,7 +42877,7 @@ interface UserInputService extends Instance {
|
|
|
42679
42877
|
*/
|
|
42680
42878
|
readonly MouseEnabled: boolean;
|
|
42681
42879
|
/**
|
|
42682
|
-
* The content ID of the image
|
|
42880
|
+
* The content ID of the image for the user's mouse icon.
|
|
42683
42881
|
*
|
|
42684
42882
|
* - **ThreadSafety**: ReadSafe
|
|
42685
42883
|
*
|
|
@@ -42687,7 +42885,7 @@ interface UserInputService extends Instance {
|
|
|
42687
42885
|
*/
|
|
42688
42886
|
MouseIcon: ContentId;
|
|
42689
42887
|
/**
|
|
42690
|
-
* Determines whether the
|
|
42888
|
+
* Determines whether the mouse icon is visible.
|
|
42691
42889
|
*
|
|
42692
42890
|
* - **ThreadSafety**: ReadSafe
|
|
42693
42891
|
*
|
|
@@ -42722,6 +42920,8 @@ interface UserInputService extends Instance {
|
|
|
42722
42920
|
*/
|
|
42723
42921
|
readonly OnScreenKeyboardVisible: boolean;
|
|
42724
42922
|
/**
|
|
42923
|
+
* Queries the primary input type a player is using, based on anticipated user behavior.
|
|
42924
|
+
*
|
|
42725
42925
|
* - **ThreadSafety**: ReadSafe
|
|
42726
42926
|
* - **Tags**: NotReplicated
|
|
42727
42927
|
*
|
|
@@ -42729,7 +42929,7 @@ interface UserInputService extends Instance {
|
|
|
42729
42929
|
*/
|
|
42730
42930
|
readonly PreferredInput: Enum.PreferredInput;
|
|
42731
42931
|
/**
|
|
42732
|
-
* Describes whether the user's
|
|
42932
|
+
* Describes whether the user's device has a touch screen available.
|
|
42733
42933
|
*
|
|
42734
42934
|
* - **ThreadSafety**: ReadSafe
|
|
42735
42935
|
* - **Tags**: NotReplicated
|
|
@@ -42765,7 +42965,7 @@ interface UserInputService extends Instance {
|
|
|
42765
42965
|
* - **ThreadSafety**: Unsafe
|
|
42766
42966
|
*
|
|
42767
42967
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UserInputService#GamepadSupports)
|
|
42768
|
-
* @param this `UserInputService` is
|
|
42968
|
+
* @param this `UserInputService` is primarily used to detect the input types available on a user's device, as well as detect input events.
|
|
42769
42969
|
* @param gamepadNum The `UserInputType` of the gamepad.
|
|
42770
42970
|
* @param gamepadKeyCode The `KeyCode` of the button in question.
|
|
42771
42971
|
* @returns Whether the given gamepad supports a button corresponding with the given `KeyCode`.
|
|
@@ -42777,7 +42977,7 @@ interface UserInputService extends Instance {
|
|
|
42777
42977
|
* - **ThreadSafety**: Unsafe
|
|
42778
42978
|
*
|
|
42779
42979
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UserInputService#GetConnectedGamepads)
|
|
42780
|
-
* @param this `UserInputService` is
|
|
42980
|
+
* @param this `UserInputService` is primarily used to detect the input types available on a user's device, as well as detect input events.
|
|
42781
42981
|
* @returns An array of `UserInputTypes` corresponding with the gamepads connected to the user's device.
|
|
42782
42982
|
*/
|
|
42783
42983
|
GetConnectedGamepads(this: UserInputService): Array<Enum.UserInputType>;
|
|
@@ -42787,7 +42987,7 @@ interface UserInputService extends Instance {
|
|
|
42787
42987
|
* - **ThreadSafety**: Unsafe
|
|
42788
42988
|
*
|
|
42789
42989
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UserInputService#GetDeviceAcceleration)
|
|
42790
|
-
* @param this `UserInputService` is
|
|
42990
|
+
* @param this `UserInputService` is primarily used to detect the input types available on a user's device, as well as detect input events.
|
|
42791
42991
|
*/
|
|
42792
42992
|
GetDeviceAcceleration(this: UserInputService): InputObject;
|
|
42793
42993
|
/**
|
|
@@ -42796,18 +42996,17 @@ interface UserInputService extends Instance {
|
|
|
42796
42996
|
* - **ThreadSafety**: Unsafe
|
|
42797
42997
|
*
|
|
42798
42998
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UserInputService#GetDeviceGravity)
|
|
42799
|
-
* @param this `UserInputService` is
|
|
42999
|
+
* @param this `UserInputService` is primarily used to detect the input types available on a user's device, as well as detect input events.
|
|
42800
43000
|
*/
|
|
42801
43001
|
GetDeviceGravity(this: UserInputService): InputObject;
|
|
42802
43002
|
/**
|
|
42803
|
-
* Returns an `InputObject` and a `CFrame
|
|
43003
|
+
* Returns an `InputObject` and a `CFrame` describing the device's current rotation vector.
|
|
42804
43004
|
*
|
|
42805
43005
|
* - **ThreadSafety**: Unsafe
|
|
42806
43006
|
*
|
|
42807
43007
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UserInputService#GetDeviceRotation)
|
|
42808
|
-
* @param this `UserInputService` is
|
|
42809
|
-
* @returns A tuple containing two properties:
|
|
42810
|
-
* 2. The CFrame is the device's current rotation relative to its default reference frame.
|
|
43008
|
+
* @param this `UserInputService` is primarily used to detect the input types available on a user's device, as well as detect input events.
|
|
43009
|
+
* @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
43010
|
*/
|
|
42812
43011
|
GetDeviceRotation(this: UserInputService): LuaTuple<[
|
|
42813
43012
|
InputObject,
|
|
@@ -42819,16 +43018,16 @@ interface UserInputService extends Instance {
|
|
|
42819
43018
|
* - **ThreadSafety**: Unsafe
|
|
42820
43019
|
*
|
|
42821
43020
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UserInputService#GetFocusedTextBox)
|
|
42822
|
-
* @param this `UserInputService` is
|
|
43021
|
+
* @param this `UserInputService` is primarily used to detect the input types available on a user's device, as well as detect input events.
|
|
42823
43022
|
*/
|
|
42824
43023
|
GetFocusedTextBox(this: UserInputService): TextBox | undefined;
|
|
42825
43024
|
/**
|
|
42826
|
-
* Returns whether a gamepad with the given `UserInputType`
|
|
43025
|
+
* Returns whether a gamepad with the given `UserInputType` is connected.
|
|
42827
43026
|
*
|
|
42828
43027
|
* - **ThreadSafety**: Unsafe
|
|
42829
43028
|
*
|
|
42830
43029
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UserInputService#GetGamepadConnected)
|
|
42831
|
-
* @param this `UserInputService` is
|
|
43030
|
+
* @param this `UserInputService` is primarily used to detect the input types available on a user's device, as well as detect input events.
|
|
42832
43031
|
* @param gamepadNum The `UserInputType` of the gamepad in question.
|
|
42833
43032
|
* @returns Whether a gamepad associated with `UserInputType` is connected.
|
|
42834
43033
|
*/
|
|
@@ -42839,7 +43038,7 @@ interface UserInputService extends Instance {
|
|
|
42839
43038
|
* - **ThreadSafety**: Unsafe
|
|
42840
43039
|
*
|
|
42841
43040
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UserInputService#GetGamepadState)
|
|
42842
|
-
* @param this `UserInputService` is
|
|
43041
|
+
* @param this `UserInputService` is primarily used to detect the input types available on a user's device, as well as detect input events.
|
|
42843
43042
|
* @param gamepadNum The `UserInputType` corresponding with the gamepad in question.
|
|
42844
43043
|
* @returns An array of `InputObjects` representing the current state of all available inputs for the given gamepad.
|
|
42845
43044
|
*/
|
|
@@ -42850,7 +43049,7 @@ interface UserInputService extends Instance {
|
|
|
42850
43049
|
* - **ThreadSafety**: Unsafe
|
|
42851
43050
|
*
|
|
42852
43051
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UserInputService#GetImageForKeyCode)
|
|
42853
|
-
* @param this `UserInputService` is
|
|
43052
|
+
* @param this `UserInputService` is primarily used to detect the input types available on a user's device, as well as detect input events.
|
|
42854
43053
|
* @param keyCode The `KeyCode` for which to fetch the associated image.
|
|
42855
43054
|
* @returns The returned image asset ID.
|
|
42856
43055
|
*/
|
|
@@ -42861,7 +43060,7 @@ interface UserInputService extends Instance {
|
|
|
42861
43060
|
* - **ThreadSafety**: Unsafe
|
|
42862
43061
|
*
|
|
42863
43062
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UserInputService#GetKeysPressed)
|
|
42864
|
-
* @param this `UserInputService` is
|
|
43063
|
+
* @param this `UserInputService` is primarily used to detect the input types available on a user's device, as well as detect input events.
|
|
42865
43064
|
* @returns An array of `InputObjects` associated with the keys currently being pressed.
|
|
42866
43065
|
*/
|
|
42867
43066
|
GetKeysPressed(this: UserInputService): Array<InputObject>;
|
|
@@ -42871,17 +43070,17 @@ interface UserInputService extends Instance {
|
|
|
42871
43070
|
* - **ThreadSafety**: Unsafe
|
|
42872
43071
|
*
|
|
42873
43072
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UserInputService#GetLastInputType)
|
|
42874
|
-
* @param this `UserInputService` is
|
|
43073
|
+
* @param this `UserInputService` is primarily used to detect the input types available on a user's device, as well as detect input events.
|
|
42875
43074
|
* @returns The `UserInputType` associated with the user's most recent input.
|
|
42876
43075
|
*/
|
|
42877
43076
|
GetLastInputType(this: UserInputService): Enum.UserInputType;
|
|
42878
43077
|
/**
|
|
42879
|
-
* Returns an array of `InputObjects`
|
|
43078
|
+
* Returns an array of `InputObjects` associated with the mouse buttons currently being held down.
|
|
42880
43079
|
*
|
|
42881
43080
|
* - **ThreadSafety**: Unsafe
|
|
42882
43081
|
*
|
|
42883
43082
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UserInputService#GetMouseButtonsPressed)
|
|
42884
|
-
* @param this `UserInputService` is
|
|
43083
|
+
* @param this `UserInputService` is primarily used to detect the input types available on a user's device, as well as detect input events.
|
|
42885
43084
|
* @returns An array of `InputObjects` corresponding to the mouse buttons currently being currently held down.
|
|
42886
43085
|
*/
|
|
42887
43086
|
GetMouseButtonsPressed(this: UserInputService): Array<InputObject>;
|
|
@@ -42891,28 +43090,28 @@ interface UserInputService extends Instance {
|
|
|
42891
43090
|
* - **ThreadSafety**: Unsafe
|
|
42892
43091
|
*
|
|
42893
43092
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UserInputService#GetMouseDelta)
|
|
42894
|
-
* @param this `UserInputService` is
|
|
43093
|
+
* @param this `UserInputService` is primarily used to detect the input types available on a user's device, as well as detect input events.
|
|
42895
43094
|
* @returns Change in movement of the mouse.
|
|
42896
43095
|
*/
|
|
42897
43096
|
GetMouseDelta(this: UserInputService): Vector2;
|
|
42898
43097
|
/**
|
|
42899
|
-
* Returns the current screen location of the player's `Mouse` relative to the top
|
|
43098
|
+
* Returns the current screen location of the player's `Mouse` relative to the top-left corner of the screen.
|
|
42900
43099
|
*
|
|
42901
43100
|
* - **ThreadSafety**: Unsafe
|
|
42902
43101
|
*
|
|
42903
43102
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UserInputService#GetMouseLocation)
|
|
42904
|
-
* @param this `UserInputService` is
|
|
43103
|
+
* @param this `UserInputService` is primarily used to detect the input types available on a user's device, as well as detect input events.
|
|
42905
43104
|
* @returns A `Vector2` representing the current screen location of the mouse, in pixels.
|
|
42906
43105
|
*/
|
|
42907
43106
|
GetMouseLocation(this: UserInputService): Vector2;
|
|
42908
43107
|
/**
|
|
42909
|
-
* Returns an array of
|
|
43108
|
+
* Returns an array of gamepads connected and enabled for `GuiObject` navigation in descending order of priority.
|
|
42910
43109
|
*
|
|
42911
43110
|
* - **ThreadSafety**: Unsafe
|
|
42912
43111
|
*
|
|
42913
43112
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UserInputService#GetNavigationGamepads)
|
|
42914
|
-
* @param this `UserInputService` is
|
|
42915
|
-
* @returns An array of `UserInputTypes` that can be used for
|
|
43113
|
+
* @param this `UserInputService` is primarily used to detect the input types available on a user's device, as well as detect input events.
|
|
43114
|
+
* @returns An array of `UserInputTypes` that can be used for navigation, in descending order of priority.
|
|
42916
43115
|
*/
|
|
42917
43116
|
GetNavigationGamepads(this: UserInputService): Array<Enum.UserInputType>;
|
|
42918
43117
|
/**
|
|
@@ -42921,7 +43120,7 @@ interface UserInputService extends Instance {
|
|
|
42921
43120
|
* - **ThreadSafety**: Unsafe
|
|
42922
43121
|
*
|
|
42923
43122
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UserInputService#GetStringForKeyCode)
|
|
42924
|
-
* @param this `UserInputService` is
|
|
43123
|
+
* @param this `UserInputService` is primarily used to detect the input types available on a user's device, as well as detect input events.
|
|
42925
43124
|
* @param keyCode
|
|
42926
43125
|
*/
|
|
42927
43126
|
GetStringForKeyCode(this: UserInputService, keyCode: CastsToEnum<Enum.KeyCode>): string;
|
|
@@ -42931,7 +43130,7 @@ interface UserInputService extends Instance {
|
|
|
42931
43130
|
* - **ThreadSafety**: Unsafe
|
|
42932
43131
|
*
|
|
42933
43132
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UserInputService#GetSupportedGamepadKeyCodes)
|
|
42934
|
-
* @param this `UserInputService` is
|
|
43133
|
+
* @param this `UserInputService` is primarily used to detect the input types available on a user's device, as well as detect input events.
|
|
42935
43134
|
* @param gamepadNum The `UserInputType` of the gamepad.
|
|
42936
43135
|
* @returns An array of `KeyCodes` supported by the given gamepad.
|
|
42937
43136
|
*/
|
|
@@ -42945,7 +43144,7 @@ interface UserInputService extends Instance {
|
|
|
42945
43144
|
* - **Tags**:
|
|
42946
43145
|
*
|
|
42947
43146
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UserInputService#GetUserCFrame)
|
|
42948
|
-
* @param this `UserInputService` is
|
|
43147
|
+
* @param this `UserInputService` is primarily used to detect the input types available on a user's device, as well as detect input events.
|
|
42949
43148
|
* @param type The `UserCFrame` corresponding to the VR device.
|
|
42950
43149
|
* @returns A `CFrame` describing the position and orientation of the specified VR device.
|
|
42951
43150
|
*
|
|
@@ -42953,15 +43152,15 @@ interface UserInputService extends Instance {
|
|
|
42953
43152
|
*/
|
|
42954
43153
|
GetUserCFrame(this: UserInputService, type: CastsToEnum<Enum.UserCFrame>): CFrame;
|
|
42955
43154
|
/**
|
|
42956
|
-
* Determines whether a particular button is pressed on a
|
|
43155
|
+
* Determines whether a particular button is pressed on a gamepad.
|
|
42957
43156
|
*
|
|
42958
43157
|
* - **ThreadSafety**: Unsafe
|
|
42959
43158
|
*
|
|
42960
43159
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UserInputService#IsGamepadButtonDown)
|
|
42961
|
-
* @param this `UserInputService` is
|
|
43160
|
+
* @param this `UserInputService` is primarily used to detect the input types available on a user's device, as well as detect input events.
|
|
42962
43161
|
* @param gamepadNum The `UserInputType` of the given gamepad.
|
|
42963
|
-
* @param gamepadKeyCode The `KeyCode` of the specified button.
|
|
42964
|
-
* @returns Whether the specified
|
|
43162
|
+
* @param gamepadKeyCode The `KeyCode` of the specified gamepad button.
|
|
43163
|
+
* @returns Whether the specified button on the given gamepad is pressed is pressed.
|
|
42965
43164
|
*/
|
|
42966
43165
|
IsGamepadButtonDown(this: UserInputService, gamepadNum: CastsToEnum<Enum.UserInputType>, gamepadKeyCode: CastsToEnum<Enum.KeyCode>): boolean;
|
|
42967
43166
|
/**
|
|
@@ -42970,29 +43169,29 @@ interface UserInputService extends Instance {
|
|
|
42970
43169
|
* - **ThreadSafety**: Unsafe
|
|
42971
43170
|
*
|
|
42972
43171
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UserInputService#IsKeyDown)
|
|
42973
|
-
* @param this `UserInputService` is
|
|
43172
|
+
* @param this `UserInputService` is primarily used to detect the input types available on a user's device, as well as detect input events.
|
|
42974
43173
|
* @param keyCode The `KeyCode` of the key.
|
|
42975
43174
|
* @returns Whether the specified key is being held down.
|
|
42976
43175
|
*/
|
|
42977
43176
|
IsKeyDown(this: UserInputService, keyCode: CastsToEnum<Enum.KeyCode>): boolean;
|
|
42978
43177
|
/**
|
|
42979
|
-
* Returns whether the given
|
|
43178
|
+
* Returns whether the given mouse button is currently held down.
|
|
42980
43179
|
*
|
|
42981
43180
|
* - **ThreadSafety**: Unsafe
|
|
42982
43181
|
*
|
|
42983
43182
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UserInputService#IsMouseButtonPressed)
|
|
42984
|
-
* @param this `UserInputService` is
|
|
43183
|
+
* @param this `UserInputService` is primarily used to detect the input types available on a user's device, as well as detect input events.
|
|
42985
43184
|
* @param mouseButton The `UserInputType` of the mouse button.
|
|
42986
43185
|
* @returns Whether the given mouse button is currently held down.
|
|
42987
43186
|
*/
|
|
42988
43187
|
IsMouseButtonPressed(this: UserInputService, mouseButton: CastsToEnum<Enum.UserInputType>): boolean;
|
|
42989
43188
|
/**
|
|
42990
|
-
* Returns true if the specified
|
|
43189
|
+
* Returns `true` if the specified gamepad is allowed to control navigation and selection `GuiObjects`.
|
|
42991
43190
|
*
|
|
42992
43191
|
* - **ThreadSafety**: Unsafe
|
|
42993
43192
|
*
|
|
42994
43193
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UserInputService#IsNavigationGamepad)
|
|
42995
|
-
* @param this `UserInputService` is
|
|
43194
|
+
* @param this `UserInputService` is primarily used to detect the input types available on a user's device, as well as detect input events.
|
|
42996
43195
|
* @param gamepadEnum The `UserInputType` of the specified gamepad.
|
|
42997
43196
|
* @returns Whether the specified gamepad is a navigation gamepad.
|
|
42998
43197
|
*/
|
|
@@ -43003,22 +43202,22 @@ interface UserInputService extends Instance {
|
|
|
43003
43202
|
* - **ThreadSafety**: Unsafe
|
|
43004
43203
|
*
|
|
43005
43204
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UserInputService#RecenterUserHeadCFrame)
|
|
43006
|
-
* @param this `UserInputService` is
|
|
43205
|
+
* @param this `UserInputService` is primarily used to detect the input types available on a user's device, as well as detect input events.
|
|
43007
43206
|
*/
|
|
43008
43207
|
RecenterUserHeadCFrame(this: UserInputService): void;
|
|
43009
43208
|
/**
|
|
43010
|
-
* Sets whether or not the specified
|
|
43209
|
+
* Sets whether or not the specified gamepad can move the `GuiObject` navigator.
|
|
43011
43210
|
*
|
|
43012
43211
|
* - **ThreadSafety**: Unsafe
|
|
43013
43212
|
*
|
|
43014
43213
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UserInputService#SetNavigationGamepad)
|
|
43015
|
-
* @param this `UserInputService` is
|
|
43214
|
+
* @param this `UserInputService` is primarily used to detect the input types available on a user's device, as well as detect input events.
|
|
43016
43215
|
* @param gamepadEnum The `UserInputType` of the specified gamepad.
|
|
43017
43216
|
* @param enabled Whether the specified gamepad can move the GUI navigator.
|
|
43018
43217
|
*/
|
|
43019
43218
|
SetNavigationGamepad(this: UserInputService, gamepadEnum: CastsToEnum<Enum.UserInputType>, enabled: boolean): void;
|
|
43020
43219
|
/**
|
|
43021
|
-
*
|
|
43220
|
+
* Fires when a user moves a device that has an accelerometer.
|
|
43022
43221
|
*
|
|
43023
43222
|
* - **ThreadSafety**: Unsafe
|
|
43024
43223
|
*
|
|
@@ -43026,7 +43225,7 @@ interface UserInputService extends Instance {
|
|
|
43026
43225
|
*/
|
|
43027
43226
|
readonly DeviceAccelerationChanged: RBXScriptSignal<(acceleration: InputObject) => void>;
|
|
43028
43227
|
/**
|
|
43029
|
-
*
|
|
43228
|
+
* Fires when the force of gravity changes on a device that has an enabled accelerometer.
|
|
43030
43229
|
*
|
|
43031
43230
|
* - **ThreadSafety**: Unsafe
|
|
43032
43231
|
*
|
|
@@ -43034,7 +43233,7 @@ interface UserInputService extends Instance {
|
|
|
43034
43233
|
*/
|
|
43035
43234
|
readonly DeviceGravityChanged: RBXScriptSignal<(gravity: InputObject) => void>;
|
|
43036
43235
|
/**
|
|
43037
|
-
*
|
|
43236
|
+
* Fires when a user rotates a device that has a gyroscope.
|
|
43038
43237
|
*
|
|
43039
43238
|
* - **ThreadSafety**: Unsafe
|
|
43040
43239
|
*
|
|
@@ -43042,7 +43241,7 @@ interface UserInputService extends Instance {
|
|
|
43042
43241
|
*/
|
|
43043
43242
|
readonly DeviceRotationChanged: RBXScriptSignal<(rotation: InputObject, cframe: CFrame) => void>;
|
|
43044
43243
|
/**
|
|
43045
|
-
* Fires when a gamepad is connected to the client.
|
|
43244
|
+
* Fires when a gamepad is connected to the client.
|
|
43046
43245
|
*
|
|
43047
43246
|
* - **ThreadSafety**: Unsafe
|
|
43048
43247
|
*
|
|
@@ -43050,7 +43249,7 @@ interface UserInputService extends Instance {
|
|
|
43050
43249
|
*/
|
|
43051
43250
|
readonly GamepadConnected: RBXScriptSignal<(gamepadNum: Enum.UserInputType) => void>;
|
|
43052
43251
|
/**
|
|
43053
|
-
* Fires when a gamepad is disconnected from the client.
|
|
43252
|
+
* Fires when a gamepad is disconnected from the client.
|
|
43054
43253
|
*
|
|
43055
43254
|
* - **ThreadSafety**: Unsafe
|
|
43056
43255
|
*
|
|
@@ -43058,7 +43257,7 @@ interface UserInputService extends Instance {
|
|
|
43058
43257
|
*/
|
|
43059
43258
|
readonly GamepadDisconnected: RBXScriptSignal<(gamepadNum: Enum.UserInputType) => void>;
|
|
43060
43259
|
/**
|
|
43061
|
-
*
|
|
43260
|
+
* Fires when a user begins interacting with an input device such as a mouse or gamepad.
|
|
43062
43261
|
*
|
|
43063
43262
|
* - **ThreadSafety**: Unsafe
|
|
43064
43263
|
*
|
|
@@ -43066,7 +43265,7 @@ interface UserInputService extends Instance {
|
|
|
43066
43265
|
*/
|
|
43067
43266
|
readonly InputBegan: RBXScriptSignal<(input: InputObject, gameProcessedEvent: boolean) => void>;
|
|
43068
43267
|
/**
|
|
43069
|
-
*
|
|
43268
|
+
* Fires when a user changes how they're interacting with an input device such as a mouse or gamepad.
|
|
43070
43269
|
*
|
|
43071
43270
|
* - **ThreadSafety**: Unsafe
|
|
43072
43271
|
*
|
|
@@ -43074,7 +43273,7 @@ interface UserInputService extends Instance {
|
|
|
43074
43273
|
*/
|
|
43075
43274
|
readonly InputChanged: RBXScriptSignal<(input: InputObject, gameProcessedEvent: boolean) => void>;
|
|
43076
43275
|
/**
|
|
43077
|
-
* Fires when a user stops interacting
|
|
43276
|
+
* Fires when a user stops interacting with an input device such as a mouse or gamepad.
|
|
43078
43277
|
*
|
|
43079
43278
|
* - **ThreadSafety**: Unsafe
|
|
43080
43279
|
*
|
|
@@ -43090,7 +43289,7 @@ interface UserInputService extends Instance {
|
|
|
43090
43289
|
*/
|
|
43091
43290
|
readonly JumpRequest: RBXScriptSignal<() => void>;
|
|
43092
43291
|
/**
|
|
43093
|
-
* Fires
|
|
43292
|
+
* Fires whenever the client's `UserInputType` is changed.
|
|
43094
43293
|
*
|
|
43095
43294
|
* - **ThreadSafety**: Unsafe
|
|
43096
43295
|
*
|
|
@@ -43098,7 +43297,7 @@ interface UserInputService extends Instance {
|
|
|
43098
43297
|
*/
|
|
43099
43298
|
readonly LastInputTypeChanged: RBXScriptSignal<(lastInputType: Enum.UserInputType) => void>;
|
|
43100
43299
|
/**
|
|
43101
|
-
* Fires when the user performs a specific pointer action
|
|
43300
|
+
* Fires when the user performs a specific pointer action.
|
|
43102
43301
|
*
|
|
43103
43302
|
* - **ThreadSafety**: Unsafe
|
|
43104
43303
|
*
|
|
@@ -43106,7 +43305,7 @@ interface UserInputService extends Instance {
|
|
|
43106
43305
|
*/
|
|
43107
43306
|
readonly PointerAction: RBXScriptSignal<(wheel: number, pan: Vector2, pinch: number, gameProcessedEvent: boolean) => void>;
|
|
43108
43307
|
/**
|
|
43109
|
-
*
|
|
43308
|
+
* Fires when the client loses focus on a `TextBox`.
|
|
43110
43309
|
*
|
|
43111
43310
|
* - **ThreadSafety**: Unsafe
|
|
43112
43311
|
*
|
|
@@ -43114,7 +43313,7 @@ interface UserInputService extends Instance {
|
|
|
43114
43313
|
*/
|
|
43115
43314
|
readonly TextBoxFocusReleased: RBXScriptSignal<(textboxReleased: TextBox) => void>;
|
|
43116
43315
|
/**
|
|
43117
|
-
*
|
|
43316
|
+
* Fires when the client focuses on a `TextBox`.
|
|
43118
43317
|
*
|
|
43119
43318
|
* - **ThreadSafety**: Unsafe
|
|
43120
43319
|
*
|
|
@@ -43122,13 +43321,15 @@ interface UserInputService extends Instance {
|
|
|
43122
43321
|
*/
|
|
43123
43322
|
readonly TextBoxFocused: RBXScriptSignal<(textboxFocused: TextBox) => void>;
|
|
43124
43323
|
/**
|
|
43324
|
+
* Fires when the user drags on the screen of a `TouchEnabled` device.
|
|
43325
|
+
*
|
|
43125
43326
|
* - **ThreadSafety**: Unsafe
|
|
43126
43327
|
*
|
|
43127
43328
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UserInputService#TouchDrag)
|
|
43128
43329
|
*/
|
|
43129
43330
|
readonly TouchDrag: RBXScriptSignal<(dragDirection: Enum.SwipeDirection, numberOfTouches: number, gameProcessedEvent: boolean) => void>;
|
|
43130
43331
|
/**
|
|
43131
|
-
*
|
|
43332
|
+
* Fires when a user releases their finger from the screen of a `TouchEnabled` device.
|
|
43132
43333
|
*
|
|
43133
43334
|
* - **ThreadSafety**: Unsafe
|
|
43134
43335
|
*
|
|
@@ -43136,7 +43337,7 @@ interface UserInputService extends Instance {
|
|
|
43136
43337
|
*/
|
|
43137
43338
|
readonly TouchEnded: RBXScriptSignal<(touch: InputObject, gameProcessedEvent: boolean) => void>;
|
|
43138
43339
|
/**
|
|
43139
|
-
*
|
|
43340
|
+
* Fires when a user holds at least one finger for a short amount of time on the screen of a `TouchEnabled` device.
|
|
43140
43341
|
*
|
|
43141
43342
|
* - **ThreadSafety**: Unsafe
|
|
43142
43343
|
*
|
|
@@ -43144,7 +43345,7 @@ interface UserInputService extends Instance {
|
|
|
43144
43345
|
*/
|
|
43145
43346
|
readonly TouchLongPress: RBXScriptSignal<(touchPositions: Array<Vector2>, state: Enum.UserInputState, gameProcessedEvent: boolean) => void>;
|
|
43146
43347
|
/**
|
|
43147
|
-
* Fires when a user moves their finger on a `TouchEnabled` device
|
|
43348
|
+
* Fires when a user moves their finger on the screen of a `TouchEnabled` device.
|
|
43148
43349
|
*
|
|
43149
43350
|
* - **ThreadSafety**: Unsafe
|
|
43150
43351
|
*
|
|
@@ -43152,7 +43353,7 @@ interface UserInputService extends Instance {
|
|
|
43152
43353
|
*/
|
|
43153
43354
|
readonly TouchMoved: RBXScriptSignal<(touch: InputObject, gameProcessedEvent: boolean) => void>;
|
|
43154
43355
|
/**
|
|
43155
|
-
*
|
|
43356
|
+
* Fires when the user drags at least one finger on the screen of a `TouchEnabled` device.
|
|
43156
43357
|
*
|
|
43157
43358
|
* - **ThreadSafety**: Unsafe
|
|
43158
43359
|
*
|
|
@@ -43160,7 +43361,7 @@ interface UserInputService extends Instance {
|
|
|
43160
43361
|
*/
|
|
43161
43362
|
readonly TouchPan: RBXScriptSignal<(touchPositions: Array<Vector2>, totalTranslation: Vector2, velocity: Vector2, state: Enum.UserInputState, gameProcessedEvent: boolean) => void>;
|
|
43162
43363
|
/**
|
|
43163
|
-
*
|
|
43364
|
+
* Fires when a user performs a pinch gesture on the screen of a `TouchEnabled` device.
|
|
43164
43365
|
*
|
|
43165
43366
|
* - **ThreadSafety**: Unsafe
|
|
43166
43367
|
*
|
|
@@ -43168,7 +43369,7 @@ interface UserInputService extends Instance {
|
|
|
43168
43369
|
*/
|
|
43169
43370
|
readonly TouchPinch: RBXScriptSignal<(touchPositions: Array<Vector2>, scale: number, velocity: number, state: Enum.UserInputState, gameProcessedEvent: boolean) => void>;
|
|
43170
43371
|
/**
|
|
43171
|
-
* Fires when a user rotates two fingers on
|
|
43372
|
+
* Fires when a user rotates two fingers on the screen of a `TouchEnabled` device.
|
|
43172
43373
|
*
|
|
43173
43374
|
* - **ThreadSafety**: Unsafe
|
|
43174
43375
|
*
|
|
@@ -43176,7 +43377,7 @@ interface UserInputService extends Instance {
|
|
|
43176
43377
|
*/
|
|
43177
43378
|
readonly TouchRotate: RBXScriptSignal<(touchPositions: Array<Vector2>, rotation: number, velocity: number, state: Enum.UserInputState, gameProcessedEvent: boolean) => void>;
|
|
43178
43379
|
/**
|
|
43179
|
-
*
|
|
43380
|
+
* Fires when a user places their finger on the screen of a `TouchEnabled` device.
|
|
43180
43381
|
*
|
|
43181
43382
|
* - **ThreadSafety**: Unsafe
|
|
43182
43383
|
*
|
|
@@ -43184,7 +43385,7 @@ interface UserInputService extends Instance {
|
|
|
43184
43385
|
*/
|
|
43185
43386
|
readonly TouchStarted: RBXScriptSignal<(touch: InputObject, gameProcessedEvent: boolean) => void>;
|
|
43186
43387
|
/**
|
|
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.
|
|
43388
|
+
* 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
43389
|
*
|
|
43189
43390
|
* - **ThreadSafety**: Unsafe
|
|
43190
43391
|
*
|
|
@@ -43192,7 +43393,7 @@ interface UserInputService extends Instance {
|
|
|
43192
43393
|
*/
|
|
43193
43394
|
readonly TouchSwipe: RBXScriptSignal<(swipeDirection: Enum.SwipeDirection, numberOfTouches: number, gameProcessedEvent: boolean) => void>;
|
|
43194
43395
|
/**
|
|
43195
|
-
*
|
|
43396
|
+
* Fires when a user taps their finger on the screen of a `TouchEnabled` device.
|
|
43196
43397
|
*
|
|
43197
43398
|
* - **ThreadSafety**: Unsafe
|
|
43198
43399
|
*
|
|
@@ -43200,7 +43401,7 @@ interface UserInputService extends Instance {
|
|
|
43200
43401
|
*/
|
|
43201
43402
|
readonly TouchTap: RBXScriptSignal<(touchPositions: Array<Vector2>, gameProcessedEvent: boolean) => void>;
|
|
43202
43403
|
/**
|
|
43203
|
-
* Fires when a user taps the
|
|
43404
|
+
* Fires when a user taps their finger on the screen of a `TouchEnabled` device and the tap location is in the 3D world.
|
|
43204
43405
|
*
|
|
43205
43406
|
* - **ThreadSafety**: Unsafe
|
|
43206
43407
|
*
|