@rbxts/types 1.0.858 → 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 +431 -158
- package/include/generated/PluginSecurity.d.ts +124 -54
- package/include/generated/enums.d.ts +242 -75
- package/package.json +1 -1
|
@@ -65,13 +65,13 @@ interface Services {
|
|
|
65
65
|
ExperienceNotificationService: ExperienceNotificationService;
|
|
66
66
|
ExperienceService: ExperienceService;
|
|
67
67
|
ExperienceStateCaptureService: ExperienceStateCaptureService;
|
|
68
|
+
ExperienceStateRecordingService: ExperienceStateRecordingService;
|
|
68
69
|
ExplorerServiceVisibilityService: ExplorerServiceVisibilityService;
|
|
69
70
|
FaceAnimatorService: FaceAnimatorService;
|
|
70
71
|
FacialAgeEstimationService: FacialAgeEstimationService;
|
|
71
72
|
FacialAnimationRecordingService: FacialAnimationRecordingService;
|
|
72
73
|
FacialAnimationStreamingServiceV2: FacialAnimationStreamingServiceV2;
|
|
73
74
|
FeatureRestrictionManager: FeatureRestrictionManager;
|
|
74
|
-
FeedService: FeedService;
|
|
75
75
|
GamepadService: GamepadService;
|
|
76
76
|
GamePassService: GamePassService;
|
|
77
77
|
GenerationService: GenerationService;
|
|
@@ -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;
|
|
@@ -136,6 +137,7 @@ interface Services {
|
|
|
136
137
|
ProcessInstancePhysicsService: ProcessInstancePhysicsService;
|
|
137
138
|
ProximityPromptService: ProximityPromptService;
|
|
138
139
|
PublishService: PublishService;
|
|
140
|
+
RecommendationService: RecommendationService;
|
|
139
141
|
ReflectionService: ReflectionService;
|
|
140
142
|
RemoteCursorService: RemoteCursorService;
|
|
141
143
|
RemoteDebuggerServer: RemoteDebuggerServer;
|
|
@@ -160,9 +162,11 @@ interface Services {
|
|
|
160
162
|
ServerScriptService: ServerScriptService;
|
|
161
163
|
ServerStorage: ServerStorage;
|
|
162
164
|
ServiceVisibilityService: ServiceVisibilityService;
|
|
165
|
+
SessionCheckService: SessionCheckService;
|
|
163
166
|
SessionService: SessionService;
|
|
164
167
|
SharedTableRegistry: SharedTableRegistry;
|
|
165
168
|
SlimContentProvider: SlimContentProvider;
|
|
169
|
+
SlimService: SlimService;
|
|
166
170
|
SmoothVoxelsUpgraderService: SmoothVoxelsUpgraderService;
|
|
167
171
|
SnippetService: SnippetService;
|
|
168
172
|
SocialService: SocialService;
|
|
@@ -480,6 +484,7 @@ interface CreatableInstances {
|
|
|
480
484
|
TremoloSoundEffect: TremoloSoundEffect;
|
|
481
485
|
TrussPart: TrussPart;
|
|
482
486
|
UIAspectRatioConstraint: UIAspectRatioConstraint;
|
|
487
|
+
UIContainerQuery: UIContainerQuery;
|
|
483
488
|
UICorner: UICorner;
|
|
484
489
|
UIDragDetector: UIDragDetector;
|
|
485
490
|
UIFlexItem: UIFlexItem;
|
|
@@ -579,7 +584,6 @@ interface Instances extends Services, CreatableInstances {
|
|
|
579
584
|
FacialAnimationStreamingSubsessionStats: FacialAnimationStreamingSubsessionStats;
|
|
580
585
|
FacsImportData: FacsImportData;
|
|
581
586
|
Feature: Feature;
|
|
582
|
-
FeedPages: FeedPages;
|
|
583
587
|
FormFactorPart: FormFactorPart;
|
|
584
588
|
FriendPages: FriendPages;
|
|
585
589
|
GenericSettings: GenericSettings;
|
|
@@ -606,7 +610,6 @@ interface Instances extends Services, CreatableInstances {
|
|
|
606
610
|
LodDataEntity: LodDataEntity;
|
|
607
611
|
LuaSourceContainer: LuaSourceContainer;
|
|
608
612
|
ManualSurfaceJointInstance: ManualSurfaceJointInstance;
|
|
609
|
-
MaterialGenerationSession: MaterialGenerationSession;
|
|
610
613
|
MaterialImportData: MaterialImportData;
|
|
611
614
|
MemoryStoreHashMap: MemoryStoreHashMap;
|
|
612
615
|
MemoryStoreHashMapPages: MemoryStoreHashMapPages;
|
|
@@ -643,6 +646,7 @@ interface Instances extends Services, CreatableInstances {
|
|
|
643
646
|
PostEffect: PostEffect;
|
|
644
647
|
PVAdornment: PVAdornment;
|
|
645
648
|
PVInstance: PVInstance;
|
|
649
|
+
RecommendationPages: RecommendationPages;
|
|
646
650
|
RobloxSerializableInstance: RobloxSerializableInstance;
|
|
647
651
|
RootImportData: RootImportData;
|
|
648
652
|
ScreenshotHud: ScreenshotHud;
|
|
@@ -1052,9 +1056,19 @@ interface EditableMesh extends RBXObject {
|
|
|
1052
1056
|
*/
|
|
1053
1057
|
SkinningEnabled: boolean;
|
|
1054
1058
|
/**
|
|
1059
|
+
* Adds a new bone and returns a stable bone ID.
|
|
1060
|
+
*
|
|
1055
1061
|
* - **ThreadSafety**: Unsafe
|
|
1056
1062
|
*
|
|
1057
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.
|
|
1058
1072
|
*/
|
|
1059
1073
|
AddBone(this: EditableMesh, boneProperties: object): number;
|
|
1060
1074
|
/**
|
|
@@ -1185,39 +1199,68 @@ interface EditableMesh extends RBXObject {
|
|
|
1185
1199
|
*/
|
|
1186
1200
|
GetAdjacentVertices(this: EditableMesh, vertexId: number): Array<number>;
|
|
1187
1201
|
/**
|
|
1202
|
+
* Finds the bone ID of the bone with the given name.
|
|
1203
|
+
*
|
|
1188
1204
|
* - **ThreadSafety**: Unsafe
|
|
1189
1205
|
*
|
|
1190
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.
|
|
1191
1210
|
*/
|
|
1192
1211
|
GetBoneByName(this: EditableMesh, boneName: string): number;
|
|
1193
1212
|
/**
|
|
1213
|
+
* Returns the initial `CFrame` of the bone in the bind pose of the mesh.
|
|
1214
|
+
*
|
|
1194
1215
|
* - **ThreadSafety**: Unsafe
|
|
1195
1216
|
*
|
|
1196
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.
|
|
1197
1221
|
*/
|
|
1198
1222
|
GetBoneCFrame(this: EditableMesh, boneId: number): CFrame;
|
|
1199
1223
|
/**
|
|
1224
|
+
* Returns `true` if the bone is virtual.
|
|
1225
|
+
*
|
|
1200
1226
|
* - **ThreadSafety**: Unsafe
|
|
1201
1227
|
*
|
|
1202
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.
|
|
1203
1232
|
*/
|
|
1204
1233
|
GetBoneIsVirtual(this: EditableMesh, boneId: number): boolean;
|
|
1205
1234
|
/**
|
|
1235
|
+
* Returns the bone name.
|
|
1236
|
+
*
|
|
1206
1237
|
* - **ThreadSafety**: Unsafe
|
|
1207
1238
|
*
|
|
1208
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.
|
|
1209
1243
|
*/
|
|
1210
1244
|
GetBoneName(this: EditableMesh, boneId: number): string;
|
|
1211
1245
|
/**
|
|
1246
|
+
* Returns the parent bone ID, if any.
|
|
1247
|
+
*
|
|
1212
1248
|
* - **ThreadSafety**: Unsafe
|
|
1213
1249
|
*
|
|
1214
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`.
|
|
1215
1254
|
*/
|
|
1216
1255
|
GetBoneParent(this: EditableMesh, boneId: number): number;
|
|
1217
1256
|
/**
|
|
1257
|
+
* Returns all bones of the mesh.
|
|
1258
|
+
*
|
|
1218
1259
|
* - **ThreadSafety**: Unsafe
|
|
1219
1260
|
*
|
|
1220
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.
|
|
1221
1264
|
*/
|
|
1222
1265
|
GetBones(this: EditableMesh): Array<unknown>;
|
|
1223
1266
|
/**
|
|
@@ -1358,27 +1401,45 @@ interface EditableMesh extends RBXObject {
|
|
|
1358
1401
|
*/
|
|
1359
1402
|
GetFacesWithUV(this: EditableMesh, uvId: number): Array<unknown>;
|
|
1360
1403
|
/**
|
|
1404
|
+
* Returns bone IDs and bone `CFrames` for all bones in a specific FACS corrective pose.
|
|
1405
|
+
*
|
|
1361
1406
|
* - **ThreadSafety**: Unsafe
|
|
1362
1407
|
*
|
|
1363
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`.
|
|
1364
1412
|
*/
|
|
1365
1413
|
GetFacsCorrectivePose(this: EditableMesh, actions: Array<unknown>): unknown;
|
|
1366
1414
|
/**
|
|
1415
|
+
* Returns all FACS corrective poses that are in use.
|
|
1416
|
+
*
|
|
1367
1417
|
* - **ThreadSafety**: Unsafe
|
|
1368
1418
|
*
|
|
1369
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.
|
|
1370
1422
|
*/
|
|
1371
1423
|
GetFacsCorrectivePoses(this: EditableMesh): Array<unknown>;
|
|
1372
1424
|
/**
|
|
1425
|
+
* Returns bone IDs and bone `CFrames` for all bones in a specific FACS action unit.
|
|
1426
|
+
*
|
|
1373
1427
|
* - **ThreadSafety**: Unsafe
|
|
1374
1428
|
*
|
|
1375
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`.
|
|
1376
1433
|
*/
|
|
1377
1434
|
GetFacsPose(this: EditableMesh, action: CastsToEnum<Enum.FacsActionUnit>): unknown;
|
|
1378
1435
|
/**
|
|
1436
|
+
* Returns all FACS action units that have poses defined.
|
|
1437
|
+
*
|
|
1379
1438
|
* - **ThreadSafety**: Unsafe
|
|
1380
1439
|
*
|
|
1381
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.
|
|
1382
1443
|
*/
|
|
1383
1444
|
GetFacsPoses(this: EditableMesh): Array<unknown>;
|
|
1384
1445
|
/**
|
|
@@ -1445,15 +1506,25 @@ interface EditableMesh extends RBXObject {
|
|
|
1445
1506
|
*/
|
|
1446
1507
|
GetUVs(this: EditableMesh): Array<unknown>;
|
|
1447
1508
|
/**
|
|
1509
|
+
* Returns skinning blend weights for each bone that is associated with the vertex.
|
|
1510
|
+
*
|
|
1448
1511
|
* - **ThreadSafety**: Unsafe
|
|
1449
1512
|
*
|
|
1450
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.
|
|
1451
1517
|
*/
|
|
1452
1518
|
GetVertexBoneWeights(this: EditableMesh, vertexId: number): Array<unknown>;
|
|
1453
1519
|
/**
|
|
1520
|
+
* Returns all bone IDs that are associated with the vertex for skinning.
|
|
1521
|
+
*
|
|
1454
1522
|
* - **ThreadSafety**: Unsafe
|
|
1455
1523
|
*
|
|
1456
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.
|
|
1457
1528
|
*/
|
|
1458
1529
|
GetVertexBones(this: EditableMesh, vertexId: number): Array<unknown>;
|
|
1459
1530
|
/**
|
|
@@ -1586,9 +1657,13 @@ interface EditableMesh extends RBXObject {
|
|
|
1586
1657
|
Vector3
|
|
1587
1658
|
]>;
|
|
1588
1659
|
/**
|
|
1660
|
+
* Removes a bone using its stable bone ID.
|
|
1661
|
+
*
|
|
1589
1662
|
* - **ThreadSafety**: Unsafe
|
|
1590
1663
|
*
|
|
1591
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
|
|
1592
1667
|
*/
|
|
1593
1668
|
RemoveBone(this: EditableMesh, boneId: number): void;
|
|
1594
1669
|
/**
|
|
@@ -1622,27 +1697,47 @@ interface EditableMesh extends RBXObject {
|
|
|
1622
1697
|
*/
|
|
1623
1698
|
ResetNormal(this: EditableMesh, normalId: number): void;
|
|
1624
1699
|
/**
|
|
1700
|
+
* Set the initial `CFrame` for a bone in the mesh's bind pose.
|
|
1701
|
+
*
|
|
1625
1702
|
* - **ThreadSafety**: Unsafe
|
|
1626
1703
|
*
|
|
1627
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.
|
|
1628
1708
|
*/
|
|
1629
1709
|
SetBoneCFrame(this: EditableMesh, boneId: number, cframe: CFrame): void;
|
|
1630
1710
|
/**
|
|
1711
|
+
* Set whether a bone is virtual.
|
|
1712
|
+
*
|
|
1631
1713
|
* - **ThreadSafety**: Unsafe
|
|
1632
1714
|
*
|
|
1633
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.
|
|
1634
1719
|
*/
|
|
1635
1720
|
SetBoneIsVirtual(this: EditableMesh, boneId: number, virtual: boolean): void;
|
|
1636
1721
|
/**
|
|
1722
|
+
* Sets the name for a bone.
|
|
1723
|
+
*
|
|
1637
1724
|
* - **ThreadSafety**: Unsafe
|
|
1638
1725
|
*
|
|
1639
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.
|
|
1640
1730
|
*/
|
|
1641
1731
|
SetBoneName(this: EditableMesh, boneId: number, name: string): void;
|
|
1642
1732
|
/**
|
|
1733
|
+
* Set a parent for a bone.
|
|
1734
|
+
*
|
|
1643
1735
|
* - **ThreadSafety**: Unsafe
|
|
1644
1736
|
*
|
|
1645
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.
|
|
1646
1741
|
*/
|
|
1647
1742
|
SetBoneParent(this: EditableMesh, boneId: number, parentBoneId: number): void;
|
|
1648
1743
|
/**
|
|
@@ -1716,21 +1811,39 @@ interface EditableMesh extends RBXObject {
|
|
|
1716
1811
|
*/
|
|
1717
1812
|
SetFaceVertices(this: EditableMesh, faceId: number, ids: Array<unknown>): void;
|
|
1718
1813
|
/**
|
|
1814
|
+
* Set `CFrame` for an individual bone in a specific FACS action unit.
|
|
1815
|
+
*
|
|
1719
1816
|
* - **ThreadSafety**: Unsafe
|
|
1720
1817
|
*
|
|
1721
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.
|
|
1722
1823
|
*/
|
|
1723
1824
|
SetFacsBonePose(this: EditableMesh, action: CastsToEnum<Enum.FacsActionUnit>, boneId: number, cframe: CFrame): void;
|
|
1724
1825
|
/**
|
|
1826
|
+
* Set pose for all bones in a specific FACS corrective pose.
|
|
1827
|
+
*
|
|
1725
1828
|
* - **ThreadSafety**: Unsafe
|
|
1726
1829
|
*
|
|
1727
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.
|
|
1728
1835
|
*/
|
|
1729
1836
|
SetFacsCorrectivePose(this: EditableMesh, actions: Array<unknown>, boneIds: Array<unknown>, cframes: Array<unknown>): void;
|
|
1730
1837
|
/**
|
|
1838
|
+
* Set pose for all bones in a specific FACS action unit.
|
|
1839
|
+
*
|
|
1731
1840
|
* - **ThreadSafety**: Unsafe
|
|
1732
1841
|
*
|
|
1733
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.
|
|
1734
1847
|
*/
|
|
1735
1848
|
SetFacsPose(this: EditableMesh, action: CastsToEnum<Enum.FacsActionUnit>, boneIds: Array<unknown>, cframes: Array<unknown>): void;
|
|
1736
1849
|
/**
|
|
@@ -1767,15 +1880,25 @@ interface EditableMesh extends RBXObject {
|
|
|
1767
1880
|
*/
|
|
1768
1881
|
SetUV(this: EditableMesh, uvId: number, uv: Vector2): void;
|
|
1769
1882
|
/**
|
|
1883
|
+
* Sets skinning blend weights for each bone associated with the vertex.
|
|
1884
|
+
*
|
|
1770
1885
|
* - **ThreadSafety**: Unsafe
|
|
1771
1886
|
*
|
|
1772
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.
|
|
1773
1891
|
*/
|
|
1774
1892
|
SetVertexBoneWeights(this: EditableMesh, vertexId: number, boneWeights: Array<unknown>): void;
|
|
1775
1893
|
/**
|
|
1894
|
+
* Assign a list of bones with the vertex for skinning.
|
|
1895
|
+
*
|
|
1776
1896
|
* - **ThreadSafety**: Unsafe
|
|
1777
1897
|
*
|
|
1778
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.
|
|
1779
1902
|
*/
|
|
1780
1903
|
SetVertexBones(this: EditableMesh, vertexId: number, boneIDs: Array<unknown>): void;
|
|
1781
1904
|
/**
|
|
@@ -3624,6 +3747,12 @@ interface AssetService extends Instance {
|
|
|
3624
3747
|
* @param editableMeshOptions Table containing options for the created `EditableMesh`. Currently no options are available since `FixedSize` will always be `false` for empty editable meshes.
|
|
3625
3748
|
*/
|
|
3626
3749
|
CreateEditableMesh(this: AssetService, editableMeshOptions?: object): EditableMesh;
|
|
3750
|
+
/**
|
|
3751
|
+
* - **ThreadSafety**: Unsafe
|
|
3752
|
+
*
|
|
3753
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AssetService#CreateSurfaceAppearance)
|
|
3754
|
+
*/
|
|
3755
|
+
CreateSurfaceAppearance(this: AssetService, content: object): SurfaceAppearance;
|
|
3627
3756
|
/**
|
|
3628
3757
|
* Uploads a new asset to Roblox from the given object.
|
|
3629
3758
|
*
|
|
@@ -6185,6 +6314,8 @@ interface AudioSpeechToText extends Instance {
|
|
|
6185
6314
|
* - **ThreadSafety**: Unsafe
|
|
6186
6315
|
*
|
|
6187
6316
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioSpeechToText#GetConnectedWires)
|
|
6317
|
+
* @param this
|
|
6318
|
+
* @param pin
|
|
6188
6319
|
*/
|
|
6189
6320
|
GetConnectedWires(this: AudioSpeechToText, pin: string): Array<Instance>;
|
|
6190
6321
|
/**
|
|
@@ -6726,12 +6857,14 @@ interface AvatarCreationService extends Instance {
|
|
|
6726
6857
|
*/
|
|
6727
6858
|
LoadGeneratedAvatarAsync(this: AvatarCreationService, generationId: string): HumanoidDescription;
|
|
6728
6859
|
/**
|
|
6860
|
+
* Prepares in-experience avatar for preview.
|
|
6861
|
+
*
|
|
6729
6862
|
* - **ThreadSafety**: Unsafe
|
|
6730
6863
|
* - **Tags**: Yields
|
|
6731
6864
|
*
|
|
6732
6865
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AvatarCreationService#PrepareAvatarForPreviewAsync)
|
|
6733
6866
|
* @param this A service to support developer avatar creators.
|
|
6734
|
-
* @param humanoidModel
|
|
6867
|
+
* @param humanoidModel The `Model` containing `MeshPart` children with `WrapDeformer` instances that require HSR data updating for preview.
|
|
6735
6868
|
*/
|
|
6736
6869
|
PrepareAvatarForPreviewAsync(this: AvatarCreationService, humanoidModel: Model): void;
|
|
6737
6870
|
/**
|
|
@@ -6809,6 +6942,8 @@ interface AvatarCreationService extends Instance {
|
|
|
6809
6942
|
*/
|
|
6810
6943
|
ValidateUGCFullBodyAsync(this: AvatarCreationService, player: Player, humanoidDescription: HumanoidDescription): unknown;
|
|
6811
6944
|
/**
|
|
6945
|
+
* Fires when an in-experience-created avatar's moderation status has been updated from pending.
|
|
6946
|
+
*
|
|
6812
6947
|
* - **ThreadSafety**: Unsafe
|
|
6813
6948
|
*
|
|
6814
6949
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AvatarCreationService#AvatarModerationCompleted)
|
|
@@ -14625,6 +14760,21 @@ interface ExperienceStateCaptureService extends Instance {
|
|
|
14625
14760
|
*/
|
|
14626
14761
|
readonly _nominal_ExperienceStateCaptureService: unique symbol;
|
|
14627
14762
|
}
|
|
14763
|
+
/**
|
|
14764
|
+
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
14765
|
+
*
|
|
14766
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ExperienceStateRecordingService)
|
|
14767
|
+
*/
|
|
14768
|
+
interface ExperienceStateRecordingService extends Instance {
|
|
14769
|
+
/**
|
|
14770
|
+
* **DO NOT USE!**
|
|
14771
|
+
*
|
|
14772
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
14773
|
+
* @hidden
|
|
14774
|
+
* @deprecated
|
|
14775
|
+
*/
|
|
14776
|
+
readonly _nominal_ExperienceStateRecordingService: unique symbol;
|
|
14777
|
+
}
|
|
14628
14778
|
/**
|
|
14629
14779
|
* - **Tags**: NotReplicated
|
|
14630
14780
|
*
|
|
@@ -15125,42 +15275,6 @@ interface FeatureRestrictionManager extends Instance {
|
|
|
15125
15275
|
*/
|
|
15126
15276
|
readonly _nominal_FeatureRestrictionManager: unique symbol;
|
|
15127
15277
|
}
|
|
15128
|
-
/**
|
|
15129
|
-
* - **Tags**: NotCreatable, Service
|
|
15130
|
-
*
|
|
15131
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/FeedService)
|
|
15132
|
-
*/
|
|
15133
|
-
interface FeedService extends Instance {
|
|
15134
|
-
/**
|
|
15135
|
-
* **DO NOT USE!**
|
|
15136
|
-
*
|
|
15137
|
-
* This field exists to force TypeScript to recognize this as a nominal type
|
|
15138
|
-
* @hidden
|
|
15139
|
-
* @deprecated
|
|
15140
|
-
*/
|
|
15141
|
-
readonly _nominal_FeedService: unique symbol;
|
|
15142
|
-
/**
|
|
15143
|
-
* - **ThreadSafety**: Unsafe
|
|
15144
|
-
* - **Tags**: Yields
|
|
15145
|
-
*
|
|
15146
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/FeedService#BatchRemoveFeedItemsAsync)
|
|
15147
|
-
*/
|
|
15148
|
-
BatchRemoveFeedItemsAsync(this: FeedService, feedItemIds: Array<unknown>): void;
|
|
15149
|
-
/**
|
|
15150
|
-
* - **ThreadSafety**: Unsafe
|
|
15151
|
-
* - **Tags**: Yields
|
|
15152
|
-
*
|
|
15153
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/FeedService#GetFeedItemsAsync)
|
|
15154
|
-
*/
|
|
15155
|
-
GetFeedItemsAsync(this: FeedService, getFeedRequest: object): FeedPages;
|
|
15156
|
-
/**
|
|
15157
|
-
* - **ThreadSafety**: Unsafe
|
|
15158
|
-
* - **Tags**: Yields
|
|
15159
|
-
*
|
|
15160
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/FeedService#RegisterFeedItemsAsync)
|
|
15161
|
-
*/
|
|
15162
|
-
RegisterFeedItemsAsync(this: FeedService, registerFeedItemsRequest: object): object;
|
|
15163
|
-
}
|
|
15164
15278
|
/**
|
|
15165
15279
|
* A particle emitter with the visual aesthetic of fire.
|
|
15166
15280
|
*
|
|
@@ -17719,7 +17833,7 @@ interface TextBox extends GuiObject {
|
|
|
17719
17833
|
*/
|
|
17720
17834
|
readonly _nominal_TextBox: unique symbol;
|
|
17721
17835
|
/**
|
|
17722
|
-
* 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.
|
|
17723
17837
|
*
|
|
17724
17838
|
* - **ThreadSafety**: ReadSafe
|
|
17725
17839
|
*
|
|
@@ -17788,7 +17902,7 @@ interface TextBox extends GuiObject {
|
|
|
17788
17902
|
*/
|
|
17789
17903
|
MaxVisibleGraphemes: number;
|
|
17790
17904
|
/**
|
|
17791
|
-
* 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.
|
|
17792
17906
|
*
|
|
17793
17907
|
* - **ThreadSafety**: ReadSafe
|
|
17794
17908
|
*
|
|
@@ -17809,7 +17923,7 @@ interface TextBox extends GuiObject {
|
|
|
17809
17923
|
*/
|
|
17810
17924
|
readonly OpenTypeFeaturesError: string;
|
|
17811
17925
|
/**
|
|
17812
|
-
* 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.
|
|
17813
17927
|
*
|
|
17814
17928
|
* - **ThreadSafety**: ReadSafe
|
|
17815
17929
|
*
|
|
@@ -17817,7 +17931,7 @@ interface TextBox extends GuiObject {
|
|
|
17817
17931
|
*/
|
|
17818
17932
|
PlaceholderColor3: Color3;
|
|
17819
17933
|
/**
|
|
17820
|
-
* 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.
|
|
17821
17935
|
*
|
|
17822
17936
|
* - **ThreadSafety**: ReadSafe
|
|
17823
17937
|
*
|
|
@@ -17825,7 +17939,7 @@ interface TextBox extends GuiObject {
|
|
|
17825
17939
|
*/
|
|
17826
17940
|
PlaceholderText: string;
|
|
17827
17941
|
/**
|
|
17828
|
-
* 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.
|
|
17829
17943
|
*
|
|
17830
17944
|
* - **ThreadSafety**: ReadSafe
|
|
17831
17945
|
*
|
|
@@ -18000,7 +18114,7 @@ interface TextBox extends GuiObject {
|
|
|
18000
18114
|
*/
|
|
18001
18115
|
CaptureFocus(this: TextBox): void;
|
|
18002
18116
|
/**
|
|
18003
|
-
* Returns true if the
|
|
18117
|
+
* Returns `true` if the `TextBox` is focused or `false` if it is not.
|
|
18004
18118
|
*
|
|
18005
18119
|
* - **ThreadSafety**: Unsafe
|
|
18006
18120
|
*
|
|
@@ -20975,6 +21089,8 @@ interface Humanoid extends Instance {
|
|
|
20975
21089
|
*/
|
|
20976
21090
|
DisplayName: string;
|
|
20977
21091
|
/**
|
|
21092
|
+
* Used to disable the internal physics and state machine of the Humanoid.
|
|
21093
|
+
*
|
|
20978
21094
|
* - **ThreadSafety**: ReadSafe
|
|
20979
21095
|
*
|
|
20980
21096
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Humanoid#EvaluateStateMachine)
|
|
@@ -23312,6 +23428,8 @@ interface InputBinding extends Instance {
|
|
|
23312
23428
|
*/
|
|
23313
23429
|
readonly _nominal_InputBinding: unique symbol;
|
|
23314
23430
|
/**
|
|
23431
|
+
* Specifies an alternate `KeyCode` for dispatching directionally "backward" inputs to the parent `InputAction`.
|
|
23432
|
+
*
|
|
23315
23433
|
* - **ThreadSafety**: ReadSafe
|
|
23316
23434
|
*
|
|
23317
23435
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputBinding#Backward)
|
|
@@ -23326,6 +23444,8 @@ interface InputBinding extends Instance {
|
|
|
23326
23444
|
*/
|
|
23327
23445
|
Down: Enum.KeyCode;
|
|
23328
23446
|
/**
|
|
23447
|
+
* Specifies an alternate `KeyCode` for dispatching directionally "forward" inputs to the parent `InputAction`.
|
|
23448
|
+
*
|
|
23329
23449
|
* - **ThreadSafety**: ReadSafe
|
|
23330
23450
|
*
|
|
23331
23451
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputBinding#Forward)
|
|
@@ -23462,7 +23582,7 @@ interface InputObject extends Instance {
|
|
|
23462
23582
|
*/
|
|
23463
23583
|
readonly _nominal_InputObject: unique symbol;
|
|
23464
23584
|
/**
|
|
23465
|
-
* A Vector3 describing the
|
|
23585
|
+
* A `Vector3` describing the delta between input movements.
|
|
23466
23586
|
*
|
|
23467
23587
|
* - **ThreadSafety**: ReadSafe
|
|
23468
23588
|
*
|
|
@@ -23478,7 +23598,7 @@ interface InputObject extends Instance {
|
|
|
23478
23598
|
*/
|
|
23479
23599
|
KeyCode: Enum.KeyCode;
|
|
23480
23600
|
/**
|
|
23481
|
-
*
|
|
23601
|
+
* A `Vector3` describing the positional value of this input.
|
|
23482
23602
|
*
|
|
23483
23603
|
* - **ThreadSafety**: ReadSafe
|
|
23484
23604
|
*
|
|
@@ -23494,7 +23614,7 @@ interface InputObject extends Instance {
|
|
|
23494
23614
|
*/
|
|
23495
23615
|
UserInputState: Enum.UserInputState;
|
|
23496
23616
|
/**
|
|
23497
|
-
* 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.).
|
|
23498
23618
|
*
|
|
23499
23619
|
* - **ThreadSafety**: ReadSafe
|
|
23500
23620
|
*
|
|
@@ -23502,11 +23622,14 @@ interface InputObject extends Instance {
|
|
|
23502
23622
|
*/
|
|
23503
23623
|
UserInputType: Enum.UserInputType;
|
|
23504
23624
|
/**
|
|
23625
|
+
* Returns whether the passed in modifier key is down.
|
|
23626
|
+
*
|
|
23505
23627
|
* - **ThreadSafety**: Unsafe
|
|
23506
23628
|
*
|
|
23507
23629
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputObject#IsModifierKeyDown)
|
|
23508
23630
|
* @param this An object created when an input begins that describes a particular user input.
|
|
23509
23631
|
* @param modifierKey
|
|
23632
|
+
* @returns `true` if the passed in `modifierKey` is being held down; `false` otherwise.
|
|
23510
23633
|
*/
|
|
23511
23634
|
IsModifierKeyDown(this: InputObject, modifierKey: CastsToEnum<Enum.ModifierKey>): boolean;
|
|
23512
23635
|
}
|
|
@@ -25875,6 +25998,13 @@ interface MarketplaceService extends Instance {
|
|
|
25875
25998
|
* @param subscriptionId The ID of the subscription to check for.
|
|
25876
25999
|
*/
|
|
25877
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>;
|
|
25878
26008
|
/**
|
|
25879
26009
|
* Returns whether the given user has the given asset.
|
|
25880
26010
|
*
|
|
@@ -26056,21 +26186,6 @@ interface MaterialGenerationService extends Instance {
|
|
|
26056
26186
|
*/
|
|
26057
26187
|
readonly _nominal_MaterialGenerationService: unique symbol;
|
|
26058
26188
|
}
|
|
26059
|
-
/**
|
|
26060
|
-
* - **Tags**: NotCreatable, NotReplicated
|
|
26061
|
-
*
|
|
26062
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MaterialGenerationSession)
|
|
26063
|
-
*/
|
|
26064
|
-
interface MaterialGenerationSession extends Instance {
|
|
26065
|
-
/**
|
|
26066
|
-
* **DO NOT USE!**
|
|
26067
|
-
*
|
|
26068
|
-
* This field exists to force TypeScript to recognize this as a nominal type
|
|
26069
|
-
* @hidden
|
|
26070
|
-
* @deprecated
|
|
26071
|
-
*/
|
|
26072
|
-
readonly _nominal_MaterialGenerationSession: unique symbol;
|
|
26073
|
-
}
|
|
26074
26189
|
/**
|
|
26075
26190
|
* The game service responsible for managing materials.
|
|
26076
26191
|
*
|
|
@@ -26596,9 +26711,24 @@ interface MetaBreakpointManager extends Instance {
|
|
|
26596
26711
|
/**
|
|
26597
26712
|
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
26598
26713
|
*
|
|
26599
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/
|
|
26714
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MicroProfilerService)
|
|
26715
|
+
*/
|
|
26716
|
+
interface MicroProfilerService extends Instance {
|
|
26717
|
+
/**
|
|
26718
|
+
* **DO NOT USE!**
|
|
26719
|
+
*
|
|
26720
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
26721
|
+
* @hidden
|
|
26722
|
+
* @deprecated
|
|
26723
|
+
*/
|
|
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)
|
|
26600
26730
|
*/
|
|
26601
|
-
interface
|
|
26731
|
+
interface ModerationService extends Instance {
|
|
26602
26732
|
/**
|
|
26603
26733
|
* **DO NOT USE!**
|
|
26604
26734
|
*
|
|
@@ -26606,25 +26736,25 @@ interface Moderation extends Instance {
|
|
|
26606
26736
|
* @hidden
|
|
26607
26737
|
* @deprecated
|
|
26608
26738
|
*/
|
|
26609
|
-
readonly
|
|
26739
|
+
readonly _nominal_ModerationService: unique symbol;
|
|
26610
26740
|
/**
|
|
26611
26741
|
* - **ThreadSafety**: Unsafe
|
|
26612
26742
|
* - **Tags**: Yields
|
|
26613
26743
|
*
|
|
26614
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/
|
|
26744
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ModerationService#InternalCreateReviewableContentAsync)
|
|
26615
26745
|
*/
|
|
26616
|
-
InternalCreateReviewableContentAsync(this:
|
|
26746
|
+
InternalCreateReviewableContentAsync(this: ModerationService, config: object): string;
|
|
26617
26747
|
/**
|
|
26618
26748
|
* - **ThreadSafety**: Unsafe
|
|
26619
26749
|
* - **Tags**: Yields
|
|
26620
26750
|
*
|
|
26621
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/
|
|
26751
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ModerationService#InternalRequestReviewableContentReviewAsync)
|
|
26622
26752
|
*/
|
|
26623
|
-
InternalRequestReviewableContentReviewAsync(this:
|
|
26753
|
+
InternalRequestReviewableContentReviewAsync(this: ModerationService, config: object): void;
|
|
26624
26754
|
/**
|
|
26625
26755
|
* - **ThreadSafety**: Unsafe
|
|
26626
26756
|
*
|
|
26627
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/
|
|
26757
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ModerationService#InternalProcessReviewableContentEvent)
|
|
26628
26758
|
*/
|
|
26629
26759
|
InternalProcessReviewableContentEvent: ((event: object) => boolean) | undefined;
|
|
26630
26760
|
}
|
|
@@ -30100,7 +30230,7 @@ interface Tool extends BackpackItem {
|
|
|
30100
30230
|
*/
|
|
30101
30231
|
GripUp: Vector3;
|
|
30102
30232
|
/**
|
|
30103
|
-
*
|
|
30233
|
+
* Controls whether the `Tool` can be activated without executing `Tool:Activate()`.
|
|
30104
30234
|
*
|
|
30105
30235
|
* - **ThreadSafety**: ReadSafe
|
|
30106
30236
|
*
|
|
@@ -30923,21 +31053,6 @@ interface DataStoreVersionPages extends Pages<DataStoreObjectVersionInfo> {
|
|
|
30923
31053
|
*/
|
|
30924
31054
|
readonly _nominal_DataStoreVersionPages: unique symbol;
|
|
30925
31055
|
}
|
|
30926
|
-
/**
|
|
30927
|
-
* - **Tags**: NotCreatable, NotReplicated
|
|
30928
|
-
*
|
|
30929
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/FeedPages)
|
|
30930
|
-
*/
|
|
30931
|
-
interface FeedPages extends Pages {
|
|
30932
|
-
/**
|
|
30933
|
-
* **DO NOT USE!**
|
|
30934
|
-
*
|
|
30935
|
-
* This field exists to force TypeScript to recognize this as a nominal type
|
|
30936
|
-
* @hidden
|
|
30937
|
-
* @deprecated
|
|
30938
|
-
*/
|
|
30939
|
-
readonly _nominal_FeedPages: unique symbol;
|
|
30940
|
-
}
|
|
30941
31056
|
/**
|
|
30942
31057
|
* A special version of `Pages` that contains information about a player's friends.
|
|
30943
31058
|
*
|
|
@@ -31029,6 +31144,21 @@ interface OutfitPages extends Pages<ReadonlyArray<{
|
|
|
31029
31144
|
*/
|
|
31030
31145
|
readonly _nominal_OutfitPages: unique symbol;
|
|
31031
31146
|
}
|
|
31147
|
+
/**
|
|
31148
|
+
* - **Tags**: NotCreatable, NotReplicated
|
|
31149
|
+
*
|
|
31150
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RecommendationPages)
|
|
31151
|
+
*/
|
|
31152
|
+
interface RecommendationPages extends Pages {
|
|
31153
|
+
/**
|
|
31154
|
+
* **DO NOT USE!**
|
|
31155
|
+
*
|
|
31156
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
31157
|
+
* @hidden
|
|
31158
|
+
* @deprecated
|
|
31159
|
+
*/
|
|
31160
|
+
readonly _nominal_RecommendationPages: unique symbol;
|
|
31161
|
+
}
|
|
31032
31162
|
/**
|
|
31033
31163
|
* - **Tags**: NotCreatable, NotReplicated
|
|
31034
31164
|
*
|
|
@@ -34268,6 +34398,61 @@ interface RTAnimationTracker extends Instance {
|
|
|
34268
34398
|
*/
|
|
34269
34399
|
readonly TrackerPrompt: RBXScriptSignal<(prompt: Enum.TrackerPromptEvent) => void>;
|
|
34270
34400
|
}
|
|
34401
|
+
/**
|
|
34402
|
+
* - **Tags**: NotCreatable, Service
|
|
34403
|
+
*
|
|
34404
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RecommendationService)
|
|
34405
|
+
*/
|
|
34406
|
+
interface RecommendationService extends Instance {
|
|
34407
|
+
/**
|
|
34408
|
+
* **DO NOT USE!**
|
|
34409
|
+
*
|
|
34410
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
34411
|
+
* @hidden
|
|
34412
|
+
* @deprecated
|
|
34413
|
+
*/
|
|
34414
|
+
readonly _nominal_RecommendationService: unique symbol;
|
|
34415
|
+
/**
|
|
34416
|
+
* - **ThreadSafety**: Unsafe
|
|
34417
|
+
*
|
|
34418
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RecommendationService#LogActionEvent)
|
|
34419
|
+
*/
|
|
34420
|
+
LogActionEvent(this: RecommendationService, actionType: CastsToEnum<Enum.RecommendationActionType>, itemId: string, tracingId: string, actionEventDetails?: object): void;
|
|
34421
|
+
/**
|
|
34422
|
+
* - **ThreadSafety**: Unsafe
|
|
34423
|
+
*
|
|
34424
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RecommendationService#LogImpressionEvent)
|
|
34425
|
+
*/
|
|
34426
|
+
LogImpressionEvent(this: RecommendationService, impressionType: CastsToEnum<Enum.RecommendationImpressionType>, itemId: string, tracingId: string, impressionEventDetails?: object): void;
|
|
34427
|
+
/**
|
|
34428
|
+
* - **ThreadSafety**: Unsafe
|
|
34429
|
+
* - **Tags**: Yields
|
|
34430
|
+
*
|
|
34431
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RecommendationService#GenerateItemListAsync)
|
|
34432
|
+
*/
|
|
34433
|
+
GenerateItemListAsync(this: RecommendationService, generateRecommendationItemListRequest: object): RecommendationPages;
|
|
34434
|
+
/**
|
|
34435
|
+
* - **ThreadSafety**: Unsafe
|
|
34436
|
+
* - **Tags**: Yields
|
|
34437
|
+
*
|
|
34438
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RecommendationService#RegisterItemAsync)
|
|
34439
|
+
*/
|
|
34440
|
+
RegisterItemAsync(this: RecommendationService, registerRecommendationItemsRequest: object): object;
|
|
34441
|
+
/**
|
|
34442
|
+
* - **ThreadSafety**: Unsafe
|
|
34443
|
+
* - **Tags**: Yields
|
|
34444
|
+
*
|
|
34445
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RecommendationService#RemoveItemAsync)
|
|
34446
|
+
*/
|
|
34447
|
+
RemoveItemAsync(this: RecommendationService, itemId: string): void;
|
|
34448
|
+
/**
|
|
34449
|
+
* - **ThreadSafety**: Unsafe
|
|
34450
|
+
* - **Tags**: Yields
|
|
34451
|
+
*
|
|
34452
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RecommendationService#UpdateItemAsync)
|
|
34453
|
+
*/
|
|
34454
|
+
UpdateItemAsync(this: RecommendationService, updateRecommendationItemRequest: object): void;
|
|
34455
|
+
}
|
|
34271
34456
|
/**
|
|
34272
34457
|
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
34273
34458
|
*
|
|
@@ -35868,6 +36053,21 @@ interface ServiceVisibilityService extends Instance {
|
|
|
35868
36053
|
*/
|
|
35869
36054
|
readonly _nominal_ServiceVisibilityService: unique symbol;
|
|
35870
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
|
+
}
|
|
35871
36071
|
/**
|
|
35872
36072
|
* - **Tags**: NotCreatable, Service
|
|
35873
36073
|
*
|
|
@@ -36040,6 +36240,21 @@ interface Sky extends Instance {
|
|
|
36040
36240
|
*/
|
|
36041
36241
|
SunTextureId: ContentId;
|
|
36042
36242
|
}
|
|
36243
|
+
/**
|
|
36244
|
+
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
36245
|
+
*
|
|
36246
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SlimService)
|
|
36247
|
+
*/
|
|
36248
|
+
interface SlimService extends Instance {
|
|
36249
|
+
/**
|
|
36250
|
+
* **DO NOT USE!**
|
|
36251
|
+
*
|
|
36252
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
36253
|
+
* @hidden
|
|
36254
|
+
* @deprecated
|
|
36255
|
+
*/
|
|
36256
|
+
readonly _nominal_SlimService: unique symbol;
|
|
36257
|
+
}
|
|
36043
36258
|
/**
|
|
36044
36259
|
* A particle emitter with the visual aesthetic of smoke.
|
|
36045
36260
|
*
|
|
@@ -36237,10 +36452,15 @@ interface SocialService extends Instance {
|
|
|
36237
36452
|
*/
|
|
36238
36453
|
CanSendGameInviteAsync(this: SocialService, player: Player, recipientId?: number): boolean;
|
|
36239
36454
|
/**
|
|
36455
|
+
* Returns the local player's RSVP status for the given event.
|
|
36456
|
+
*
|
|
36240
36457
|
* - **ThreadSafety**: Unsafe
|
|
36241
36458
|
* - **Tags**: Yields
|
|
36242
36459
|
*
|
|
36243
36460
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SocialService#GetEventRsvpStatusAsync)
|
|
36461
|
+
* @param this Facilitates social functions that impact relationships made on the Roblox platform.
|
|
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`.
|
|
36244
36464
|
*/
|
|
36245
36465
|
GetEventRsvpStatusAsync(this: SocialService, eventId: string): Enum.RsvpStatus;
|
|
36246
36466
|
/**
|
|
@@ -36256,10 +36476,15 @@ interface SocialService extends Instance {
|
|
|
36256
36476
|
*/
|
|
36257
36477
|
GetPartyAsync(this: SocialService, partyId: string): Array<unknown>;
|
|
36258
36478
|
/**
|
|
36479
|
+
* Prompts the local `Player` with a prompt to change their RSVP status to the given event.
|
|
36480
|
+
*
|
|
36259
36481
|
* - **ThreadSafety**: Unsafe
|
|
36260
36482
|
* - **Tags**: Yields
|
|
36261
36483
|
*
|
|
36262
36484
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SocialService#PromptRsvpToEventAsync)
|
|
36485
|
+
* @param this Facilitates social functions that impact relationships made on the Roblox platform.
|
|
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.
|
|
36263
36488
|
*/
|
|
36264
36489
|
PromptRsvpToEventAsync(this: SocialService, eventId: string): Enum.RsvpStatus;
|
|
36265
36490
|
/**
|
|
@@ -37427,7 +37652,7 @@ interface StarterPlayer extends Instance {
|
|
|
37427
37652
|
*/
|
|
37428
37653
|
DevCameraOcclusionMode: Enum.DevCameraOcclusionMode;
|
|
37429
37654
|
/**
|
|
37430
|
-
* Lets
|
|
37655
|
+
* Lets you overwrite the player's camera mode on a computer.
|
|
37431
37656
|
*
|
|
37432
37657
|
* - **ThreadSafety**: ReadSafe
|
|
37433
37658
|
*
|
|
@@ -37435,7 +37660,7 @@ interface StarterPlayer extends Instance {
|
|
|
37435
37660
|
*/
|
|
37436
37661
|
DevComputerCameraMovementMode: Enum.DevComputerCameraMovementMode;
|
|
37437
37662
|
/**
|
|
37438
|
-
* Lets
|
|
37663
|
+
* Lets you overwrite the player's movement mode on a computer.
|
|
37439
37664
|
*
|
|
37440
37665
|
* - **ThreadSafety**: ReadSafe
|
|
37441
37666
|
*
|
|
@@ -37443,7 +37668,7 @@ interface StarterPlayer extends Instance {
|
|
|
37443
37668
|
*/
|
|
37444
37669
|
DevComputerMovementMode: Enum.DevComputerMovementMode;
|
|
37445
37670
|
/**
|
|
37446
|
-
* Lets
|
|
37671
|
+
* Lets you overwrite the player's camera mode on a touch-enabled device.
|
|
37447
37672
|
*
|
|
37448
37673
|
* - **ThreadSafety**: ReadSafe
|
|
37449
37674
|
*
|
|
@@ -37451,7 +37676,7 @@ interface StarterPlayer extends Instance {
|
|
|
37451
37676
|
*/
|
|
37452
37677
|
DevTouchCameraMovementMode: Enum.DevTouchCameraMovementMode;
|
|
37453
37678
|
/**
|
|
37454
|
-
* Lets
|
|
37679
|
+
* Lets you overwrite the player's movement mode on a touch-enabled device.
|
|
37455
37680
|
*
|
|
37456
37681
|
* - **ThreadSafety**: ReadSafe
|
|
37457
37682
|
*
|
|
@@ -39213,6 +39438,12 @@ interface TestService extends Instance {
|
|
|
39213
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.
|
|
39214
39439
|
*/
|
|
39215
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;
|
|
39216
39447
|
/**
|
|
39217
39448
|
* Prints if a condition is true, otherwise prints a warning.
|
|
39218
39449
|
*
|
|
@@ -41344,6 +41575,45 @@ interface UITextSizeConstraint extends UIConstraint {
|
|
|
41344
41575
|
*/
|
|
41345
41576
|
MinTextSize: number;
|
|
41346
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
|
+
}
|
|
41347
41617
|
/**
|
|
41348
41618
|
* UI modifier which applies deformation to corners of its parent `GuiObject`.
|
|
41349
41619
|
*
|
|
@@ -42516,7 +42786,7 @@ interface UserGameSettings extends Instance {
|
|
|
42516
42786
|
readonly StudioModeChanged: RBXScriptSignal<(isStudioMode: boolean) => void>;
|
|
42517
42787
|
}
|
|
42518
42788
|
/**
|
|
42519
|
-
* `UserInputService` is
|
|
42789
|
+
* `UserInputService` is primarily used to detect the input types available on a user's device, as well as detect input events.
|
|
42520
42790
|
*
|
|
42521
42791
|
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
42522
42792
|
*
|
|
@@ -42541,7 +42811,7 @@ interface UserInputService extends Instance {
|
|
|
42541
42811
|
*/
|
|
42542
42812
|
readonly AccelerometerEnabled: boolean;
|
|
42543
42813
|
/**
|
|
42544
|
-
* Describes whether the device
|
|
42814
|
+
* Describes whether the user's device has an available gamepad.
|
|
42545
42815
|
*
|
|
42546
42816
|
* - **ThreadSafety**: ReadSafe
|
|
42547
42817
|
* - **Tags**: NotReplicated
|
|
@@ -42607,7 +42877,7 @@ interface UserInputService extends Instance {
|
|
|
42607
42877
|
*/
|
|
42608
42878
|
readonly MouseEnabled: boolean;
|
|
42609
42879
|
/**
|
|
42610
|
-
* The content ID of the image
|
|
42880
|
+
* The content ID of the image for the user's mouse icon.
|
|
42611
42881
|
*
|
|
42612
42882
|
* - **ThreadSafety**: ReadSafe
|
|
42613
42883
|
*
|
|
@@ -42615,7 +42885,7 @@ interface UserInputService extends Instance {
|
|
|
42615
42885
|
*/
|
|
42616
42886
|
MouseIcon: ContentId;
|
|
42617
42887
|
/**
|
|
42618
|
-
* Determines whether the
|
|
42888
|
+
* Determines whether the mouse icon is visible.
|
|
42619
42889
|
*
|
|
42620
42890
|
* - **ThreadSafety**: ReadSafe
|
|
42621
42891
|
*
|
|
@@ -42650,6 +42920,8 @@ interface UserInputService extends Instance {
|
|
|
42650
42920
|
*/
|
|
42651
42921
|
readonly OnScreenKeyboardVisible: boolean;
|
|
42652
42922
|
/**
|
|
42923
|
+
* Queries the primary input type a player is using, based on anticipated user behavior.
|
|
42924
|
+
*
|
|
42653
42925
|
* - **ThreadSafety**: ReadSafe
|
|
42654
42926
|
* - **Tags**: NotReplicated
|
|
42655
42927
|
*
|
|
@@ -42657,7 +42929,7 @@ interface UserInputService extends Instance {
|
|
|
42657
42929
|
*/
|
|
42658
42930
|
readonly PreferredInput: Enum.PreferredInput;
|
|
42659
42931
|
/**
|
|
42660
|
-
* Describes whether the user's
|
|
42932
|
+
* Describes whether the user's device has a touch screen available.
|
|
42661
42933
|
*
|
|
42662
42934
|
* - **ThreadSafety**: ReadSafe
|
|
42663
42935
|
* - **Tags**: NotReplicated
|
|
@@ -42693,7 +42965,7 @@ interface UserInputService extends Instance {
|
|
|
42693
42965
|
* - **ThreadSafety**: Unsafe
|
|
42694
42966
|
*
|
|
42695
42967
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UserInputService#GamepadSupports)
|
|
42696
|
-
* @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.
|
|
42697
42969
|
* @param gamepadNum The `UserInputType` of the gamepad.
|
|
42698
42970
|
* @param gamepadKeyCode The `KeyCode` of the button in question.
|
|
42699
42971
|
* @returns Whether the given gamepad supports a button corresponding with the given `KeyCode`.
|
|
@@ -42705,7 +42977,7 @@ interface UserInputService extends Instance {
|
|
|
42705
42977
|
* - **ThreadSafety**: Unsafe
|
|
42706
42978
|
*
|
|
42707
42979
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UserInputService#GetConnectedGamepads)
|
|
42708
|
-
* @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.
|
|
42709
42981
|
* @returns An array of `UserInputTypes` corresponding with the gamepads connected to the user's device.
|
|
42710
42982
|
*/
|
|
42711
42983
|
GetConnectedGamepads(this: UserInputService): Array<Enum.UserInputType>;
|
|
@@ -42715,7 +42987,7 @@ interface UserInputService extends Instance {
|
|
|
42715
42987
|
* - **ThreadSafety**: Unsafe
|
|
42716
42988
|
*
|
|
42717
42989
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UserInputService#GetDeviceAcceleration)
|
|
42718
|
-
* @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.
|
|
42719
42991
|
*/
|
|
42720
42992
|
GetDeviceAcceleration(this: UserInputService): InputObject;
|
|
42721
42993
|
/**
|
|
@@ -42724,18 +42996,17 @@ interface UserInputService extends Instance {
|
|
|
42724
42996
|
* - **ThreadSafety**: Unsafe
|
|
42725
42997
|
*
|
|
42726
42998
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UserInputService#GetDeviceGravity)
|
|
42727
|
-
* @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.
|
|
42728
43000
|
*/
|
|
42729
43001
|
GetDeviceGravity(this: UserInputService): InputObject;
|
|
42730
43002
|
/**
|
|
42731
|
-
* Returns an `InputObject` and a `CFrame
|
|
43003
|
+
* Returns an `InputObject` and a `CFrame` describing the device's current rotation vector.
|
|
42732
43004
|
*
|
|
42733
43005
|
* - **ThreadSafety**: Unsafe
|
|
42734
43006
|
*
|
|
42735
43007
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UserInputService#GetDeviceRotation)
|
|
42736
|
-
* @param this `UserInputService` is
|
|
42737
|
-
* @returns A tuple containing two properties:
|
|
42738
|
-
* 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.
|
|
42739
43010
|
*/
|
|
42740
43011
|
GetDeviceRotation(this: UserInputService): LuaTuple<[
|
|
42741
43012
|
InputObject,
|
|
@@ -42747,16 +43018,16 @@ interface UserInputService extends Instance {
|
|
|
42747
43018
|
* - **ThreadSafety**: Unsafe
|
|
42748
43019
|
*
|
|
42749
43020
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UserInputService#GetFocusedTextBox)
|
|
42750
|
-
* @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.
|
|
42751
43022
|
*/
|
|
42752
43023
|
GetFocusedTextBox(this: UserInputService): TextBox | undefined;
|
|
42753
43024
|
/**
|
|
42754
|
-
* Returns whether a gamepad with the given `UserInputType`
|
|
43025
|
+
* Returns whether a gamepad with the given `UserInputType` is connected.
|
|
42755
43026
|
*
|
|
42756
43027
|
* - **ThreadSafety**: Unsafe
|
|
42757
43028
|
*
|
|
42758
43029
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UserInputService#GetGamepadConnected)
|
|
42759
|
-
* @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.
|
|
42760
43031
|
* @param gamepadNum The `UserInputType` of the gamepad in question.
|
|
42761
43032
|
* @returns Whether a gamepad associated with `UserInputType` is connected.
|
|
42762
43033
|
*/
|
|
@@ -42767,7 +43038,7 @@ interface UserInputService extends Instance {
|
|
|
42767
43038
|
* - **ThreadSafety**: Unsafe
|
|
42768
43039
|
*
|
|
42769
43040
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UserInputService#GetGamepadState)
|
|
42770
|
-
* @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.
|
|
42771
43042
|
* @param gamepadNum The `UserInputType` corresponding with the gamepad in question.
|
|
42772
43043
|
* @returns An array of `InputObjects` representing the current state of all available inputs for the given gamepad.
|
|
42773
43044
|
*/
|
|
@@ -42778,7 +43049,7 @@ interface UserInputService extends Instance {
|
|
|
42778
43049
|
* - **ThreadSafety**: Unsafe
|
|
42779
43050
|
*
|
|
42780
43051
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UserInputService#GetImageForKeyCode)
|
|
42781
|
-
* @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.
|
|
42782
43053
|
* @param keyCode The `KeyCode` for which to fetch the associated image.
|
|
42783
43054
|
* @returns The returned image asset ID.
|
|
42784
43055
|
*/
|
|
@@ -42789,7 +43060,7 @@ interface UserInputService extends Instance {
|
|
|
42789
43060
|
* - **ThreadSafety**: Unsafe
|
|
42790
43061
|
*
|
|
42791
43062
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UserInputService#GetKeysPressed)
|
|
42792
|
-
* @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.
|
|
42793
43064
|
* @returns An array of `InputObjects` associated with the keys currently being pressed.
|
|
42794
43065
|
*/
|
|
42795
43066
|
GetKeysPressed(this: UserInputService): Array<InputObject>;
|
|
@@ -42799,17 +43070,17 @@ interface UserInputService extends Instance {
|
|
|
42799
43070
|
* - **ThreadSafety**: Unsafe
|
|
42800
43071
|
*
|
|
42801
43072
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UserInputService#GetLastInputType)
|
|
42802
|
-
* @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.
|
|
42803
43074
|
* @returns The `UserInputType` associated with the user's most recent input.
|
|
42804
43075
|
*/
|
|
42805
43076
|
GetLastInputType(this: UserInputService): Enum.UserInputType;
|
|
42806
43077
|
/**
|
|
42807
|
-
* Returns an array of `InputObjects`
|
|
43078
|
+
* Returns an array of `InputObjects` associated with the mouse buttons currently being held down.
|
|
42808
43079
|
*
|
|
42809
43080
|
* - **ThreadSafety**: Unsafe
|
|
42810
43081
|
*
|
|
42811
43082
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UserInputService#GetMouseButtonsPressed)
|
|
42812
|
-
* @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.
|
|
42813
43084
|
* @returns An array of `InputObjects` corresponding to the mouse buttons currently being currently held down.
|
|
42814
43085
|
*/
|
|
42815
43086
|
GetMouseButtonsPressed(this: UserInputService): Array<InputObject>;
|
|
@@ -42819,28 +43090,28 @@ interface UserInputService extends Instance {
|
|
|
42819
43090
|
* - **ThreadSafety**: Unsafe
|
|
42820
43091
|
*
|
|
42821
43092
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UserInputService#GetMouseDelta)
|
|
42822
|
-
* @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.
|
|
42823
43094
|
* @returns Change in movement of the mouse.
|
|
42824
43095
|
*/
|
|
42825
43096
|
GetMouseDelta(this: UserInputService): Vector2;
|
|
42826
43097
|
/**
|
|
42827
|
-
* 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.
|
|
42828
43099
|
*
|
|
42829
43100
|
* - **ThreadSafety**: Unsafe
|
|
42830
43101
|
*
|
|
42831
43102
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UserInputService#GetMouseLocation)
|
|
42832
|
-
* @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.
|
|
42833
43104
|
* @returns A `Vector2` representing the current screen location of the mouse, in pixels.
|
|
42834
43105
|
*/
|
|
42835
43106
|
GetMouseLocation(this: UserInputService): Vector2;
|
|
42836
43107
|
/**
|
|
42837
|
-
* Returns an array of
|
|
43108
|
+
* Returns an array of gamepads connected and enabled for `GuiObject` navigation in descending order of priority.
|
|
42838
43109
|
*
|
|
42839
43110
|
* - **ThreadSafety**: Unsafe
|
|
42840
43111
|
*
|
|
42841
43112
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UserInputService#GetNavigationGamepads)
|
|
42842
|
-
* @param this `UserInputService` is
|
|
42843
|
-
* @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.
|
|
42844
43115
|
*/
|
|
42845
43116
|
GetNavigationGamepads(this: UserInputService): Array<Enum.UserInputType>;
|
|
42846
43117
|
/**
|
|
@@ -42849,7 +43120,7 @@ interface UserInputService extends Instance {
|
|
|
42849
43120
|
* - **ThreadSafety**: Unsafe
|
|
42850
43121
|
*
|
|
42851
43122
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UserInputService#GetStringForKeyCode)
|
|
42852
|
-
* @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.
|
|
42853
43124
|
* @param keyCode
|
|
42854
43125
|
*/
|
|
42855
43126
|
GetStringForKeyCode(this: UserInputService, keyCode: CastsToEnum<Enum.KeyCode>): string;
|
|
@@ -42859,7 +43130,7 @@ interface UserInputService extends Instance {
|
|
|
42859
43130
|
* - **ThreadSafety**: Unsafe
|
|
42860
43131
|
*
|
|
42861
43132
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UserInputService#GetSupportedGamepadKeyCodes)
|
|
42862
|
-
* @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.
|
|
42863
43134
|
* @param gamepadNum The `UserInputType` of the gamepad.
|
|
42864
43135
|
* @returns An array of `KeyCodes` supported by the given gamepad.
|
|
42865
43136
|
*/
|
|
@@ -42873,7 +43144,7 @@ interface UserInputService extends Instance {
|
|
|
42873
43144
|
* - **Tags**:
|
|
42874
43145
|
*
|
|
42875
43146
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UserInputService#GetUserCFrame)
|
|
42876
|
-
* @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.
|
|
42877
43148
|
* @param type The `UserCFrame` corresponding to the VR device.
|
|
42878
43149
|
* @returns A `CFrame` describing the position and orientation of the specified VR device.
|
|
42879
43150
|
*
|
|
@@ -42881,15 +43152,15 @@ interface UserInputService extends Instance {
|
|
|
42881
43152
|
*/
|
|
42882
43153
|
GetUserCFrame(this: UserInputService, type: CastsToEnum<Enum.UserCFrame>): CFrame;
|
|
42883
43154
|
/**
|
|
42884
|
-
* Determines whether a particular button is pressed on a
|
|
43155
|
+
* Determines whether a particular button is pressed on a gamepad.
|
|
42885
43156
|
*
|
|
42886
43157
|
* - **ThreadSafety**: Unsafe
|
|
42887
43158
|
*
|
|
42888
43159
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UserInputService#IsGamepadButtonDown)
|
|
42889
|
-
* @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.
|
|
42890
43161
|
* @param gamepadNum The `UserInputType` of the given gamepad.
|
|
42891
|
-
* @param gamepadKeyCode The `KeyCode` of the specified button.
|
|
42892
|
-
* @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.
|
|
42893
43164
|
*/
|
|
42894
43165
|
IsGamepadButtonDown(this: UserInputService, gamepadNum: CastsToEnum<Enum.UserInputType>, gamepadKeyCode: CastsToEnum<Enum.KeyCode>): boolean;
|
|
42895
43166
|
/**
|
|
@@ -42898,29 +43169,29 @@ interface UserInputService extends Instance {
|
|
|
42898
43169
|
* - **ThreadSafety**: Unsafe
|
|
42899
43170
|
*
|
|
42900
43171
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UserInputService#IsKeyDown)
|
|
42901
|
-
* @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.
|
|
42902
43173
|
* @param keyCode The `KeyCode` of the key.
|
|
42903
43174
|
* @returns Whether the specified key is being held down.
|
|
42904
43175
|
*/
|
|
42905
43176
|
IsKeyDown(this: UserInputService, keyCode: CastsToEnum<Enum.KeyCode>): boolean;
|
|
42906
43177
|
/**
|
|
42907
|
-
* Returns whether the given
|
|
43178
|
+
* Returns whether the given mouse button is currently held down.
|
|
42908
43179
|
*
|
|
42909
43180
|
* - **ThreadSafety**: Unsafe
|
|
42910
43181
|
*
|
|
42911
43182
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UserInputService#IsMouseButtonPressed)
|
|
42912
|
-
* @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.
|
|
42913
43184
|
* @param mouseButton The `UserInputType` of the mouse button.
|
|
42914
43185
|
* @returns Whether the given mouse button is currently held down.
|
|
42915
43186
|
*/
|
|
42916
43187
|
IsMouseButtonPressed(this: UserInputService, mouseButton: CastsToEnum<Enum.UserInputType>): boolean;
|
|
42917
43188
|
/**
|
|
42918
|
-
* Returns true if the specified
|
|
43189
|
+
* Returns `true` if the specified gamepad is allowed to control navigation and selection `GuiObjects`.
|
|
42919
43190
|
*
|
|
42920
43191
|
* - **ThreadSafety**: Unsafe
|
|
42921
43192
|
*
|
|
42922
43193
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UserInputService#IsNavigationGamepad)
|
|
42923
|
-
* @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.
|
|
42924
43195
|
* @param gamepadEnum The `UserInputType` of the specified gamepad.
|
|
42925
43196
|
* @returns Whether the specified gamepad is a navigation gamepad.
|
|
42926
43197
|
*/
|
|
@@ -42931,22 +43202,22 @@ interface UserInputService extends Instance {
|
|
|
42931
43202
|
* - **ThreadSafety**: Unsafe
|
|
42932
43203
|
*
|
|
42933
43204
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UserInputService#RecenterUserHeadCFrame)
|
|
42934
|
-
* @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.
|
|
42935
43206
|
*/
|
|
42936
43207
|
RecenterUserHeadCFrame(this: UserInputService): void;
|
|
42937
43208
|
/**
|
|
42938
|
-
* Sets whether or not the specified
|
|
43209
|
+
* Sets whether or not the specified gamepad can move the `GuiObject` navigator.
|
|
42939
43210
|
*
|
|
42940
43211
|
* - **ThreadSafety**: Unsafe
|
|
42941
43212
|
*
|
|
42942
43213
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UserInputService#SetNavigationGamepad)
|
|
42943
|
-
* @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.
|
|
42944
43215
|
* @param gamepadEnum The `UserInputType` of the specified gamepad.
|
|
42945
43216
|
* @param enabled Whether the specified gamepad can move the GUI navigator.
|
|
42946
43217
|
*/
|
|
42947
43218
|
SetNavigationGamepad(this: UserInputService, gamepadEnum: CastsToEnum<Enum.UserInputType>, enabled: boolean): void;
|
|
42948
43219
|
/**
|
|
42949
|
-
*
|
|
43220
|
+
* Fires when a user moves a device that has an accelerometer.
|
|
42950
43221
|
*
|
|
42951
43222
|
* - **ThreadSafety**: Unsafe
|
|
42952
43223
|
*
|
|
@@ -42954,7 +43225,7 @@ interface UserInputService extends Instance {
|
|
|
42954
43225
|
*/
|
|
42955
43226
|
readonly DeviceAccelerationChanged: RBXScriptSignal<(acceleration: InputObject) => void>;
|
|
42956
43227
|
/**
|
|
42957
|
-
*
|
|
43228
|
+
* Fires when the force of gravity changes on a device that has an enabled accelerometer.
|
|
42958
43229
|
*
|
|
42959
43230
|
* - **ThreadSafety**: Unsafe
|
|
42960
43231
|
*
|
|
@@ -42962,7 +43233,7 @@ interface UserInputService extends Instance {
|
|
|
42962
43233
|
*/
|
|
42963
43234
|
readonly DeviceGravityChanged: RBXScriptSignal<(gravity: InputObject) => void>;
|
|
42964
43235
|
/**
|
|
42965
|
-
*
|
|
43236
|
+
* Fires when a user rotates a device that has a gyroscope.
|
|
42966
43237
|
*
|
|
42967
43238
|
* - **ThreadSafety**: Unsafe
|
|
42968
43239
|
*
|
|
@@ -42970,7 +43241,7 @@ interface UserInputService extends Instance {
|
|
|
42970
43241
|
*/
|
|
42971
43242
|
readonly DeviceRotationChanged: RBXScriptSignal<(rotation: InputObject, cframe: CFrame) => void>;
|
|
42972
43243
|
/**
|
|
42973
|
-
* Fires when a gamepad is connected to the client.
|
|
43244
|
+
* Fires when a gamepad is connected to the client.
|
|
42974
43245
|
*
|
|
42975
43246
|
* - **ThreadSafety**: Unsafe
|
|
42976
43247
|
*
|
|
@@ -42978,7 +43249,7 @@ interface UserInputService extends Instance {
|
|
|
42978
43249
|
*/
|
|
42979
43250
|
readonly GamepadConnected: RBXScriptSignal<(gamepadNum: Enum.UserInputType) => void>;
|
|
42980
43251
|
/**
|
|
42981
|
-
* Fires when a gamepad is disconnected from the client.
|
|
43252
|
+
* Fires when a gamepad is disconnected from the client.
|
|
42982
43253
|
*
|
|
42983
43254
|
* - **ThreadSafety**: Unsafe
|
|
42984
43255
|
*
|
|
@@ -42986,7 +43257,7 @@ interface UserInputService extends Instance {
|
|
|
42986
43257
|
*/
|
|
42987
43258
|
readonly GamepadDisconnected: RBXScriptSignal<(gamepadNum: Enum.UserInputType) => void>;
|
|
42988
43259
|
/**
|
|
42989
|
-
*
|
|
43260
|
+
* Fires when a user begins interacting with an input device such as a mouse or gamepad.
|
|
42990
43261
|
*
|
|
42991
43262
|
* - **ThreadSafety**: Unsafe
|
|
42992
43263
|
*
|
|
@@ -42994,7 +43265,7 @@ interface UserInputService extends Instance {
|
|
|
42994
43265
|
*/
|
|
42995
43266
|
readonly InputBegan: RBXScriptSignal<(input: InputObject, gameProcessedEvent: boolean) => void>;
|
|
42996
43267
|
/**
|
|
42997
|
-
*
|
|
43268
|
+
* Fires when a user changes how they're interacting with an input device such as a mouse or gamepad.
|
|
42998
43269
|
*
|
|
42999
43270
|
* - **ThreadSafety**: Unsafe
|
|
43000
43271
|
*
|
|
@@ -43002,7 +43273,7 @@ interface UserInputService extends Instance {
|
|
|
43002
43273
|
*/
|
|
43003
43274
|
readonly InputChanged: RBXScriptSignal<(input: InputObject, gameProcessedEvent: boolean) => void>;
|
|
43004
43275
|
/**
|
|
43005
|
-
* Fires when a user stops interacting
|
|
43276
|
+
* Fires when a user stops interacting with an input device such as a mouse or gamepad.
|
|
43006
43277
|
*
|
|
43007
43278
|
* - **ThreadSafety**: Unsafe
|
|
43008
43279
|
*
|
|
@@ -43018,7 +43289,7 @@ interface UserInputService extends Instance {
|
|
|
43018
43289
|
*/
|
|
43019
43290
|
readonly JumpRequest: RBXScriptSignal<() => void>;
|
|
43020
43291
|
/**
|
|
43021
|
-
* Fires
|
|
43292
|
+
* Fires whenever the client's `UserInputType` is changed.
|
|
43022
43293
|
*
|
|
43023
43294
|
* - **ThreadSafety**: Unsafe
|
|
43024
43295
|
*
|
|
@@ -43026,7 +43297,7 @@ interface UserInputService extends Instance {
|
|
|
43026
43297
|
*/
|
|
43027
43298
|
readonly LastInputTypeChanged: RBXScriptSignal<(lastInputType: Enum.UserInputType) => void>;
|
|
43028
43299
|
/**
|
|
43029
|
-
* Fires when the user performs a specific pointer action
|
|
43300
|
+
* Fires when the user performs a specific pointer action.
|
|
43030
43301
|
*
|
|
43031
43302
|
* - **ThreadSafety**: Unsafe
|
|
43032
43303
|
*
|
|
@@ -43034,7 +43305,7 @@ interface UserInputService extends Instance {
|
|
|
43034
43305
|
*/
|
|
43035
43306
|
readonly PointerAction: RBXScriptSignal<(wheel: number, pan: Vector2, pinch: number, gameProcessedEvent: boolean) => void>;
|
|
43036
43307
|
/**
|
|
43037
|
-
*
|
|
43308
|
+
* Fires when the client loses focus on a `TextBox`.
|
|
43038
43309
|
*
|
|
43039
43310
|
* - **ThreadSafety**: Unsafe
|
|
43040
43311
|
*
|
|
@@ -43042,7 +43313,7 @@ interface UserInputService extends Instance {
|
|
|
43042
43313
|
*/
|
|
43043
43314
|
readonly TextBoxFocusReleased: RBXScriptSignal<(textboxReleased: TextBox) => void>;
|
|
43044
43315
|
/**
|
|
43045
|
-
*
|
|
43316
|
+
* Fires when the client focuses on a `TextBox`.
|
|
43046
43317
|
*
|
|
43047
43318
|
* - **ThreadSafety**: Unsafe
|
|
43048
43319
|
*
|
|
@@ -43050,13 +43321,15 @@ interface UserInputService extends Instance {
|
|
|
43050
43321
|
*/
|
|
43051
43322
|
readonly TextBoxFocused: RBXScriptSignal<(textboxFocused: TextBox) => void>;
|
|
43052
43323
|
/**
|
|
43324
|
+
* Fires when the user drags on the screen of a `TouchEnabled` device.
|
|
43325
|
+
*
|
|
43053
43326
|
* - **ThreadSafety**: Unsafe
|
|
43054
43327
|
*
|
|
43055
43328
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UserInputService#TouchDrag)
|
|
43056
43329
|
*/
|
|
43057
43330
|
readonly TouchDrag: RBXScriptSignal<(dragDirection: Enum.SwipeDirection, numberOfTouches: number, gameProcessedEvent: boolean) => void>;
|
|
43058
43331
|
/**
|
|
43059
|
-
*
|
|
43332
|
+
* Fires when a user releases their finger from the screen of a `TouchEnabled` device.
|
|
43060
43333
|
*
|
|
43061
43334
|
* - **ThreadSafety**: Unsafe
|
|
43062
43335
|
*
|
|
@@ -43064,7 +43337,7 @@ interface UserInputService extends Instance {
|
|
|
43064
43337
|
*/
|
|
43065
43338
|
readonly TouchEnded: RBXScriptSignal<(touch: InputObject, gameProcessedEvent: boolean) => void>;
|
|
43066
43339
|
/**
|
|
43067
|
-
*
|
|
43340
|
+
* Fires when a user holds at least one finger for a short amount of time on the screen of a `TouchEnabled` device.
|
|
43068
43341
|
*
|
|
43069
43342
|
* - **ThreadSafety**: Unsafe
|
|
43070
43343
|
*
|
|
@@ -43072,7 +43345,7 @@ interface UserInputService extends Instance {
|
|
|
43072
43345
|
*/
|
|
43073
43346
|
readonly TouchLongPress: RBXScriptSignal<(touchPositions: Array<Vector2>, state: Enum.UserInputState, gameProcessedEvent: boolean) => void>;
|
|
43074
43347
|
/**
|
|
43075
|
-
* 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.
|
|
43076
43349
|
*
|
|
43077
43350
|
* - **ThreadSafety**: Unsafe
|
|
43078
43351
|
*
|
|
@@ -43080,7 +43353,7 @@ interface UserInputService extends Instance {
|
|
|
43080
43353
|
*/
|
|
43081
43354
|
readonly TouchMoved: RBXScriptSignal<(touch: InputObject, gameProcessedEvent: boolean) => void>;
|
|
43082
43355
|
/**
|
|
43083
|
-
*
|
|
43356
|
+
* Fires when the user drags at least one finger on the screen of a `TouchEnabled` device.
|
|
43084
43357
|
*
|
|
43085
43358
|
* - **ThreadSafety**: Unsafe
|
|
43086
43359
|
*
|
|
@@ -43088,7 +43361,7 @@ interface UserInputService extends Instance {
|
|
|
43088
43361
|
*/
|
|
43089
43362
|
readonly TouchPan: RBXScriptSignal<(touchPositions: Array<Vector2>, totalTranslation: Vector2, velocity: Vector2, state: Enum.UserInputState, gameProcessedEvent: boolean) => void>;
|
|
43090
43363
|
/**
|
|
43091
|
-
*
|
|
43364
|
+
* Fires when a user performs a pinch gesture on the screen of a `TouchEnabled` device.
|
|
43092
43365
|
*
|
|
43093
43366
|
* - **ThreadSafety**: Unsafe
|
|
43094
43367
|
*
|
|
@@ -43096,7 +43369,7 @@ interface UserInputService extends Instance {
|
|
|
43096
43369
|
*/
|
|
43097
43370
|
readonly TouchPinch: RBXScriptSignal<(touchPositions: Array<Vector2>, scale: number, velocity: number, state: Enum.UserInputState, gameProcessedEvent: boolean) => void>;
|
|
43098
43371
|
/**
|
|
43099
|
-
* Fires when a user rotates two fingers on
|
|
43372
|
+
* Fires when a user rotates two fingers on the screen of a `TouchEnabled` device.
|
|
43100
43373
|
*
|
|
43101
43374
|
* - **ThreadSafety**: Unsafe
|
|
43102
43375
|
*
|
|
@@ -43104,7 +43377,7 @@ interface UserInputService extends Instance {
|
|
|
43104
43377
|
*/
|
|
43105
43378
|
readonly TouchRotate: RBXScriptSignal<(touchPositions: Array<Vector2>, rotation: number, velocity: number, state: Enum.UserInputState, gameProcessedEvent: boolean) => void>;
|
|
43106
43379
|
/**
|
|
43107
|
-
*
|
|
43380
|
+
* Fires when a user places their finger on the screen of a `TouchEnabled` device.
|
|
43108
43381
|
*
|
|
43109
43382
|
* - **ThreadSafety**: Unsafe
|
|
43110
43383
|
*
|
|
@@ -43112,7 +43385,7 @@ interface UserInputService extends Instance {
|
|
|
43112
43385
|
*/
|
|
43113
43386
|
readonly TouchStarted: RBXScriptSignal<(touch: InputObject, gameProcessedEvent: boolean) => void>;
|
|
43114
43387
|
/**
|
|
43115
|
-
* 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.
|
|
43116
43389
|
*
|
|
43117
43390
|
* - **ThreadSafety**: Unsafe
|
|
43118
43391
|
*
|
|
@@ -43120,7 +43393,7 @@ interface UserInputService extends Instance {
|
|
|
43120
43393
|
*/
|
|
43121
43394
|
readonly TouchSwipe: RBXScriptSignal<(swipeDirection: Enum.SwipeDirection, numberOfTouches: number, gameProcessedEvent: boolean) => void>;
|
|
43122
43395
|
/**
|
|
43123
|
-
*
|
|
43396
|
+
* Fires when a user taps their finger on the screen of a `TouchEnabled` device.
|
|
43124
43397
|
*
|
|
43125
43398
|
* - **ThreadSafety**: Unsafe
|
|
43126
43399
|
*
|
|
@@ -43128,7 +43401,7 @@ interface UserInputService extends Instance {
|
|
|
43128
43401
|
*/
|
|
43129
43402
|
readonly TouchTap: RBXScriptSignal<(touchPositions: Array<Vector2>, gameProcessedEvent: boolean) => void>;
|
|
43130
43403
|
/**
|
|
43131
|
-
* 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.
|
|
43132
43405
|
*
|
|
43133
43406
|
* - **ThreadSafety**: Unsafe
|
|
43134
43407
|
*
|