@rbxts/types 1.0.925 → 1.0.928
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 +558 -744
- package/include/generated/PluginSecurity.d.ts +1046 -178
- package/include/generated/enums.d.ts +423 -12
- package/package.json +1 -1
|
@@ -23,8 +23,6 @@ interface Services {
|
|
|
23
23
|
AssetQualityService: AssetQualityService;
|
|
24
24
|
AssetService: AssetService;
|
|
25
25
|
AudioFocusService: AudioFocusService;
|
|
26
|
-
AuroraScriptService: AuroraScriptService;
|
|
27
|
-
AuroraService: AuroraService;
|
|
28
26
|
AvatarChatService: AvatarChatService;
|
|
29
27
|
AvatarCreationService: AvatarCreationService;
|
|
30
28
|
AvatarEditorService: AvatarEditorService;
|
|
@@ -38,6 +36,7 @@ interface Services {
|
|
|
38
36
|
CaptureService: CaptureService;
|
|
39
37
|
ChangeHistoryStreamingService: ChangeHistoryStreamingService;
|
|
40
38
|
Chat: Chat;
|
|
39
|
+
ClientStorageService: ClientStorageService;
|
|
41
40
|
CloudCRUDService: CloudCRUDService;
|
|
42
41
|
CloudExecutionService: CloudExecutionService;
|
|
43
42
|
CollaboratorsService: CollaboratorsService;
|
|
@@ -104,7 +103,6 @@ interface Services {
|
|
|
104
103
|
InstanceFileSyncService: InstanceFileSyncService;
|
|
105
104
|
InternalMessagingService: InternalMessagingService;
|
|
106
105
|
InternalMessagingServiceVerifier: InternalMessagingServiceVerifier;
|
|
107
|
-
InternalSyncService: InternalSyncService;
|
|
108
106
|
IXPService: IXPService;
|
|
109
107
|
JointsService: JointsService;
|
|
110
108
|
KeyframeSequenceProvider: KeyframeSequenceProvider;
|
|
@@ -118,7 +116,6 @@ interface Services {
|
|
|
118
116
|
LodDataService: LodDataService;
|
|
119
117
|
LogReporterService: LogReporterService;
|
|
120
118
|
LogService: LogService;
|
|
121
|
-
LSPFileSyncService: LSPFileSyncService;
|
|
122
119
|
LuauScriptAnalyzerService: LuauScriptAnalyzerService;
|
|
123
120
|
MarketplaceService: MarketplaceService;
|
|
124
121
|
MatchmakingService: MatchmakingService;
|
|
@@ -195,6 +192,7 @@ interface Services {
|
|
|
195
192
|
SharedTableRegistry: SharedTableRegistry;
|
|
196
193
|
SlimAnimationReplicationService: SlimAnimationReplicationService;
|
|
197
194
|
SlimContentProvider: SlimContentProvider;
|
|
195
|
+
SlimDebugSettings: SlimDebugSettings;
|
|
198
196
|
SlimReplicationService: SlimReplicationService;
|
|
199
197
|
SlimService: SlimService;
|
|
200
198
|
SmoothVoxelsUpgraderService: SmoothVoxelsUpgraderService;
|
|
@@ -308,7 +306,6 @@ interface CreatableInstances {
|
|
|
308
306
|
AudioSpeechToText: AudioSpeechToText;
|
|
309
307
|
AudioTextToSpeech: AudioTextToSpeech;
|
|
310
308
|
AudioTremolo: AudioTremolo;
|
|
311
|
-
AuroraScript: AuroraScript;
|
|
312
309
|
AvatarAbilityRules: AvatarAbilityRules;
|
|
313
310
|
AvatarAccessoryRules: AvatarAccessoryRules;
|
|
314
311
|
AvatarAnimationRules: AvatarAnimationRules;
|
|
@@ -415,7 +412,6 @@ interface CreatableInstances {
|
|
|
415
412
|
InputBinding: InputBinding;
|
|
416
413
|
InputContext: InputContext;
|
|
417
414
|
IntConstrainedValue: IntConstrainedValue;
|
|
418
|
-
InternalSyncItem: InternalSyncItem;
|
|
419
415
|
IntersectOperation: IntersectOperation;
|
|
420
416
|
IntValue: IntValue;
|
|
421
417
|
Keyframe: Keyframe;
|
|
@@ -521,6 +517,7 @@ interface CreatableInstances {
|
|
|
521
517
|
TextBox: TextBox;
|
|
522
518
|
TextButton: TextButton;
|
|
523
519
|
TextChannel: TextChannel;
|
|
520
|
+
TextChannelWindow: TextChannelWindow;
|
|
524
521
|
TextChatCommand: TextChatCommand;
|
|
525
522
|
TextChatMessageProperties: TextChatMessageProperties;
|
|
526
523
|
TextGenerator: TextGenerator;
|
|
@@ -763,6 +760,7 @@ interface Objects extends Instances {
|
|
|
763
760
|
OutputLink: OutputLink;
|
|
764
761
|
PluginConnection: PluginConnection;
|
|
765
762
|
ScreenshotCapture: ScreenshotCapture;
|
|
763
|
+
StudioActionOverride: StudioActionOverride;
|
|
766
764
|
TerrainIterateOperation: TerrainIterateOperation;
|
|
767
765
|
TerrainModifyOperation: TerrainModifyOperation;
|
|
768
766
|
TerrainReadOperation: TerrainReadOperation;
|
|
@@ -1014,7 +1012,7 @@ interface ConfigSnapshot extends RBXObject {
|
|
|
1014
1012
|
readonly UpdateAvailable: RBXScriptSignal<() => void>;
|
|
1015
1013
|
}
|
|
1016
1014
|
/**
|
|
1017
|
-
*
|
|
1015
|
+
* Object which allows for the runtime creation and manipulation of images.
|
|
1018
1016
|
*
|
|
1019
1017
|
* - **Tags**: NotCreatable
|
|
1020
1018
|
*
|
|
@@ -1042,7 +1040,7 @@ interface EditableImage extends RBXObject {
|
|
|
1042
1040
|
* - **ThreadSafety**: Unsafe
|
|
1043
1041
|
*
|
|
1044
1042
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableImage#Destroy)
|
|
1045
|
-
* @param this
|
|
1043
|
+
* @param this Object which allows for the runtime creation and manipulation of images.
|
|
1046
1044
|
*/
|
|
1047
1045
|
Destroy(this: EditableImage): void;
|
|
1048
1046
|
/**
|
|
@@ -1051,7 +1049,7 @@ interface EditableImage extends RBXObject {
|
|
|
1051
1049
|
* - **ThreadSafety**: Unsafe
|
|
1052
1050
|
*
|
|
1053
1051
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableImage#DrawCircle)
|
|
1054
|
-
* @param this
|
|
1052
|
+
* @param this Object which allows for the runtime creation and manipulation of images.
|
|
1055
1053
|
* @param center Center of the circle, relative to the top-left corner of the `EditableImage`. Positions outside the canvas bounds are allowed.
|
|
1056
1054
|
* @param radius Radius of the circle in pixels.
|
|
1057
1055
|
* @param color Color of the circle.
|
|
@@ -1066,7 +1064,7 @@ interface EditableImage extends RBXObject {
|
|
|
1066
1064
|
* - **ThreadSafety**: Unsafe
|
|
1067
1065
|
*
|
|
1068
1066
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableImage#DrawImage)
|
|
1069
|
-
* @param this
|
|
1067
|
+
* @param this Object which allows for the runtime creation and manipulation of images.
|
|
1070
1068
|
* @param position Position at which the top-left corner of the added image will be drawn.
|
|
1071
1069
|
* @param image The `EditableImage` to draw into this `EditableImage`.
|
|
1072
1070
|
* @param combineType How the pixels of the source image should be blended with the pixels of the added image.
|
|
@@ -1078,7 +1076,7 @@ interface EditableImage extends RBXObject {
|
|
|
1078
1076
|
* - **ThreadSafety**: Unsafe
|
|
1079
1077
|
*
|
|
1080
1078
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableImage#DrawImageProjected)
|
|
1081
|
-
* @param this
|
|
1079
|
+
* @param this Object which allows for the runtime creation and manipulation of images.
|
|
1082
1080
|
* @param mesh The `EditableMesh` used to project into.
|
|
1083
1081
|
* @param projection Projection configuration dictionary including the following key-value pairs: - `Direction` (`Vector3`) where the projector is facing.
|
|
1084
1082
|
* - `Position` (`Vector3`) as the position in local space with respect to the mesh.
|
|
@@ -1099,7 +1097,7 @@ interface EditableImage extends RBXObject {
|
|
|
1099
1097
|
* - **ThreadSafety**: Unsafe
|
|
1100
1098
|
*
|
|
1101
1099
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableImage#DrawImageTransformed)
|
|
1102
|
-
* @param this
|
|
1100
|
+
* @param this Object which allows for the runtime creation and manipulation of images.
|
|
1103
1101
|
* @param position Position in pixels where the pivot point of the source image will be placed on this image.
|
|
1104
1102
|
* @param scale Scaling factors for the source image along the X and Y axes.
|
|
1105
1103
|
* @param rotation The rotation angle in degrees, applied around the pivot point of the source image.
|
|
@@ -1115,7 +1113,7 @@ interface EditableImage extends RBXObject {
|
|
|
1115
1113
|
* - **ThreadSafety**: Unsafe
|
|
1116
1114
|
*
|
|
1117
1115
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableImage#DrawLine)
|
|
1118
|
-
* @param this
|
|
1116
|
+
* @param this Object which allows for the runtime creation and manipulation of images.
|
|
1119
1117
|
* @param p1 Start point of the line.
|
|
1120
1118
|
* @param p2 End point of the line.
|
|
1121
1119
|
* @param color Color of the line.
|
|
@@ -1130,7 +1128,7 @@ interface EditableImage extends RBXObject {
|
|
|
1130
1128
|
* - **ThreadSafety**: Unsafe
|
|
1131
1129
|
*
|
|
1132
1130
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableImage#DrawRectangle)
|
|
1133
|
-
* @param this
|
|
1131
|
+
* @param this Object which allows for the runtime creation and manipulation of images.
|
|
1134
1132
|
* @param position Position of the top-left of the rectangle. Unlike other drawing methods, this cannot be outside the canvas bounds of the `EditableImage`.
|
|
1135
1133
|
* @param size Size of the rectangle to draw, in pixels.
|
|
1136
1134
|
* @param color Color of the rectangle.
|
|
@@ -1145,7 +1143,7 @@ interface EditableImage extends RBXObject {
|
|
|
1145
1143
|
* - **Tags**: CustomLuaState
|
|
1146
1144
|
*
|
|
1147
1145
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableImage#ReadPixelsBuffer)
|
|
1148
|
-
* @param this
|
|
1146
|
+
* @param this Object which allows for the runtime creation and manipulation of images.
|
|
1149
1147
|
* @param position Top-left corner of the rectangular region of pixels to read.
|
|
1150
1148
|
* @param size Size of the rectangular region of pixels to read.
|
|
1151
1149
|
* @returns Buffer where each pixel is represented by four bytes (red, green, blue and alpha respectively). The length of the buffer can be calculated as `X * Size.Y * 4` bytes.
|
|
@@ -1158,7 +1156,7 @@ interface EditableImage extends RBXObject {
|
|
|
1158
1156
|
* - **Tags**: CustomLuaState
|
|
1159
1157
|
*
|
|
1160
1158
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableImage#WritePixelsBuffer)
|
|
1161
|
-
* @param this
|
|
1159
|
+
* @param this Object which allows for the runtime creation and manipulation of images.
|
|
1162
1160
|
* @param position Top-left corner of the rectangular region to draw the pixels into.
|
|
1163
1161
|
* @param size Size of the rectangular region of pixels to write.
|
|
1164
1162
|
* @param buffer A buffer where each pixel is represented by four bytes (red, green, blue, and alpha respectively). The length of the buffer should be `X * Size.Y * 4` bytes.
|
|
@@ -1166,7 +1164,7 @@ interface EditableImage extends RBXObject {
|
|
|
1166
1164
|
WritePixelsBuffer(this: EditableImage, position: Vector2, size: Vector2, buffer: buffer): void;
|
|
1167
1165
|
}
|
|
1168
1166
|
/**
|
|
1169
|
-
*
|
|
1167
|
+
* Object which allows for the runtime creation and manipulation of meshes.
|
|
1170
1168
|
*
|
|
1171
1169
|
* - **Tags**: NotCreatable
|
|
1172
1170
|
*
|
|
@@ -1196,7 +1194,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1196
1194
|
* - **ThreadSafety**: Unsafe
|
|
1197
1195
|
*
|
|
1198
1196
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#AddBone)
|
|
1199
|
-
* @param this
|
|
1197
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1200
1198
|
* @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.
|
|
1201
1199
|
* - `ParentId` — Optional bone ID of the new bone's parent.
|
|
1202
1200
|
* - `CFrame` — Initial `CFrame` of the bone in the bind pose of the mesh, in the mesh's local space.
|
|
@@ -1212,7 +1210,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1212
1210
|
* - **ThreadSafety**: Unsafe
|
|
1213
1211
|
*
|
|
1214
1212
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#AddColor)
|
|
1215
|
-
* @param this
|
|
1213
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1216
1214
|
* @param color The new color.
|
|
1217
1215
|
* @param alpha The color alpha (transparency).
|
|
1218
1216
|
* @returns Stable color ID of the new color.
|
|
@@ -1230,7 +1228,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1230
1228
|
* - **ThreadSafety**: Unsafe
|
|
1231
1229
|
*
|
|
1232
1230
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#AddNormal)
|
|
1233
|
-
* @param this
|
|
1231
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1234
1232
|
* @param normal The normal vector. If the normal value isn't specified, the normal will be automatically calculated.
|
|
1235
1233
|
* @returns Stable normal ID of the new normal.
|
|
1236
1234
|
*/
|
|
@@ -1241,7 +1239,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1241
1239
|
* - **ThreadSafety**: Unsafe
|
|
1242
1240
|
*
|
|
1243
1241
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#AddTriangle)
|
|
1244
|
-
* @param this
|
|
1242
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1245
1243
|
* @param vertexId0 ID of the first vertex of the triangle.
|
|
1246
1244
|
* @param vertexId1 ID of the second vertex of the triangle.
|
|
1247
1245
|
* @param vertexId2 ID of the third vertex of the triangle.
|
|
@@ -1254,7 +1252,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1254
1252
|
* - **ThreadSafety**: Unsafe
|
|
1255
1253
|
*
|
|
1256
1254
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#AddUV)
|
|
1257
|
-
* @param this
|
|
1255
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1258
1256
|
* @param uv The new UV coordinate.
|
|
1259
1257
|
* @returns Stable UV ID of the new UV.
|
|
1260
1258
|
*/
|
|
@@ -1265,18 +1263,25 @@ interface EditableMesh extends RBXObject {
|
|
|
1265
1263
|
* - **ThreadSafety**: Unsafe
|
|
1266
1264
|
*
|
|
1267
1265
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#AddVertex)
|
|
1268
|
-
* @param this
|
|
1266
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1269
1267
|
* @param p Position in the mesh's local object space.
|
|
1270
1268
|
* @returns Stable vertex ID of the new vertex.
|
|
1271
1269
|
*/
|
|
1272
1270
|
AddVertex(this: EditableMesh, p: Vector3): number;
|
|
1271
|
+
/**
|
|
1272
|
+
* - **ThreadSafety**: Unsafe
|
|
1273
|
+
* - **Tags**: NotBrowsable
|
|
1274
|
+
*
|
|
1275
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#Clear)
|
|
1276
|
+
*/
|
|
1277
|
+
Clear(this: EditableMesh): void;
|
|
1273
1278
|
/**
|
|
1274
1279
|
* Destroys the mesh.
|
|
1275
1280
|
*
|
|
1276
1281
|
* - **ThreadSafety**: Unsafe
|
|
1277
1282
|
*
|
|
1278
1283
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#Destroy)
|
|
1279
|
-
* @param this
|
|
1284
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1280
1285
|
*/
|
|
1281
1286
|
Destroy(this: EditableMesh): void;
|
|
1282
1287
|
/**
|
|
@@ -1285,7 +1290,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1285
1290
|
* - **ThreadSafety**: Unsafe
|
|
1286
1291
|
*
|
|
1287
1292
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#FindClosestPointOnSurface)
|
|
1288
|
-
* @param this
|
|
1293
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1289
1294
|
* @param point Point position in the mesh's local object space.
|
|
1290
1295
|
* @returns Tuple of the face ID, point on the mesh in local object space, and the barycentric coordinate of the position within the face.
|
|
1291
1296
|
*/
|
|
@@ -1300,7 +1305,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1300
1305
|
* - **ThreadSafety**: Unsafe
|
|
1301
1306
|
*
|
|
1302
1307
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#FindClosestVertex)
|
|
1303
|
-
* @param this
|
|
1308
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1304
1309
|
* @param toThisPoint Point position in the mesh's local object space.
|
|
1305
1310
|
* @returns Closest stable vertex ID to the specified point in space.
|
|
1306
1311
|
*/
|
|
@@ -1311,7 +1316,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1311
1316
|
* - **ThreadSafety**: Unsafe
|
|
1312
1317
|
*
|
|
1313
1318
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#FindVerticesWithinSphere)
|
|
1314
|
-
* @param this
|
|
1319
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1315
1320
|
* @param center Center of the sphere in the mesh's local object space.
|
|
1316
1321
|
* @param radius Radius of the sphere.
|
|
1317
1322
|
* @returns List of stable vertex IDs within the requested sphere.
|
|
@@ -1323,7 +1328,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1323
1328
|
* - **ThreadSafety**: Unsafe
|
|
1324
1329
|
*
|
|
1325
1330
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetAdjacentFaces)
|
|
1326
|
-
* @param this
|
|
1331
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1327
1332
|
* @param faceId
|
|
1328
1333
|
* @returns List of face IDs adjacent to the given face.
|
|
1329
1334
|
*/
|
|
@@ -1334,7 +1339,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1334
1339
|
* - **ThreadSafety**: Unsafe
|
|
1335
1340
|
*
|
|
1336
1341
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetAdjacentVertices)
|
|
1337
|
-
* @param this
|
|
1342
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1338
1343
|
* @param vertexId Vertex ID around which to get adjacent vertices.
|
|
1339
1344
|
* @returns List of IDs of adjacent vertices around the given vertex ID.
|
|
1340
1345
|
*/
|
|
@@ -1345,7 +1350,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1345
1350
|
* - **ThreadSafety**: Unsafe
|
|
1346
1351
|
*
|
|
1347
1352
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetBoneByName)
|
|
1348
|
-
* @param this
|
|
1353
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1349
1354
|
* @param boneName Bone name to search for.
|
|
1350
1355
|
* @returns Bone ID of the bone with the given name.
|
|
1351
1356
|
*/
|
|
@@ -1356,7 +1361,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1356
1361
|
* - **ThreadSafety**: Unsafe
|
|
1357
1362
|
*
|
|
1358
1363
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetBoneCFrame)
|
|
1359
|
-
* @param this
|
|
1364
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1360
1365
|
* @param boneId Bone ID for which to get the `CFrame`.
|
|
1361
1366
|
* @returns Initial `CFrame` of the bone in the bind pose of the mesh, in the mesh's local space.
|
|
1362
1367
|
*/
|
|
@@ -1367,7 +1372,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1367
1372
|
* - **ThreadSafety**: Unsafe
|
|
1368
1373
|
*
|
|
1369
1374
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetBoneIsVirtual)
|
|
1370
|
-
* @param this
|
|
1375
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1371
1376
|
* @param boneId Bone ID for which to get whether the bone is virtual.
|
|
1372
1377
|
* @returns Whether the bone with the given bone ID is virtual. Virtual bones can only be bound to a `FaceControls` instance.
|
|
1373
1378
|
*/
|
|
@@ -1378,7 +1383,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1378
1383
|
* - **ThreadSafety**: Unsafe
|
|
1379
1384
|
*
|
|
1380
1385
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetBoneName)
|
|
1381
|
-
* @param this
|
|
1386
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1382
1387
|
* @param boneId Bone ID for which to get the name.
|
|
1383
1388
|
* @returns Name of the bone with the given bone ID.
|
|
1384
1389
|
*/
|
|
@@ -1389,7 +1394,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1389
1394
|
* - **ThreadSafety**: Unsafe
|
|
1390
1395
|
*
|
|
1391
1396
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetBoneParent)
|
|
1392
|
-
* @param this
|
|
1397
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1393
1398
|
* @param boneId Bone ID for which to get the parent.
|
|
1394
1399
|
* @returns Bone ID for the parent of the bone with the given bone ID. If there is no parent, returns `0`.
|
|
1395
1400
|
*/
|
|
@@ -1400,7 +1405,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1400
1405
|
* - **ThreadSafety**: Unsafe
|
|
1401
1406
|
*
|
|
1402
1407
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetBones)
|
|
1403
|
-
* @param this
|
|
1408
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1404
1409
|
* @returns List of stable bone IDs.
|
|
1405
1410
|
*/
|
|
1406
1411
|
GetBones(this: EditableMesh): Array<unknown>;
|
|
@@ -1408,7 +1413,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1408
1413
|
* - **ThreadSafety**: Unsafe
|
|
1409
1414
|
*
|
|
1410
1415
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetCenter)
|
|
1411
|
-
* @param this
|
|
1416
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1412
1417
|
* @returns Center of the bounding box of the `EditableMesh`.
|
|
1413
1418
|
*/
|
|
1414
1419
|
GetCenter(this: EditableMesh): Vector3;
|
|
@@ -1418,7 +1423,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1418
1423
|
* - **ThreadSafety**: Unsafe
|
|
1419
1424
|
*
|
|
1420
1425
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetColor)
|
|
1421
|
-
* @param this
|
|
1426
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1422
1427
|
* @param colorId Color ID for which to get the color.
|
|
1423
1428
|
* @returns Color for the requested stable color ID.
|
|
1424
1429
|
*/
|
|
@@ -1429,7 +1434,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1429
1434
|
* - **ThreadSafety**: Unsafe
|
|
1430
1435
|
*
|
|
1431
1436
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetColorAlpha)
|
|
1432
|
-
* @param this
|
|
1437
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1433
1438
|
* @param colorId Color ID for which to get the alpha.
|
|
1434
1439
|
* @returns Color alpha at the request stable color ID.
|
|
1435
1440
|
*/
|
|
@@ -1441,7 +1446,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1441
1446
|
* - **Tags**: CustomLuaState
|
|
1442
1447
|
*
|
|
1443
1448
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetColors)
|
|
1444
|
-
* @param this
|
|
1449
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1445
1450
|
* @returns List of stable color IDs.
|
|
1446
1451
|
*/
|
|
1447
1452
|
GetColors(this: EditableMesh): Array<unknown>;
|
|
@@ -1452,7 +1457,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1452
1457
|
* - **Tags**: CustomLuaState
|
|
1453
1458
|
*
|
|
1454
1459
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetFaceColors)
|
|
1455
|
-
* @param this
|
|
1460
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1456
1461
|
* @param faceId Face ID for which to get the color IDs.
|
|
1457
1462
|
* @returns List of color IDs used for the vertices on the given face.
|
|
1458
1463
|
*/
|
|
@@ -1464,7 +1469,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1464
1469
|
* - **Tags**: CustomLuaState
|
|
1465
1470
|
*
|
|
1466
1471
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetFaceNormals)
|
|
1467
|
-
* @param this
|
|
1472
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1468
1473
|
* @param faceId Face ID for which to get the normal IDs.
|
|
1469
1474
|
* @returns List of normal IDs used for the vertices on the given face.
|
|
1470
1475
|
*/
|
|
@@ -1476,7 +1481,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1476
1481
|
* - **Tags**: CustomLuaState
|
|
1477
1482
|
*
|
|
1478
1483
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetFaceUVs)
|
|
1479
|
-
* @param this
|
|
1484
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1480
1485
|
* @param faceId Face ID for which to get the UV IDs.
|
|
1481
1486
|
* @returns List of UV IDs used for the vertices on the given face.
|
|
1482
1487
|
*/
|
|
@@ -1488,7 +1493,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1488
1493
|
* - **Tags**: CustomLuaState
|
|
1489
1494
|
*
|
|
1490
1495
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetFaceVertices)
|
|
1491
|
-
* @param this
|
|
1496
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1492
1497
|
* @param faceId
|
|
1493
1498
|
* @returns List of vertex IDs around the given face.
|
|
1494
1499
|
*/
|
|
@@ -1500,7 +1505,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1500
1505
|
* - **Tags**: CustomLuaState
|
|
1501
1506
|
*
|
|
1502
1507
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetFaces)
|
|
1503
|
-
* @param this
|
|
1508
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1504
1509
|
* @returns List of stable face IDs.
|
|
1505
1510
|
*/
|
|
1506
1511
|
GetFaces(this: EditableMesh): Array<unknown>;
|
|
@@ -1513,7 +1518,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1513
1518
|
* - **Tags**:
|
|
1514
1519
|
*
|
|
1515
1520
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetFacesWithAttribute)
|
|
1516
|
-
* @param this
|
|
1521
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1517
1522
|
* @param id Attribute ID for which to find faces that use it.
|
|
1518
1523
|
* @returns List of face IDs which use the given attribute ID.
|
|
1519
1524
|
*
|
|
@@ -1527,7 +1532,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1527
1532
|
* - **Tags**: CustomLuaState
|
|
1528
1533
|
*
|
|
1529
1534
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetFacesWithColor)
|
|
1530
|
-
* @param this
|
|
1535
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1531
1536
|
* @param colorId Color ID to find faces for.
|
|
1532
1537
|
* @returns List of face IDs that use the provided color ID.
|
|
1533
1538
|
*/
|
|
@@ -1539,7 +1544,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1539
1544
|
* - **Tags**: CustomLuaState
|
|
1540
1545
|
*
|
|
1541
1546
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetFacesWithNormal)
|
|
1542
|
-
* @param this
|
|
1547
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1543
1548
|
* @param normalId Normal ID to find faces for.
|
|
1544
1549
|
* @returns List of face IDs that use the provided normal ID.
|
|
1545
1550
|
*/
|
|
@@ -1551,7 +1556,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1551
1556
|
* - **Tags**: CustomLuaState
|
|
1552
1557
|
*
|
|
1553
1558
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetFacesWithUV)
|
|
1554
|
-
* @param this
|
|
1559
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1555
1560
|
* @param uvId UV ID to find faces for.
|
|
1556
1561
|
* @returns List of face IDs that use the provided UV ID.
|
|
1557
1562
|
*/
|
|
@@ -1562,7 +1567,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1562
1567
|
* - **ThreadSafety**: Unsafe
|
|
1563
1568
|
*
|
|
1564
1569
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetFacsCorrectivePose)
|
|
1565
|
-
* @param this
|
|
1570
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1566
1571
|
* @param actions Array or 2 or 3 `FacsActionUnit` values that specify a corrective pose.
|
|
1567
1572
|
* @returns Array of bone IDs and corresponding array of bone `CFrames`.
|
|
1568
1573
|
*/
|
|
@@ -1573,7 +1578,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1573
1578
|
* - **ThreadSafety**: Unsafe
|
|
1574
1579
|
*
|
|
1575
1580
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetFacsCorrectivePoses)
|
|
1576
|
-
* @param this
|
|
1581
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1577
1582
|
* @returns Array of corrective poses. Each corrective pose is specified by a small array of 2 or 3 `FacsActionUnit` values.
|
|
1578
1583
|
*/
|
|
1579
1584
|
GetFacsCorrectivePoses(this: EditableMesh): Array<unknown>;
|
|
@@ -1583,7 +1588,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1583
1588
|
* - **ThreadSafety**: Unsafe
|
|
1584
1589
|
*
|
|
1585
1590
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetFacsPose)
|
|
1586
|
-
* @param this
|
|
1591
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1587
1592
|
* @param action FACS action unit for which to get the pose.
|
|
1588
1593
|
* @returns Array of bone IDs and corresponding array of bone `CFrame`.
|
|
1589
1594
|
*/
|
|
@@ -1594,7 +1599,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1594
1599
|
* - **ThreadSafety**: Unsafe
|
|
1595
1600
|
*
|
|
1596
1601
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetFacsPoses)
|
|
1597
|
-
* @param this
|
|
1602
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1598
1603
|
* @returns Array of `FacsActionUnit`, one for each FACS action unit that has a pose defined.
|
|
1599
1604
|
*/
|
|
1600
1605
|
GetFacsPoses(this: EditableMesh): Array<unknown>;
|
|
@@ -1604,7 +1609,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1604
1609
|
* - **ThreadSafety**: Unsafe
|
|
1605
1610
|
*
|
|
1606
1611
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetNormal)
|
|
1607
|
-
* @param this
|
|
1612
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1608
1613
|
* @param normalId Normal ID for which to get the normal vector.
|
|
1609
1614
|
* @returns Normal vector at the requested normal ID.
|
|
1610
1615
|
*/
|
|
@@ -1616,7 +1621,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1616
1621
|
* - **Tags**: CustomLuaState
|
|
1617
1622
|
*
|
|
1618
1623
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetNormals)
|
|
1619
|
-
* @param this
|
|
1624
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1620
1625
|
* @returns List of stable normal IDs.
|
|
1621
1626
|
*/
|
|
1622
1627
|
GetNormals(this: EditableMesh): Array<unknown>;
|
|
@@ -1626,7 +1631,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1626
1631
|
* - **ThreadSafety**: Unsafe
|
|
1627
1632
|
*
|
|
1628
1633
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetPosition)
|
|
1629
|
-
* @param this
|
|
1634
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1630
1635
|
* @param vertexId Stable vertex ID for which to get the position.
|
|
1631
1636
|
* @returns Position of a vertex in the mesh's local object space.
|
|
1632
1637
|
*/
|
|
@@ -1635,7 +1640,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1635
1640
|
* - **ThreadSafety**: Unsafe
|
|
1636
1641
|
*
|
|
1637
1642
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetSize)
|
|
1638
|
-
* @param this
|
|
1643
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1639
1644
|
* @returns Size of the `EditableMesh`.
|
|
1640
1645
|
*/
|
|
1641
1646
|
GetSize(this: EditableMesh): Vector3;
|
|
@@ -1645,7 +1650,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1645
1650
|
* - **ThreadSafety**: Unsafe
|
|
1646
1651
|
*
|
|
1647
1652
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetUV)
|
|
1648
|
-
* @param this
|
|
1653
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1649
1654
|
* @param uvId UV ID for which to get the UV coordinate.
|
|
1650
1655
|
* @returns UV coordinates at the requested UV ID.
|
|
1651
1656
|
*/
|
|
@@ -1657,7 +1662,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1657
1662
|
* - **Tags**: CustomLuaState
|
|
1658
1663
|
*
|
|
1659
1664
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetUVs)
|
|
1660
|
-
* @param this
|
|
1665
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1661
1666
|
* @returns List of stable UV IDs.
|
|
1662
1667
|
*/
|
|
1663
1668
|
GetUVs(this: EditableMesh): Array<unknown>;
|
|
@@ -1667,7 +1672,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1667
1672
|
* - **ThreadSafety**: Unsafe
|
|
1668
1673
|
*
|
|
1669
1674
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetVertexBoneWeights)
|
|
1670
|
-
* @param this
|
|
1675
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1671
1676
|
* @param vertexId Vertex ID for which to get the associated bone weights.
|
|
1672
1677
|
* @returns Skinning blend weights for each bone that is associated with the vertex.
|
|
1673
1678
|
*/
|
|
@@ -1678,7 +1683,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1678
1683
|
* - **ThreadSafety**: Unsafe
|
|
1679
1684
|
*
|
|
1680
1685
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetVertexBones)
|
|
1681
|
-
* @param this
|
|
1686
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1682
1687
|
* @param vertexId Vertex ID for which to get the associated bones.
|
|
1683
1688
|
* @returns Bone IDs associated with the vertex for skinning.
|
|
1684
1689
|
*/
|
|
@@ -1690,7 +1695,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1690
1695
|
* - **Tags**: CustomLuaState
|
|
1691
1696
|
*
|
|
1692
1697
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetVertexColors)
|
|
1693
|
-
* @param this
|
|
1698
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1694
1699
|
* @param vertexId Stable vertex ID to find color IDs.
|
|
1695
1700
|
* @returns Array of color IDs of faces attached to the given vertex.
|
|
1696
1701
|
*/
|
|
@@ -1701,7 +1706,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1701
1706
|
* - **ThreadSafety**: Unsafe
|
|
1702
1707
|
*
|
|
1703
1708
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetVertexFaceColor)
|
|
1704
|
-
* @param this
|
|
1709
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1705
1710
|
* @param vertexId Stable vertex ID.
|
|
1706
1711
|
* @param faceId Stable face ID.
|
|
1707
1712
|
* @returns Stable color ID of the vertex/face pair.
|
|
@@ -1713,7 +1718,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1713
1718
|
* - **ThreadSafety**: Unsafe
|
|
1714
1719
|
*
|
|
1715
1720
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetVertexFaceNormal)
|
|
1716
|
-
* @param this
|
|
1721
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1717
1722
|
* @param vertexId Stable vertex ID.
|
|
1718
1723
|
* @param faceId Stable face ID.
|
|
1719
1724
|
* @returns Stable normal ID of the vertex/face pair.
|
|
@@ -1725,7 +1730,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1725
1730
|
* - **ThreadSafety**: Unsafe
|
|
1726
1731
|
*
|
|
1727
1732
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetVertexFaceUV)
|
|
1728
|
-
* @param this
|
|
1733
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1729
1734
|
* @param vertexId Stable vertex ID.
|
|
1730
1735
|
* @param faceId Stable face ID.
|
|
1731
1736
|
* @returns Stable UV ID of the vertex/face pair.
|
|
@@ -1738,7 +1743,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1738
1743
|
* - **Tags**: CustomLuaState
|
|
1739
1744
|
*
|
|
1740
1745
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetVertexFaces)
|
|
1741
|
-
* @param this
|
|
1746
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1742
1747
|
* @param vertexId Stable vertex ID to find faces for.
|
|
1743
1748
|
* @returns Array of face IDs attached to the given vertex.
|
|
1744
1749
|
*/
|
|
@@ -1750,7 +1755,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1750
1755
|
* - **Tags**: CustomLuaState
|
|
1751
1756
|
*
|
|
1752
1757
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetVertexNormals)
|
|
1753
|
-
* @param this
|
|
1758
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1754
1759
|
* @param vertexId Stable vertex ID to find normal IDs.
|
|
1755
1760
|
* @returns Array of normal IDs of faces attached to the given vertex.
|
|
1756
1761
|
*/
|
|
@@ -1762,7 +1767,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1762
1767
|
* - **Tags**: CustomLuaState
|
|
1763
1768
|
*
|
|
1764
1769
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetVertexUVs)
|
|
1765
|
-
* @param this
|
|
1770
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1766
1771
|
* @param vertexId Stable vertex ID to find UV IDs.
|
|
1767
1772
|
* @returns Array of UV IDs of faces attached to the given vertex.
|
|
1768
1773
|
*/
|
|
@@ -1773,7 +1778,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1773
1778
|
* - **ThreadSafety**: Unsafe
|
|
1774
1779
|
*
|
|
1775
1780
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetVertices)
|
|
1776
|
-
* @param this
|
|
1781
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1777
1782
|
* @returns List of stable vertex IDs.
|
|
1778
1783
|
*/
|
|
1779
1784
|
GetVertices(this: EditableMesh): Array<number>;
|
|
@@ -1786,7 +1791,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1786
1791
|
* - **Tags**:
|
|
1787
1792
|
*
|
|
1788
1793
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetVerticesWithAttribute)
|
|
1789
|
-
* @param this
|
|
1794
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1790
1795
|
* @param id Attribute ID for which to find vertices that use it.
|
|
1791
1796
|
* @returns List of vertex IDs which use the given attribute ID.
|
|
1792
1797
|
*
|
|
@@ -1800,7 +1805,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1800
1805
|
* - **Tags**: CustomLuaState
|
|
1801
1806
|
*
|
|
1802
1807
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetVerticesWithColor)
|
|
1803
|
-
* @param this
|
|
1808
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1804
1809
|
* @param colorId Color ID to find faces for.
|
|
1805
1810
|
* @returns List of face IDs that use the provided color ID.
|
|
1806
1811
|
*/
|
|
@@ -1812,7 +1817,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1812
1817
|
* - **Tags**: CustomLuaState
|
|
1813
1818
|
*
|
|
1814
1819
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetVerticesWithNormal)
|
|
1815
|
-
* @param this
|
|
1820
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1816
1821
|
* @param normalId Normal ID to find vertices for.
|
|
1817
1822
|
* @returns List of vertex IDs that use the provided normal ID.
|
|
1818
1823
|
*/
|
|
@@ -1824,7 +1829,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1824
1829
|
* - **Tags**: CustomLuaState
|
|
1825
1830
|
*
|
|
1826
1831
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetVerticesWithUV)
|
|
1827
|
-
* @param this
|
|
1832
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1828
1833
|
* @param uvId UV ID to find vertices for.
|
|
1829
1834
|
* @returns List of vertex IDs that use the provided UV ID.
|
|
1830
1835
|
*/
|
|
@@ -1835,7 +1840,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1835
1840
|
* - **ThreadSafety**: Unsafe
|
|
1836
1841
|
*
|
|
1837
1842
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#IdDebugString)
|
|
1838
|
-
* @param this
|
|
1843
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1839
1844
|
* @param id ID for which to return a debugging information string.
|
|
1840
1845
|
* @returns String that describes the ID in human-readable format.
|
|
1841
1846
|
*/
|
|
@@ -1846,7 +1851,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1846
1851
|
* - **ThreadSafety**: Unsafe
|
|
1847
1852
|
*
|
|
1848
1853
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#MergeVertices)
|
|
1849
|
-
* @param this
|
|
1854
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1850
1855
|
* @param mergeTolerance The distance at which the vertices are considered to touch each other.
|
|
1851
1856
|
* @returns A mapping of old vertex ID to new vertex ID for vertices that have been merged.
|
|
1852
1857
|
*/
|
|
@@ -1855,7 +1860,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1855
1860
|
* - **ThreadSafety**: Unsafe
|
|
1856
1861
|
*
|
|
1857
1862
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#RaycastLocal)
|
|
1858
|
-
* @param this
|
|
1863
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1859
1864
|
* @param origin Origin of the ray in the mesh's local object space.
|
|
1860
1865
|
* @param direction Direction of the ray.
|
|
1861
1866
|
* @returns Tuple of the point of intersection, face ID, and barycentric coordinates.
|
|
@@ -1871,7 +1876,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1871
1876
|
* - **ThreadSafety**: Unsafe
|
|
1872
1877
|
*
|
|
1873
1878
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#RemoveBone)
|
|
1874
|
-
* @param this
|
|
1879
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1875
1880
|
* @param boneId
|
|
1876
1881
|
*/
|
|
1877
1882
|
RemoveBone(this: EditableMesh, boneId: number): void;
|
|
@@ -1881,7 +1886,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1881
1886
|
* - **ThreadSafety**: Unsafe
|
|
1882
1887
|
*
|
|
1883
1888
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#RemoveFace)
|
|
1884
|
-
* @param this
|
|
1889
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1885
1890
|
* @param faceId
|
|
1886
1891
|
*/
|
|
1887
1892
|
RemoveFace(this: EditableMesh, faceId: number): void;
|
|
@@ -1891,7 +1896,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1891
1896
|
* - **ThreadSafety**: Unsafe
|
|
1892
1897
|
*
|
|
1893
1898
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#RemoveUnused)
|
|
1894
|
-
* @param this
|
|
1899
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1895
1900
|
* @returns All of the removed stable IDs.
|
|
1896
1901
|
*/
|
|
1897
1902
|
RemoveUnused(this: EditableMesh): Array<unknown>;
|
|
@@ -1901,7 +1906,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1901
1906
|
* - **ThreadSafety**: Unsafe
|
|
1902
1907
|
*
|
|
1903
1908
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#ResetNormal)
|
|
1904
|
-
* @param this
|
|
1909
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1905
1910
|
* @param normalId Stable normal ID to reset.
|
|
1906
1911
|
*/
|
|
1907
1912
|
ResetNormal(this: EditableMesh, normalId: number): void;
|
|
@@ -1911,7 +1916,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1911
1916
|
* - **ThreadSafety**: Unsafe
|
|
1912
1917
|
*
|
|
1913
1918
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#SetBoneCFrame)
|
|
1914
|
-
* @param this
|
|
1919
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1915
1920
|
* @param boneId Bone ID for which to set the initial `CFrame`.
|
|
1916
1921
|
* @param cframe Initial `CFrame` for the bone in the mesh's bind pose, in the mesh's local space.
|
|
1917
1922
|
*/
|
|
@@ -1922,7 +1927,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1922
1927
|
* - **ThreadSafety**: Unsafe
|
|
1923
1928
|
*
|
|
1924
1929
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#SetBoneIsVirtual)
|
|
1925
|
-
* @param this
|
|
1930
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1926
1931
|
* @param boneId Bone ID for which to set whether the bone is virtual.
|
|
1927
1932
|
* @param virtual Whether the bone should be virtual.
|
|
1928
1933
|
*/
|
|
@@ -1933,7 +1938,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1933
1938
|
* - **ThreadSafety**: Unsafe
|
|
1934
1939
|
*
|
|
1935
1940
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#SetBoneName)
|
|
1936
|
-
* @param this
|
|
1941
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1937
1942
|
* @param boneId Bone ID for which to set the name.
|
|
1938
1943
|
* @param name Bone name to set.
|
|
1939
1944
|
*/
|
|
@@ -1944,7 +1949,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1944
1949
|
* - **ThreadSafety**: Unsafe
|
|
1945
1950
|
*
|
|
1946
1951
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#SetBoneParent)
|
|
1947
|
-
* @param this
|
|
1952
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1948
1953
|
* @param boneId Bone ID for which to set the parent.
|
|
1949
1954
|
* @param parentBoneId Parent bone ID.
|
|
1950
1955
|
*/
|
|
@@ -1955,7 +1960,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1955
1960
|
* - **ThreadSafety**: Unsafe
|
|
1956
1961
|
*
|
|
1957
1962
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#SetColor)
|
|
1958
|
-
* @param this
|
|
1963
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1959
1964
|
* @param colorId Stable color ID for which to set the color.
|
|
1960
1965
|
* @param color Color to set.
|
|
1961
1966
|
*/
|
|
@@ -1966,7 +1971,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1966
1971
|
* - **ThreadSafety**: Unsafe
|
|
1967
1972
|
*
|
|
1968
1973
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#SetColorAlpha)
|
|
1969
|
-
* @param this
|
|
1974
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1970
1975
|
* @param colorId Stable color ID for which to set the color alpha.
|
|
1971
1976
|
* @param alpha Alpha to set.
|
|
1972
1977
|
*/
|
|
@@ -1978,7 +1983,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1978
1983
|
* - **Tags**: CustomLuaState
|
|
1979
1984
|
*
|
|
1980
1985
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#SetFaceColors)
|
|
1981
|
-
* @param this
|
|
1986
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1982
1987
|
* @param faceId Face ID for which to update the vertex colors.
|
|
1983
1988
|
* @param ids List of new stable color IDs to use for the given face's vertices.
|
|
1984
1989
|
*/
|
|
@@ -1990,7 +1995,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1990
1995
|
* - **Tags**: CustomLuaState
|
|
1991
1996
|
*
|
|
1992
1997
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#SetFaceNormals)
|
|
1993
|
-
* @param this
|
|
1998
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1994
1999
|
* @param faceId Face ID for which to update the vertex normals.
|
|
1995
2000
|
* @param ids List of new stable normal IDs to use for the given face's vertices.
|
|
1996
2001
|
*/
|
|
@@ -2002,7 +2007,7 @@ interface EditableMesh extends RBXObject {
|
|
|
2002
2007
|
* - **Tags**: CustomLuaState
|
|
2003
2008
|
*
|
|
2004
2009
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#SetFaceUVs)
|
|
2005
|
-
* @param this
|
|
2010
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
2006
2011
|
* @param faceId Face ID for which to update the vertex UVs.
|
|
2007
2012
|
* @param ids List of new stable UV IDs to use for the given face's vertices.
|
|
2008
2013
|
*/
|
|
@@ -2014,7 +2019,7 @@ interface EditableMesh extends RBXObject {
|
|
|
2014
2019
|
* - **Tags**: CustomLuaState
|
|
2015
2020
|
*
|
|
2016
2021
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#SetFaceVertices)
|
|
2017
|
-
* @param this
|
|
2022
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
2018
2023
|
* @param faceId Face ID for which to update the vertices.
|
|
2019
2024
|
* @param ids List of new stable vertex IDs to use for the given face.
|
|
2020
2025
|
*/
|
|
@@ -2025,7 +2030,7 @@ interface EditableMesh extends RBXObject {
|
|
|
2025
2030
|
* - **ThreadSafety**: Unsafe
|
|
2026
2031
|
*
|
|
2027
2032
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#SetFacsBonePose)
|
|
2028
|
-
* @param this
|
|
2033
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
2029
2034
|
* @param action FACS action unit for which to set the pose.
|
|
2030
2035
|
* @param boneId Bone to set a `CFrame` for this pose.
|
|
2031
2036
|
* @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.
|
|
@@ -2037,7 +2042,7 @@ interface EditableMesh extends RBXObject {
|
|
|
2037
2042
|
* - **ThreadSafety**: Unsafe
|
|
2038
2043
|
*
|
|
2039
2044
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#SetFacsCorrectivePose)
|
|
2040
|
-
* @param this
|
|
2045
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
2041
2046
|
* @param actions Array or 2 or 3 `FacsActionUnit` values to apply as a corrective pose.
|
|
2042
2047
|
* @param boneIds Bones to set a `CFrame` for this pose.
|
|
2043
2048
|
* @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.
|
|
@@ -2049,7 +2054,7 @@ interface EditableMesh extends RBXObject {
|
|
|
2049
2054
|
* - **ThreadSafety**: Unsafe
|
|
2050
2055
|
*
|
|
2051
2056
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#SetFacsPose)
|
|
2052
|
-
* @param this
|
|
2057
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
2053
2058
|
* @param action FACS action unit to set the pose for.
|
|
2054
2059
|
* @param boneIds Bones for which to set a `CFrame` for this pose.
|
|
2055
2060
|
* @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.
|
|
@@ -2061,7 +2066,7 @@ interface EditableMesh extends RBXObject {
|
|
|
2061
2066
|
* - **ThreadSafety**: Unsafe
|
|
2062
2067
|
*
|
|
2063
2068
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#SetNormal)
|
|
2064
|
-
* @param this
|
|
2069
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
2065
2070
|
* @param normalId Stable normal ID for which to set the normal vector.
|
|
2066
2071
|
* @param normal Normal vector to set.
|
|
2067
2072
|
*/
|
|
@@ -2072,7 +2077,7 @@ interface EditableMesh extends RBXObject {
|
|
|
2072
2077
|
* - **ThreadSafety**: Unsafe
|
|
2073
2078
|
*
|
|
2074
2079
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#SetPosition)
|
|
2075
|
-
* @param this
|
|
2080
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
2076
2081
|
* @param vertexId Stable vertex ID of the vertex to position.
|
|
2077
2082
|
* @param p Position in the mesh's local object space.
|
|
2078
2083
|
*/
|
|
@@ -2083,7 +2088,7 @@ interface EditableMesh extends RBXObject {
|
|
|
2083
2088
|
* - **ThreadSafety**: Unsafe
|
|
2084
2089
|
*
|
|
2085
2090
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#SetUV)
|
|
2086
|
-
* @param this
|
|
2091
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
2087
2092
|
* @param uvId UV ID for which to set the UV coordinates.
|
|
2088
2093
|
* @param uv UV coordinates.
|
|
2089
2094
|
*/
|
|
@@ -2094,7 +2099,7 @@ interface EditableMesh extends RBXObject {
|
|
|
2094
2099
|
* - **ThreadSafety**: Unsafe
|
|
2095
2100
|
*
|
|
2096
2101
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#SetVertexBoneWeights)
|
|
2097
|
-
* @param this
|
|
2102
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
2098
2103
|
* @param vertexId Vertex ID on which to set skinning blend weights.
|
|
2099
2104
|
* @param boneWeights Skinning blend weights to set on the vertex.
|
|
2100
2105
|
*/
|
|
@@ -2105,7 +2110,7 @@ interface EditableMesh extends RBXObject {
|
|
|
2105
2110
|
* - **ThreadSafety**: Unsafe
|
|
2106
2111
|
*
|
|
2107
2112
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#SetVertexBones)
|
|
2108
|
-
* @param this
|
|
2113
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
2109
2114
|
* @param vertexId Vertex ID to set vertex skinning bones.
|
|
2110
2115
|
* @param boneIDs Bone IDs to use with this vertex for skinning.
|
|
2111
2116
|
*/
|
|
@@ -2116,7 +2121,7 @@ interface EditableMesh extends RBXObject {
|
|
|
2116
2121
|
* - **ThreadSafety**: Unsafe
|
|
2117
2122
|
*
|
|
2118
2123
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#SetVertexFaceColor)
|
|
2119
|
-
* @param this
|
|
2124
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
2120
2125
|
* @param vertexId Stable vertex ID.
|
|
2121
2126
|
* @param faceId Stable face ID.
|
|
2122
2127
|
* @param colorId Stable color ID to set for the vertex/face pair.
|
|
@@ -2128,7 +2133,7 @@ interface EditableMesh extends RBXObject {
|
|
|
2128
2133
|
* - **ThreadSafety**: Unsafe
|
|
2129
2134
|
*
|
|
2130
2135
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#SetVertexFaceNormal)
|
|
2131
|
-
* @param this
|
|
2136
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
2132
2137
|
* @param vertexId Stable vertex ID.
|
|
2133
2138
|
* @param faceId Stable face ID.
|
|
2134
2139
|
* @param normalId Stable normal ID to set for the vertex/face pair.
|
|
@@ -2140,7 +2145,7 @@ interface EditableMesh extends RBXObject {
|
|
|
2140
2145
|
* - **ThreadSafety**: Unsafe
|
|
2141
2146
|
*
|
|
2142
2147
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#SetVertexFaceUV)
|
|
2143
|
-
* @param this
|
|
2148
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
2144
2149
|
* @param vertexId Stable vertex ID.
|
|
2145
2150
|
* @param faceId Stable face ID.
|
|
2146
2151
|
* @param uvId Stable UV ID to set for the vertex/face pair.
|
|
@@ -2152,7 +2157,7 @@ interface EditableMesh extends RBXObject {
|
|
|
2152
2157
|
* - **ThreadSafety**: Unsafe
|
|
2153
2158
|
*
|
|
2154
2159
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#Triangulate)
|
|
2155
|
-
* @param this
|
|
2160
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
2156
2161
|
*/
|
|
2157
2162
|
Triangulate(this: EditableMesh): void;
|
|
2158
2163
|
}
|
|
@@ -3287,6 +3292,12 @@ interface Animation extends Instance {
|
|
|
3287
3292
|
* @deprecated
|
|
3288
3293
|
*/
|
|
3289
3294
|
readonly _nominal_Animation: unique symbol;
|
|
3295
|
+
/**
|
|
3296
|
+
* - **ThreadSafety**: ReadSafe
|
|
3297
|
+
*
|
|
3298
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Animation#AnimationContent)
|
|
3299
|
+
*/
|
|
3300
|
+
AnimationContent: Content;
|
|
3290
3301
|
/**
|
|
3291
3302
|
* Asset ID of the animation an `Animation` object is referencing.
|
|
3292
3303
|
*
|
|
@@ -3474,9 +3485,9 @@ interface AnimationClipProvider extends Instance {
|
|
|
3474
3485
|
* @param userId The user ID of the user.
|
|
3475
3486
|
* @returns An `InventoryPages` of animations.
|
|
3476
3487
|
*
|
|
3477
|
-
* @deprecated
|
|
3488
|
+
* @deprecated
|
|
3478
3489
|
*/
|
|
3479
|
-
GetAnimations(this: AnimationClipProvider, userId:
|
|
3490
|
+
GetAnimations(this: AnimationClipProvider, userId: User): Instance | undefined;
|
|
3480
3491
|
/**
|
|
3481
3492
|
* This function returns an `InventoryPages` object which can be used to iterate over animations owned by a specific user.
|
|
3482
3493
|
*
|
|
@@ -3488,7 +3499,7 @@ interface AnimationClipProvider extends Instance {
|
|
|
3488
3499
|
* @param userId The user ID of the user.
|
|
3489
3500
|
* @returns An `InventoryPages` of animations.
|
|
3490
3501
|
*/
|
|
3491
|
-
GetAnimationsAsync(this: AnimationClipProvider, userId:
|
|
3502
|
+
GetAnimationsAsync(this: AnimationClipProvider, userId: User): Instance | undefined;
|
|
3492
3503
|
/**
|
|
3493
3504
|
* - **ThreadSafety**: Unsafe
|
|
3494
3505
|
* - **Tags**: Yields
|
|
@@ -4385,7 +4396,7 @@ interface AssetService extends Instance {
|
|
|
4385
4396
|
* @param editableMeshOptions Options table containing controls for the method: - `FixedSize` – A `bool`. Default value is `true`, and the returned `EditableMesh` will not allow you to add or remove vertices, only modify their values. Set to `false` if the ability to change the mesh topology is required, at the expense of using more memory.
|
|
4386
4397
|
*
|
|
4387
4398
|
*
|
|
4388
|
-
* @returns The new `EditableMesh`
|
|
4399
|
+
* @returns The new `EditableMesh` object.
|
|
4389
4400
|
*/
|
|
4390
4401
|
CreateEditableMeshAsync(this: AssetService, content: Content, editableMeshOptions?: object): EditableMesh;
|
|
4391
4402
|
/**
|
|
@@ -4461,7 +4472,7 @@ interface AssetService extends Instance {
|
|
|
4461
4472
|
* @param packageAssetId
|
|
4462
4473
|
* @returns Asset IDs that are contained in a specified package.
|
|
4463
4474
|
*
|
|
4464
|
-
* @deprecated
|
|
4475
|
+
* @deprecated
|
|
4465
4476
|
*/
|
|
4466
4477
|
GetAssetIdsForPackage(this: AssetService, packageAssetId: number): Array<number>;
|
|
4467
4478
|
/**
|
|
@@ -4527,7 +4538,7 @@ interface AssetService extends Instance {
|
|
|
4527
4538
|
* @param this A non-replicated service that handles asset-related queries to the Roblox web API.
|
|
4528
4539
|
* @param creationID
|
|
4529
4540
|
*
|
|
4530
|
-
* @deprecated
|
|
4541
|
+
* @deprecated
|
|
4531
4542
|
*/
|
|
4532
4543
|
GetCreatorAssetID(this: AssetService, creationID: number): number;
|
|
4533
4544
|
/**
|
|
@@ -4602,7 +4613,7 @@ interface AssetService extends Instance {
|
|
|
4602
4613
|
* @param this A non-replicated service that handles asset-related queries to the Roblox web API.
|
|
4603
4614
|
* @param searchParameters
|
|
4604
4615
|
*
|
|
4605
|
-
* @deprecated
|
|
4616
|
+
* @deprecated
|
|
4606
4617
|
*/
|
|
4607
4618
|
SearchAudio(this: AssetService, searchParameters: AudioSearchParams): AudioPages;
|
|
4608
4619
|
/**
|
|
@@ -4739,7 +4750,7 @@ interface Attachment extends Instance {
|
|
|
4739
4750
|
*
|
|
4740
4751
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Attachment#Rotation)
|
|
4741
4752
|
*
|
|
4742
|
-
* @deprecated
|
|
4753
|
+
* @deprecated
|
|
4743
4754
|
*/
|
|
4744
4755
|
Rotation: Vector3;
|
|
4745
4756
|
/**
|
|
@@ -4805,7 +4816,7 @@ interface Attachment extends Instance {
|
|
|
4805
4816
|
*
|
|
4806
4817
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Attachment#WorldRotation)
|
|
4807
4818
|
*
|
|
4808
|
-
* @deprecated
|
|
4819
|
+
* @deprecated
|
|
4809
4820
|
*/
|
|
4810
4821
|
readonly WorldRotation: Vector3;
|
|
4811
4822
|
/**
|
|
@@ -4828,7 +4839,7 @@ interface Attachment extends Instance {
|
|
|
4828
4839
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Attachment#GetAxis)
|
|
4829
4840
|
* @param this Defines a point and orientation relative to an ancestor `PVInstance`, `Bone`, or another `Attachment`.
|
|
4830
4841
|
*
|
|
4831
|
-
* @deprecated
|
|
4842
|
+
* @deprecated
|
|
4832
4843
|
*/
|
|
4833
4844
|
GetAxis(this: Attachment): Vector3;
|
|
4834
4845
|
/**
|
|
@@ -4851,7 +4862,7 @@ interface Attachment extends Instance {
|
|
|
4851
4862
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Attachment#GetSecondaryAxis)
|
|
4852
4863
|
* @param this Defines a point and orientation relative to an ancestor `PVInstance`, `Bone`, or another `Attachment`.
|
|
4853
4864
|
*
|
|
4854
|
-
* @deprecated
|
|
4865
|
+
* @deprecated
|
|
4855
4866
|
*/
|
|
4856
4867
|
GetSecondaryAxis(this: Attachment): Vector3;
|
|
4857
4868
|
/**
|
|
@@ -4866,7 +4877,7 @@ interface Attachment extends Instance {
|
|
|
4866
4877
|
* @param this Defines a point and orientation relative to an ancestor `PVInstance`, `Bone`, or another `Attachment`.
|
|
4867
4878
|
* @param axis
|
|
4868
4879
|
*
|
|
4869
|
-
* @deprecated
|
|
4880
|
+
* @deprecated
|
|
4870
4881
|
*/
|
|
4871
4882
|
SetAxis(this: Attachment, axis: Vector3): void;
|
|
4872
4883
|
/**
|
|
@@ -4881,7 +4892,7 @@ interface Attachment extends Instance {
|
|
|
4881
4892
|
* @param this Defines a point and orientation relative to an ancestor `PVInstance`, `Bone`, or another `Attachment`.
|
|
4882
4893
|
* @param axis
|
|
4883
4894
|
*
|
|
4884
|
-
* @deprecated
|
|
4895
|
+
* @deprecated
|
|
4885
4896
|
*/
|
|
4886
4897
|
SetSecondaryAxis(this: Attachment, axis: Vector3): void;
|
|
4887
4898
|
}
|
|
@@ -5725,7 +5736,7 @@ interface AudioEmitter extends Instance {
|
|
|
5725
5736
|
*
|
|
5726
5737
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioEmitter#SimulationFidelity)
|
|
5727
5738
|
*
|
|
5728
|
-
* @deprecated
|
|
5739
|
+
* @deprecated
|
|
5729
5740
|
*/
|
|
5730
5741
|
SimulationFidelity: Enum.AudioSimulationFidelity;
|
|
5731
5742
|
/**
|
|
@@ -6404,7 +6415,7 @@ interface AudioListener extends Instance {
|
|
|
6404
6415
|
*
|
|
6405
6416
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioListener#SimulationFidelity)
|
|
6406
6417
|
*
|
|
6407
|
-
* @deprecated
|
|
6418
|
+
* @deprecated
|
|
6408
6419
|
*/
|
|
6409
6420
|
SimulationFidelity: Enum.AudioSimulationFidelity;
|
|
6410
6421
|
/**
|
|
@@ -6619,7 +6630,7 @@ interface AudioPlayer extends Instance {
|
|
|
6619
6630
|
*
|
|
6620
6631
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioPlayer#AssetId)
|
|
6621
6632
|
*
|
|
6622
|
-
* @deprecated
|
|
6633
|
+
* @deprecated
|
|
6623
6634
|
*/
|
|
6624
6635
|
AssetId: string;
|
|
6625
6636
|
/**
|
|
@@ -7164,7 +7175,7 @@ interface AudioSearchParams extends Instance {
|
|
|
7164
7175
|
*
|
|
7165
7176
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioSearchParams#AudioSubtype)
|
|
7166
7177
|
*
|
|
7167
|
-
* @deprecated
|
|
7178
|
+
* @deprecated
|
|
7168
7179
|
*/
|
|
7169
7180
|
AudioSubtype: Enum.AudioSubType;
|
|
7170
7181
|
/**
|
|
@@ -7602,216 +7613,6 @@ interface AuroraScriptObject extends Instance {
|
|
|
7602
7613
|
*/
|
|
7603
7614
|
PriorFrameInvoked: number;
|
|
7604
7615
|
}
|
|
7605
|
-
/**
|
|
7606
|
-
* - **Tags**: NotCreatable, Service
|
|
7607
|
-
*
|
|
7608
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraScriptService)
|
|
7609
|
-
*
|
|
7610
|
-
* @deprecated
|
|
7611
|
-
*/
|
|
7612
|
-
interface AuroraScriptService extends Instance {
|
|
7613
|
-
/**
|
|
7614
|
-
* **DO NOT USE!**
|
|
7615
|
-
*
|
|
7616
|
-
* This field exists to force TypeScript to recognize this as a nominal type
|
|
7617
|
-
* @hidden
|
|
7618
|
-
* @deprecated
|
|
7619
|
-
*/
|
|
7620
|
-
readonly _nominal_AuroraScriptService: unique symbol;
|
|
7621
|
-
/**
|
|
7622
|
-
* - **ThreadSafety**: Unsafe
|
|
7623
|
-
*
|
|
7624
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraScriptService#CreateCollection)
|
|
7625
|
-
*/
|
|
7626
|
-
CreateCollection(this: AuroraScriptService, query: string, root?: Instance): CollectionHandle;
|
|
7627
|
-
/**
|
|
7628
|
-
* - **ThreadSafety**: Safe
|
|
7629
|
-
* - **Tags**: CustomLuaState
|
|
7630
|
-
*
|
|
7631
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraScriptService#FindBinding)
|
|
7632
|
-
*/
|
|
7633
|
-
FindBinding(this: AuroraScriptService, instance: Instance, scriptName: string): RBXObject;
|
|
7634
|
-
/**
|
|
7635
|
-
* - **ThreadSafety**: Safe
|
|
7636
|
-
* - **Tags**: CustomLuaState
|
|
7637
|
-
*
|
|
7638
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraScriptService#FindBindings)
|
|
7639
|
-
*/
|
|
7640
|
-
FindBindings(this: AuroraScriptService, instance: Instance): object;
|
|
7641
|
-
/**
|
|
7642
|
-
* - **ThreadSafety**: Unsafe
|
|
7643
|
-
*
|
|
7644
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraScriptService#GetAllCollections)
|
|
7645
|
-
*/
|
|
7646
|
-
GetAllCollections(this: AuroraScriptService): Array<unknown>;
|
|
7647
|
-
/**
|
|
7648
|
-
* - **ThreadSafety**: Safe
|
|
7649
|
-
*
|
|
7650
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraScriptService#GetLocalFrameId)
|
|
7651
|
-
*/
|
|
7652
|
-
GetLocalFrameId(this: AuroraScriptService): number;
|
|
7653
|
-
/**
|
|
7654
|
-
* - **ThreadSafety**: Safe
|
|
7655
|
-
*
|
|
7656
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraScriptService#SendMessage)
|
|
7657
|
-
*/
|
|
7658
|
-
SendMessage(this: AuroraScriptService, instance: Instance, behaviorName: string, functionName: string, args: unknown): void;
|
|
7659
|
-
/**
|
|
7660
|
-
* - **ThreadSafety**: Unsafe
|
|
7661
|
-
*
|
|
7662
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraScriptService#getBehaviors)
|
|
7663
|
-
*/
|
|
7664
|
-
getBehaviors(this: AuroraScriptService): Array<Instance>;
|
|
7665
|
-
/**
|
|
7666
|
-
* - **ThreadSafety**: Unsafe
|
|
7667
|
-
*
|
|
7668
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraScriptService#getBehaviorsForInstance)
|
|
7669
|
-
*/
|
|
7670
|
-
getBehaviorsForInstance(this: AuroraScriptService, instance: Instance): Array<Instance>;
|
|
7671
|
-
/**
|
|
7672
|
-
* - **ThreadSafety**: Unsafe
|
|
7673
|
-
*
|
|
7674
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraScriptService#getInstancesForBehavior)
|
|
7675
|
-
*/
|
|
7676
|
-
getInstancesForBehavior(this: AuroraScriptService, behavior: AuroraScript): Array<Instance>;
|
|
7677
|
-
}
|
|
7678
|
-
/**
|
|
7679
|
-
* - **Tags**: NotCreatable, Service
|
|
7680
|
-
*
|
|
7681
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService)
|
|
7682
|
-
*
|
|
7683
|
-
* @deprecated
|
|
7684
|
-
*/
|
|
7685
|
-
interface AuroraService extends Instance {
|
|
7686
|
-
/**
|
|
7687
|
-
* **DO NOT USE!**
|
|
7688
|
-
*
|
|
7689
|
-
* This field exists to force TypeScript to recognize this as a nominal type
|
|
7690
|
-
* @hidden
|
|
7691
|
-
* @deprecated
|
|
7692
|
-
*/
|
|
7693
|
-
readonly _nominal_AuroraService: unique symbol;
|
|
7694
|
-
/**
|
|
7695
|
-
* - **ThreadSafety**: ReadSafe
|
|
7696
|
-
*
|
|
7697
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService#HashRoundingPoint)
|
|
7698
|
-
*/
|
|
7699
|
-
HashRoundingPoint: number;
|
|
7700
|
-
/**
|
|
7701
|
-
* - **ThreadSafety**: ReadSafe
|
|
7702
|
-
*
|
|
7703
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService#IgnoreRotation)
|
|
7704
|
-
*/
|
|
7705
|
-
IgnoreRotation: boolean;
|
|
7706
|
-
/**
|
|
7707
|
-
* - **ThreadSafety**: ReadSafe
|
|
7708
|
-
*
|
|
7709
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService#LockStepIdOffset)
|
|
7710
|
-
*/
|
|
7711
|
-
LockStepIdOffset: boolean;
|
|
7712
|
-
/**
|
|
7713
|
-
* - **ThreadSafety**: ReadSafe
|
|
7714
|
-
*
|
|
7715
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService#RollbackOffset)
|
|
7716
|
-
*/
|
|
7717
|
-
RollbackOffset: number;
|
|
7718
|
-
/**
|
|
7719
|
-
* - **ThreadSafety**: Unsafe
|
|
7720
|
-
*
|
|
7721
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService#GetPredictedInstances)
|
|
7722
|
-
*/
|
|
7723
|
-
GetPredictedInstances(this: AuroraService): Array<unknown>;
|
|
7724
|
-
/**
|
|
7725
|
-
* - **ThreadSafety**: Unsafe
|
|
7726
|
-
*
|
|
7727
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService#GetRemoteWorldStepId)
|
|
7728
|
-
*/
|
|
7729
|
-
GetRemoteWorldStepId(this: AuroraService): number;
|
|
7730
|
-
/**
|
|
7731
|
-
* - **ThreadSafety**: Unsafe
|
|
7732
|
-
*
|
|
7733
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService#GetServerView)
|
|
7734
|
-
*/
|
|
7735
|
-
GetServerView(this: AuroraService, target: Instance): Instance | undefined;
|
|
7736
|
-
/**
|
|
7737
|
-
* - **ThreadSafety**: Unsafe
|
|
7738
|
-
*
|
|
7739
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService#GetWorldStepId)
|
|
7740
|
-
*/
|
|
7741
|
-
GetWorldStepId(this: AuroraService): number;
|
|
7742
|
-
/**
|
|
7743
|
-
* - **ThreadSafety**: Unsafe
|
|
7744
|
-
*
|
|
7745
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService#IsInstancePredicted)
|
|
7746
|
-
*/
|
|
7747
|
-
IsInstancePredicted(this: AuroraService, target: Instance): boolean;
|
|
7748
|
-
/**
|
|
7749
|
-
* - **ThreadSafety**: Unsafe
|
|
7750
|
-
*
|
|
7751
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService#PlayInputRecording)
|
|
7752
|
-
*/
|
|
7753
|
-
PlayInputRecording(this: AuroraService): void;
|
|
7754
|
-
/**
|
|
7755
|
-
* - **ThreadSafety**: Unsafe
|
|
7756
|
-
*
|
|
7757
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService#SetReplicationLag)
|
|
7758
|
-
*/
|
|
7759
|
-
SetReplicationLag(this: AuroraService, seconds: number): void;
|
|
7760
|
-
/**
|
|
7761
|
-
* - **ThreadSafety**: Unsafe
|
|
7762
|
-
*
|
|
7763
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService#ShowDebugVisualizer)
|
|
7764
|
-
*/
|
|
7765
|
-
ShowDebugVisualizer(this: AuroraService, state: boolean): void;
|
|
7766
|
-
/**
|
|
7767
|
-
* - **ThreadSafety**: Unsafe
|
|
7768
|
-
*
|
|
7769
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService#StartInputRecording)
|
|
7770
|
-
*/
|
|
7771
|
-
StartInputRecording(this: AuroraService): void;
|
|
7772
|
-
/**
|
|
7773
|
-
* - **ThreadSafety**: Unsafe
|
|
7774
|
-
*
|
|
7775
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService#StartPrediction)
|
|
7776
|
-
*/
|
|
7777
|
-
StartPrediction(this: AuroraService, target: Instance): void;
|
|
7778
|
-
/**
|
|
7779
|
-
* - **ThreadSafety**: Unsafe
|
|
7780
|
-
*
|
|
7781
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService#StepPhysics)
|
|
7782
|
-
*/
|
|
7783
|
-
StepPhysics(this: AuroraService, worldSteps: number, parts?: Array<Instance>): void;
|
|
7784
|
-
/**
|
|
7785
|
-
* - **ThreadSafety**: Unsafe
|
|
7786
|
-
*
|
|
7787
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService#StopInputRecording)
|
|
7788
|
-
*/
|
|
7789
|
-
StopInputRecording(this: AuroraService): void;
|
|
7790
|
-
/**
|
|
7791
|
-
* - **ThreadSafety**: Unsafe
|
|
7792
|
-
*
|
|
7793
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService#StopPrediction)
|
|
7794
|
-
*/
|
|
7795
|
-
StopPrediction(this: AuroraService, target: Instance): void;
|
|
7796
|
-
/**
|
|
7797
|
-
* - **ThreadSafety**: Unsafe
|
|
7798
|
-
*
|
|
7799
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService#UpdateProperties)
|
|
7800
|
-
*/
|
|
7801
|
-
UpdateProperties(this: AuroraService, target: Instance): void;
|
|
7802
|
-
/**
|
|
7803
|
-
* - **ThreadSafety**: Unsafe
|
|
7804
|
-
*
|
|
7805
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService#FixedRateTick)
|
|
7806
|
-
*/
|
|
7807
|
-
readonly FixedRateTick: RBXScriptSignal<(deltaTime: number, worldStepId: number) => void>;
|
|
7808
|
-
/**
|
|
7809
|
-
* - **ThreadSafety**: Unsafe
|
|
7810
|
-
*
|
|
7811
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService#Step)
|
|
7812
|
-
*/
|
|
7813
|
-
readonly Step: RBXScriptSignal<() => void>;
|
|
7814
|
-
}
|
|
7815
7616
|
/**
|
|
7816
7617
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AvatarAbilityRules)
|
|
7817
7618
|
*/
|
|
@@ -8177,6 +7978,8 @@ interface AvatarEditorService extends Instance {
|
|
|
8177
7978
|
* @param this A service to support developer Avatar Editors.
|
|
8178
7979
|
* @param outfit The `Outfit` that the player will be prompted to created.
|
|
8179
7980
|
* @param rigType The `RigType` that the outfit will be created for if the player confirms the prompt.
|
|
7981
|
+
* @param outfitOptions Reserved for future options. Must be empty or omitted.
|
|
7982
|
+
* @param outfitType Optional `OutfitType`. Only `Avatar` and `Makeup` values are accepted. When omitted, the type is inferred from the description.
|
|
8180
7983
|
*/
|
|
8181
7984
|
PromptCreateOutfit(this: AvatarEditorService, outfit: HumanoidDescription, rigType: CastsToEnum<Enum.HumanoidRigType>, outfitOptions: object, outfitType: unknown): void;
|
|
8182
7985
|
/**
|
|
@@ -8247,7 +8050,7 @@ interface AvatarEditorService extends Instance {
|
|
|
8247
8050
|
* @param humanoidDescription The HumanoidDescription to check if default clothing is required.
|
|
8248
8051
|
* @returns Returns a HumanoidDescription if default clothing was necessary. Otherwise returns `nil`.
|
|
8249
8052
|
*
|
|
8250
|
-
* @deprecated
|
|
8053
|
+
* @deprecated
|
|
8251
8054
|
*/
|
|
8252
8055
|
CheckApplyDefaultClothing(this: AvatarEditorService, humanoidDescription: HumanoidDescription): HumanoidDescription | undefined;
|
|
8253
8056
|
/**
|
|
@@ -8272,7 +8075,7 @@ interface AvatarEditorService extends Instance {
|
|
|
8272
8075
|
* @param this A service to support developer Avatar Editors.
|
|
8273
8076
|
* @param humanoidDescription
|
|
8274
8077
|
*
|
|
8275
|
-
* @deprecated
|
|
8078
|
+
* @deprecated
|
|
8276
8079
|
*/
|
|
8277
8080
|
ConformToAvatarRules(this: AvatarEditorService, humanoidDescription: HumanoidDescription): HumanoidDescription;
|
|
8278
8081
|
/**
|
|
@@ -8299,7 +8102,7 @@ interface AvatarEditorService extends Instance {
|
|
|
8299
8102
|
* @param this A service to support developer Avatar Editors.
|
|
8300
8103
|
* @returns A dictionary containing the platform Avatar rules for things like scaling, default shirts and pants, number of wearable assets, ect. See the example return in the main description above.
|
|
8301
8104
|
*
|
|
8302
|
-
* @deprecated
|
|
8105
|
+
* @deprecated
|
|
8303
8106
|
*/
|
|
8304
8107
|
GetAvatarRules(this: AvatarEditorService): AvatarRules;
|
|
8305
8108
|
/**
|
|
@@ -8327,7 +8130,7 @@ interface AvatarEditorService extends Instance {
|
|
|
8327
8130
|
* @param itemType The type of the item ids provided.
|
|
8328
8131
|
* @returns Returns an array of item details. See `AvatarEditorService:GetBatchItemDetailsAsync()` for the response format.
|
|
8329
8132
|
*
|
|
8330
|
-
* @deprecated
|
|
8133
|
+
* @deprecated
|
|
8331
8134
|
*/
|
|
8332
8135
|
GetBatchItemDetails(this: AvatarEditorService, itemIds: ReadonlyArray<number>, itemType: CastsToEnum<Enum.AvatarItemType.Asset>): ReadonlyArray<AssetItemDetails>;
|
|
8333
8136
|
GetBatchItemDetails(this: AvatarEditorService, itemIds: ReadonlyArray<number>, itemType: CastsToEnum<Enum.AvatarItemType.Bundle>): ReadonlyArray<BundleItemDetails>;
|
|
@@ -8366,7 +8169,7 @@ interface AvatarEditorService extends Instance {
|
|
|
8366
8169
|
* @param itemType The `AvatarItemType` of the specified asset or bundle.
|
|
8367
8170
|
* @returns Whether the `LocalPlayer` has favorited the given bundle or asset.
|
|
8368
8171
|
*
|
|
8369
|
-
* @deprecated
|
|
8172
|
+
* @deprecated
|
|
8370
8173
|
*/
|
|
8371
8174
|
GetFavorite(this: AvatarEditorService, itemId: number, itemType: CastsToEnum<Enum.AvatarItemType>): boolean;
|
|
8372
8175
|
/**
|
|
@@ -8405,7 +8208,7 @@ interface AvatarEditorService extends Instance {
|
|
|
8405
8208
|
* @param this A service to support developer Avatar Editors.
|
|
8406
8209
|
* @param assetTypes The `AvatarAssetType` that can will be checked for in the player's inventory.
|
|
8407
8210
|
*
|
|
8408
|
-
* @deprecated
|
|
8211
|
+
* @deprecated
|
|
8409
8212
|
*/
|
|
8410
8213
|
GetInventory(this: AvatarEditorService, assetTypes: ReadonlyArray<Enum.AvatarAssetType>): InventoryPages<{
|
|
8411
8214
|
AssetId: number;
|
|
@@ -8438,7 +8241,7 @@ interface AvatarEditorService extends Instance {
|
|
|
8438
8241
|
* @param itemType An enum value indicating the type of item whose details are being retrieved.
|
|
8439
8242
|
* @returns A table containing the item info for the retrieved item. See above for a sample table.
|
|
8440
8243
|
*
|
|
8441
|
-
* @deprecated
|
|
8244
|
+
* @deprecated
|
|
8442
8245
|
*/
|
|
8443
8246
|
GetItemDetails(this: AvatarEditorService, itemId: number, itemType: CastsToEnum<Enum.AvatarItemType.Asset>): AssetItemDetails;
|
|
8444
8247
|
GetItemDetails(this: AvatarEditorService, itemId: number, itemType: CastsToEnum<Enum.AvatarItemType.Bundle>): BundleItemDetails;
|
|
@@ -8469,7 +8272,7 @@ interface AvatarEditorService extends Instance {
|
|
|
8469
8272
|
* @param outfitId The ID of the outfit whose details are being retrieved.
|
|
8470
8273
|
* @returns A table containing the outfit info for the retrieved outfit. See above for a sample table.
|
|
8471
8274
|
*
|
|
8472
|
-
* @deprecated
|
|
8275
|
+
* @deprecated
|
|
8473
8276
|
*/
|
|
8474
8277
|
GetOutfitDetails(this: AvatarEditorService, outfitId: number): object;
|
|
8475
8278
|
/**
|
|
@@ -8497,7 +8300,7 @@ interface AvatarEditorService extends Instance {
|
|
|
8497
8300
|
* @param outfitSource
|
|
8498
8301
|
* @param outfitType
|
|
8499
8302
|
*
|
|
8500
|
-
* @deprecated
|
|
8303
|
+
* @deprecated
|
|
8501
8304
|
*/
|
|
8502
8305
|
GetOutfits(this: AvatarEditorService, outfitSource?: CastsToEnum<Enum.OutfitSource>, outfitType?: CastsToEnum<Enum.OutfitType>): OutfitPages;
|
|
8503
8306
|
/**
|
|
@@ -8526,7 +8329,7 @@ interface AvatarEditorService extends Instance {
|
|
|
8526
8329
|
* @param contextAssetId The ID of an asset with a type matching the provided assetType used for context when retrieving recommendations.
|
|
8527
8330
|
* @returns A list of recommendations based on the given `AssetType`.
|
|
8528
8331
|
*
|
|
8529
|
-
* @deprecated
|
|
8332
|
+
* @deprecated
|
|
8530
8333
|
*/
|
|
8531
8334
|
GetRecommendedAssets(this: AvatarEditorService, assetType: CastsToEnum<Enum.AvatarAssetType>, contextAssetId?: number): ReadonlyArray<RecommendedAsset>;
|
|
8532
8335
|
/**
|
|
@@ -8555,7 +8358,7 @@ interface AvatarEditorService extends Instance {
|
|
|
8555
8358
|
* @param bundleId A list of recommended bundles.
|
|
8556
8359
|
* @returns The bundle ID that the recommended bundles will be returned for.
|
|
8557
8360
|
*
|
|
8558
|
-
* @deprecated
|
|
8361
|
+
* @deprecated
|
|
8559
8362
|
*/
|
|
8560
8363
|
GetRecommendedBundles(this: AvatarEditorService, bundleId: number): ReadonlyArray<RecommendedBundle>;
|
|
8561
8364
|
/**
|
|
@@ -8582,7 +8385,7 @@ interface AvatarEditorService extends Instance {
|
|
|
8582
8385
|
* @param this A service to support developer Avatar Editors.
|
|
8583
8386
|
* @param searchParameters An object containing the parameters used for the search.
|
|
8584
8387
|
*
|
|
8585
|
-
* @deprecated
|
|
8388
|
+
* @deprecated
|
|
8586
8389
|
*/
|
|
8587
8390
|
SearchCatalog(this: AvatarEditorService, searchParameters: CatalogSearchParams): CatalogPages;
|
|
8588
8391
|
/**
|
|
@@ -8742,7 +8545,7 @@ interface BadgeService extends Instance {
|
|
|
8742
8545
|
* @param badgeId The ID of the badge to be awarded.
|
|
8743
8546
|
* @returns Boolean of `true` if the badge was awarded successfully.
|
|
8744
8547
|
*
|
|
8745
|
-
* @deprecated
|
|
8548
|
+
* @deprecated
|
|
8746
8549
|
*/
|
|
8747
8550
|
AwardBadge(this: BadgeService, userId: number, badgeId: number): boolean;
|
|
8748
8551
|
/**
|
|
@@ -8757,7 +8560,7 @@ interface BadgeService extends Instance {
|
|
|
8757
8560
|
* @param badgeId The ID of the badge to be awarded.
|
|
8758
8561
|
* @returns Boolean of `true` if the badge was awarded successfully.
|
|
8759
8562
|
*/
|
|
8760
|
-
AwardBadgeAsync(this: BadgeService, userId:
|
|
8563
|
+
AwardBadgeAsync(this: BadgeService, userId: User, badgeId: number): boolean;
|
|
8761
8564
|
/**
|
|
8762
8565
|
* Checks a list of badge IDs against a `UserId` and returns a list of badge IDs that the player owns.
|
|
8763
8566
|
*
|
|
@@ -8770,7 +8573,7 @@ interface BadgeService extends Instance {
|
|
|
8770
8573
|
* @param badgeIds The list of IDs of the badges to check ownership of. Maximum length of 10.
|
|
8771
8574
|
* @returns The list of badge IDs the given user owns out of the provided badge IDs. Empty if none of the provided badges are owned by the given user. Not guaranteed to be in the same order as the input list. Some badge IDs may be omitted if the user with the target `userId` has not recently been in the server and the badge IDs are not associated with the requesting experience.
|
|
8772
8575
|
*/
|
|
8773
|
-
CheckUserBadgesAsync(this: BadgeService, userId:
|
|
8576
|
+
CheckUserBadgesAsync(this: BadgeService, userId: User, badgeIds: Array<unknown>): Array<unknown>;
|
|
8774
8577
|
/**
|
|
8775
8578
|
* Fetch information about a badge given its ID.
|
|
8776
8579
|
*
|
|
@@ -8816,7 +8619,7 @@ interface BadgeService extends Instance {
|
|
|
8816
8619
|
*/
|
|
8817
8620
|
IsLegal(this: BadgeService, badgeId: number): boolean;
|
|
8818
8621
|
/**
|
|
8819
|
-
* **Deprecated:** This method has been superseded by `BadgeService:UserHasBadgeAsync()` which should be used for new instead.
|
|
8622
|
+
* **Deprecated:** This method has been superseded by `BadgeService:UserHasBadgeAsync()` which should be used for new work instead.
|
|
8820
8623
|
*
|
|
8821
8624
|
* Checks whether a user has the badge given the `Player.UserId` and the badge ID.
|
|
8822
8625
|
*
|
|
@@ -8831,7 +8634,7 @@ interface BadgeService extends Instance {
|
|
|
8831
8634
|
*
|
|
8832
8635
|
* @deprecated
|
|
8833
8636
|
*/
|
|
8834
|
-
UserHasBadge(this: BadgeService, userId:
|
|
8637
|
+
UserHasBadge(this: BadgeService, userId: User, badgeId: number): boolean;
|
|
8835
8638
|
/**
|
|
8836
8639
|
* Checks whether a player has the badge given the `Player.UserId` and the badge ID.
|
|
8837
8640
|
*
|
|
@@ -9430,7 +9233,7 @@ interface RootImportData extends BaseImportData {
|
|
|
9430
9233
|
WorldUp: Enum.NormalId;
|
|
9431
9234
|
}
|
|
9432
9235
|
/**
|
|
9433
|
-
*
|
|
9236
|
+
* `BasePlayerGui` is an abstract class which the GUI drawing storage classes inherit from.
|
|
9434
9237
|
*
|
|
9435
9238
|
* - **Tags**: NotCreatable
|
|
9436
9239
|
*
|
|
@@ -9451,9 +9254,9 @@ interface BasePlayerGui extends Instance {
|
|
|
9451
9254
|
* - **ThreadSafety**: Unsafe
|
|
9452
9255
|
*
|
|
9453
9256
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/BasePlayerGui#GetGuiObjectsAtPosition)
|
|
9454
|
-
* @param this
|
|
9455
|
-
* @param x The
|
|
9456
|
-
* @param y The
|
|
9257
|
+
* @param this `BasePlayerGui` is an abstract class which the GUI drawing storage classes inherit from.
|
|
9258
|
+
* @param x The **X** position on the screen relative to the top-left corner after the GUI inset is applied (see `GuiService:GetGuiInset()`).
|
|
9259
|
+
* @param y The **Y** position on the screen relative to the top-left corner after the GUI inset is applied (see `GuiService:GetGuiInset()`).
|
|
9457
9260
|
* @returns A table of the `GuiObject` instances that occupy the given screen space.
|
|
9458
9261
|
*/
|
|
9459
9262
|
GetGuiObjectsAtPosition(this: BasePlayerGui, x: number, y: number): Array<GuiObject>;
|
|
@@ -10113,6 +9916,12 @@ interface Beam extends Instance {
|
|
|
10113
9916
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Beam#Texture)
|
|
10114
9917
|
*/
|
|
10115
9918
|
Texture: ContentId;
|
|
9919
|
+
/**
|
|
9920
|
+
* - **ThreadSafety**: ReadSafe
|
|
9921
|
+
*
|
|
9922
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Beam#TextureContent)
|
|
9923
|
+
*/
|
|
9924
|
+
TextureContent: Content;
|
|
10116
9925
|
/**
|
|
10117
9926
|
* Sets the length of the beam's texture, dependent on `TextureMode`.
|
|
10118
9927
|
*
|
|
@@ -10280,7 +10089,7 @@ interface BodyMover extends Instance {
|
|
|
10280
10089
|
*
|
|
10281
10090
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/BodyAngularVelocity)
|
|
10282
10091
|
*
|
|
10283
|
-
* @deprecated
|
|
10092
|
+
* @deprecated
|
|
10284
10093
|
*/
|
|
10285
10094
|
interface BodyAngularVelocity extends BodyMover {
|
|
10286
10095
|
/**
|
|
@@ -10325,7 +10134,7 @@ interface BodyAngularVelocity extends BodyMover {
|
|
|
10325
10134
|
*
|
|
10326
10135
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/BodyForce)
|
|
10327
10136
|
*
|
|
10328
|
-
* @deprecated
|
|
10137
|
+
* @deprecated
|
|
10329
10138
|
*/
|
|
10330
10139
|
interface BodyForce extends BodyMover {
|
|
10331
10140
|
/**
|
|
@@ -10354,7 +10163,7 @@ interface BodyForce extends BodyMover {
|
|
|
10354
10163
|
*
|
|
10355
10164
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/BodyGyro)
|
|
10356
10165
|
*
|
|
10357
|
-
* @deprecated
|
|
10166
|
+
* @deprecated
|
|
10358
10167
|
*/
|
|
10359
10168
|
interface BodyGyro extends BodyMover {
|
|
10360
10169
|
/**
|
|
@@ -10407,7 +10216,7 @@ interface BodyGyro extends BodyMover {
|
|
|
10407
10216
|
*
|
|
10408
10217
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/BodyPosition)
|
|
10409
10218
|
*
|
|
10410
|
-
* @deprecated
|
|
10219
|
+
* @deprecated
|
|
10411
10220
|
*/
|
|
10412
10221
|
interface BodyPosition extends BodyMover {
|
|
10413
10222
|
/**
|
|
@@ -10479,7 +10288,7 @@ interface BodyPosition extends BodyMover {
|
|
|
10479
10288
|
*
|
|
10480
10289
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/BodyThrust)
|
|
10481
10290
|
*
|
|
10482
|
-
* @deprecated
|
|
10291
|
+
* @deprecated
|
|
10483
10292
|
*/
|
|
10484
10293
|
interface BodyThrust extends BodyMover {
|
|
10485
10294
|
/**
|
|
@@ -10516,7 +10325,7 @@ interface BodyThrust extends BodyMover {
|
|
|
10516
10325
|
*
|
|
10517
10326
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/BodyVelocity)
|
|
10518
10327
|
*
|
|
10519
|
-
* @deprecated
|
|
10328
|
+
* @deprecated
|
|
10520
10329
|
*/
|
|
10521
10330
|
interface BodyVelocity extends BodyMover {
|
|
10522
10331
|
/**
|
|
@@ -10583,7 +10392,7 @@ interface BodyVelocity extends BodyMover {
|
|
|
10583
10392
|
*
|
|
10584
10393
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RocketPropulsion)
|
|
10585
10394
|
*
|
|
10586
|
-
* @deprecated
|
|
10395
|
+
* @deprecated
|
|
10587
10396
|
*/
|
|
10588
10397
|
interface RocketPropulsion extends BodyMover {
|
|
10589
10398
|
/**
|
|
@@ -11035,7 +10844,7 @@ interface CaptureService extends Instance {
|
|
|
11035
10844
|
*
|
|
11036
10845
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CaptureService#CaptureSaved)
|
|
11037
10846
|
*
|
|
11038
|
-
* @deprecated
|
|
10847
|
+
* @deprecated
|
|
11039
10848
|
*/
|
|
11040
10849
|
readonly CaptureSaved: RBXScriptSignal<(captureInfo: Record<string, unknown>) => void>;
|
|
11041
10850
|
/**
|
|
@@ -11302,6 +11111,12 @@ interface Pants extends Clothing {
|
|
|
11302
11111
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Pants#PantsTemplate)
|
|
11303
11112
|
*/
|
|
11304
11113
|
PantsTemplate: ContentId;
|
|
11114
|
+
/**
|
|
11115
|
+
* - **ThreadSafety**: ReadSafe
|
|
11116
|
+
*
|
|
11117
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Pants#PantsTemplateContent)
|
|
11118
|
+
*/
|
|
11119
|
+
PantsTemplateContent: Content;
|
|
11305
11120
|
}
|
|
11306
11121
|
/**
|
|
11307
11122
|
* Displays a shirt texture on a `Humanoid` rig.
|
|
@@ -11325,6 +11140,12 @@ interface Shirt extends Clothing {
|
|
|
11325
11140
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Shirt#ShirtTemplate)
|
|
11326
11141
|
*/
|
|
11327
11142
|
ShirtTemplate: ContentId;
|
|
11143
|
+
/**
|
|
11144
|
+
* - **ThreadSafety**: ReadSafe
|
|
11145
|
+
*
|
|
11146
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Shirt#ShirtTemplateContent)
|
|
11147
|
+
*/
|
|
11148
|
+
ShirtTemplateContent: Content;
|
|
11328
11149
|
}
|
|
11329
11150
|
/**
|
|
11330
11151
|
* Applies a texture to the front surface of a character's torso, used to display t-shirts.
|
|
@@ -11356,6 +11177,12 @@ interface ShirtGraphic extends CharacterAppearance {
|
|
|
11356
11177
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ShirtGraphic#Graphic)
|
|
11357
11178
|
*/
|
|
11358
11179
|
Graphic: ContentId;
|
|
11180
|
+
/**
|
|
11181
|
+
* - **ThreadSafety**: ReadSafe
|
|
11182
|
+
*
|
|
11183
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ShirtGraphic#TextureContent)
|
|
11184
|
+
*/
|
|
11185
|
+
TextureContent: Content;
|
|
11359
11186
|
}
|
|
11360
11187
|
/**
|
|
11361
11188
|
* Houses the Luau code responsible for running the legacy chat system.
|
|
@@ -11497,7 +11324,7 @@ interface Chat extends Instance {
|
|
|
11497
11324
|
* @param playerToFilterFor Player that the string is being filtered for.
|
|
11498
11325
|
* @returns Filtered string result.
|
|
11499
11326
|
*
|
|
11500
|
-
* @deprecated
|
|
11327
|
+
* @deprecated
|
|
11501
11328
|
*/
|
|
11502
11329
|
FilterStringForPlayerAsync(this: Chat, stringToFilter: string, playerToFilterFor: Player): string;
|
|
11503
11330
|
/**
|
|
@@ -11873,13 +11700,6 @@ interface DragDetector extends ClickDetector {
|
|
|
11873
11700
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DragDetector#DragContinue)
|
|
11874
11701
|
*/
|
|
11875
11702
|
readonly DragContinue: RBXScriptSignal<(playerWhoDragged: Player, cursorRay: Ray, viewFrame: CFrame, vrInputFrame: CFrame | undefined, isModeSwitchKeyDown: boolean) => void>;
|
|
11876
|
-
/**
|
|
11877
|
-
* - **ThreadSafety**: Unsafe
|
|
11878
|
-
* - **Tags**: Hidden
|
|
11879
|
-
*
|
|
11880
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DragDetector#DragContinueReplicate)
|
|
11881
|
-
*/
|
|
11882
|
-
readonly DragContinueReplicate: RBXScriptSignal<(playerWhoDragged: Player, cursorRay: Ray, viewFrame: CFrame, vrInputFrame: CFrame | undefined, isModeSwitchKeyDown: boolean) => void>;
|
|
11883
11703
|
/**
|
|
11884
11704
|
* Fires when a user stops dragging the object.
|
|
11885
11705
|
*
|
|
@@ -11888,13 +11708,6 @@ interface DragDetector extends ClickDetector {
|
|
|
11888
11708
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DragDetector#DragEnd)
|
|
11889
11709
|
*/
|
|
11890
11710
|
readonly DragEnd: RBXScriptSignal<(playerWhoDragged: Player) => void>;
|
|
11891
|
-
/**
|
|
11892
|
-
* - **ThreadSafety**: Unsafe
|
|
11893
|
-
* - **Tags**: Hidden
|
|
11894
|
-
*
|
|
11895
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DragDetector#DragEndReplicate)
|
|
11896
|
-
*/
|
|
11897
|
-
readonly DragEndReplicate: RBXScriptSignal<(playerWhoDragged: Player) => void>;
|
|
11898
11711
|
/**
|
|
11899
11712
|
* Fires when a user starts dragging the object.
|
|
11900
11713
|
*
|
|
@@ -11903,20 +11716,21 @@ interface DragDetector extends ClickDetector {
|
|
|
11903
11716
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DragDetector#DragStart)
|
|
11904
11717
|
*/
|
|
11905
11718
|
readonly DragStart: RBXScriptSignal<(playerWhoDragged: Player, cursorRay: Ray, viewFrame: CFrame, hitFrame: CFrame, clickedPart: BasePart, vrInputFrame: CFrame | undefined, isModeSwitchKeyDown: boolean) => void>;
|
|
11719
|
+
}
|
|
11720
|
+
/**
|
|
11721
|
+
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
11722
|
+
*
|
|
11723
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ClientStorageService)
|
|
11724
|
+
*/
|
|
11725
|
+
interface ClientStorageService extends Instance {
|
|
11906
11726
|
/**
|
|
11907
|
-
*
|
|
11908
|
-
* - **Tags**: Hidden
|
|
11909
|
-
*
|
|
11910
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DragDetector#DragStartReplicate)
|
|
11911
|
-
*/
|
|
11912
|
-
readonly DragStartReplicate: RBXScriptSignal<(playerWhoDragged: Player, cursorRay: Ray, viewFrame: CFrame, hitFrame: CFrame, clickedPart: BasePart, vrInputFrame: CFrame | undefined, isModeSwitchKeyDown: boolean) => void>;
|
|
11913
|
-
/**
|
|
11914
|
-
* - **ThreadSafety**: Unsafe
|
|
11915
|
-
* - **Tags**: Hidden
|
|
11727
|
+
* **DO NOT USE!**
|
|
11916
11728
|
*
|
|
11917
|
-
*
|
|
11729
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
11730
|
+
* @hidden
|
|
11731
|
+
* @deprecated
|
|
11918
11732
|
*/
|
|
11919
|
-
readonly
|
|
11733
|
+
readonly _nominal_ClientStorageService: unique symbol;
|
|
11920
11734
|
}
|
|
11921
11735
|
/**
|
|
11922
11736
|
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
@@ -12022,7 +11836,7 @@ interface Collaborator extends Instance {
|
|
|
12022
11836
|
*
|
|
12023
11837
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Collaborator#CollaboratorColor)
|
|
12024
11838
|
*
|
|
12025
|
-
* @deprecated
|
|
11839
|
+
* @deprecated
|
|
12026
11840
|
*/
|
|
12027
11841
|
CollaboratorColor: number;
|
|
12028
11842
|
/**
|
|
@@ -12211,7 +12025,7 @@ interface CollectionService extends Instance {
|
|
|
12211
12025
|
*
|
|
12212
12026
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CollectionService#ItemAdded)
|
|
12213
12027
|
*
|
|
12214
|
-
* @deprecated
|
|
12028
|
+
* @deprecated
|
|
12215
12029
|
*/
|
|
12216
12030
|
readonly ItemAdded: RBXScriptSignal<(instance: Instance) => void>;
|
|
12217
12031
|
/**
|
|
@@ -12224,7 +12038,7 @@ interface CollectionService extends Instance {
|
|
|
12224
12038
|
*
|
|
12225
12039
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CollectionService#ItemRemoved)
|
|
12226
12040
|
*
|
|
12227
|
-
* @deprecated
|
|
12041
|
+
* @deprecated
|
|
12228
12042
|
*/
|
|
12229
12043
|
readonly ItemRemoved: RBXScriptSignal<(instance: Instance) => void>;
|
|
12230
12044
|
/**
|
|
@@ -13340,7 +13154,7 @@ interface PlaneConstraint extends Constraint {
|
|
|
13340
13154
|
*
|
|
13341
13155
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Plane)
|
|
13342
13156
|
*
|
|
13343
|
-
* @deprecated
|
|
13157
|
+
* @deprecated
|
|
13344
13158
|
*/
|
|
13345
13159
|
interface Plane extends PlaneConstraint {
|
|
13346
13160
|
/**
|
|
@@ -14013,7 +13827,7 @@ interface TorsionSpringConstraint extends Constraint {
|
|
|
14013
13827
|
*
|
|
14014
13828
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TorsionSpringConstraint#LimitEnabled)
|
|
14015
13829
|
*
|
|
14016
|
-
* @deprecated
|
|
13830
|
+
* @deprecated
|
|
14017
13831
|
*/
|
|
14018
13832
|
LimitEnabled: boolean;
|
|
14019
13833
|
/**
|
|
@@ -14225,7 +14039,7 @@ interface ContentProvider extends Instance {
|
|
|
14225
14039
|
* @param this Service that is used to load content, or assets, into a game.
|
|
14226
14040
|
* @param contentId
|
|
14227
14041
|
*
|
|
14228
|
-
* @deprecated
|
|
14042
|
+
* @deprecated
|
|
14229
14043
|
*/
|
|
14230
14044
|
Preload(this: ContentProvider, contentId: ContentId): void;
|
|
14231
14045
|
/**
|
|
@@ -14354,7 +14168,7 @@ interface ContextActionService extends Instance {
|
|
|
14354
14168
|
* @param createTouchButton
|
|
14355
14169
|
* @param inputTypes
|
|
14356
14170
|
*
|
|
14357
|
-
* @deprecated
|
|
14171
|
+
* @deprecated
|
|
14358
14172
|
*/
|
|
14359
14173
|
BindActionToInputTypes(this: ContextActionService, actionName: string, functionToBind: Callback, createTouchButton: boolean, inputTypes: unknown): void;
|
|
14360
14174
|
/**
|
|
@@ -15275,6 +15089,12 @@ interface FileMesh extends DataModelMesh {
|
|
|
15275
15089
|
* @deprecated
|
|
15276
15090
|
*/
|
|
15277
15091
|
readonly _nominal_FileMesh: unique symbol;
|
|
15092
|
+
/**
|
|
15093
|
+
* - **ThreadSafety**: ReadSafe
|
|
15094
|
+
*
|
|
15095
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/FileMesh#MeshContent)
|
|
15096
|
+
*/
|
|
15097
|
+
MeshContent: Content;
|
|
15278
15098
|
/**
|
|
15279
15099
|
* The MeshId is the content ID of the mesh that is to be displayed.
|
|
15280
15100
|
*
|
|
@@ -15283,6 +15103,12 @@ interface FileMesh extends DataModelMesh {
|
|
|
15283
15103
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/FileMesh#MeshId)
|
|
15284
15104
|
*/
|
|
15285
15105
|
MeshId: ContentId;
|
|
15106
|
+
/**
|
|
15107
|
+
* - **ThreadSafety**: ReadSafe
|
|
15108
|
+
*
|
|
15109
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/FileMesh#TextureContent)
|
|
15110
|
+
*/
|
|
15111
|
+
TextureContent: Content;
|
|
15286
15112
|
/**
|
|
15287
15113
|
* The TextureId is the content ID of the texture that is to be applied to the mesh.
|
|
15288
15114
|
*
|
|
@@ -17846,13 +17672,17 @@ interface GenerationService extends Instance {
|
|
|
17846
17672
|
*
|
|
17847
17673
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GenerationService#GenerateModelAsync)
|
|
17848
17674
|
* @param this Service that allows developers to generate 3D objects from text prompts.
|
|
17849
|
-
* @param inputs A table representing conditioning inputs with the following keys: - `TextPrompt` — String description of the object to generate.
|
|
17675
|
+
* @param inputs A table representing conditioning inputs with the following keys: - `TextPrompt` — String description of the object to generate. Required unless an `Image` is provided; you must supply at least one of `TextPrompt` or `Image`.
|
|
17676
|
+
* - `Image` — Optional `Content` referencing an image asset (for example, the result of `Content.fromAssetId()`) used to visually condition the generation. Supply it together with or instead of `TextPrompt`.
|
|
17850
17677
|
* - `Size` — Optional `Vector3` describing the object size to generate. This is only approximate; scale the model extents post‑generation if you need a specific size.
|
|
17851
17678
|
* - `MaxTriangles` — Optional integer describing the maximum number of triangles that the returned model will contain. Lower values result in more faceted and low-poly generations.
|
|
17852
17679
|
* - `GenerateTextures` — `true` (default) textures the resulting generation, while `false` will not generate textures.
|
|
17853
17680
|
*
|
|
17854
17681
|
*
|
|
17855
|
-
* @param schema Table representing the generation schema.
|
|
17682
|
+
* @param schema Table representing the generation schema. Provide exactly one of the following keys: - `PredefinedSchema` — String selecting a built-in schema. Current valid options are `Car5` for a basic vehicle chassis consisting of five `Models`, or `Body1` which results in a single mesh output.
|
|
17683
|
+
* - `SchemaDefinition` — Table describing a custom multi-part structure. It contains a `Groups` array of part-name strings (one entry per desired part); the returned `Model` is organized to match the named groups. Use this instead of `PredefinedSchema` when you need a structure the predefined schemas don't cover.
|
|
17684
|
+
*
|
|
17685
|
+
*
|
|
17856
17686
|
* @param options Currently not used; reserved for future customization options.
|
|
17857
17687
|
* @returns Tuple with the following elements: - A standard `Model` container instance that is compliant with the specified `schema`.
|
|
17858
17688
|
* - A table containing a UUID and other metadata about the generation.
|
|
@@ -18483,7 +18313,7 @@ interface GroupService extends Instance {
|
|
|
18483
18313
|
* @param groupId The group's ID.
|
|
18484
18314
|
* @returns A table with two fields: `IsMember` (boolean) and `Roles` (array of public role tables). Each role table contains `Id` (int64), `Name` (string), and `Rank` (int). The array is ordered as returned by the backend.
|
|
18485
18315
|
*/
|
|
18486
|
-
GetRolesInGroupAsync(this: GroupService, userId:
|
|
18316
|
+
GetRolesInGroupAsync(this: GroupService, userId: User, groupId: number): unknown;
|
|
18487
18317
|
/**
|
|
18488
18318
|
* Prompts the local `Player` to join a specified Roblox group via a native modal.
|
|
18489
18319
|
*
|
|
@@ -18575,7 +18405,7 @@ interface GuiBase2d extends GuiBase {
|
|
|
18575
18405
|
*
|
|
18576
18406
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GuiBase2d#Localize)
|
|
18577
18407
|
*
|
|
18578
|
-
* @deprecated
|
|
18408
|
+
* @deprecated
|
|
18579
18409
|
*/
|
|
18580
18410
|
Localize: boolean;
|
|
18581
18411
|
/**
|
|
@@ -19485,7 +19315,7 @@ interface TextButton extends GuiButton {
|
|
|
19485
19315
|
*
|
|
19486
19316
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TextButton#FontSize)
|
|
19487
19317
|
*
|
|
19488
|
-
* @deprecated
|
|
19318
|
+
* @deprecated
|
|
19489
19319
|
*/
|
|
19490
19320
|
FontSize: Enum.FontSize;
|
|
19491
19321
|
/**
|
|
@@ -19647,7 +19477,7 @@ interface TextButton extends GuiButton {
|
|
|
19647
19477
|
*
|
|
19648
19478
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TextButton#TextWrap)
|
|
19649
19479
|
*
|
|
19650
|
-
* @deprecated
|
|
19480
|
+
* @deprecated
|
|
19651
19481
|
*/
|
|
19652
19482
|
TextWrap: boolean;
|
|
19653
19483
|
/**
|
|
@@ -19854,7 +19684,7 @@ interface TextLabel extends GuiLabel {
|
|
|
19854
19684
|
*
|
|
19855
19685
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TextLabel#FontSize)
|
|
19856
19686
|
*
|
|
19857
|
-
* @deprecated
|
|
19687
|
+
* @deprecated
|
|
19858
19688
|
*/
|
|
19859
19689
|
FontSize: Enum.FontSize;
|
|
19860
19690
|
/**
|
|
@@ -20016,7 +19846,7 @@ interface TextLabel extends GuiLabel {
|
|
|
20016
19846
|
*
|
|
20017
19847
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TextLabel#TextWrap)
|
|
20018
19848
|
*
|
|
20019
|
-
* @deprecated
|
|
19849
|
+
* @deprecated
|
|
20020
19850
|
*/
|
|
20021
19851
|
TextWrap: boolean;
|
|
20022
19852
|
/**
|
|
@@ -20316,7 +20146,7 @@ interface TextBox extends GuiObject {
|
|
|
20316
20146
|
*
|
|
20317
20147
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TextBox#FontSize)
|
|
20318
20148
|
*
|
|
20319
|
-
* @deprecated
|
|
20149
|
+
* @deprecated
|
|
20320
20150
|
*/
|
|
20321
20151
|
FontSize: Enum.FontSize;
|
|
20322
20152
|
/**
|
|
@@ -20439,7 +20269,7 @@ interface TextBox extends GuiObject {
|
|
|
20439
20269
|
*/
|
|
20440
20270
|
TextDirection: Enum.TextDirection;
|
|
20441
20271
|
/**
|
|
20442
|
-
* Determines whether the
|
|
20272
|
+
* Determines whether the player can change the `Text`.
|
|
20443
20273
|
*
|
|
20444
20274
|
* - **ThreadSafety**: ReadSafe
|
|
20445
20275
|
*
|
|
@@ -20511,7 +20341,7 @@ interface TextBox extends GuiObject {
|
|
|
20511
20341
|
*
|
|
20512
20342
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TextBox#TextWrap)
|
|
20513
20343
|
*
|
|
20514
|
-
* @deprecated
|
|
20344
|
+
* @deprecated
|
|
20515
20345
|
*/
|
|
20516
20346
|
TextWrap: boolean;
|
|
20517
20347
|
/**
|
|
@@ -20583,12 +20413,35 @@ interface TextBox extends GuiObject {
|
|
|
20583
20413
|
*/
|
|
20584
20414
|
readonly Focused: RBXScriptSignal<() => void>;
|
|
20585
20415
|
/**
|
|
20416
|
+
* Fires when the `TextBox` is focused and the player presses the on-screen keyboard's return/enter button.
|
|
20417
|
+
*
|
|
20586
20418
|
* - **ThreadSafety**: Unsafe
|
|
20587
20419
|
*
|
|
20588
20420
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TextBox#ReturnPressedFromOnScreenKeyboard)
|
|
20589
20421
|
*/
|
|
20590
20422
|
readonly ReturnPressedFromOnScreenKeyboard: RBXScriptSignal<() => void>;
|
|
20591
20423
|
}
|
|
20424
|
+
/**
|
|
20425
|
+
* - **Tags**: NotBrowsable
|
|
20426
|
+
*
|
|
20427
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TextChannelWindow)
|
|
20428
|
+
*/
|
|
20429
|
+
interface TextChannelWindow extends GuiObject {
|
|
20430
|
+
/**
|
|
20431
|
+
* **DO NOT USE!**
|
|
20432
|
+
*
|
|
20433
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
20434
|
+
* @hidden
|
|
20435
|
+
* @deprecated
|
|
20436
|
+
*/
|
|
20437
|
+
readonly _nominal_TextChannelWindow: unique symbol;
|
|
20438
|
+
/**
|
|
20439
|
+
* - **ThreadSafety**: ReadSafe
|
|
20440
|
+
*
|
|
20441
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TextChannelWindow#Target)
|
|
20442
|
+
*/
|
|
20443
|
+
Target: TextChannel | undefined;
|
|
20444
|
+
}
|
|
20592
20445
|
/**
|
|
20593
20446
|
* A GUI object that displays video content from a connected `VideoPlayer`.
|
|
20594
20447
|
*
|
|
@@ -20711,6 +20564,12 @@ interface VideoFrame extends GuiObject {
|
|
|
20711
20564
|
* @deprecated
|
|
20712
20565
|
*/
|
|
20713
20566
|
readonly _nominal_VideoFrame: unique symbol;
|
|
20567
|
+
/**
|
|
20568
|
+
* - **ThreadSafety**: ReadSafe
|
|
20569
|
+
*
|
|
20570
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VideoFrame#InternalVideoUsage)
|
|
20571
|
+
*/
|
|
20572
|
+
InternalVideoUsage: Enum.InternalVideoUsage;
|
|
20714
20573
|
/**
|
|
20715
20574
|
* Indicates when the `VideoFrame.Video` has loaded from Roblox servers and is ready to play.
|
|
20716
20575
|
*
|
|
@@ -21270,6 +21129,12 @@ interface AdGui extends SurfaceGuiBase {
|
|
|
21270
21129
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AdGui#FallbackImage)
|
|
21271
21130
|
*/
|
|
21272
21131
|
FallbackImage: ContentId;
|
|
21132
|
+
/**
|
|
21133
|
+
* - **ThreadSafety**: ReadSafe
|
|
21134
|
+
*
|
|
21135
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AdGui#FallbackImageContent)
|
|
21136
|
+
*/
|
|
21137
|
+
FallbackImageContent: Content;
|
|
21273
21138
|
/**
|
|
21274
21139
|
* - **ThreadSafety**: ReadSafe
|
|
21275
21140
|
* - **Tags**: NotReplicated
|
|
@@ -21569,7 +21434,7 @@ interface SelectionBox extends InstanceAdornment {
|
|
|
21569
21434
|
*
|
|
21570
21435
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SelectionBox#SurfaceColor)
|
|
21571
21436
|
*
|
|
21572
|
-
* @deprecated
|
|
21437
|
+
* @deprecated
|
|
21573
21438
|
*/
|
|
21574
21439
|
SurfaceColor: BrickColor;
|
|
21575
21440
|
/**
|
|
@@ -21850,6 +21715,12 @@ interface ImageHandleAdornment extends HandleAdornment {
|
|
|
21850
21715
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ImageHandleAdornment#Image)
|
|
21851
21716
|
*/
|
|
21852
21717
|
Image: ContentId;
|
|
21718
|
+
/**
|
|
21719
|
+
* - **ThreadSafety**: ReadSafe
|
|
21720
|
+
*
|
|
21721
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ImageHandleAdornment#ImageContent)
|
|
21722
|
+
*/
|
|
21723
|
+
ImageContent: Content;
|
|
21853
21724
|
/**
|
|
21854
21725
|
* Size of the image in studs.
|
|
21855
21726
|
*
|
|
@@ -22085,7 +21956,7 @@ interface SelectionSphere extends PVAdornment {
|
|
|
22085
21956
|
*
|
|
22086
21957
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SelectionSphere#SurfaceColor)
|
|
22087
21958
|
*
|
|
22088
|
-
* @deprecated
|
|
21959
|
+
* @deprecated
|
|
22089
21960
|
*/
|
|
22090
21961
|
SurfaceColor: BrickColor;
|
|
22091
21962
|
/**
|
|
@@ -22729,7 +22600,7 @@ interface GuiService extends Instance {
|
|
|
22729
22600
|
* @param selectionName
|
|
22730
22601
|
* @param selectionParent
|
|
22731
22602
|
*
|
|
22732
|
-
* @deprecated
|
|
22603
|
+
* @deprecated
|
|
22733
22604
|
*/
|
|
22734
22605
|
AddSelectionParent(this: GuiService, selectionName: string, selectionParent: GuiObject): void;
|
|
22735
22606
|
/**
|
|
@@ -22748,7 +22619,7 @@ interface GuiService extends Instance {
|
|
|
22748
22619
|
* @param selectionName The name of the added selection.
|
|
22749
22620
|
* @param selections The selection(s) added.
|
|
22750
22621
|
*
|
|
22751
|
-
* @deprecated
|
|
22622
|
+
* @deprecated
|
|
22752
22623
|
*/
|
|
22753
22624
|
AddSelectionTuple(this: GuiService, selectionName: string, selections: Array<GuiObject>): void;
|
|
22754
22625
|
/**
|
|
@@ -22802,7 +22673,7 @@ interface GuiService extends Instance {
|
|
|
22802
22673
|
Vector2
|
|
22803
22674
|
]>;
|
|
22804
22675
|
/**
|
|
22805
|
-
* Takes an `ScreenInsets` value and returns a `
|
|
22676
|
+
* Takes an `ScreenInsets` value and returns a `Rect` describing the inset region, relative to the `CoreUISafeInsets` area.
|
|
22806
22677
|
*
|
|
22807
22678
|
* - **ThreadSafety**: Unsafe
|
|
22808
22679
|
*
|
|
@@ -22841,7 +22712,7 @@ interface GuiService extends Instance {
|
|
|
22841
22712
|
* @param this Offers numerous properties and methods for working with `GuiObjects`, player preferences, and other UI‑related tasks.
|
|
22842
22713
|
* @param userId The `UserId` of the player to inspect.
|
|
22843
22714
|
*/
|
|
22844
|
-
InspectPlayerFromUserId(this: GuiService, userId:
|
|
22715
|
+
InspectPlayerFromUserId(this: GuiService, userId: User): void;
|
|
22845
22716
|
/**
|
|
22846
22717
|
* Returns `true` if the client is using the ten foot interface, a special version of Roblox's UI exclusive to consoles.
|
|
22847
22718
|
*
|
|
@@ -22863,7 +22734,7 @@ interface GuiService extends Instance {
|
|
|
22863
22734
|
* @param this Offers numerous properties and methods for working with `GuiObjects`, player preferences, and other UI‑related tasks.
|
|
22864
22735
|
* @param selectionName
|
|
22865
22736
|
*
|
|
22866
|
-
* @deprecated
|
|
22737
|
+
* @deprecated
|
|
22867
22738
|
*/
|
|
22868
22739
|
RemoveSelectionGroup(this: GuiService, selectionName: string): void;
|
|
22869
22740
|
/**
|
|
@@ -22985,7 +22856,10 @@ interface HapticEffect extends Instance {
|
|
|
22985
22856
|
*/
|
|
22986
22857
|
Play(this: HapticEffect): void;
|
|
22987
22858
|
/**
|
|
22988
|
-
* Defines a custom waveform as a table and applies it to the haptic.
|
|
22859
|
+
* Defines a custom waveform as a table and applies it to the haptic.
|
|
22860
|
+
* ```
|
|
22861
|
+
* This method takes in an array of `FloatCurveKey` objects.
|
|
22862
|
+
* ```
|
|
22989
22863
|
*
|
|
22990
22864
|
* - **ThreadSafety**: Unsafe
|
|
22991
22865
|
*
|
|
@@ -24034,7 +23908,7 @@ interface Humanoid extends Instance {
|
|
|
24034
23908
|
* @param humanoidDescription The `HumanoidDescription` instance which you want to set the character to match.
|
|
24035
23909
|
* @param assetTypeVerification The asset type verification mode.
|
|
24036
23910
|
*
|
|
24037
|
-
* @deprecated
|
|
23911
|
+
* @deprecated
|
|
24038
23912
|
*/
|
|
24039
23913
|
ApplyDescription(this: Humanoid, humanoidDescription: HumanoidDescription, assetTypeVerification?: CastsToEnum<Enum.AssetTypeVerification>): void;
|
|
24040
23914
|
/**
|
|
@@ -24062,7 +23936,7 @@ interface Humanoid extends Instance {
|
|
|
24062
23936
|
* @param humanoidDescription The `HumanoidDescription` instance which you want to set the character to match.
|
|
24063
23937
|
* @param assetTypeVerification The asset type verification mode.
|
|
24064
23938
|
*
|
|
24065
|
-
* @deprecated
|
|
23939
|
+
* @deprecated
|
|
24066
23940
|
*/
|
|
24067
23941
|
ApplyDescriptionReset(this: Humanoid, humanoidDescription: HumanoidDescription, assetTypeVerification?: CastsToEnum<Enum.AssetTypeVerification>): void;
|
|
24068
23942
|
/**
|
|
@@ -24090,7 +23964,7 @@ interface Humanoid extends Instance {
|
|
|
24090
23964
|
* @param emoteName name of the emote to play.
|
|
24091
23965
|
* @returns successfully played.
|
|
24092
23966
|
*
|
|
24093
|
-
* @deprecated
|
|
23967
|
+
* @deprecated
|
|
24094
23968
|
*/
|
|
24095
23969
|
PlayEmote(this: Humanoid, emoteName: string): boolean;
|
|
24096
23970
|
/**
|
|
@@ -25883,6 +25757,8 @@ interface InputBinding extends Instance {
|
|
|
25883
25757
|
*/
|
|
25884
25758
|
Backward: Enum.KeyCode;
|
|
25885
25759
|
/**
|
|
25760
|
+
* Specifies how the binding normalizes composite directional input to a maximum magnitude of `1`.
|
|
25761
|
+
*
|
|
25886
25762
|
* - **ThreadSafety**: ReadSafe
|
|
25887
25763
|
*
|
|
25888
25764
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputBinding#ClampMagnitudeToOne)
|
|
@@ -25967,7 +25843,7 @@ interface InputBinding extends Instance {
|
|
|
25967
25843
|
*/
|
|
25968
25844
|
Right: Enum.KeyCode;
|
|
25969
25845
|
/**
|
|
25970
|
-
*
|
|
25846
|
+
* Scalar multiplier applied uniformly to all components of a directional `InputAction`'s output.
|
|
25971
25847
|
*
|
|
25972
25848
|
* - **ThreadSafety**: ReadSafe
|
|
25973
25849
|
*
|
|
@@ -25991,6 +25867,8 @@ interface InputBinding extends Instance {
|
|
|
25991
25867
|
*/
|
|
25992
25868
|
UIButton: GuiButton | undefined;
|
|
25993
25869
|
/**
|
|
25870
|
+
* Specifies a `GuiButton` that must be active for the binding to activate.
|
|
25871
|
+
*
|
|
25994
25872
|
* - **ThreadSafety**: ReadSafe
|
|
25995
25873
|
*
|
|
25996
25874
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputBinding#UIModifier)
|
|
@@ -26005,7 +25883,7 @@ interface InputBinding extends Instance {
|
|
|
26005
25883
|
*/
|
|
26006
25884
|
Up: Enum.KeyCode;
|
|
26007
25885
|
/**
|
|
26008
|
-
*
|
|
25886
|
+
* Per-component scale applied to the output of a `Direction2D` action.
|
|
26009
25887
|
*
|
|
26010
25888
|
* - **ThreadSafety**: ReadSafe
|
|
26011
25889
|
*
|
|
@@ -26013,6 +25891,8 @@ interface InputBinding extends Instance {
|
|
|
26013
25891
|
*/
|
|
26014
25892
|
Vector2Scale: Vector2;
|
|
26015
25893
|
/**
|
|
25894
|
+
* Per-component scale applied to the output of a `Direction3D` action.
|
|
25895
|
+
*
|
|
26016
25896
|
* - **ThreadSafety**: ReadSafe
|
|
26017
25897
|
*
|
|
26018
25898
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputBinding#Vector3Scale)
|
|
@@ -26219,7 +26099,7 @@ interface InsertService extends Instance {
|
|
|
26219
26099
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InsertService#GetBaseCategories)
|
|
26220
26100
|
* @param this Used to insert assets from the Roblox website.
|
|
26221
26101
|
*
|
|
26222
|
-
* @deprecated
|
|
26102
|
+
* @deprecated
|
|
26223
26103
|
*/
|
|
26224
26104
|
GetBaseCategories(this: InsertService): Array<unknown>;
|
|
26225
26105
|
/**
|
|
@@ -26265,7 +26145,7 @@ interface InsertService extends Instance {
|
|
|
26265
26145
|
* @param pageNum The page number in the Catalog to return.
|
|
26266
26146
|
* @returns A single table (of returned free decals) wrapped in a table.
|
|
26267
26147
|
*
|
|
26268
|
-
* @deprecated
|
|
26148
|
+
* @deprecated
|
|
26269
26149
|
*/
|
|
26270
26150
|
GetFreeDecals(this: InsertService, searchText: string, pageNum: number): [
|
|
26271
26151
|
Array<FreeSearchResult>
|
|
@@ -26297,7 +26177,7 @@ interface InsertService extends Instance {
|
|
|
26297
26177
|
* @param pageNum The page number in the Catalog to return.
|
|
26298
26178
|
* @returns A single table (of returned free models) wrapped in a table.
|
|
26299
26179
|
*
|
|
26300
|
-
* @deprecated
|
|
26180
|
+
* @deprecated
|
|
26301
26181
|
*/
|
|
26302
26182
|
GetFreeModels(this: InsertService, searchText: string, pageNum: number): [
|
|
26303
26183
|
Array<FreeSearchResult>
|
|
@@ -26336,9 +26216,9 @@ interface InsertService extends Instance {
|
|
|
26336
26216
|
* @param this Used to insert assets from the Roblox website.
|
|
26337
26217
|
* @param userId
|
|
26338
26218
|
*
|
|
26339
|
-
* @deprecated
|
|
26219
|
+
* @deprecated
|
|
26340
26220
|
*/
|
|
26341
|
-
GetUserCategories(this: InsertService, userId:
|
|
26221
|
+
GetUserCategories(this: InsertService, userId: User): Array<unknown>;
|
|
26342
26222
|
/**
|
|
26343
26223
|
* **Deprecated:** [Sets have been removed](https://devforum.roblox.com/t/sunsetting-sets/189402) from Roblox.
|
|
26344
26224
|
*
|
|
@@ -26377,13 +26257,6 @@ interface InsertService extends Instance {
|
|
|
26377
26257
|
* @param assetVersionId
|
|
26378
26258
|
*/
|
|
26379
26259
|
LoadAssetVersion(this: InsertService, assetVersionId: number): Model;
|
|
26380
|
-
/**
|
|
26381
|
-
* - **ThreadSafety**: Unsafe
|
|
26382
|
-
* - **Tags**: Hidden
|
|
26383
|
-
*
|
|
26384
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InsertService#InternalDelete)
|
|
26385
|
-
*/
|
|
26386
|
-
readonly InternalDelete: RBXScriptSignal<(instance: Instance) => void>;
|
|
26387
26260
|
}
|
|
26388
26261
|
/**
|
|
26389
26262
|
* - **Tags**: NotCreatable, Service
|
|
@@ -26447,36 +26320,6 @@ interface InternalMessagingServiceVerifier extends Instance {
|
|
|
26447
26320
|
*/
|
|
26448
26321
|
readonly _nominal_InternalMessagingServiceVerifier: unique symbol;
|
|
26449
26322
|
}
|
|
26450
|
-
/**
|
|
26451
|
-
* - **Tags**: NotReplicated
|
|
26452
|
-
*
|
|
26453
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InternalSyncItem)
|
|
26454
|
-
*/
|
|
26455
|
-
interface InternalSyncItem extends Instance {
|
|
26456
|
-
/**
|
|
26457
|
-
* **DO NOT USE!**
|
|
26458
|
-
*
|
|
26459
|
-
* This field exists to force TypeScript to recognize this as a nominal type
|
|
26460
|
-
* @hidden
|
|
26461
|
-
* @deprecated
|
|
26462
|
-
*/
|
|
26463
|
-
readonly _nominal_InternalSyncItem: unique symbol;
|
|
26464
|
-
}
|
|
26465
|
-
/**
|
|
26466
|
-
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
26467
|
-
*
|
|
26468
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InternalSyncService)
|
|
26469
|
-
*/
|
|
26470
|
-
interface InternalSyncService extends Instance {
|
|
26471
|
-
/**
|
|
26472
|
-
* **DO NOT USE!**
|
|
26473
|
-
*
|
|
26474
|
-
* This field exists to force TypeScript to recognize this as a nominal type
|
|
26475
|
-
* @hidden
|
|
26476
|
-
* @deprecated
|
|
26477
|
-
*/
|
|
26478
|
-
readonly _nominal_InternalSyncService: unique symbol;
|
|
26479
|
-
}
|
|
26480
26323
|
/**
|
|
26481
26324
|
* The base class for joints.
|
|
26482
26325
|
*
|
|
@@ -26575,7 +26418,7 @@ interface DynamicRotate extends JointInstance {
|
|
|
26575
26418
|
*
|
|
26576
26419
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RotateP)
|
|
26577
26420
|
*
|
|
26578
|
-
* @deprecated
|
|
26421
|
+
* @deprecated
|
|
26579
26422
|
*/
|
|
26580
26423
|
interface RotateP extends DynamicRotate {
|
|
26581
26424
|
/**
|
|
@@ -26594,7 +26437,7 @@ interface RotateP extends DynamicRotate {
|
|
|
26594
26437
|
*
|
|
26595
26438
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RotateV)
|
|
26596
26439
|
*
|
|
26597
|
-
* @deprecated
|
|
26440
|
+
* @deprecated
|
|
26598
26441
|
*/
|
|
26599
26442
|
interface RotateV extends DynamicRotate {
|
|
26600
26443
|
/**
|
|
@@ -26615,7 +26458,7 @@ interface RotateV extends DynamicRotate {
|
|
|
26615
26458
|
*
|
|
26616
26459
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Glue)
|
|
26617
26460
|
*
|
|
26618
|
-
* @deprecated
|
|
26461
|
+
* @deprecated
|
|
26619
26462
|
*/
|
|
26620
26463
|
interface Glue extends JointInstance {
|
|
26621
26464
|
/**
|
|
@@ -26668,7 +26511,7 @@ interface Glue extends JointInstance {
|
|
|
26668
26511
|
*
|
|
26669
26512
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ManualSurfaceJointInstance)
|
|
26670
26513
|
*
|
|
26671
|
-
* @deprecated
|
|
26514
|
+
* @deprecated
|
|
26672
26515
|
*/
|
|
26673
26516
|
interface ManualSurfaceJointInstance extends JointInstance {
|
|
26674
26517
|
/**
|
|
@@ -26689,7 +26532,7 @@ interface ManualSurfaceJointInstance extends JointInstance {
|
|
|
26689
26532
|
*
|
|
26690
26533
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ManualGlue)
|
|
26691
26534
|
*
|
|
26692
|
-
* @deprecated
|
|
26535
|
+
* @deprecated
|
|
26693
26536
|
*/
|
|
26694
26537
|
interface ManualGlue extends ManualSurfaceJointInstance {
|
|
26695
26538
|
/**
|
|
@@ -26710,7 +26553,7 @@ interface ManualGlue extends ManualSurfaceJointInstance {
|
|
|
26710
26553
|
*
|
|
26711
26554
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ManualWeld)
|
|
26712
26555
|
*
|
|
26713
|
-
* @deprecated
|
|
26556
|
+
* @deprecated
|
|
26714
26557
|
*/
|
|
26715
26558
|
interface ManualWeld extends ManualSurfaceJointInstance {
|
|
26716
26559
|
/**
|
|
@@ -26803,7 +26646,7 @@ interface Motor6D extends Motor {
|
|
|
26803
26646
|
*
|
|
26804
26647
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Rotate)
|
|
26805
26648
|
*
|
|
26806
|
-
* @deprecated
|
|
26649
|
+
* @deprecated
|
|
26807
26650
|
*/
|
|
26808
26651
|
interface Rotate extends JointInstance {
|
|
26809
26652
|
/**
|
|
@@ -26824,7 +26667,7 @@ interface Rotate extends JointInstance {
|
|
|
26824
26667
|
*
|
|
26825
26668
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Snap)
|
|
26826
26669
|
*
|
|
26827
|
-
* @deprecated
|
|
26670
|
+
* @deprecated
|
|
26828
26671
|
*/
|
|
26829
26672
|
interface Snap extends JointInstance {
|
|
26830
26673
|
/**
|
|
@@ -27129,7 +26972,7 @@ interface KeyframeSequenceProvider extends Instance {
|
|
|
27129
26972
|
* @param userId The user ID of the user.
|
|
27130
26973
|
* @returns An `InventoryPages` of animations.
|
|
27131
26974
|
*
|
|
27132
|
-
* @deprecated
|
|
26975
|
+
* @deprecated
|
|
27133
26976
|
*/
|
|
27134
26977
|
GetAnimations(this: KeyframeSequenceProvider, userId: number): InventoryPages<number>;
|
|
27135
26978
|
/**
|
|
@@ -27143,7 +26986,7 @@ interface KeyframeSequenceProvider extends Instance {
|
|
|
27143
26986
|
* @param userId The user ID of the user.
|
|
27144
26987
|
* @returns An `InventoryPages` of animations.
|
|
27145
26988
|
*/
|
|
27146
|
-
GetAnimationsAsync(this: KeyframeSequenceProvider, userId:
|
|
26989
|
+
GetAnimationsAsync(this: KeyframeSequenceProvider, userId: User): Instance | undefined;
|
|
27147
26990
|
/**
|
|
27148
26991
|
* Returns a KeyframeSequence based on the specified assetId asynchronously.
|
|
27149
26992
|
*
|
|
@@ -27157,21 +27000,6 @@ interface KeyframeSequenceProvider extends Instance {
|
|
|
27157
27000
|
*/
|
|
27158
27001
|
GetKeyframeSequenceAsync(this: KeyframeSequenceProvider, assetId: string): KeyframeSequence;
|
|
27159
27002
|
}
|
|
27160
|
-
/**
|
|
27161
|
-
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
27162
|
-
*
|
|
27163
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/LSPFileSyncService)
|
|
27164
|
-
*/
|
|
27165
|
-
interface LSPFileSyncService extends Instance {
|
|
27166
|
-
/**
|
|
27167
|
-
* **DO NOT USE!**
|
|
27168
|
-
*
|
|
27169
|
-
* This field exists to force TypeScript to recognize this as a nominal type
|
|
27170
|
-
* @hidden
|
|
27171
|
-
* @deprecated
|
|
27172
|
-
*/
|
|
27173
|
-
readonly _nominal_LSPFileSyncService: unique symbol;
|
|
27174
|
-
}
|
|
27175
27003
|
/**
|
|
27176
27004
|
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
27177
27005
|
*
|
|
@@ -27779,7 +27607,7 @@ interface LocalizationTable extends Instance {
|
|
|
27779
27607
|
*
|
|
27780
27608
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/LocalizationTable#DevelopmentLanguage)
|
|
27781
27609
|
*
|
|
27782
|
-
* @deprecated
|
|
27610
|
+
* @deprecated
|
|
27783
27611
|
*/
|
|
27784
27612
|
DevelopmentLanguage: string;
|
|
27785
27613
|
/**
|
|
@@ -27792,7 +27620,7 @@ interface LocalizationTable extends Instance {
|
|
|
27792
27620
|
*
|
|
27793
27621
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/LocalizationTable#Root)
|
|
27794
27622
|
*
|
|
27795
|
-
* @deprecated
|
|
27623
|
+
* @deprecated
|
|
27796
27624
|
*/
|
|
27797
27625
|
Root: Instance | undefined;
|
|
27798
27626
|
/**
|
|
@@ -27812,7 +27640,7 @@ interface LocalizationTable extends Instance {
|
|
|
27812
27640
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/LocalizationTable#GetContents)
|
|
27813
27641
|
* @param this A LocalizationTable is a database of translations. It contains source strings and translations for various languages.
|
|
27814
27642
|
*
|
|
27815
|
-
* @deprecated
|
|
27643
|
+
* @deprecated
|
|
27816
27644
|
*/
|
|
27817
27645
|
GetContents(this: LocalizationTable): string;
|
|
27818
27646
|
/**
|
|
@@ -27839,7 +27667,7 @@ interface LocalizationTable extends Instance {
|
|
|
27839
27667
|
* @param key An optional unique key for fast hash lookups in code. If it is non-empty it must be unique in the table.
|
|
27840
27668
|
* @returns Translated string.
|
|
27841
27669
|
*
|
|
27842
|
-
* @deprecated
|
|
27670
|
+
* @deprecated
|
|
27843
27671
|
*/
|
|
27844
27672
|
GetString(this: LocalizationTable, targetLocaleId: string, key: string): string;
|
|
27845
27673
|
/**
|
|
@@ -27890,7 +27718,7 @@ interface LocalizationTable extends Instance {
|
|
|
27890
27718
|
* @param this A LocalizationTable is a database of translations. It contains source strings and translations for various languages.
|
|
27891
27719
|
* @param key
|
|
27892
27720
|
*
|
|
27893
|
-
* @deprecated
|
|
27721
|
+
* @deprecated
|
|
27894
27722
|
*/
|
|
27895
27723
|
RemoveKey(this: LocalizationTable, key: string): void;
|
|
27896
27724
|
/**
|
|
@@ -27915,7 +27743,7 @@ interface LocalizationTable extends Instance {
|
|
|
27915
27743
|
* @param this A LocalizationTable is a database of translations. It contains source strings and translations for various languages.
|
|
27916
27744
|
* @param contents
|
|
27917
27745
|
*
|
|
27918
|
-
* @deprecated
|
|
27746
|
+
* @deprecated
|
|
27919
27747
|
*/
|
|
27920
27748
|
SetContents(this: LocalizationTable, contents: string): void;
|
|
27921
27749
|
/**
|
|
@@ -27940,7 +27768,7 @@ interface LocalizationTable extends Instance {
|
|
|
27940
27768
|
* @param targetLocaleId
|
|
27941
27769
|
* @param text
|
|
27942
27770
|
*
|
|
27943
|
-
* @deprecated
|
|
27771
|
+
* @deprecated
|
|
27944
27772
|
*/
|
|
27945
27773
|
SetEntry(this: LocalizationTable, key: string, targetLocaleId: string, text: string): void;
|
|
27946
27774
|
/**
|
|
@@ -28198,47 +28026,6 @@ interface LuaSourceContainer extends Instance {
|
|
|
28198
28026
|
*/
|
|
28199
28027
|
readonly _nominal_LuaSourceContainer: unique symbol;
|
|
28200
28028
|
}
|
|
28201
|
-
/**
|
|
28202
|
-
* - **Tags**:
|
|
28203
|
-
*
|
|
28204
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraScript)
|
|
28205
|
-
*
|
|
28206
|
-
* @deprecated
|
|
28207
|
-
*/
|
|
28208
|
-
interface AuroraScript extends LuaSourceContainer {
|
|
28209
|
-
/**
|
|
28210
|
-
* **DO NOT USE!**
|
|
28211
|
-
*
|
|
28212
|
-
* This field exists to force TypeScript to recognize this as a nominal type
|
|
28213
|
-
* @hidden
|
|
28214
|
-
* @deprecated
|
|
28215
|
-
*/
|
|
28216
|
-
readonly _nominal_AuroraScript: unique symbol;
|
|
28217
|
-
/**
|
|
28218
|
-
* - **ThreadSafety**: Unsafe
|
|
28219
|
-
*
|
|
28220
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraScript#AddTo)
|
|
28221
|
-
*/
|
|
28222
|
-
AddTo(this: AuroraScript, instance: Instance, parameters?: object): void;
|
|
28223
|
-
/**
|
|
28224
|
-
* - **ThreadSafety**: Unsafe
|
|
28225
|
-
*
|
|
28226
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraScript#IsOnInstance)
|
|
28227
|
-
*/
|
|
28228
|
-
IsOnInstance(this: AuroraScript, instance: Instance): boolean;
|
|
28229
|
-
/**
|
|
28230
|
-
* - **ThreadSafety**: Unsafe
|
|
28231
|
-
*
|
|
28232
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraScript#RemoveFrom)
|
|
28233
|
-
*/
|
|
28234
|
-
RemoveFrom(this: AuroraScript, instance: Instance): void;
|
|
28235
|
-
/**
|
|
28236
|
-
* - **ThreadSafety**: Unsafe
|
|
28237
|
-
*
|
|
28238
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraScript#SignalFired)
|
|
28239
|
-
*/
|
|
28240
|
-
SignalFired(this: AuroraScript, instance: Instance, topic: string): RBXScriptSignal;
|
|
28241
|
-
}
|
|
28242
28029
|
/**
|
|
28243
28030
|
* The base class for all script objects which run automatically.
|
|
28244
28031
|
*
|
|
@@ -28664,7 +28451,7 @@ interface MarketplaceService extends Instance {
|
|
|
28664
28451
|
* @param this The service responsible for in-experience transactions.
|
|
28665
28452
|
* @param player The user being prompted to purchase Premium.
|
|
28666
28453
|
*
|
|
28667
|
-
* @deprecated
|
|
28454
|
+
* @deprecated
|
|
28668
28455
|
*/
|
|
28669
28456
|
PromptPremiumPurchase(this: MarketplaceService, player: Player): void;
|
|
28670
28457
|
/**
|
|
@@ -28744,7 +28531,7 @@ interface MarketplaceService extends Instance {
|
|
|
28744
28531
|
* @param infoType An `InfoType` enum value specifying the type of information being retrieved.
|
|
28745
28532
|
* @returns A dictionary containing information about the queried item, described in the previous tables.
|
|
28746
28533
|
*
|
|
28747
|
-
* @deprecated
|
|
28534
|
+
* @deprecated
|
|
28748
28535
|
*/
|
|
28749
28536
|
GetProductInfo(this: MarketplaceService, id: number): AssetProductInfo;
|
|
28750
28537
|
GetProductInfo(this: MarketplaceService, id: number, infoType: CastsToEnum<Enum.InfoType.Asset>): AssetProductInfo;
|
|
@@ -28826,7 +28613,7 @@ interface MarketplaceService extends Instance {
|
|
|
28826
28613
|
*/
|
|
28827
28614
|
GetUserSubscriptionStatusAsync(this: MarketplaceService, user: Player, subscriptionId: string): UserSubscriptionStatus;
|
|
28828
28615
|
/**
|
|
28829
|
-
* Returns the regionalized price
|
|
28616
|
+
* Returns the regionalized price levels of users, representing the recommended price for an item in each user's regional market.
|
|
28830
28617
|
*
|
|
28831
28618
|
* - **ThreadSafety**: Unsafe
|
|
28832
28619
|
* - **Tags**: Yields
|
|
@@ -28851,7 +28638,7 @@ interface MarketplaceService extends Instance {
|
|
|
28851
28638
|
* @param assetId The asset ID for which the given player's inventory is tested.
|
|
28852
28639
|
* @returns Indicates whether the given player's inventory contains the given asset.
|
|
28853
28640
|
*
|
|
28854
|
-
* @deprecated
|
|
28641
|
+
* @deprecated
|
|
28855
28642
|
*/
|
|
28856
28643
|
PlayerOwnsAsset(this: MarketplaceService, player: Player, assetId: number): boolean;
|
|
28857
28644
|
/**
|
|
@@ -28881,7 +28668,7 @@ interface MarketplaceService extends Instance {
|
|
|
28881
28668
|
* @param bundleId The bundle ID for which the given player's inventory is tested.
|
|
28882
28669
|
* @returns Indicates whether the given player's inventory contains the given bundle.
|
|
28883
28670
|
*
|
|
28884
|
-
* @deprecated
|
|
28671
|
+
* @deprecated
|
|
28885
28672
|
*/
|
|
28886
28673
|
PlayerOwnsBundle(this: MarketplaceService, player: Player, bundleId: number): boolean;
|
|
28887
28674
|
/**
|
|
@@ -28960,7 +28747,7 @@ interface MarketplaceService extends Instance {
|
|
|
28960
28747
|
* @param userId The `UserId` of the `Player` whose inventory you're checking.
|
|
28961
28748
|
* @param gamePassId The pass ID you want to check for. Not to be confused with an asset ID.
|
|
28962
28749
|
*/
|
|
28963
|
-
UserOwnsGamePassAsync(this: MarketplaceService, userId:
|
|
28750
|
+
UserOwnsGamePassAsync(this: MarketplaceService, userId: User, gamePassId: number): boolean;
|
|
28964
28751
|
/**
|
|
28965
28752
|
* Fires when a purchase prompt for bulk avatar items is closed.
|
|
28966
28753
|
*
|
|
@@ -29920,7 +29707,7 @@ interface Mouse extends Instance {
|
|
|
29920
29707
|
*
|
|
29921
29708
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Mouse#KeyDown)
|
|
29922
29709
|
*
|
|
29923
|
-
* @deprecated
|
|
29710
|
+
* @deprecated
|
|
29924
29711
|
*/
|
|
29925
29712
|
readonly KeyDown: RBXScriptSignal<(key: string) => void>;
|
|
29926
29713
|
/**
|
|
@@ -29933,7 +29720,7 @@ interface Mouse extends Instance {
|
|
|
29933
29720
|
*
|
|
29934
29721
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Mouse#KeyUp)
|
|
29935
29722
|
*
|
|
29936
|
-
* @deprecated
|
|
29723
|
+
* @deprecated
|
|
29937
29724
|
*/
|
|
29938
29725
|
readonly KeyUp: RBXScriptSignal<(key: string) => void>;
|
|
29939
29726
|
/**
|
|
@@ -30079,7 +29866,7 @@ interface OmniRecommendationsService extends Instance {
|
|
|
30079
29866
|
*
|
|
30080
29867
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/OpenCloudApiV1)
|
|
30081
29868
|
*
|
|
30082
|
-
* @deprecated
|
|
29869
|
+
* @deprecated
|
|
30083
29870
|
*/
|
|
30084
29871
|
interface OpenCloudApiV1 extends Instance {
|
|
30085
29872
|
/**
|
|
@@ -30125,7 +29912,7 @@ interface OpenCloudApiV1 extends Instance {
|
|
|
30125
29912
|
*
|
|
30126
29913
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/OpenCloudService)
|
|
30127
29914
|
*
|
|
30128
|
-
* @deprecated
|
|
29915
|
+
* @deprecated
|
|
30129
29916
|
*/
|
|
30130
29917
|
interface OpenCloudService extends Instance {
|
|
30131
29918
|
/**
|
|
@@ -30462,7 +30249,7 @@ interface BasePart extends PVInstance {
|
|
|
30462
30249
|
*
|
|
30463
30250
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/BasePart#CollisionGroupId)
|
|
30464
30251
|
*
|
|
30465
|
-
* @deprecated
|
|
30252
|
+
* @deprecated
|
|
30466
30253
|
*/
|
|
30467
30254
|
CollisionGroupId: number;
|
|
30468
30255
|
/**
|
|
@@ -30814,7 +30601,7 @@ interface BasePart extends PVInstance {
|
|
|
30814
30601
|
*
|
|
30815
30602
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/BasePart#RotVelocity)
|
|
30816
30603
|
*
|
|
30817
|
-
* @deprecated
|
|
30604
|
+
* @deprecated
|
|
30818
30605
|
*/
|
|
30819
30606
|
RotVelocity: Vector3;
|
|
30820
30607
|
/**
|
|
@@ -30913,7 +30700,7 @@ interface BasePart extends PVInstance {
|
|
|
30913
30700
|
*
|
|
30914
30701
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/BasePart#Velocity)
|
|
30915
30702
|
*
|
|
30916
|
-
* @deprecated
|
|
30703
|
+
* @deprecated
|
|
30917
30704
|
*/
|
|
30918
30705
|
Velocity: Vector3;
|
|
30919
30706
|
/**
|
|
@@ -30998,11 +30785,14 @@ interface BasePart extends PVInstance {
|
|
|
30998
30785
|
string | undefined
|
|
30999
30786
|
]>;
|
|
31000
30787
|
/**
|
|
30788
|
+
* Returns the closest point on the part's surface to the given point.
|
|
30789
|
+
*
|
|
31001
30790
|
* - **ThreadSafety**: Unsafe
|
|
31002
30791
|
*
|
|
31003
30792
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/BasePart#GetClosestPointOnSurface)
|
|
31004
30793
|
* @param this The abstract base class for in-world objects that physically interact.
|
|
31005
|
-
* @param position
|
|
30794
|
+
* @param position The world-space point to find the closest surface point to.
|
|
30795
|
+
* @returns The closest point on the part's surface in world space.
|
|
31006
30796
|
*/
|
|
31007
30797
|
GetClosestPointOnSurface(this: BasePart, position: Vector3): Vector3;
|
|
31008
30798
|
/**
|
|
@@ -31088,7 +30878,7 @@ interface BasePart extends PVInstance {
|
|
|
31088
30878
|
* @param this The abstract base class for in-world objects that physically interact.
|
|
31089
30879
|
* @returns The base part of an assembly (a collection of parts connected together).
|
|
31090
30880
|
*
|
|
31091
|
-
* @deprecated
|
|
30881
|
+
* @deprecated
|
|
31092
30882
|
*/
|
|
31093
30883
|
GetRootPart(this: BasePart): BasePart;
|
|
31094
30884
|
/**
|
|
@@ -31217,7 +31007,15 @@ interface BasePart extends PVInstance {
|
|
|
31217
31007
|
*/
|
|
31218
31008
|
SubtractAsync(this: BasePart, parts: Array<BasePart>, collisionfidelity?: CastsToEnum<Enum.CollisionFidelity>): UnionOperation | undefined;
|
|
31219
31009
|
/**
|
|
31220
|
-
* Note: It is highly recommended to use the newer
|
|
31010
|
+
* Note: It is highly recommended to use the newer `GeometryService:UnionAsync` instead of this function. As well as having better performance and more features, the new function differs as follows: - The output is an array of instances rather than a single instance.
|
|
31011
|
+
* - The input parts do not need to be parented to the scene, allowing for background operations.
|
|
31012
|
+
* - When the `SplitApart` option is set to `true` (default), each distinct body will be returned in its own `PartOperation`.
|
|
31013
|
+
* - All the returned parts are in the coordinate space of the main part, so their `PVInstance.Origin` positions are the same as the main part's. This keeps the vertices of the mesh in the same position relative to the object as before the operation, but it does also mean the `(0, 0, 0)` of a returned part is not necessarily at the center of its body.
|
|
31014
|
+
* ```
|
|
31015
|
+
* Creates a new `UnionOperation` from the part, plus the geometry
|
|
31016
|
+
* ```
|
|
31017
|
+
*
|
|
31018
|
+
* occupied by the parts in the given array.
|
|
31221
31019
|
*
|
|
31222
31020
|
* - **ThreadSafety**: Unsafe
|
|
31223
31021
|
* - **Tags**: Yields
|
|
@@ -31260,7 +31058,7 @@ interface BasePart extends PVInstance {
|
|
|
31260
31058
|
*
|
|
31261
31059
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/BasePart#StoppedTouching)
|
|
31262
31060
|
*
|
|
31263
|
-
* @deprecated
|
|
31061
|
+
* @deprecated
|
|
31264
31062
|
*/
|
|
31265
31063
|
readonly StoppedTouching: RBXScriptSignal<(otherPart: BasePart) => void>;
|
|
31266
31064
|
/**
|
|
@@ -31361,20 +31159,6 @@ interface Platform extends Part {
|
|
|
31361
31159
|
* @deprecated
|
|
31362
31160
|
*/
|
|
31363
31161
|
readonly _nominal_Platform: unique symbol;
|
|
31364
|
-
/**
|
|
31365
|
-
* - **ThreadSafety**: Unsafe
|
|
31366
|
-
* - **Tags**: Hidden
|
|
31367
|
-
*
|
|
31368
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Platform#RemoteCreateMotor6D)
|
|
31369
|
-
*/
|
|
31370
|
-
readonly RemoteCreateMotor6D: RBXScriptSignal<(humanoid: Humanoid) => void>;
|
|
31371
|
-
/**
|
|
31372
|
-
* - **ThreadSafety**: Unsafe
|
|
31373
|
-
* - **Tags**: Hidden
|
|
31374
|
-
*
|
|
31375
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Platform#RemoteDestroyMotor6D)
|
|
31376
|
-
*/
|
|
31377
|
-
readonly RemoteDestroyMotor6D: RBXScriptSignal<() => void>;
|
|
31378
31162
|
}
|
|
31379
31163
|
/**
|
|
31380
31164
|
* A type of `BasePart` that characters can 'sit' in. When a character touches an enabled Seat object, it will be attached to the part by a `Weld` and the default character scripts will play a sitting animation.
|
|
@@ -31417,20 +31201,6 @@ interface Seat extends Part {
|
|
|
31417
31201
|
* @param humanoid
|
|
31418
31202
|
*/
|
|
31419
31203
|
Sit(this: Seat, humanoid: Humanoid | undefined): void;
|
|
31420
|
-
/**
|
|
31421
|
-
* - **ThreadSafety**: Unsafe
|
|
31422
|
-
* - **Tags**: Hidden
|
|
31423
|
-
*
|
|
31424
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Seat#RemoteCreateSeatWeld)
|
|
31425
|
-
*/
|
|
31426
|
-
readonly RemoteCreateSeatWeld: RBXScriptSignal<(humanoid: Humanoid) => void>;
|
|
31427
|
-
/**
|
|
31428
|
-
* - **ThreadSafety**: Unsafe
|
|
31429
|
-
* - **Tags**: Hidden
|
|
31430
|
-
*
|
|
31431
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Seat#RemoteDestroySeatWeld)
|
|
31432
|
-
*/
|
|
31433
|
-
readonly RemoteDestroySeatWeld: RBXScriptSignal<() => void>;
|
|
31434
31204
|
}
|
|
31435
31205
|
/**
|
|
31436
31206
|
* **Deprecated:** The SkateboardPlatform object has been deprecated and is no longer supported by Roblox. Developers looking to create skateboards or similar vehicles are advised to program their own systems. Additionally, the `VehicleSeat` object can be used to quickly create simple vehicles.
|
|
@@ -31522,20 +31292,6 @@ interface SkateboardPlatform extends Part {
|
|
|
31522
31292
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SkateboardPlatform#MoveStateChanged)
|
|
31523
31293
|
*/
|
|
31524
31294
|
readonly MoveStateChanged: RBXScriptSignal<(newState: Enum.MoveState, oldState: Enum.MoveState) => void>;
|
|
31525
|
-
/**
|
|
31526
|
-
* - **ThreadSafety**: Unsafe
|
|
31527
|
-
* - **Tags**: Hidden
|
|
31528
|
-
*
|
|
31529
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SkateboardPlatform#RemoteCreateMotor6D)
|
|
31530
|
-
*/
|
|
31531
|
-
readonly RemoteCreateMotor6D: RBXScriptSignal<(humanoid: Humanoid) => void>;
|
|
31532
|
-
/**
|
|
31533
|
-
* - **ThreadSafety**: Unsafe
|
|
31534
|
-
* - **Tags**: Hidden
|
|
31535
|
-
*
|
|
31536
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SkateboardPlatform#RemoteDestroyMotor6D)
|
|
31537
|
-
*/
|
|
31538
|
-
readonly RemoteDestroyMotor6D: RBXScriptSignal<() => void>;
|
|
31539
31295
|
/**
|
|
31540
31296
|
* Fired whenever the skateboard is unequipped.
|
|
31541
31297
|
*
|
|
@@ -31845,12 +31601,6 @@ interface Terrain extends BasePart {
|
|
|
31845
31601
|
* @param material The material with which the wedge will be filled.
|
|
31846
31602
|
*/
|
|
31847
31603
|
FillWedge(this: Terrain, cframe: CFrame, size: Vector3, material: CastsToEnum<Enum.Material>): void;
|
|
31848
|
-
/**
|
|
31849
|
-
* - **ThreadSafety**: Unsafe
|
|
31850
|
-
*
|
|
31851
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Terrain#GetBaseMaterialSlotIndex)
|
|
31852
|
-
*/
|
|
31853
|
-
GetBaseMaterialSlotIndex(this: Terrain, baseMaterial: CastsToEnum<Enum.Material>): number | undefined;
|
|
31854
31604
|
/**
|
|
31855
31605
|
* **Deprecated:** This item is a deprecated function of a legacy `Terrain` engine that has been removed. Do not use it for new work.
|
|
31856
31606
|
*
|
|
@@ -31868,12 +31618,6 @@ interface Terrain extends BasePart {
|
|
|
31868
31618
|
* @deprecated
|
|
31869
31619
|
*/
|
|
31870
31620
|
GetCell(this: Terrain, x: number, y: number, z: number): unknown;
|
|
31871
|
-
/**
|
|
31872
|
-
* - **ThreadSafety**: Unsafe
|
|
31873
|
-
*
|
|
31874
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Terrain#GetFirstCustomMaterialSlotIndex)
|
|
31875
|
-
*/
|
|
31876
|
-
GetFirstCustomMaterialSlotIndex(this: Terrain): number;
|
|
31877
31621
|
/**
|
|
31878
31622
|
* Returns current terrain material color for specified terrain material.
|
|
31879
31623
|
*
|
|
@@ -32314,11 +32058,10 @@ interface PartOperation extends TriangleMeshPart {
|
|
|
32314
32058
|
* The number of polygons in this solid model.
|
|
32315
32059
|
*
|
|
32316
32060
|
* - **ThreadSafety**: ReadSafe
|
|
32317
|
-
* - **Tags**: NotReplicated
|
|
32318
32061
|
*
|
|
32319
32062
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PartOperation#TriangleCount)
|
|
32320
32063
|
*/
|
|
32321
|
-
|
|
32064
|
+
get TriangleCount(): number;
|
|
32322
32065
|
/**
|
|
32323
32066
|
* Sets whether the `PartOperation` can be recolored using inherited color properties.
|
|
32324
32067
|
*
|
|
@@ -32523,20 +32266,6 @@ interface VehicleSeat extends BasePart {
|
|
|
32523
32266
|
* @param humanoid The `Humanoid` being forced to sit in the `VehicleSeat`.
|
|
32524
32267
|
*/
|
|
32525
32268
|
Sit(this: VehicleSeat, humanoid: Instance): void;
|
|
32526
|
-
/**
|
|
32527
|
-
* - **ThreadSafety**: Unsafe
|
|
32528
|
-
* - **Tags**: Hidden
|
|
32529
|
-
*
|
|
32530
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VehicleSeat#RemoteCreateSeatWeld)
|
|
32531
|
-
*/
|
|
32532
|
-
readonly RemoteCreateSeatWeld: RBXScriptSignal<(humanoid: Instance) => void>;
|
|
32533
|
-
/**
|
|
32534
|
-
* - **ThreadSafety**: Unsafe
|
|
32535
|
-
* - **Tags**: Hidden
|
|
32536
|
-
*
|
|
32537
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VehicleSeat#RemoteDestroySeatWeld)
|
|
32538
|
-
*/
|
|
32539
|
-
readonly RemoteDestroySeatWeld: RBXScriptSignal<() => void>;
|
|
32540
32269
|
}
|
|
32541
32270
|
/**
|
|
32542
32271
|
* A class which defines a view of the 3D world.
|
|
@@ -32586,7 +32315,7 @@ interface Camera extends PVInstance {
|
|
|
32586
32315
|
*
|
|
32587
32316
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Camera#CoordinateFrame)
|
|
32588
32317
|
*
|
|
32589
|
-
* @deprecated
|
|
32318
|
+
* @deprecated
|
|
32590
32319
|
*/
|
|
32591
32320
|
CoordinateFrame: CFrame;
|
|
32592
32321
|
/**
|
|
@@ -32997,7 +32726,7 @@ interface Model extends PVInstance {
|
|
|
32997
32726
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Model#GetModelCFrame)
|
|
32998
32727
|
* @param this Models are container objects, meaning they group objects together. They are best used to hold collections of `BaseParts` and have a number of functions that extend their functionality.
|
|
32999
32728
|
*
|
|
33000
|
-
* @deprecated
|
|
32729
|
+
* @deprecated
|
|
33001
32730
|
*/
|
|
33002
32731
|
GetModelCFrame(this: Model): CFrame;
|
|
33003
32732
|
/**
|
|
@@ -33011,7 +32740,7 @@ interface Model extends PVInstance {
|
|
|
33011
32740
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Model#GetModelSize)
|
|
33012
32741
|
* @param this Models are container objects, meaning they group objects together. They are best used to hold collections of `BaseParts` and have a number of functions that extend their functionality.
|
|
33013
32742
|
*
|
|
33014
|
-
* @deprecated
|
|
32743
|
+
* @deprecated
|
|
33015
32744
|
*/
|
|
33016
32745
|
GetModelSize(this: Model): Vector3;
|
|
33017
32746
|
/**
|
|
@@ -33035,7 +32764,7 @@ interface Model extends PVInstance {
|
|
|
33035
32764
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Model#GetPrimaryPartCFrame)
|
|
33036
32765
|
* @param this Models are container objects, meaning they group objects together. They are best used to hold collections of `BaseParts` and have a number of functions that extend their functionality.
|
|
33037
32766
|
*
|
|
33038
|
-
* @deprecated
|
|
32767
|
+
* @deprecated
|
|
33039
32768
|
*/
|
|
33040
32769
|
GetPrimaryPartCFrame(this: Model): CFrame;
|
|
33041
32770
|
/**
|
|
@@ -33093,7 +32822,7 @@ interface Model extends PVInstance {
|
|
|
33093
32822
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Model#ResetOrientationToIdentity)
|
|
33094
32823
|
* @param this Models are container objects, meaning they group objects together. They are best used to hold collections of `BaseParts` and have a number of functions that extend their functionality.
|
|
33095
32824
|
*
|
|
33096
|
-
* @deprecated
|
|
32825
|
+
* @deprecated
|
|
33097
32826
|
*/
|
|
33098
32827
|
ResetOrientationToIdentity(this: Model): void;
|
|
33099
32828
|
/**
|
|
@@ -33117,7 +32846,7 @@ interface Model extends PVInstance {
|
|
|
33117
32846
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Model#SetIdentityOrientation)
|
|
33118
32847
|
* @param this Models are container objects, meaning they group objects together. They are best used to hold collections of `BaseParts` and have a number of functions that extend their functionality.
|
|
33119
32848
|
*
|
|
33120
|
-
* @deprecated
|
|
32849
|
+
* @deprecated
|
|
33121
32850
|
*/
|
|
33122
32851
|
SetIdentityOrientation(this: Model): void;
|
|
33123
32852
|
/**
|
|
@@ -33132,7 +32861,7 @@ interface Model extends PVInstance {
|
|
|
33132
32861
|
* @param this Models are container objects, meaning they group objects together. They are best used to hold collections of `BaseParts` and have a number of functions that extend their functionality.
|
|
33133
32862
|
* @param cframe The `CFrame` to be set.
|
|
33134
32863
|
*
|
|
33135
|
-
* @deprecated
|
|
32864
|
+
* @deprecated
|
|
33136
32865
|
*/
|
|
33137
32866
|
SetPrimaryPartCFrame(this: Model, cframe: CFrame): void;
|
|
33138
32867
|
/**
|
|
@@ -33506,7 +33235,7 @@ interface WorldRoot extends Model {
|
|
|
33506
33235
|
* @param ignoreWater
|
|
33507
33236
|
* @returns The `BasePart` or `Terrain` cell hit, the `Vector3` point of intersection, the `Vector3` surface normal at the point of intersection, and the `Material` of the `BasePart` or terrain cell hit.
|
|
33508
33237
|
*
|
|
33509
|
-
* @deprecated
|
|
33238
|
+
* @deprecated
|
|
33510
33239
|
*/
|
|
33511
33240
|
FindPartOnRay(this: WorldRoot, ray: Ray, ignoreDescendantsInstance?: Instance, terrainCellsAreCubes?: boolean, ignoreWater?: boolean): LuaTuple<[
|
|
33512
33241
|
BasePart | undefined,
|
|
@@ -33530,7 +33259,7 @@ interface WorldRoot extends Model {
|
|
|
33530
33259
|
* @param ignoreWater
|
|
33531
33260
|
* @returns The `BasePart` or `Terrain` cell hit, the `Vector3` point of intersection, the `Vector3` surface normal at the point of intersection, and the `Material` of the `BasePart` or terrain cell hit.
|
|
33532
33261
|
*
|
|
33533
|
-
* @deprecated
|
|
33262
|
+
* @deprecated
|
|
33534
33263
|
*/
|
|
33535
33264
|
FindPartOnRayWithIgnoreList(this: WorldRoot, ray: Ray, ignoreDescendantsTable: Array<Instance>, terrainCellsAreCubes?: boolean, ignoreWater?: boolean): LuaTuple<[
|
|
33536
33265
|
BasePart | undefined,
|
|
@@ -33553,7 +33282,7 @@ interface WorldRoot extends Model {
|
|
|
33553
33282
|
* @param ignoreWater
|
|
33554
33283
|
* @returns The `BasePart` or `Terrain` cell hit, the `Vector3` point of intersection, the `Vector3` surface normal at the point of intersection, and the `Material` of the `BasePart` or terrain cell hit.
|
|
33555
33284
|
*
|
|
33556
|
-
* @deprecated
|
|
33285
|
+
* @deprecated
|
|
33557
33286
|
*/
|
|
33558
33287
|
FindPartOnRayWithWhitelist(this: WorldRoot, ray: Ray, whitelistDescendantsTable: Array<Instance>, ignoreWater?: boolean): LuaTuple<[
|
|
33559
33288
|
BasePart | undefined,
|
|
@@ -33576,7 +33305,7 @@ interface WorldRoot extends Model {
|
|
|
33576
33305
|
* @param maxParts The maximum amount of `BaseParts` to be returned.
|
|
33577
33306
|
* @returns An array of `BaseParts` within the `Region3`.
|
|
33578
33307
|
*
|
|
33579
|
-
* @deprecated
|
|
33308
|
+
* @deprecated
|
|
33580
33309
|
*/
|
|
33581
33310
|
FindPartsInRegion3(this: WorldRoot, region: Region3, ignoreDescendantsInstance?: Instance, maxParts?: number): Array<BasePart>;
|
|
33582
33311
|
/**
|
|
@@ -33594,7 +33323,7 @@ interface WorldRoot extends Model {
|
|
|
33594
33323
|
* @param maxParts The maximum number of `BaseParts` to be returned.
|
|
33595
33324
|
* @returns An array of `BaseParts` found within the `Region3`.
|
|
33596
33325
|
*
|
|
33597
|
-
* @deprecated
|
|
33326
|
+
* @deprecated
|
|
33598
33327
|
*/
|
|
33599
33328
|
FindPartsInRegion3WithIgnoreList(this: WorldRoot, region: Region3, ignoreDescendantsTable: Array<Instance>, maxParts?: number): Array<BasePart>;
|
|
33600
33329
|
/**
|
|
@@ -33612,7 +33341,7 @@ interface WorldRoot extends Model {
|
|
|
33612
33341
|
* @param maxParts The maximum number of `BaseParts` to be returned.
|
|
33613
33342
|
* @returns An array of `BaseParts` within the `Region3`.
|
|
33614
33343
|
*
|
|
33615
|
-
* @deprecated
|
|
33344
|
+
* @deprecated
|
|
33616
33345
|
*/
|
|
33617
33346
|
FindPartsInRegion3WithWhiteList(this: WorldRoot, region: Region3, whitelistDescendantsTable: Array<Instance>, maxParts?: number): Array<BasePart>;
|
|
33618
33347
|
/**
|
|
@@ -33670,7 +33399,7 @@ interface WorldRoot extends Model {
|
|
|
33670
33399
|
* @param ignoreDescendentsInstance An `Instance` to be ignored.
|
|
33671
33400
|
* @returns True if the `Region3` is empty.
|
|
33672
33401
|
*
|
|
33673
|
-
* @deprecated
|
|
33402
|
+
* @deprecated
|
|
33674
33403
|
*/
|
|
33675
33404
|
IsRegion3Empty(this: WorldRoot, region: Region3, ignoreDescendentsInstance?: Instance): boolean;
|
|
33676
33405
|
/**
|
|
@@ -33687,7 +33416,7 @@ interface WorldRoot extends Model {
|
|
|
33687
33416
|
* @param ignoreDescendentsTable An array of objects to be ignored.
|
|
33688
33417
|
* @returns True if the `Region3` is empty.
|
|
33689
33418
|
*
|
|
33690
|
-
* @deprecated
|
|
33419
|
+
* @deprecated
|
|
33691
33420
|
*/
|
|
33692
33421
|
IsRegion3EmptyWithIgnoreList(this: WorldRoot, region: Region3, ignoreDescendentsTable: Array<Instance>): boolean;
|
|
33693
33422
|
/**
|
|
@@ -33729,7 +33458,7 @@ interface WorldRoot extends Model {
|
|
|
33729
33458
|
Spherecast(this: WorldRoot, position: Vector3, radius: number, direction: Vector3, raycastParams?: RaycastParams): RaycastResult | undefined;
|
|
33730
33459
|
}
|
|
33731
33460
|
/**
|
|
33732
|
-
*
|
|
33461
|
+
* `Workspace` houses 3D objects which are rendered to the 3D world. Objects not descending from it will not be rendered or physically interact with the world.
|
|
33733
33462
|
*
|
|
33734
33463
|
* - **Tags**: NotCreatable, Service
|
|
33735
33464
|
*
|
|
@@ -33878,7 +33607,7 @@ interface Workspace extends WorldRoot {
|
|
|
33878
33607
|
* - **ThreadSafety**: Safe
|
|
33879
33608
|
*
|
|
33880
33609
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Workspace#GetNumAwakeParts)
|
|
33881
|
-
* @param this
|
|
33610
|
+
* @param this `Workspace` houses 3D objects which are rendered to the 3D world. Objects not descending from it will not be rendered or physically interact with the world.
|
|
33882
33611
|
* @returns The number of awake parts.
|
|
33883
33612
|
*/
|
|
33884
33613
|
GetNumAwakeParts(this: Workspace): number;
|
|
@@ -33888,7 +33617,7 @@ interface Workspace extends WorldRoot {
|
|
|
33888
33617
|
* - **ThreadSafety**: Safe
|
|
33889
33618
|
*
|
|
33890
33619
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Workspace#GetPhysicsThrottling)
|
|
33891
|
-
* @param this
|
|
33620
|
+
* @param this `Workspace` houses 3D objects which are rendered to the 3D world. Objects not descending from it will not be rendered or physically interact with the world.
|
|
33892
33621
|
* @returns The percentage of real time that physics simulation is currently being throttled to.
|
|
33893
33622
|
*/
|
|
33894
33623
|
GetPhysicsThrottling(this: Workspace): number;
|
|
@@ -33898,7 +33627,7 @@ interface Workspace extends WorldRoot {
|
|
|
33898
33627
|
* - **ThreadSafety**: Safe
|
|
33899
33628
|
*
|
|
33900
33629
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Workspace#GetRealPhysicsFPS)
|
|
33901
|
-
* @param this
|
|
33630
|
+
* @param this `Workspace` houses 3D objects which are rendered to the 3D world. Objects not descending from it will not be rendered or physically interact with the world.
|
|
33902
33631
|
* @returns Returns the number of frames per second that physics is currently being simulated at.
|
|
33903
33632
|
*/
|
|
33904
33633
|
GetRealPhysicsFPS(this: Workspace): number;
|
|
@@ -33908,7 +33637,7 @@ interface Workspace extends WorldRoot {
|
|
|
33908
33637
|
* - **ThreadSafety**: Safe
|
|
33909
33638
|
*
|
|
33910
33639
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Workspace#GetServerTimeNow)
|
|
33911
|
-
* @param this
|
|
33640
|
+
* @param this `Workspace` houses 3D objects which are rendered to the 3D world. Objects not descending from it will not be rendered or physically interact with the world.
|
|
33912
33641
|
* @returns The estimated Unix timestamp on the server.
|
|
33913
33642
|
*/
|
|
33914
33643
|
GetServerTimeNow(this: Workspace): number;
|
|
@@ -33918,7 +33647,7 @@ interface Workspace extends WorldRoot {
|
|
|
33918
33647
|
* - **ThreadSafety**: Unsafe
|
|
33919
33648
|
*
|
|
33920
33649
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Workspace#JoinToOutsiders)
|
|
33921
|
-
* @param this
|
|
33650
|
+
* @param this `Workspace` houses 3D objects which are rendered to the 3D world. Objects not descending from it will not be rendered or physically interact with the world.
|
|
33922
33651
|
* @param objects An array of `BaseParts` for whom joints are to be made.
|
|
33923
33652
|
* @param jointType The `JointCreationMode` to be used. Passing in `Enum.JointCreationMode.All` or `Enum.JointCreationMode.Surface` has the same behavior which equates to Join Always.
|
|
33924
33653
|
*/
|
|
@@ -33929,7 +33658,7 @@ interface Workspace extends WorldRoot {
|
|
|
33929
33658
|
* - **ThreadSafety**: Unsafe
|
|
33930
33659
|
*
|
|
33931
33660
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Workspace#PGSIsEnabled)
|
|
33932
|
-
* @param this
|
|
33661
|
+
* @param this `Workspace` houses 3D objects which are rendered to the 3D world. Objects not descending from it will not be rendered or physically interact with the world.
|
|
33933
33662
|
* @returns True if the PGS solver is enabled.
|
|
33934
33663
|
*/
|
|
33935
33664
|
PGSIsEnabled(this: Workspace): boolean;
|
|
@@ -33939,7 +33668,7 @@ interface Workspace extends WorldRoot {
|
|
|
33939
33668
|
* - **ThreadSafety**: Unsafe
|
|
33940
33669
|
*
|
|
33941
33670
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Workspace#UnjoinFromOutsiders)
|
|
33942
|
-
* @param this
|
|
33671
|
+
* @param this `Workspace` houses 3D objects which are rendered to the 3D world. Objects not descending from it will not be rendered or physically interact with the world.
|
|
33943
33672
|
* @param objects An array of `BaseParts` for whom joints are to be broken.
|
|
33944
33673
|
*/
|
|
33945
33674
|
UnjoinFromOutsiders(this: Workspace, objects: Array<Instance>): void;
|
|
@@ -33989,6 +33718,13 @@ interface PackageLink extends Instance {
|
|
|
33989
33718
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PackageLink#DefaultName)
|
|
33990
33719
|
*/
|
|
33991
33720
|
get DefaultName(): string;
|
|
33721
|
+
/**
|
|
33722
|
+
* - **ThreadSafety**: ReadSafe
|
|
33723
|
+
* - **Tags**: NotReplicated
|
|
33724
|
+
*
|
|
33725
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PackageLink#PackageContent)
|
|
33726
|
+
*/
|
|
33727
|
+
readonly PackageContent: Content;
|
|
33992
33728
|
/**
|
|
33993
33729
|
* The ID of the asset this package corresponds to.
|
|
33994
33730
|
*
|
|
@@ -34611,6 +34347,12 @@ interface ParticleEmitter extends Instance {
|
|
|
34611
34347
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ParticleEmitter#Texture)
|
|
34612
34348
|
*/
|
|
34613
34349
|
Texture: ContentId;
|
|
34350
|
+
/**
|
|
34351
|
+
* - **ThreadSafety**: ReadSafe
|
|
34352
|
+
*
|
|
34353
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ParticleEmitter#TextureContent)
|
|
34354
|
+
*/
|
|
34355
|
+
TextureContent: Content;
|
|
34614
34356
|
/**
|
|
34615
34357
|
* Value between 0 and 1 that controls the speed of the particle effect.
|
|
34616
34358
|
*
|
|
@@ -34645,7 +34387,7 @@ interface ParticleEmitter extends Instance {
|
|
|
34645
34387
|
*
|
|
34646
34388
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ParticleEmitter#VelocitySpread)
|
|
34647
34389
|
*
|
|
34648
|
-
* @deprecated
|
|
34390
|
+
* @deprecated
|
|
34649
34391
|
*/
|
|
34650
34392
|
VelocitySpread: number;
|
|
34651
34393
|
/**
|
|
@@ -34683,20 +34425,6 @@ interface ParticleEmitter extends Instance {
|
|
|
34683
34425
|
* @param particleCount The number of particles to emit.
|
|
34684
34426
|
*/
|
|
34685
34427
|
Emit(this: ParticleEmitter, particleCount?: number): void;
|
|
34686
|
-
/**
|
|
34687
|
-
* - **ThreadSafety**: Unsafe
|
|
34688
|
-
* - **Tags**: Hidden
|
|
34689
|
-
*
|
|
34690
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ParticleEmitter#OnClearRequested)
|
|
34691
|
-
*/
|
|
34692
|
-
readonly OnClearRequested: RBXScriptSignal<() => void>;
|
|
34693
|
-
/**
|
|
34694
|
-
* - **ThreadSafety**: Unsafe
|
|
34695
|
-
* - **Tags**: Hidden
|
|
34696
|
-
*
|
|
34697
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ParticleEmitter#OnEmitRequested)
|
|
34698
|
-
*/
|
|
34699
|
-
readonly OnEmitRequested: RBXScriptSignal<(particleCount: number) => void>;
|
|
34700
34428
|
}
|
|
34701
34429
|
/**
|
|
34702
34430
|
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
@@ -34797,7 +34525,7 @@ interface Path extends Instance {
|
|
|
34797
34525
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Path#GetPointCoordinates)
|
|
34798
34526
|
* @param this Stores the result of paths created by `PathfindingService:CreatePath()`.
|
|
34799
34527
|
*
|
|
34800
|
-
* @deprecated
|
|
34528
|
+
* @deprecated
|
|
34801
34529
|
*/
|
|
34802
34530
|
GetPointCoordinates(this: Path): Array<unknown>;
|
|
34803
34531
|
/**
|
|
@@ -34981,7 +34709,7 @@ interface PathfindingService extends Instance {
|
|
|
34981
34709
|
* @param maxDistance
|
|
34982
34710
|
* @returns A `Path` object.
|
|
34983
34711
|
*
|
|
34984
|
-
* @deprecated
|
|
34712
|
+
* @deprecated
|
|
34985
34713
|
*/
|
|
34986
34714
|
ComputeRawPathAsync(this: PathfindingService, start: Vector3, finish: Vector3, maxDistance: number): Path;
|
|
34987
34715
|
/**
|
|
@@ -34998,7 +34726,7 @@ interface PathfindingService extends Instance {
|
|
|
34998
34726
|
* @param finish
|
|
34999
34727
|
* @param maxDistance
|
|
35000
34728
|
*
|
|
35001
|
-
* @deprecated
|
|
34729
|
+
* @deprecated
|
|
35002
34730
|
*/
|
|
35003
34731
|
ComputeSmoothPathAsync(this: PathfindingService, start: Vector3, finish: Vector3, maxDistance: number): Path;
|
|
35004
34732
|
/**
|
|
@@ -35102,7 +34830,7 @@ interface PhysicsService extends Instance {
|
|
|
35102
34830
|
* @param name
|
|
35103
34831
|
* @param part
|
|
35104
34832
|
*
|
|
35105
|
-
* @deprecated
|
|
34833
|
+
* @deprecated
|
|
35106
34834
|
*/
|
|
35107
34835
|
CollisionGroupContainsPart(this: PhysicsService, name: string, part: BasePart): boolean;
|
|
35108
34836
|
/**
|
|
@@ -35140,7 +34868,7 @@ interface PhysicsService extends Instance {
|
|
|
35140
34868
|
* @param this
|
|
35141
34869
|
* @param name
|
|
35142
34870
|
*
|
|
35143
|
-
* @deprecated
|
|
34871
|
+
* @deprecated
|
|
35144
34872
|
*/
|
|
35145
34873
|
CreateCollisionGroup(this: PhysicsService, name: string): number;
|
|
35146
34874
|
/**
|
|
@@ -35156,7 +34884,7 @@ interface PhysicsService extends Instance {
|
|
|
35156
34884
|
* @param name The name of the collision group being retrieved.
|
|
35157
34885
|
* @returns The ID of the retrieved collision group, or `nil` if no such group exists.
|
|
35158
34886
|
*
|
|
35159
|
-
* @deprecated
|
|
34887
|
+
* @deprecated
|
|
35160
34888
|
*/
|
|
35161
34889
|
GetCollisionGroupId(this: PhysicsService, name: string): number;
|
|
35162
34890
|
/**
|
|
@@ -35171,7 +34899,7 @@ interface PhysicsService extends Instance {
|
|
|
35171
34899
|
* @param this
|
|
35172
34900
|
* @param name
|
|
35173
34901
|
*
|
|
35174
|
-
* @deprecated
|
|
34902
|
+
* @deprecated
|
|
35175
34903
|
*/
|
|
35176
34904
|
GetCollisionGroupName(this: PhysicsService, name: number): string;
|
|
35177
34905
|
/**
|
|
@@ -35185,7 +34913,7 @@ interface PhysicsService extends Instance {
|
|
|
35185
34913
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PhysicsService#GetCollisionGroups)
|
|
35186
34914
|
* @param this
|
|
35187
34915
|
*
|
|
35188
|
-
* @deprecated
|
|
34916
|
+
* @deprecated
|
|
35189
34917
|
*/
|
|
35190
34918
|
GetCollisionGroups(this: PhysicsService): Array<CollisionGroupInfo & {
|
|
35191
34919
|
id: number;
|
|
@@ -35240,7 +34968,7 @@ interface PhysicsService extends Instance {
|
|
|
35240
34968
|
* @param this
|
|
35241
34969
|
* @param name
|
|
35242
34970
|
*
|
|
35243
|
-
* @deprecated
|
|
34971
|
+
* @deprecated
|
|
35244
34972
|
*/
|
|
35245
34973
|
RemoveCollisionGroup(this: PhysicsService, name: string): void;
|
|
35246
34974
|
/**
|
|
@@ -35267,7 +34995,7 @@ interface PhysicsService extends Instance {
|
|
|
35267
34995
|
* @param part The part being set.
|
|
35268
34996
|
* @param name The name of collision group that the part's collision group is being set to.
|
|
35269
34997
|
*
|
|
35270
|
-
* @deprecated
|
|
34998
|
+
* @deprecated
|
|
35271
34999
|
*/
|
|
35272
35000
|
SetPartCollisionGroup(this: PhysicsService, part: BasePart, name: string): void;
|
|
35273
35001
|
/**
|
|
@@ -35394,6 +35122,12 @@ interface Player extends Instance {
|
|
|
35394
35122
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#AccountAge)
|
|
35395
35123
|
*/
|
|
35396
35124
|
readonly AccountAge: number;
|
|
35125
|
+
/**
|
|
35126
|
+
* - **ThreadSafety**: ReadSafe
|
|
35127
|
+
*
|
|
35128
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#AgeChecked)
|
|
35129
|
+
*/
|
|
35130
|
+
get AgeChecked(): Enum.AgeCheckStatus;
|
|
35397
35131
|
/**
|
|
35398
35132
|
* Determines whether the character of a player using a mobile device will automatically jump upon hitting an obstacle.
|
|
35399
35133
|
*
|
|
@@ -35452,7 +35186,7 @@ interface Player extends Instance {
|
|
|
35452
35186
|
*
|
|
35453
35187
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#CharacterAppearance)
|
|
35454
35188
|
*
|
|
35455
|
-
* @deprecated
|
|
35189
|
+
* @deprecated
|
|
35456
35190
|
*/
|
|
35457
35191
|
CharacterAppearance: string;
|
|
35458
35192
|
/**
|
|
@@ -35663,6 +35397,14 @@ interface Player extends Instance {
|
|
|
35663
35397
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#TeamColor)
|
|
35664
35398
|
*/
|
|
35665
35399
|
TeamColor: BrickColor;
|
|
35400
|
+
/**
|
|
35401
|
+
* The `User` representing this player's domain-scoped identity within the current experience.
|
|
35402
|
+
*
|
|
35403
|
+
* - **ThreadSafety**: ReadSafe
|
|
35404
|
+
*
|
|
35405
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#User)
|
|
35406
|
+
*/
|
|
35407
|
+
get User(): User;
|
|
35666
35408
|
/**
|
|
35667
35409
|
* A unique identifying integer assigned to all user accounts.
|
|
35668
35410
|
*
|
|
@@ -35682,9 +35424,12 @@ interface Player extends Instance {
|
|
|
35682
35424
|
*/
|
|
35683
35425
|
AddReplicationFocus(this: Player, part: BasePart): void;
|
|
35684
35426
|
/**
|
|
35427
|
+
* Clears the cached avatar appearance for the player, forcing a fresh fetch from the backend on the next respawn.
|
|
35428
|
+
*
|
|
35685
35429
|
* - **ThreadSafety**: Unsafe
|
|
35686
35430
|
*
|
|
35687
35431
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#ClearCachedAvatarAppearance)
|
|
35432
|
+
* @param this An object that represents a presently connected client to the experience.
|
|
35688
35433
|
*/
|
|
35689
35434
|
ClearCachedAvatarAppearance(this: Player): void;
|
|
35690
35435
|
/**
|
|
@@ -35858,6 +35603,12 @@ interface Player extends Instance {
|
|
|
35858
35603
|
* @param relativeToCamera A boolean indicating whether the player should move relative to the player's camera.
|
|
35859
35604
|
*/
|
|
35860
35605
|
Move(this: Player, walkDirection: Vector3, relativeToCamera?: boolean): void;
|
|
35606
|
+
/**
|
|
35607
|
+
* - **ThreadSafety**: Unsafe
|
|
35608
|
+
*
|
|
35609
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#PromptAgeCheck)
|
|
35610
|
+
*/
|
|
35611
|
+
PromptAgeCheck(this: Player): void;
|
|
35861
35612
|
/**
|
|
35862
35613
|
* Removes a previously added replication focus.
|
|
35863
35614
|
*
|
|
@@ -35945,7 +35696,7 @@ interface Player extends Instance {
|
|
|
35945
35696
|
* @param maxFriends The maximum number of online friends to return.
|
|
35946
35697
|
* @returns A dictionary of online friends (see the table above).
|
|
35947
35698
|
*
|
|
35948
|
-
* @deprecated
|
|
35699
|
+
* @deprecated
|
|
35949
35700
|
*/
|
|
35950
35701
|
GetFriendsOnline(this: Player, maxFriends?: number): Array<FriendOnlineInfo>;
|
|
35951
35702
|
/**
|
|
@@ -35982,7 +35733,7 @@ interface Player extends Instance {
|
|
|
35982
35733
|
* @param groupId The `groupId` of the specified group.
|
|
35983
35734
|
* @returns The player's rank in the group.
|
|
35984
35735
|
*
|
|
35985
|
-
* @deprecated
|
|
35736
|
+
* @deprecated
|
|
35986
35737
|
*/
|
|
35987
35738
|
GetRankInGroup(this: Player, groupId: number): number;
|
|
35988
35739
|
/**
|
|
@@ -35998,7 +35749,7 @@ interface Player extends Instance {
|
|
|
35998
35749
|
* @param groupId The `groupId` of the specified group.
|
|
35999
35750
|
* @returns The player's rank in the group.
|
|
36000
35751
|
*
|
|
36001
|
-
* @deprecated
|
|
35752
|
+
* @deprecated
|
|
36002
35753
|
*/
|
|
36003
35754
|
GetRankInGroupAsync(this: Player, groupId: number): number;
|
|
36004
35755
|
/**
|
|
@@ -36014,7 +35765,7 @@ interface Player extends Instance {
|
|
|
36014
35765
|
* @param groupId The group ID of the specified group.
|
|
36015
35766
|
* @returns The player's role in the specified group, or `Guest` if the player is not a member.
|
|
36016
35767
|
*
|
|
36017
|
-
* @deprecated
|
|
35768
|
+
* @deprecated
|
|
36018
35769
|
*/
|
|
36019
35770
|
GetRoleInGroup(this: Player, groupId: number): string;
|
|
36020
35771
|
/**
|
|
@@ -36030,7 +35781,7 @@ interface Player extends Instance {
|
|
|
36030
35781
|
* @param groupId The group ID of the specified group.
|
|
36031
35782
|
* @returns The player's role in the specified group, or `Guest` if the player is not a member.
|
|
36032
35783
|
*
|
|
36033
|
-
* @deprecated
|
|
35784
|
+
* @deprecated
|
|
36034
35785
|
*/
|
|
36035
35786
|
GetRoleInGroupAsync(this: Player, groupId: number): string;
|
|
36036
35787
|
/**
|
|
@@ -36047,7 +35798,7 @@ interface Player extends Instance {
|
|
|
36047
35798
|
*
|
|
36048
35799
|
* @deprecated
|
|
36049
35800
|
*/
|
|
36050
|
-
IsBestFriendsWith(this: Player, userId:
|
|
35801
|
+
IsBestFriendsWith(this: Player, userId: User): boolean;
|
|
36051
35802
|
/**
|
|
36052
35803
|
* **Deprecated:** This method has been superseded by the `Player:IsFriendsWithAsync()` method which should be used for new work.
|
|
36053
35804
|
*
|
|
@@ -36061,9 +35812,9 @@ interface Player extends Instance {
|
|
|
36061
35812
|
* @param userId The `Player.UserId` of the specified player.
|
|
36062
35813
|
* @returns A boolean indicating whether a player is a friend of the specified user.
|
|
36063
35814
|
*
|
|
36064
|
-
* @deprecated
|
|
35815
|
+
* @deprecated
|
|
36065
35816
|
*/
|
|
36066
|
-
IsFriendsWith(this: Player, userId:
|
|
35817
|
+
IsFriendsWith(this: Player, userId: User): boolean;
|
|
36067
35818
|
/**
|
|
36068
35819
|
* Checks whether a player is a friend of the user with the given `Player.UserId`.
|
|
36069
35820
|
*
|
|
@@ -36075,7 +35826,7 @@ interface Player extends Instance {
|
|
|
36075
35826
|
* @param userId The `Player.UserId` of the specified player.
|
|
36076
35827
|
* @returns A boolean indicating whether a player is a friend of the specified user.
|
|
36077
35828
|
*/
|
|
36078
|
-
IsFriendsWithAsync(this: Player, userId:
|
|
35829
|
+
IsFriendsWithAsync(this: Player, userId: User): boolean;
|
|
36079
35830
|
/**
|
|
36080
35831
|
* **Deprecated:** This method has been superseded by `IsInGroupAsync()`.
|
|
36081
35832
|
*
|
|
@@ -36089,7 +35840,7 @@ interface Player extends Instance {
|
|
|
36089
35840
|
* @param groupId The group ID of the specified group.
|
|
36090
35841
|
* @returns A boolean indicating whether the player is in the specified group.
|
|
36091
35842
|
*
|
|
36092
|
-
* @deprecated
|
|
35843
|
+
* @deprecated
|
|
36093
35844
|
*/
|
|
36094
35845
|
IsInGroup(this: Player, groupId: number): boolean;
|
|
36095
35846
|
/**
|
|
@@ -36115,7 +35866,7 @@ interface Player extends Instance {
|
|
|
36115
35866
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#LoadCharacter)
|
|
36116
35867
|
* @param this An object that represents a presently connected client to the experience.
|
|
36117
35868
|
*
|
|
36118
|
-
* @deprecated
|
|
35869
|
+
* @deprecated
|
|
36119
35870
|
*/
|
|
36120
35871
|
LoadCharacter(this: Player): void;
|
|
36121
35872
|
/**
|
|
@@ -36141,7 +35892,7 @@ interface Player extends Instance {
|
|
|
36141
35892
|
* @param humanoidDescription A `HumanoidDescription` containing traits like body parts/colors, body scaling, accessories, clothing, and animations that will be equipped to the loaded character.
|
|
36142
35893
|
* @param assetTypeVerification The asset type verification mode.
|
|
36143
35894
|
*
|
|
36144
|
-
* @deprecated
|
|
35895
|
+
* @deprecated
|
|
36145
35896
|
*/
|
|
36146
35897
|
LoadCharacterWithHumanoidDescription(this: Player, humanoidDescription: HumanoidDescription): void;
|
|
36147
35898
|
/**
|
|
@@ -36682,7 +36433,7 @@ interface Players extends Instance {
|
|
|
36682
36433
|
*
|
|
36683
36434
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Players#NumPlayers)
|
|
36684
36435
|
*
|
|
36685
|
-
* @deprecated
|
|
36436
|
+
* @deprecated
|
|
36686
36437
|
*/
|
|
36687
36438
|
readonly NumPlayers: number;
|
|
36688
36439
|
/**
|
|
@@ -36745,7 +36496,8 @@ interface Players extends Instance {
|
|
|
36745
36496
|
* - `Duration` (required; integer) — Duration of the ban, in seconds. Permanent bans should have a value of `-1`. `0` and all other negative values are invalid.
|
|
36746
36497
|
* - `DisplayReason` (required; string) — The message that will be displayed to users when they attempt to and fail to join an experience. Maximum string length is `400`.
|
|
36747
36498
|
* - `PrivateReason` (required; string) — Internal messaging that will be returned when querying the user's ban history. Maximum string length is `1000`.
|
|
36748
|
-
* - `ExcludeAltAccounts` (optional; boolean) — When `true`, Roblox does not attempt to ban
|
|
36499
|
+
* - `ExcludeAltAccounts` (optional; boolean) — When `true`, Roblox does not attempt to ban alternate accounts. Default is `false`.
|
|
36500
|
+
* - `ApplyDeviceBlock` (optional; boolean) — When `true`, Roblox will block banned users' devices from rejoining the experience for 24 hours after the ban is applied. Default is `false`.
|
|
36749
36501
|
*/
|
|
36750
36502
|
BanAsync(this: Players, config: BanAsyncConfig): void;
|
|
36751
36503
|
/**
|
|
@@ -36763,7 +36515,7 @@ interface Players extends Instance {
|
|
|
36763
36515
|
* @param assetTypeVerification The asset type verification mode.
|
|
36764
36516
|
* @returns A `Humanoid` character `Model`.
|
|
36765
36517
|
*
|
|
36766
|
-
* @deprecated
|
|
36518
|
+
* @deprecated
|
|
36767
36519
|
*/
|
|
36768
36520
|
CreateHumanoidModelFromDescription(this: Players, description: HumanoidDescription, rigType: CastsToEnum<Enum.HumanoidRigType>, assetTypeVerification?: CastsToEnum<Enum.AssetTypeVerification>): Model;
|
|
36769
36521
|
/**
|
|
@@ -36793,9 +36545,9 @@ interface Players extends Instance {
|
|
|
36793
36545
|
* @param userId The userId for a Roblox user. (The UserId is the number in the profile of the user e.g www.roblox.com/users/1/profile).
|
|
36794
36546
|
* @returns A Humanoid character Model.
|
|
36795
36547
|
*
|
|
36796
|
-
* @deprecated
|
|
36548
|
+
* @deprecated
|
|
36797
36549
|
*/
|
|
36798
|
-
CreateHumanoidModelFromUserId(this: Players, userId:
|
|
36550
|
+
CreateHumanoidModelFromUserId(this: Players, userId: User): Model;
|
|
36799
36551
|
/**
|
|
36800
36552
|
* Returns a character Model set-up with everything equipped to match the avatar of the user specified by the passed in userId.
|
|
36801
36553
|
*
|
|
@@ -36807,7 +36559,7 @@ interface Players extends Instance {
|
|
|
36807
36559
|
* @param userId The userId for a Roblox user. (The UserId is the number in the profile of the user e.g www.roblox.com/users/1/profile).
|
|
36808
36560
|
* @returns A Humanoid character Model.
|
|
36809
36561
|
*/
|
|
36810
|
-
CreateHumanoidModelFromUserIdAsync(this: Players, userId:
|
|
36562
|
+
CreateHumanoidModelFromUserIdAsync(this: Players, userId: User): Model;
|
|
36811
36563
|
/**
|
|
36812
36564
|
* Retrieves the ban and unban history of any user within the experience's universe. This method is enabled and disabled by the `Players.BanningEnabled` property, which you can toggle in Studio.
|
|
36813
36565
|
*
|
|
@@ -36819,7 +36571,7 @@ interface Players extends Instance {
|
|
|
36819
36571
|
* @param userId
|
|
36820
36572
|
* @returns See `BanHistoryPages` for return reference.
|
|
36821
36573
|
*/
|
|
36822
|
-
GetBanHistoryAsync(this: Players, userId:
|
|
36574
|
+
GetBanHistoryAsync(this: Players, userId: User): BanHistoryPages;
|
|
36823
36575
|
/**
|
|
36824
36576
|
* **Deprecated:**
|
|
36825
36577
|
*
|
|
@@ -36834,7 +36586,7 @@ interface Players extends Instance {
|
|
|
36834
36586
|
*
|
|
36835
36587
|
* @deprecated
|
|
36836
36588
|
*/
|
|
36837
|
-
GetCharacterAppearanceAsync(this: Players, userId:
|
|
36589
|
+
GetCharacterAppearanceAsync(this: Players, userId: User): Model;
|
|
36838
36590
|
/**
|
|
36839
36591
|
* Returns information about the character appearance of a given user.
|
|
36840
36592
|
*
|
|
@@ -36857,7 +36609,7 @@ interface Players extends Instance {
|
|
|
36857
36609
|
* @param this A service that contains presently connected `Player` objects.
|
|
36858
36610
|
* @param userId The user ID of the player being specified.
|
|
36859
36611
|
*/
|
|
36860
|
-
GetFriendsAsync(this: Players, userId:
|
|
36612
|
+
GetFriendsAsync(this: Players, userId: User): FriendPages;
|
|
36861
36613
|
/**
|
|
36862
36614
|
* **Deprecated:** This method has been superseded by `GetHumanoidDescriptionFromOutfitIdAsync()`.
|
|
36863
36615
|
*
|
|
@@ -36871,7 +36623,7 @@ interface Players extends Instance {
|
|
|
36871
36623
|
* @param outfitId The ID of the outfit for which the HumanoidDescription is sought.
|
|
36872
36624
|
* @returns HumanoidDescription initialized with the specification for the passed in outfitId.
|
|
36873
36625
|
*
|
|
36874
|
-
* @deprecated
|
|
36626
|
+
* @deprecated
|
|
36875
36627
|
*/
|
|
36876
36628
|
GetHumanoidDescriptionFromOutfitId(this: Players, outfitId: number): HumanoidDescription;
|
|
36877
36629
|
/**
|
|
@@ -36899,9 +36651,9 @@ interface Players extends Instance {
|
|
|
36899
36651
|
* @param userId The userId for a Roblox user. (The UserId is the number in the profile of the user e.g www.roblox.com/users/1/profile).
|
|
36900
36652
|
* @returns HumanoidDescription initialized with the passed in user's avatar specification.
|
|
36901
36653
|
*
|
|
36902
|
-
* @deprecated
|
|
36654
|
+
* @deprecated
|
|
36903
36655
|
*/
|
|
36904
|
-
GetHumanoidDescriptionFromUserId(this: Players, userId:
|
|
36656
|
+
GetHumanoidDescriptionFromUserId(this: Players, userId: User): HumanoidDescription;
|
|
36905
36657
|
/**
|
|
36906
36658
|
* Returns a HumanoidDescription which specifies everything equipped for the avatar of the user specified by the passed in userId.
|
|
36907
36659
|
*
|
|
@@ -36913,7 +36665,7 @@ interface Players extends Instance {
|
|
|
36913
36665
|
* @param userId The userId for a Roblox user. (The UserId is the number in the profile of the user e.g www.roblox.com/users/1/profile).
|
|
36914
36666
|
* @returns HumanoidDescription initialized with the passed in user's avatar specification.
|
|
36915
36667
|
*/
|
|
36916
|
-
GetHumanoidDescriptionFromUserIdAsync(this: Players, userId:
|
|
36668
|
+
GetHumanoidDescriptionFromUserIdAsync(this: Players, userId: User): HumanoidDescription;
|
|
36917
36669
|
/**
|
|
36918
36670
|
* Sends a query to the Roblox website for the username of an account with a given `UserId`.
|
|
36919
36671
|
*
|
|
@@ -36925,7 +36677,7 @@ interface Players extends Instance {
|
|
|
36925
36677
|
* @param userId The `Player.UserId` of the player being specified.
|
|
36926
36678
|
* @returns The name of a user with the specified `Player.UserId`.
|
|
36927
36679
|
*/
|
|
36928
|
-
GetNameFromUserIdAsync(this: Players, userId:
|
|
36680
|
+
GetNameFromUserIdAsync(this: Players, userId: User): string;
|
|
36929
36681
|
/**
|
|
36930
36682
|
* Sends a query to the Roblox website for the `userId` of an account with a given username.
|
|
36931
36683
|
*
|
|
@@ -38081,7 +37833,7 @@ interface RecommendationService extends Instance {
|
|
|
38081
37833
|
* - `ReferenceId` — The developer-defined string that uniquely identifies the item.
|
|
38082
37834
|
* - `Duration` — The duration of the content in seconds.
|
|
38083
37835
|
* - `Attributes` — The table of attributes for the item, such as `AssetId` or `Description`.
|
|
38084
|
-
* - `CustomTags` — The list of string tags for filtering and boosting.
|
|
37836
|
+
* - `CustomTags` — The list of string tags for filtering and boosting. Individual custom tags can't contain commas.
|
|
38085
37837
|
* - `Visibility` — The `RecommendationItemVisibility` enum that controls the item's visibility, such as `Public` or `Private`.
|
|
38086
37838
|
*
|
|
38087
37839
|
*
|
|
@@ -38109,7 +37861,7 @@ interface RecommendationService extends Instance {
|
|
|
38109
37861
|
* - `Duration` — The new duration for the content in seconds.
|
|
38110
37862
|
* - `Visibility` — The new visibility setting for the item.
|
|
38111
37863
|
* - `Attributes` — The new table of attributes for the item.
|
|
38112
|
-
* - `CustomTags` — The new list of string tags.
|
|
37864
|
+
* - `CustomTags` — The new list of string tags. Individual custom tags can't contain commas.
|
|
38113
37865
|
*/
|
|
38114
37866
|
UpdateItemAsync(this: RecommendationService, updateRecommendationItemRequest: object): void;
|
|
38115
37867
|
}
|
|
@@ -38305,34 +38057,6 @@ interface RemoteFunction<T extends Callback = Callback> extends Instance {
|
|
|
38305
38057
|
* @returns Values returned from the `OnServerInvoke` callback.
|
|
38306
38058
|
*/
|
|
38307
38059
|
InvokeServer(this: RemoteFunction, ...args: Parameters<T>): ReturnType<T>;
|
|
38308
|
-
/**
|
|
38309
|
-
* - **ThreadSafety**: Unsafe
|
|
38310
|
-
* - **Tags**: Hidden
|
|
38311
|
-
*
|
|
38312
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RemoteFunction#RemoteOnInvokeClient)
|
|
38313
|
-
*/
|
|
38314
|
-
readonly RemoteOnInvokeClient: RBXScriptSignal<(id: number, arguments: unknown) => void>;
|
|
38315
|
-
/**
|
|
38316
|
-
* - **ThreadSafety**: Unsafe
|
|
38317
|
-
* - **Tags**: Hidden
|
|
38318
|
-
*
|
|
38319
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RemoteFunction#RemoteOnInvokeError)
|
|
38320
|
-
*/
|
|
38321
|
-
readonly RemoteOnInvokeError: RBXScriptSignal<(id: number, arguments: string) => void>;
|
|
38322
|
-
/**
|
|
38323
|
-
* - **ThreadSafety**: Unsafe
|
|
38324
|
-
* - **Tags**: Hidden
|
|
38325
|
-
*
|
|
38326
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RemoteFunction#RemoteOnInvokeServer)
|
|
38327
|
-
*/
|
|
38328
|
-
readonly RemoteOnInvokeServer: RBXScriptSignal<(id: number, player: Player, arguments: unknown) => void>;
|
|
38329
|
-
/**
|
|
38330
|
-
* - **ThreadSafety**: Unsafe
|
|
38331
|
-
* - **Tags**: Hidden
|
|
38332
|
-
*
|
|
38333
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RemoteFunction#RemoteOnInvokeSuccess)
|
|
38334
|
-
*/
|
|
38335
|
-
readonly RemoteOnInvokeSuccess: RBXScriptSignal<(id: number, arguments: unknown) => void>;
|
|
38336
38060
|
/**
|
|
38337
38061
|
* Callback for when the `RemoteFunction` is invoked with `InvokeClient()`.
|
|
38338
38062
|
*
|
|
@@ -38977,6 +38701,12 @@ interface ScreenshotHud extends Instance {
|
|
|
38977
38701
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScreenshotHud#CameraButtonIcon)
|
|
38978
38702
|
*/
|
|
38979
38703
|
CameraButtonIcon: ContentId;
|
|
38704
|
+
/**
|
|
38705
|
+
* - **ThreadSafety**: ReadSafe
|
|
38706
|
+
*
|
|
38707
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScreenshotHud#CameraButtonIconContent)
|
|
38708
|
+
*/
|
|
38709
|
+
CameraButtonIconContent: Content;
|
|
38980
38710
|
/**
|
|
38981
38711
|
* Screen location of the camera button.
|
|
38982
38712
|
*
|
|
@@ -39122,7 +38852,7 @@ interface SyncScriptBuilder extends ScriptBuilder {
|
|
|
39122
38852
|
*
|
|
39123
38853
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SyncScriptBuilder#RawBytecode)
|
|
39124
38854
|
*
|
|
39125
|
-
* @deprecated
|
|
38855
|
+
* @deprecated
|
|
39126
38856
|
*/
|
|
39127
38857
|
RawBytecode: boolean;
|
|
39128
38858
|
}
|
|
@@ -39820,7 +39550,7 @@ interface DataModel extends ServiceProvider<Services> {
|
|
|
39820
39550
|
*
|
|
39821
39551
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DataModel#VIPServerId)
|
|
39822
39552
|
*
|
|
39823
|
-
* @deprecated
|
|
39553
|
+
* @deprecated
|
|
39824
39554
|
*/
|
|
39825
39555
|
readonly VIPServerId: string;
|
|
39826
39556
|
/**
|
|
@@ -39833,7 +39563,7 @@ interface DataModel extends ServiceProvider<Services> {
|
|
|
39833
39563
|
*
|
|
39834
39564
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DataModel#VIPServerOwnerId)
|
|
39835
39565
|
*
|
|
39836
|
-
* @deprecated
|
|
39566
|
+
* @deprecated
|
|
39837
39567
|
*/
|
|
39838
39568
|
readonly VIPServerOwnerId: number;
|
|
39839
39569
|
/**
|
|
@@ -39972,6 +39702,12 @@ interface DataModel extends ServiceProvider<Services> {
|
|
|
39972
39702
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DataModel#ServerLifecycleChanged)
|
|
39973
39703
|
*/
|
|
39974
39704
|
readonly ServerLifecycleChanged: RBXScriptSignal<(serverLifecycleChangedEvent: object) => void>;
|
|
39705
|
+
/**
|
|
39706
|
+
* - **ThreadSafety**: Unsafe
|
|
39707
|
+
*
|
|
39708
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DataModel#ServerRestartScheduled)
|
|
39709
|
+
*/
|
|
39710
|
+
readonly ServerRestartScheduled: RBXScriptSignal<(restartTime: DateTime, source: Enum.CloseReason, attributes: object) => void>;
|
|
39975
39711
|
/**
|
|
39976
39712
|
* **Deprecated:** This function is deprecated. It is recommended to use `DataModel:BindToClose()` instead.
|
|
39977
39713
|
*
|
|
@@ -39982,7 +39718,7 @@ interface DataModel extends ServiceProvider<Services> {
|
|
|
39982
39718
|
*
|
|
39983
39719
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DataModel#OnClose)
|
|
39984
39720
|
*
|
|
39985
|
-
* @deprecated
|
|
39721
|
+
* @deprecated
|
|
39986
39722
|
*/
|
|
39987
39723
|
OnClose: (() => unknown) | undefined;
|
|
39988
39724
|
}
|
|
@@ -40321,6 +40057,21 @@ interface SlimAnimationReplicationService extends Instance {
|
|
|
40321
40057
|
*/
|
|
40322
40058
|
readonly _nominal_SlimAnimationReplicationService: unique symbol;
|
|
40323
40059
|
}
|
|
40060
|
+
/**
|
|
40061
|
+
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
40062
|
+
*
|
|
40063
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SlimDebugSettings)
|
|
40064
|
+
*/
|
|
40065
|
+
interface SlimDebugSettings extends Instance {
|
|
40066
|
+
/**
|
|
40067
|
+
* **DO NOT USE!**
|
|
40068
|
+
*
|
|
40069
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
40070
|
+
* @hidden
|
|
40071
|
+
* @deprecated
|
|
40072
|
+
*/
|
|
40073
|
+
readonly _nominal_SlimDebugSettings: unique symbol;
|
|
40074
|
+
}
|
|
40324
40075
|
/**
|
|
40325
40076
|
* - **Tags**: NotCreatable, Service
|
|
40326
40077
|
*
|
|
@@ -40624,7 +40375,7 @@ interface SocialService extends Instance {
|
|
|
40624
40375
|
*
|
|
40625
40376
|
* @returns A tuple containing an `PromptLinkSharingResult` indicating the result of the link sharing prompt.
|
|
40626
40377
|
*
|
|
40627
|
-
* @deprecated
|
|
40378
|
+
* @deprecated
|
|
40628
40379
|
*/
|
|
40629
40380
|
PromptLinkSharing(this: SocialService, player: Player, options?: object): unknown;
|
|
40630
40381
|
/**
|
|
@@ -40738,7 +40489,7 @@ interface Sound extends Instance {
|
|
|
40738
40489
|
*
|
|
40739
40490
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Sound#EmitterSize)
|
|
40740
40491
|
*
|
|
40741
|
-
* @deprecated
|
|
40492
|
+
* @deprecated
|
|
40742
40493
|
*/
|
|
40743
40494
|
EmitterSize: number;
|
|
40744
40495
|
/**
|
|
@@ -40794,7 +40545,7 @@ interface Sound extends Instance {
|
|
|
40794
40545
|
*
|
|
40795
40546
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Sound#MaxDistance)
|
|
40796
40547
|
*
|
|
40797
|
-
* @deprecated
|
|
40548
|
+
* @deprecated
|
|
40798
40549
|
*/
|
|
40799
40550
|
MaxDistance: number;
|
|
40800
40551
|
/**
|
|
@@ -40807,7 +40558,7 @@ interface Sound extends Instance {
|
|
|
40807
40558
|
*
|
|
40808
40559
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Sound#MinDistance)
|
|
40809
40560
|
*
|
|
40810
|
-
* @deprecated
|
|
40561
|
+
* @deprecated
|
|
40811
40562
|
*/
|
|
40812
40563
|
MinDistance: number;
|
|
40813
40564
|
/**
|
|
@@ -40820,7 +40571,7 @@ interface Sound extends Instance {
|
|
|
40820
40571
|
*
|
|
40821
40572
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Sound#Pitch)
|
|
40822
40573
|
*
|
|
40823
|
-
* @deprecated
|
|
40574
|
+
* @deprecated
|
|
40824
40575
|
*/
|
|
40825
40576
|
Pitch: number;
|
|
40826
40577
|
/**
|
|
@@ -41563,6 +41314,24 @@ interface SoundService extends Instance {
|
|
|
41563
41314
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SoundService#DopplerScale)
|
|
41564
41315
|
*/
|
|
41565
41316
|
DopplerScale: number;
|
|
41317
|
+
/**
|
|
41318
|
+
* - **ThreadSafety**: ReadSafe
|
|
41319
|
+
*
|
|
41320
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SoundService#ListenerCFrame)
|
|
41321
|
+
*/
|
|
41322
|
+
ListenerCFrame: CFrame;
|
|
41323
|
+
/**
|
|
41324
|
+
* - **ThreadSafety**: ReadSafe
|
|
41325
|
+
*
|
|
41326
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SoundService#ListenerObject)
|
|
41327
|
+
*/
|
|
41328
|
+
ListenerObject: Instance | undefined;
|
|
41329
|
+
/**
|
|
41330
|
+
* - **ThreadSafety**: ReadSafe
|
|
41331
|
+
*
|
|
41332
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SoundService#ListenerType)
|
|
41333
|
+
*/
|
|
41334
|
+
ListenerType: Enum.ListenerType;
|
|
41566
41335
|
/**
|
|
41567
41336
|
* Sets whether `Sound` playback from a client will replicate to the server.
|
|
41568
41337
|
*
|
|
@@ -43551,7 +43320,7 @@ interface TeleportService extends Instance {
|
|
|
43551
43320
|
* @param placeId The `DataModel.PlaceId` of the place the reserved server is being created for.
|
|
43552
43321
|
* @returns The server access code required by `TeleportService:TeleportToPrivateServer()` and the `DataModel.PrivateServerId` for the reserved server.
|
|
43553
43322
|
*
|
|
43554
|
-
* @deprecated
|
|
43323
|
+
* @deprecated
|
|
43555
43324
|
*/
|
|
43556
43325
|
ReserveServer(this: TeleportService, placeId: number): LuaTuple<[
|
|
43557
43326
|
string,
|
|
@@ -43833,7 +43602,7 @@ interface TestService extends Instance {
|
|
|
43833
43602
|
*
|
|
43834
43603
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TestService#Is30FpsThrottleEnabled)
|
|
43835
43604
|
*
|
|
43836
|
-
* @deprecated
|
|
43605
|
+
* @deprecated
|
|
43837
43606
|
*/
|
|
43838
43607
|
Is30FpsThrottleEnabled: boolean;
|
|
43839
43608
|
/**
|
|
@@ -45153,7 +44922,7 @@ interface TextChatService extends Instance {
|
|
|
45153
44922
|
* @param this A service handling in-experience text chat.
|
|
45154
44923
|
* @param userId
|
|
45155
44924
|
*/
|
|
45156
|
-
CanUserChatAsync(this: TextChatService, userId:
|
|
44925
|
+
CanUserChatAsync(this: TextChatService, userId: User): boolean;
|
|
45157
44926
|
/**
|
|
45158
44927
|
* Determines whether or not two users can receive messages from each other.
|
|
45159
44928
|
*
|
|
@@ -45165,7 +44934,7 @@ interface TextChatService extends Instance {
|
|
|
45165
44934
|
* @param userIdFrom
|
|
45166
44935
|
* @param userIdTo
|
|
45167
44936
|
*/
|
|
45168
|
-
CanUsersChatAsync(this: TextChatService, userIdFrom:
|
|
44937
|
+
CanUsersChatAsync(this: TextChatService, userIdFrom: User, userIdTo: User): boolean;
|
|
45169
44938
|
/**
|
|
45170
44939
|
* Determines whether a user has permission to chat directly with other users in experiences based on factors such as their parental control settings.
|
|
45171
44940
|
*
|
|
@@ -45178,7 +44947,7 @@ interface TextChatService extends Instance {
|
|
|
45178
44947
|
* @param userIds A list of users who the `requesterUserId` would like to chat with directly. Users not in the current server are ignored.
|
|
45179
44948
|
* @returns A list of users who could participate in the direct chat request. If none of the users can direct chat with the `requesterUserId`, the result is an empty array.
|
|
45180
44949
|
*/
|
|
45181
|
-
CanUsersDirectChatAsync(this: TextChatService, requesterUserId:
|
|
44950
|
+
CanUsersDirectChatAsync(this: TextChatService, requesterUserId: User, userIds: Array<unknown>): Array<unknown>;
|
|
45182
44951
|
/**
|
|
45183
44952
|
* Returns chat group IDs that indicate which players can synchronously text chat together.
|
|
45184
44953
|
*
|
|
@@ -45825,6 +45594,12 @@ interface Trail extends Instance {
|
|
|
45825
45594
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Trail#Texture)
|
|
45826
45595
|
*/
|
|
45827
45596
|
Texture: ContentId;
|
|
45597
|
+
/**
|
|
45598
|
+
* - **ThreadSafety**: ReadSafe
|
|
45599
|
+
*
|
|
45600
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Trail#TextureContent)
|
|
45601
|
+
*/
|
|
45602
|
+
TextureContent: Content;
|
|
45828
45603
|
/**
|
|
45829
45604
|
* Sets the length of the trail's texture, dependent on `TextureMode`.
|
|
45830
45605
|
*
|
|
@@ -45866,13 +45641,6 @@ interface Trail extends Instance {
|
|
|
45866
45641
|
* @param this Used to create a trail effect between two attachments.
|
|
45867
45642
|
*/
|
|
45868
45643
|
Clear(this: Trail): void;
|
|
45869
|
-
/**
|
|
45870
|
-
* - **ThreadSafety**: Unsafe
|
|
45871
|
-
* - **Tags**: Hidden
|
|
45872
|
-
*
|
|
45873
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Trail#OnClearRequested)
|
|
45874
|
-
*/
|
|
45875
|
-
readonly OnClearRequested: RBXScriptSignal<() => void>;
|
|
45876
45644
|
}
|
|
45877
45645
|
/**
|
|
45878
45646
|
* The role of a Translator is to manufacture/return strings localized for the viewing player.
|
|
@@ -46671,6 +46439,18 @@ interface UIGradient extends UIComponent {
|
|
|
46671
46439
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UIGradient#Rotation)
|
|
46672
46440
|
*/
|
|
46673
46441
|
Rotation: number;
|
|
46442
|
+
/**
|
|
46443
|
+
* - **ThreadSafety**: ReadSafe
|
|
46444
|
+
*
|
|
46445
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UIGradient#Scale)
|
|
46446
|
+
*/
|
|
46447
|
+
Scale: number;
|
|
46448
|
+
/**
|
|
46449
|
+
* - **ThreadSafety**: ReadSafe
|
|
46450
|
+
*
|
|
46451
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UIGradient#TileMode)
|
|
46452
|
+
*/
|
|
46453
|
+
TileMode: Enum.GradientTileMode;
|
|
46674
46454
|
/**
|
|
46675
46455
|
* Determines how much the parent GuiObject can be seen through along the length of the gradient.
|
|
46676
46456
|
*
|
|
@@ -46679,6 +46459,12 @@ interface UIGradient extends UIComponent {
|
|
|
46679
46459
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UIGradient#Transparency)
|
|
46680
46460
|
*/
|
|
46681
46461
|
Transparency: NumberSequence;
|
|
46462
|
+
/**
|
|
46463
|
+
* - **ThreadSafety**: ReadSafe
|
|
46464
|
+
*
|
|
46465
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UIGradient#Type)
|
|
46466
|
+
*/
|
|
46467
|
+
Type: Enum.GradientType;
|
|
46682
46468
|
}
|
|
46683
46469
|
/**
|
|
46684
46470
|
* The base class for UI layout classes.
|
|
@@ -47210,6 +46996,8 @@ interface UIShadow extends UIComponent {
|
|
|
47210
46996
|
*/
|
|
47211
46997
|
Color: Color3;
|
|
47212
46998
|
/**
|
|
46999
|
+
* Determines whether the `UIShadow` is visible.
|
|
47000
|
+
*
|
|
47213
47001
|
* - **ThreadSafety**: ReadSafe
|
|
47214
47002
|
*
|
|
47215
47003
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UIShadow#Enabled)
|
|
@@ -47661,7 +47449,7 @@ interface UserInputService extends Instance {
|
|
|
47661
47449
|
*
|
|
47662
47450
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UserInputService#ModalEnabled)
|
|
47663
47451
|
*
|
|
47664
|
-
* @deprecated
|
|
47452
|
+
* @deprecated
|
|
47665
47453
|
*/
|
|
47666
47454
|
ModalEnabled: boolean;
|
|
47667
47455
|
/**
|
|
@@ -48287,10 +48075,15 @@ interface UserService extends Instance {
|
|
|
48287
48075
|
*/
|
|
48288
48076
|
readonly _nominal_UserService: unique symbol;
|
|
48289
48077
|
/**
|
|
48078
|
+
* Returns a `User` for the given global user ID within the current experience.
|
|
48079
|
+
*
|
|
48290
48080
|
* - **ThreadSafety**: Unsafe
|
|
48291
48081
|
* - **Tags**: Yields
|
|
48292
48082
|
*
|
|
48293
48083
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UserService#GetUserFromGlobalUserIdAsync)
|
|
48084
|
+
* @param this A service that handles queries regarding users on the Roblox platform.
|
|
48085
|
+
* @param userId The global user ID to resolve.
|
|
48086
|
+
* @returns User: The `User` representing the resolved domain-scoped identity.
|
|
48294
48087
|
*/
|
|
48295
48088
|
GetUserFromGlobalUserIdAsync(this: UserService, userId: number): User;
|
|
48296
48089
|
/**
|
|
@@ -49194,6 +48987,12 @@ interface VideoPlayer extends Instance {
|
|
|
49194
48987
|
* @deprecated
|
|
49195
48988
|
*/
|
|
49196
48989
|
readonly _nominal_VideoPlayer: unique symbol;
|
|
48990
|
+
/**
|
|
48991
|
+
* - **ThreadSafety**: ReadSafe
|
|
48992
|
+
*
|
|
48993
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VideoPlayer#InternalVideoUsage)
|
|
48994
|
+
*/
|
|
48995
|
+
InternalVideoUsage: Enum.InternalVideoUsage;
|
|
49197
48996
|
/**
|
|
49198
48997
|
* Indicates when the `VideoContent` has loaded and is ready to play.
|
|
49199
48998
|
*
|
|
@@ -49683,7 +49482,7 @@ interface VoiceChatService extends Instance {
|
|
|
49683
49482
|
* @param userId The `Player.UserId` to check.
|
|
49684
49483
|
* @returns If that user has voice enabled.
|
|
49685
49484
|
*/
|
|
49686
|
-
IsVoiceEnabledForUserIdAsync(this: VoiceChatService, userId:
|
|
49485
|
+
IsVoiceEnabledForUserIdAsync(this: VoiceChatService, userId: User): boolean;
|
|
49687
49486
|
}
|
|
49688
49487
|
/**
|
|
49689
49488
|
* - **Tags**: NotCreatable, NotReplicated
|
|
@@ -49990,6 +49789,21 @@ interface PluginConnection extends RBXObject {
|
|
|
49990
49789
|
*/
|
|
49991
49790
|
readonly _nominal_PluginConnection: unique symbol;
|
|
49992
49791
|
}
|
|
49792
|
+
/**
|
|
49793
|
+
* - **Tags**: NotCreatable, NotReplicated
|
|
49794
|
+
*
|
|
49795
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StudioActionOverride)
|
|
49796
|
+
*/
|
|
49797
|
+
interface StudioActionOverride extends RBXObject {
|
|
49798
|
+
/**
|
|
49799
|
+
* **DO NOT USE!**
|
|
49800
|
+
*
|
|
49801
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
49802
|
+
* @hidden
|
|
49803
|
+
* @deprecated
|
|
49804
|
+
*/
|
|
49805
|
+
readonly _nominal_StudioActionOverride: unique symbol;
|
|
49806
|
+
}
|
|
49993
49807
|
/**
|
|
49994
49808
|
* - **Tags**: NotCreatable, NotReplicated
|
|
49995
49809
|
*
|