@rbxts/types 1.0.952 → 1.0.954
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 +510 -196
- package/include/generated/PluginSecurity.d.ts +100 -58
- package/include/generated/enums.d.ts +717 -65
- package/package.json +1 -1
|
@@ -79,6 +79,7 @@ interface Services {
|
|
|
79
79
|
ExperienceStateCaptureService: ExperienceStateCaptureService;
|
|
80
80
|
ExperienceStateRecordingService: ExperienceStateRecordingService;
|
|
81
81
|
ExplorerServiceVisibilityService: ExplorerServiceVisibilityService;
|
|
82
|
+
ExternalIdentityService: ExternalIdentityService;
|
|
82
83
|
FaceAnimatorService: FaceAnimatorService;
|
|
83
84
|
FacialAgeEstimationService: FacialAgeEstimationService;
|
|
84
85
|
FacialAnimationRecordingService: FacialAnimationRecordingService;
|
|
@@ -169,6 +170,7 @@ interface Services {
|
|
|
169
170
|
ProcessInstancePhysicsService: ProcessInstancePhysicsService;
|
|
170
171
|
ProximityPromptService: ProximityPromptService;
|
|
171
172
|
PublishService: PublishService;
|
|
173
|
+
QueueService: QueueService;
|
|
172
174
|
RecommendationService: RecommendationService;
|
|
173
175
|
ReflectionService: ReflectionService;
|
|
174
176
|
RemoteCommandService: RemoteCommandService;
|
|
@@ -210,7 +212,6 @@ interface Services {
|
|
|
210
212
|
SlimReplicationService: SlimReplicationService;
|
|
211
213
|
SlimService: SlimService;
|
|
212
214
|
SmoothVoxelsUpgraderService: SmoothVoxelsUpgraderService;
|
|
213
|
-
SnippetService: SnippetService;
|
|
214
215
|
SocialService: SocialService;
|
|
215
216
|
SoundService: SoundService;
|
|
216
217
|
SoundShimService: SoundShimService;
|
|
@@ -280,6 +281,7 @@ interface CreatableInstances {
|
|
|
280
281
|
Accoutrement: Accoutrement;
|
|
281
282
|
Actor: Actor;
|
|
282
283
|
AdGui: AdGui;
|
|
284
|
+
AdPlacement: AdPlacement;
|
|
283
285
|
AdPortal: AdPortal;
|
|
284
286
|
AirController: AirController;
|
|
285
287
|
AlignOrientation: AlignOrientation;
|
|
@@ -743,6 +745,7 @@ interface Instances extends Services, CreatableInstances {
|
|
|
743
745
|
SoundEffect: SoundEffect;
|
|
744
746
|
StackFrame: StackFrame;
|
|
745
747
|
StandardPages: StandardPages;
|
|
748
|
+
StandardQueue: StandardQueue;
|
|
746
749
|
StarterCharacterScripts: StarterCharacterScripts;
|
|
747
750
|
StarterPlayerScripts: StarterPlayerScripts;
|
|
748
751
|
StudioObjectBase: StudioObjectBase;
|
|
@@ -1113,6 +1116,8 @@ interface EditableImage extends RBXObject {
|
|
|
1113
1116
|
*/
|
|
1114
1117
|
readonly Size: Vector2;
|
|
1115
1118
|
/**
|
|
1119
|
+
* Destroys the image contents and immediately reclaims the memory they use.
|
|
1120
|
+
*
|
|
1116
1121
|
* - **ThreadSafety**: Unsafe
|
|
1117
1122
|
*
|
|
1118
1123
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableImage#Destroy)
|
|
@@ -1226,11 +1231,25 @@ interface EditableImage extends RBXObject {
|
|
|
1226
1231
|
*/
|
|
1227
1232
|
ReadPixelsBuffer(this: EditableImage, position: Vector2, size: Vector2): buffer;
|
|
1228
1233
|
/**
|
|
1234
|
+
* Projects pixels from an `EditableMesh` texture into this `EditableImage`.
|
|
1235
|
+
*
|
|
1229
1236
|
* - **ThreadSafety**: Unsafe
|
|
1230
1237
|
*
|
|
1231
1238
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableImage#SampleImageProjected)
|
|
1239
|
+
* @param this Object which allows for the runtime creation and manipulation of images.
|
|
1240
|
+
* @param sourceMesh The `EditableMesh` that maps `sourceTexture` onto the surface being sampled.
|
|
1241
|
+
* @param sourceTexture The `EditableImage` from which pixels are sampled.
|
|
1242
|
+
* @param projectionConfig Projection configuration dictionary containing the following key-value pairs: - `Direction` (`Vector3`) where the projector is facing.
|
|
1243
|
+
* - `Position` (`Vector3`) as the projector position in local space with respect to the mesh.
|
|
1244
|
+
* - `Size` (`Vector3`) as the size of the projector. The **X** and **Y** components specify its dimensions, while the **Z** component specifies the projection depth.
|
|
1245
|
+
* - `Up` (`Vector3`) as the up vector of the projector in local space with respect to the mesh.
|
|
1246
|
+
*
|
|
1247
|
+
*
|
|
1248
|
+
* @param brushConfig Brush configuration dictionary containing the following key-value pairs: - `AlphaBlendType` (`ImageAlphaType`) which determines how the sampled alpha values are blended.
|
|
1249
|
+
* - `ColorBlendType` (`ImageCombineType`) which determines how the sampled color values are blended.
|
|
1250
|
+
* - `FadeAngle` (number) as the angle in degrees at which the projection begins to fade based on the surface normal. A value of `180` applies no normal-angle fade.
|
|
1232
1251
|
*/
|
|
1233
|
-
SampleImageProjected(this: EditableImage,
|
|
1252
|
+
SampleImageProjected(this: EditableImage, projectionSource: RBXObject, sourceTexture: EditableImage, projectionConfig: object, brushConfig: object): void;
|
|
1234
1253
|
/**
|
|
1235
1254
|
* Writes a rectangular region of pixels into the image.
|
|
1236
1255
|
*
|
|
@@ -1271,31 +1290,31 @@ interface EditableMesh extends RBXObject {
|
|
|
1271
1290
|
*/
|
|
1272
1291
|
get FixedSize(): boolean;
|
|
1273
1292
|
/**
|
|
1274
|
-
* Adds a new bone and returns a
|
|
1293
|
+
* Adds a new bone and returns a bone ID.
|
|
1275
1294
|
*
|
|
1276
1295
|
* - **ThreadSafety**: Unsafe
|
|
1277
1296
|
*
|
|
1278
1297
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#AddBone)
|
|
1279
1298
|
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1280
|
-
* @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.
|
|
1299
|
+
* @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, and the maximum length is 100 characters.
|
|
1281
1300
|
* - `ParentId` — Optional bone ID of the new bone's parent.
|
|
1282
1301
|
* - `CFrame` — Initial `CFrame` of the bone in the bind pose of the mesh, in the mesh's local space.
|
|
1283
1302
|
* - `Virtual` — Boolean that specifies whether this bone is virtual. Virtual bones can only be bound to a `FaceControls` instance.
|
|
1284
1303
|
*
|
|
1285
1304
|
*
|
|
1286
|
-
* @returns
|
|
1305
|
+
* @returns Bone ID of the new bone.
|
|
1287
1306
|
*/
|
|
1288
1307
|
AddBone(this: EditableMesh, boneProperties: object): number;
|
|
1289
1308
|
/**
|
|
1290
|
-
* Adds a new color to the geometry and returns a
|
|
1309
|
+
* Adds a new color to the geometry and returns a color ID.
|
|
1291
1310
|
*
|
|
1292
1311
|
* - **ThreadSafety**: Unsafe
|
|
1293
1312
|
*
|
|
1294
1313
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#AddColor)
|
|
1295
1314
|
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1296
1315
|
* @param color The new color.
|
|
1297
|
-
* @param alpha The color alpha (transparency).
|
|
1298
|
-
* @returns
|
|
1316
|
+
* @param alpha The color alpha (transparency). `0` is fully transparent, and `1` is fully opaque.
|
|
1317
|
+
* @returns Color ID of the new color.
|
|
1299
1318
|
*/
|
|
1300
1319
|
AddColor(this: EditableMesh, color: Color3, alpha: number): number;
|
|
1301
1320
|
/**
|
|
@@ -1305,18 +1324,18 @@ interface EditableMesh extends RBXObject {
|
|
|
1305
1324
|
*/
|
|
1306
1325
|
AddFace(this: EditableMesh, vertexIds: Array<unknown>): number;
|
|
1307
1326
|
/**
|
|
1308
|
-
* Adds a new normal to the geometry and returns a
|
|
1327
|
+
* Adds a new normal to the geometry and returns a normal ID.
|
|
1309
1328
|
*
|
|
1310
1329
|
* - **ThreadSafety**: Unsafe
|
|
1311
1330
|
*
|
|
1312
1331
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#AddNormal)
|
|
1313
1332
|
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1314
1333
|
* @param normal The normal vector. If the normal value isn't specified, the normal will be automatically calculated.
|
|
1315
|
-
* @returns
|
|
1334
|
+
* @returns Normal ID of the new normal.
|
|
1316
1335
|
*/
|
|
1317
1336
|
AddNormal(this: EditableMesh, normal?: Vector3): number;
|
|
1318
1337
|
/**
|
|
1319
|
-
* Adds a new triangle to the mesh and returns a
|
|
1338
|
+
* Adds a new triangle to the mesh and returns a face ID.
|
|
1320
1339
|
*
|
|
1321
1340
|
* - **ThreadSafety**: Unsafe
|
|
1322
1341
|
*
|
|
@@ -1325,29 +1344,29 @@ interface EditableMesh extends RBXObject {
|
|
|
1325
1344
|
* @param vertexId0 ID of the first vertex of the triangle.
|
|
1326
1345
|
* @param vertexId1 ID of the second vertex of the triangle.
|
|
1327
1346
|
* @param vertexId2 ID of the third vertex of the triangle.
|
|
1328
|
-
* @returns
|
|
1347
|
+
* @returns Face ID of the new face.
|
|
1329
1348
|
*/
|
|
1330
1349
|
AddTriangle(this: EditableMesh, vertexId0: number, vertexId1: number, vertexId2: number): number;
|
|
1331
1350
|
/**
|
|
1332
|
-
* Adds a new UV to the geometry and returns a
|
|
1351
|
+
* Adds a new UV to the geometry and returns a UV ID.
|
|
1333
1352
|
*
|
|
1334
1353
|
* - **ThreadSafety**: Unsafe
|
|
1335
1354
|
*
|
|
1336
1355
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#AddUV)
|
|
1337
1356
|
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1338
1357
|
* @param uv The new UV coordinate.
|
|
1339
|
-
* @returns
|
|
1358
|
+
* @returns UV ID of the new UV.
|
|
1340
1359
|
*/
|
|
1341
1360
|
AddUV(this: EditableMesh, uv: Vector2): number;
|
|
1342
1361
|
/**
|
|
1343
|
-
* Adds a new vertex to the geometry and returns a
|
|
1362
|
+
* Adds a new vertex to the geometry and returns a vertex ID.
|
|
1344
1363
|
*
|
|
1345
1364
|
* - **ThreadSafety**: Unsafe
|
|
1346
1365
|
*
|
|
1347
1366
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#AddVertex)
|
|
1348
1367
|
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1349
1368
|
* @param p Position in the mesh's local object space.
|
|
1350
|
-
* @returns
|
|
1369
|
+
* @returns Vertex ID of the new vertex.
|
|
1351
1370
|
*/
|
|
1352
1371
|
AddVertex(this: EditableMesh, p: Vector3): number;
|
|
1353
1372
|
/**
|
|
@@ -1359,7 +1378,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1359
1378
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#BatchAdd)
|
|
1360
1379
|
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1361
1380
|
* @param attr The `MeshAttribute` type of element to create.
|
|
1362
|
-
* @param data Values to initialize the new elements. An array of `Vector3` for `Vertex` or `Normal`; an array of `Vector2` for `UV`; an array of `Color3` followed by
|
|
1381
|
+
* @param data Values to initialize the new elements. An array of `Vector3` for `Vertex` or `Normal`; an array of `Vector2` for `UV`; an array of `Color3` followed by a matching array of alpha numbers (same length) for `Color`; a 2D array of vertex-ID arrays for `Face`.
|
|
1363
1382
|
* @returns Ordered array of new element IDs matching the input order.
|
|
1364
1383
|
*/
|
|
1365
1384
|
BatchAdd(this: EditableMesh, attr: CastsToEnum<Enum.MeshAttribute>, data: Array<unknown>): Array<unknown>;
|
|
@@ -1371,7 +1390,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1371
1390
|
*
|
|
1372
1391
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#BatchGetFaceAttributes)
|
|
1373
1392
|
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1374
|
-
* @param attr The attribute to retrieve for each face's corners
|
|
1393
|
+
* @param attr The attribute to retrieve for each face's corners. Must be `MeshAttribute.Vertex`, `MeshAttribute.Normal`, `MeshAttribute.Color`, or `MeshAttribute.UV`; `MeshAttribute.Face` is not supported and throws an error.
|
|
1375
1394
|
* @param faceIds Faces to query.
|
|
1376
1395
|
* @returns 2D array where `result[i]` is the array of attribute IDs at the corners of `faceIds[i]`.
|
|
1377
1396
|
*/
|
|
@@ -1384,7 +1403,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1384
1403
|
*
|
|
1385
1404
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#BatchGetValues)
|
|
1386
1405
|
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1387
|
-
* @param ids IDs of the elements to read. All must be the same type.
|
|
1406
|
+
* @param ids IDs of the elements to read. All must be the same attribute type — vertex, normal, color, or UV. The attribute is determined by the ID type, so no `MeshAttribute` argument is needed. Mixing types, or passing face or bone IDs, throws an error.
|
|
1388
1407
|
* @returns A tuple of two values. The first is an array of attribute values: `Vector3` for vertex or normal IDs, `Vector2` for UV IDs, `Color3` for color IDs. The second is `nil` for all attribute types except color, where it is an array of alpha numbers.
|
|
1389
1408
|
*/
|
|
1390
1409
|
BatchGetValues(this: EditableMesh, ids: Array<unknown>): unknown;
|
|
@@ -1396,7 +1415,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1396
1415
|
*
|
|
1397
1416
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#BatchGetVertexAttributes)
|
|
1398
1417
|
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1399
|
-
* @param attr The attribute type to look up
|
|
1418
|
+
* @param attr The attribute type to look up. Must be `MeshAttribute.Face` (faces that reference each vertex), `MeshAttribute.Normal`, `MeshAttribute.Color`, or `MeshAttribute.UV`; `MeshAttribute.Vertex` is not supported and throws an error (to read vertex positions, use `BatchGetValues()`).
|
|
1400
1419
|
* @param vertexIds Vertices to query.
|
|
1401
1420
|
* @returns 2D array where `result[i]` is the array of attribute IDs associated with `vertexIds[i]`.
|
|
1402
1421
|
*/
|
|
@@ -1409,9 +1428,9 @@ interface EditableMesh extends RBXObject {
|
|
|
1409
1428
|
*
|
|
1410
1429
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#BatchGetVertexFaceAttributes)
|
|
1411
1430
|
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1412
|
-
* @param attr The attribute to retrieve.
|
|
1431
|
+
* @param attr The attribute to retrieve. Must be `MeshAttribute.Normal`, `MeshAttribute.Color`, or `MeshAttribute.UV`; `MeshAttribute.Vertex` and `MeshAttribute.Face` are not supported and throw an error.
|
|
1413
1432
|
* @param vertexIds Vertices that identify each corner.
|
|
1414
|
-
* @param faceIds Faces that identify each corner.
|
|
1433
|
+
* @param faceIds Faces that identify each corner. Must be the same length as `vertexIds`.
|
|
1415
1434
|
* @returns Array of attribute IDs at each corner, in the same order as the inputs.
|
|
1416
1435
|
*/
|
|
1417
1436
|
BatchGetVertexFaceAttributes(this: EditableMesh, attr: CastsToEnum<Enum.MeshAttribute>, vertexIds: Array<unknown>, faceIds: Array<unknown>): Array<unknown>;
|
|
@@ -1423,7 +1442,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1423
1442
|
*
|
|
1424
1443
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#BatchRemove)
|
|
1425
1444
|
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1426
|
-
* @param faceIds Face IDs to remove.
|
|
1445
|
+
* @param faceIds Face IDs to remove. An invalid or already-removed ID throws an error and removes nothing; duplicate IDs are collapsed to a single removal.
|
|
1427
1446
|
*/
|
|
1428
1447
|
BatchRemove(this: EditableMesh, ids: Array<unknown>): void;
|
|
1429
1448
|
/**
|
|
@@ -1434,8 +1453,8 @@ interface EditableMesh extends RBXObject {
|
|
|
1434
1453
|
*
|
|
1435
1454
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#BatchSetFaceAttributes)
|
|
1436
1455
|
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1437
|
-
* @param faceIds
|
|
1438
|
-
* @param attrIdArrays 2D array. `attrIdArrays[i]` is the list of attribute IDs for the corners of `faceIds[i]
|
|
1456
|
+
* @param faceIds Face IDs to update. Must be the same length as `attrIdArrays`.
|
|
1457
|
+
* @param attrIdArrays 2D array. `attrIdArrays[i]` is the list of attribute IDs for the corners of `faceIds[i]`, in order. Each inner array must have one entry per corner of the face. All IDs must be of the same attribute type — vertex, normal, color, or UV; mixing types (or passing another ID type) throws an error.
|
|
1439
1458
|
*/
|
|
1440
1459
|
BatchSetFaceAttributes(this: EditableMesh, faceIds: Array<unknown>, attrIdArrays: Array<unknown>): void;
|
|
1441
1460
|
/**
|
|
@@ -1446,7 +1465,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1446
1465
|
*
|
|
1447
1466
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#BatchSetValues)
|
|
1448
1467
|
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1449
|
-
* @param ids IDs of the elements to write. All must be the same type.
|
|
1468
|
+
* @param ids IDs of the elements to write. All must be the same attribute type — vertex, normal, color, or UV. The attribute is determined by the ID type, so no `MeshAttribute` argument is needed. Mixing types, or passing face or bone IDs, throws an error.
|
|
1450
1469
|
* @param values Values to assign. Type depends on the ID type: `Vector3` for vertex or normal IDs, `Vector2` for UV IDs, `Color3` or a number for color IDs. Pass `nil` for normal IDs to reset each normal to auto-computed values, equivalent to calling `ResetNormal()` on each.
|
|
1451
1470
|
*/
|
|
1452
1471
|
BatchSetValues(this: EditableMesh, ids: Array<unknown>, values: Array<unknown>): void;
|
|
@@ -1458,9 +1477,9 @@ interface EditableMesh extends RBXObject {
|
|
|
1458
1477
|
*
|
|
1459
1478
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#BatchSetVertexFaceAttributes)
|
|
1460
1479
|
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1461
|
-
* @param vertexIds
|
|
1462
|
-
* @param faceIds
|
|
1463
|
-
* @param attrIds Attribute IDs to assign.
|
|
1480
|
+
* @param vertexIds Vertex IDs that identify each corner.
|
|
1481
|
+
* @param faceIds Face IDs that identify each corner. Must be the same length as `vertexIds`.
|
|
1482
|
+
* @param attrIds Attribute IDs to assign, one per pair; must be the same length as `vertexIds`. All must be the same attribute type — normal, color, or UV; passing a vertex or face ID throws an error.
|
|
1464
1483
|
*/
|
|
1465
1484
|
BatchSetVertexFaceAttributes(this: EditableMesh, vertexIds: Array<unknown>, faceIds: Array<unknown>, attrIds: Array<unknown>): void;
|
|
1466
1485
|
/**
|
|
@@ -1504,7 +1523,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1504
1523
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#FindClosestVertex)
|
|
1505
1524
|
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1506
1525
|
* @param toThisPoint Point position in the mesh's local object space.
|
|
1507
|
-
* @returns Closest
|
|
1526
|
+
* @returns Closest vertex ID to the specified point in space.
|
|
1508
1527
|
*/
|
|
1509
1528
|
FindClosestVertex(this: EditableMesh, toThisPoint: Vector3): number;
|
|
1510
1529
|
/**
|
|
@@ -1516,7 +1535,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1516
1535
|
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1517
1536
|
* @param center Center of the sphere in the mesh's local object space.
|
|
1518
1537
|
* @param radius Radius of the sphere.
|
|
1519
|
-
* @returns List of
|
|
1538
|
+
* @returns List of vertex IDs within the requested sphere.
|
|
1520
1539
|
*/
|
|
1521
1540
|
FindVerticesWithinSphere(this: EditableMesh, center: Vector3, radius: number): Array<number>;
|
|
1522
1541
|
/**
|
|
@@ -1526,7 +1545,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1526
1545
|
*
|
|
1527
1546
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetAdjacentFaces)
|
|
1528
1547
|
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1529
|
-
* @param faceId
|
|
1548
|
+
* @param faceId Face ID for which to get adjacent faces.
|
|
1530
1549
|
* @returns List of face IDs adjacent to the given face.
|
|
1531
1550
|
*/
|
|
1532
1551
|
GetAdjacentFaces(this: EditableMesh, faceId: number): Array<unknown>;
|
|
@@ -1603,10 +1622,12 @@ interface EditableMesh extends RBXObject {
|
|
|
1603
1622
|
*
|
|
1604
1623
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetBones)
|
|
1605
1624
|
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1606
|
-
* @returns List of
|
|
1625
|
+
* @returns List of bone IDs.
|
|
1607
1626
|
*/
|
|
1608
1627
|
GetBones(this: EditableMesh): Array<unknown>;
|
|
1609
1628
|
/**
|
|
1629
|
+
* Returns the center of the mesh's axis-aligned bounding box.
|
|
1630
|
+
*
|
|
1610
1631
|
* - **ThreadSafety**: Safe
|
|
1611
1632
|
*
|
|
1612
1633
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetCenter)
|
|
@@ -1622,7 +1643,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1622
1643
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetColor)
|
|
1623
1644
|
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1624
1645
|
* @param colorId Color ID for which to get the color.
|
|
1625
|
-
* @returns Color for the requested
|
|
1646
|
+
* @returns Color for the requested color ID.
|
|
1626
1647
|
*/
|
|
1627
1648
|
GetColor(this: EditableMesh, colorId: number): Color3 | undefined;
|
|
1628
1649
|
/**
|
|
@@ -1633,7 +1654,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1633
1654
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetColorAlpha)
|
|
1634
1655
|
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1635
1656
|
* @param colorId Color ID for which to get the alpha.
|
|
1636
|
-
* @returns Color alpha at the request
|
|
1657
|
+
* @returns Color alpha at the request color ID.
|
|
1637
1658
|
*/
|
|
1638
1659
|
GetColorAlpha(this: EditableMesh, colorId: number): number | undefined;
|
|
1639
1660
|
/**
|
|
@@ -1644,7 +1665,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1644
1665
|
*
|
|
1645
1666
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetColors)
|
|
1646
1667
|
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1647
|
-
* @returns List of
|
|
1668
|
+
* @returns List of color IDs.
|
|
1648
1669
|
*/
|
|
1649
1670
|
GetColors(this: EditableMesh): Array<unknown>;
|
|
1650
1671
|
/**
|
|
@@ -1691,7 +1712,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1691
1712
|
*
|
|
1692
1713
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetFaceVertices)
|
|
1693
1714
|
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1694
|
-
* @param faceId
|
|
1715
|
+
* @param faceId Face ID for which to get the vertex IDs.
|
|
1695
1716
|
* @returns List of vertex IDs around the given face.
|
|
1696
1717
|
*/
|
|
1697
1718
|
GetFaceVertices(this: EditableMesh, faceId: number): Array<unknown>;
|
|
@@ -1703,7 +1724,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1703
1724
|
*
|
|
1704
1725
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetFaces)
|
|
1705
1726
|
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1706
|
-
* @returns List of
|
|
1727
|
+
* @returns List of face IDs.
|
|
1707
1728
|
*/
|
|
1708
1729
|
GetFaces(this: EditableMesh): Array<unknown>;
|
|
1709
1730
|
/**
|
|
@@ -1819,7 +1840,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1819
1840
|
*
|
|
1820
1841
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetNormals)
|
|
1821
1842
|
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1822
|
-
* @returns List of
|
|
1843
|
+
* @returns List of normal IDs.
|
|
1823
1844
|
*/
|
|
1824
1845
|
GetNormals(this: EditableMesh): Array<unknown>;
|
|
1825
1846
|
/**
|
|
@@ -1829,11 +1850,13 @@ interface EditableMesh extends RBXObject {
|
|
|
1829
1850
|
*
|
|
1830
1851
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetPosition)
|
|
1831
1852
|
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1832
|
-
* @param vertexId
|
|
1853
|
+
* @param vertexId Vertex ID for which to get the position.
|
|
1833
1854
|
* @returns Position of a vertex in the mesh's local object space.
|
|
1834
1855
|
*/
|
|
1835
1856
|
GetPosition(this: EditableMesh, vertexId: number): Vector3;
|
|
1836
1857
|
/**
|
|
1858
|
+
* Returns the size of the mesh's axis-aligned bounding box.
|
|
1859
|
+
*
|
|
1837
1860
|
* - **ThreadSafety**: Safe
|
|
1838
1861
|
*
|
|
1839
1862
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetSize)
|
|
@@ -1860,7 +1883,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1860
1883
|
*
|
|
1861
1884
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetUVs)
|
|
1862
1885
|
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1863
|
-
* @returns List of
|
|
1886
|
+
* @returns List of UV IDs.
|
|
1864
1887
|
*/
|
|
1865
1888
|
GetUVs(this: EditableMesh): Array<unknown>;
|
|
1866
1889
|
/**
|
|
@@ -1893,7 +1916,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1893
1916
|
*
|
|
1894
1917
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetVertexColors)
|
|
1895
1918
|
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1896
|
-
* @param vertexId
|
|
1919
|
+
* @param vertexId Vertex ID to find color IDs.
|
|
1897
1920
|
* @returns Array of color IDs of faces attached to the given vertex.
|
|
1898
1921
|
*/
|
|
1899
1922
|
GetVertexColors(this: EditableMesh, vertexId: number): Array<unknown>;
|
|
@@ -1904,9 +1927,9 @@ interface EditableMesh extends RBXObject {
|
|
|
1904
1927
|
*
|
|
1905
1928
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetVertexFaceColor)
|
|
1906
1929
|
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1907
|
-
* @param vertexId
|
|
1908
|
-
* @param faceId
|
|
1909
|
-
* @returns
|
|
1930
|
+
* @param vertexId Vertex ID.
|
|
1931
|
+
* @param faceId Face ID.
|
|
1932
|
+
* @returns Color ID of the vertex/face pair.
|
|
1910
1933
|
*/
|
|
1911
1934
|
GetVertexFaceColor(this: EditableMesh, vertexId: number, faceId: number): number;
|
|
1912
1935
|
/**
|
|
@@ -1916,9 +1939,9 @@ interface EditableMesh extends RBXObject {
|
|
|
1916
1939
|
*
|
|
1917
1940
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetVertexFaceNormal)
|
|
1918
1941
|
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1919
|
-
* @param vertexId
|
|
1920
|
-
* @param faceId
|
|
1921
|
-
* @returns
|
|
1942
|
+
* @param vertexId Vertex ID.
|
|
1943
|
+
* @param faceId Face ID.
|
|
1944
|
+
* @returns Normal ID of the vertex/face pair.
|
|
1922
1945
|
*/
|
|
1923
1946
|
GetVertexFaceNormal(this: EditableMesh, vertexId: number, faceId: number): number;
|
|
1924
1947
|
/**
|
|
@@ -1928,9 +1951,9 @@ interface EditableMesh extends RBXObject {
|
|
|
1928
1951
|
*
|
|
1929
1952
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetVertexFaceUV)
|
|
1930
1953
|
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1931
|
-
* @param vertexId
|
|
1932
|
-
* @param faceId
|
|
1933
|
-
* @returns
|
|
1954
|
+
* @param vertexId Vertex ID.
|
|
1955
|
+
* @param faceId Face ID.
|
|
1956
|
+
* @returns UV ID of the vertex/face pair.
|
|
1934
1957
|
*/
|
|
1935
1958
|
GetVertexFaceUV(this: EditableMesh, vertexId: number, faceId: number): number;
|
|
1936
1959
|
/**
|
|
@@ -1941,7 +1964,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1941
1964
|
*
|
|
1942
1965
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetVertexFaces)
|
|
1943
1966
|
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1944
|
-
* @param vertexId
|
|
1967
|
+
* @param vertexId Vertex ID to find faces for.
|
|
1945
1968
|
* @returns Array of face IDs attached to the given vertex.
|
|
1946
1969
|
*/
|
|
1947
1970
|
GetVertexFaces(this: EditableMesh, vertexId: number): Array<unknown>;
|
|
@@ -1953,7 +1976,7 @@ interface EditableMesh extends RBXObject {
|
|
|
1953
1976
|
*
|
|
1954
1977
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetVertexNormals)
|
|
1955
1978
|
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1956
|
-
* @param vertexId
|
|
1979
|
+
* @param vertexId Vertex ID to find normal IDs.
|
|
1957
1980
|
* @returns Array of normal IDs of faces attached to the given vertex.
|
|
1958
1981
|
*/
|
|
1959
1982
|
GetVertexNormals(this: EditableMesh, vertexId: number): Array<unknown>;
|
|
@@ -1965,18 +1988,18 @@ interface EditableMesh extends RBXObject {
|
|
|
1965
1988
|
*
|
|
1966
1989
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetVertexUVs)
|
|
1967
1990
|
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1968
|
-
* @param vertexId
|
|
1991
|
+
* @param vertexId Vertex ID to find UV IDs.
|
|
1969
1992
|
* @returns Array of UV IDs of faces attached to the given vertex.
|
|
1970
1993
|
*/
|
|
1971
1994
|
GetVertexUVs(this: EditableMesh, vertexId: number): Array<unknown>;
|
|
1972
1995
|
/**
|
|
1973
|
-
* Returns all vertices as a list of
|
|
1996
|
+
* Returns all vertices as a list of vertex IDs.
|
|
1974
1997
|
*
|
|
1975
1998
|
* - **ThreadSafety**: Safe
|
|
1976
1999
|
*
|
|
1977
2000
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetVertices)
|
|
1978
2001
|
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1979
|
-
* @returns List of
|
|
2002
|
+
* @returns List of vertex IDs.
|
|
1980
2003
|
*/
|
|
1981
2004
|
GetVertices(this: EditableMesh): Array<number>;
|
|
1982
2005
|
/**
|
|
@@ -2032,7 +2055,7 @@ interface EditableMesh extends RBXObject {
|
|
|
2032
2055
|
*/
|
|
2033
2056
|
GetVerticesWithUV(this: EditableMesh, uvId: number): Array<unknown>;
|
|
2034
2057
|
/**
|
|
2035
|
-
* Returns a string describing
|
|
2058
|
+
* Returns a string describing an ID, useful for debugging purposes.
|
|
2036
2059
|
*
|
|
2037
2060
|
* - **ThreadSafety**: Unsafe
|
|
2038
2061
|
*
|
|
@@ -2054,6 +2077,8 @@ interface EditableMesh extends RBXObject {
|
|
|
2054
2077
|
*/
|
|
2055
2078
|
MergeVertices(this: EditableMesh, mergeTolerance: number): unknown;
|
|
2056
2079
|
/**
|
|
2080
|
+
* Casts a ray and returns the intersection point, face ID, and barycentric coordinates.
|
|
2081
|
+
*
|
|
2057
2082
|
* - **ThreadSafety**: Safe
|
|
2058
2083
|
*
|
|
2059
2084
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#RaycastLocal)
|
|
@@ -2068,23 +2093,23 @@ interface EditableMesh extends RBXObject {
|
|
|
2068
2093
|
Vector3
|
|
2069
2094
|
]>;
|
|
2070
2095
|
/**
|
|
2071
|
-
* Removes a bone using its
|
|
2096
|
+
* Removes a bone using its bone ID.
|
|
2072
2097
|
*
|
|
2073
2098
|
* - **ThreadSafety**: Unsafe
|
|
2074
2099
|
*
|
|
2075
2100
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#RemoveBone)
|
|
2076
2101
|
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
2077
|
-
* @param boneId
|
|
2102
|
+
* @param boneId Bone ID of the bone to remove.
|
|
2078
2103
|
*/
|
|
2079
2104
|
RemoveBone(this: EditableMesh, boneId: number): void;
|
|
2080
2105
|
/**
|
|
2081
|
-
* Removes a face using its
|
|
2106
|
+
* Removes a face using its face ID.
|
|
2082
2107
|
*
|
|
2083
2108
|
* - **ThreadSafety**: Unsafe
|
|
2084
2109
|
*
|
|
2085
2110
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#RemoveFace)
|
|
2086
2111
|
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
2087
|
-
* @param faceId
|
|
2112
|
+
* @param faceId Face ID of the face to remove.
|
|
2088
2113
|
*/
|
|
2089
2114
|
RemoveFace(this: EditableMesh, faceId: number): void;
|
|
2090
2115
|
/**
|
|
@@ -2094,7 +2119,7 @@ interface EditableMesh extends RBXObject {
|
|
|
2094
2119
|
*
|
|
2095
2120
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#RemoveUnused)
|
|
2096
2121
|
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
2097
|
-
* @returns All of the removed
|
|
2122
|
+
* @returns All of the removed IDs.
|
|
2098
2123
|
*/
|
|
2099
2124
|
RemoveUnused(this: EditableMesh): Array<unknown>;
|
|
2100
2125
|
/**
|
|
@@ -2104,7 +2129,7 @@ interface EditableMesh extends RBXObject {
|
|
|
2104
2129
|
*
|
|
2105
2130
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#ResetNormal)
|
|
2106
2131
|
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
2107
|
-
* @param normalId
|
|
2132
|
+
* @param normalId Normal ID to reset.
|
|
2108
2133
|
*/
|
|
2109
2134
|
ResetNormal(this: EditableMesh, normalId: number): void;
|
|
2110
2135
|
/**
|
|
@@ -2158,7 +2183,7 @@ interface EditableMesh extends RBXObject {
|
|
|
2158
2183
|
*
|
|
2159
2184
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#SetColor)
|
|
2160
2185
|
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
2161
|
-
* @param colorId
|
|
2186
|
+
* @param colorId Color ID for which to set the color.
|
|
2162
2187
|
* @param color Color to set.
|
|
2163
2188
|
*/
|
|
2164
2189
|
SetColor(this: EditableMesh, colorId: number, color: Color3): void;
|
|
@@ -2169,7 +2194,7 @@ interface EditableMesh extends RBXObject {
|
|
|
2169
2194
|
*
|
|
2170
2195
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#SetColorAlpha)
|
|
2171
2196
|
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
2172
|
-
* @param colorId
|
|
2197
|
+
* @param colorId Color ID for which to set the color alpha.
|
|
2173
2198
|
* @param alpha Alpha to set.
|
|
2174
2199
|
*/
|
|
2175
2200
|
SetColorAlpha(this: EditableMesh, colorId: number, alpha: number): void;
|
|
@@ -2182,7 +2207,7 @@ interface EditableMesh extends RBXObject {
|
|
|
2182
2207
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#SetFaceColors)
|
|
2183
2208
|
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
2184
2209
|
* @param faceId Face ID for which to update the vertex colors.
|
|
2185
|
-
* @param ids List of new
|
|
2210
|
+
* @param ids List of new color IDs to use for the given face's vertices.
|
|
2186
2211
|
*/
|
|
2187
2212
|
SetFaceColors(this: EditableMesh, faceId: number, ids: Array<unknown>): void;
|
|
2188
2213
|
/**
|
|
@@ -2194,7 +2219,7 @@ interface EditableMesh extends RBXObject {
|
|
|
2194
2219
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#SetFaceNormals)
|
|
2195
2220
|
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
2196
2221
|
* @param faceId Face ID for which to update the vertex normals.
|
|
2197
|
-
* @param ids List of new
|
|
2222
|
+
* @param ids List of new normal IDs to use for the given face's vertices.
|
|
2198
2223
|
*/
|
|
2199
2224
|
SetFaceNormals(this: EditableMesh, faceId: number, ids: Array<unknown>): void;
|
|
2200
2225
|
/**
|
|
@@ -2206,7 +2231,7 @@ interface EditableMesh extends RBXObject {
|
|
|
2206
2231
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#SetFaceUVs)
|
|
2207
2232
|
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
2208
2233
|
* @param faceId Face ID for which to update the vertex UVs.
|
|
2209
|
-
* @param ids List of new
|
|
2234
|
+
* @param ids List of new UV IDs to use for the given face's vertices.
|
|
2210
2235
|
*/
|
|
2211
2236
|
SetFaceUVs(this: EditableMesh, faceId: number, ids: Array<unknown>): void;
|
|
2212
2237
|
/**
|
|
@@ -2218,7 +2243,7 @@ interface EditableMesh extends RBXObject {
|
|
|
2218
2243
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#SetFaceVertices)
|
|
2219
2244
|
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
2220
2245
|
* @param faceId Face ID for which to update the vertices.
|
|
2221
|
-
* @param ids List of new
|
|
2246
|
+
* @param ids List of new vertex IDs to use for the given face.
|
|
2222
2247
|
*/
|
|
2223
2248
|
SetFaceVertices(this: EditableMesh, faceId: number, ids: Array<unknown>): void;
|
|
2224
2249
|
/**
|
|
@@ -2264,7 +2289,7 @@ interface EditableMesh extends RBXObject {
|
|
|
2264
2289
|
*
|
|
2265
2290
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#SetNormal)
|
|
2266
2291
|
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
2267
|
-
* @param normalId
|
|
2292
|
+
* @param normalId Normal ID for which to set the normal vector.
|
|
2268
2293
|
* @param normal Normal vector to set.
|
|
2269
2294
|
*/
|
|
2270
2295
|
SetNormal(this: EditableMesh, normalId: number, normal: Vector3): void;
|
|
@@ -2275,7 +2300,7 @@ interface EditableMesh extends RBXObject {
|
|
|
2275
2300
|
*
|
|
2276
2301
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#SetPosition)
|
|
2277
2302
|
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
2278
|
-
* @param vertexId
|
|
2303
|
+
* @param vertexId Vertex ID of the vertex to position.
|
|
2279
2304
|
* @param p Position in the mesh's local object space.
|
|
2280
2305
|
*/
|
|
2281
2306
|
SetPosition(this: EditableMesh, vertexId: number, p: Vector3): void;
|
|
@@ -2319,9 +2344,9 @@ interface EditableMesh extends RBXObject {
|
|
|
2319
2344
|
*
|
|
2320
2345
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#SetVertexFaceColor)
|
|
2321
2346
|
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
2322
|
-
* @param vertexId
|
|
2323
|
-
* @param faceId
|
|
2324
|
-
* @param colorId
|
|
2347
|
+
* @param vertexId Vertex ID.
|
|
2348
|
+
* @param faceId Face ID.
|
|
2349
|
+
* @param colorId Color ID to set for the vertex/face pair.
|
|
2325
2350
|
*/
|
|
2326
2351
|
SetVertexFaceColor(this: EditableMesh, vertexId: number, faceId: number, colorId: number): void;
|
|
2327
2352
|
/**
|
|
@@ -2331,9 +2356,9 @@ interface EditableMesh extends RBXObject {
|
|
|
2331
2356
|
*
|
|
2332
2357
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#SetVertexFaceNormal)
|
|
2333
2358
|
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
2334
|
-
* @param vertexId
|
|
2335
|
-
* @param faceId
|
|
2336
|
-
* @param normalId
|
|
2359
|
+
* @param vertexId Vertex ID.
|
|
2360
|
+
* @param faceId Face ID.
|
|
2361
|
+
* @param normalId Normal ID to set for the vertex/face pair.
|
|
2337
2362
|
*/
|
|
2338
2363
|
SetVertexFaceNormal(this: EditableMesh, vertexId: number, faceId: number, normalId: number): void;
|
|
2339
2364
|
/**
|
|
@@ -2343,9 +2368,9 @@ interface EditableMesh extends RBXObject {
|
|
|
2343
2368
|
*
|
|
2344
2369
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#SetVertexFaceUV)
|
|
2345
2370
|
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
2346
|
-
* @param vertexId
|
|
2347
|
-
* @param faceId
|
|
2348
|
-
* @param uvId
|
|
2371
|
+
* @param vertexId Vertex ID.
|
|
2372
|
+
* @param faceId Face ID.
|
|
2373
|
+
* @param uvId UV ID to set for the vertex/face pair.
|
|
2349
2374
|
*/
|
|
2350
2375
|
SetVertexFaceUV(this: EditableMesh, vertexId: number, faceId: number, uvId: number): void;
|
|
2351
2376
|
/**
|
|
@@ -3095,6 +3120,65 @@ interface ActivityHistoryEventService extends Instance {
|
|
|
3095
3120
|
*/
|
|
3096
3121
|
readonly _nominal_ActivityHistoryEventService: unique symbol;
|
|
3097
3122
|
}
|
|
3123
|
+
/**
|
|
3124
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AdPlacement)
|
|
3125
|
+
*/
|
|
3126
|
+
interface AdPlacement extends Instance {
|
|
3127
|
+
/**
|
|
3128
|
+
* **DO NOT USE!**
|
|
3129
|
+
*
|
|
3130
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
3131
|
+
* @hidden
|
|
3132
|
+
* @deprecated
|
|
3133
|
+
*/
|
|
3134
|
+
readonly _nominal_AdPlacement: unique symbol;
|
|
3135
|
+
/**
|
|
3136
|
+
* - **ThreadSafety**: ReadSafe
|
|
3137
|
+
*
|
|
3138
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AdPlacement#ActivationInstance)
|
|
3139
|
+
*/
|
|
3140
|
+
ActivationInstance: Instance | undefined;
|
|
3141
|
+
/**
|
|
3142
|
+
* - **ThreadSafety**: ReadSafe
|
|
3143
|
+
*
|
|
3144
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AdPlacement#AdFormat)
|
|
3145
|
+
*/
|
|
3146
|
+
AdFormat: Enum.AdFormat;
|
|
3147
|
+
/**
|
|
3148
|
+
* - **ThreadSafety**: ReadSafe
|
|
3149
|
+
*
|
|
3150
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AdPlacement#PlacementId)
|
|
3151
|
+
*/
|
|
3152
|
+
PlacementId: number;
|
|
3153
|
+
/**
|
|
3154
|
+
* - **ThreadSafety**: ReadSafe
|
|
3155
|
+
* - **Tags**: NotReplicated
|
|
3156
|
+
*
|
|
3157
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AdPlacement#RewardId)
|
|
3158
|
+
*/
|
|
3159
|
+
readonly RewardId: string;
|
|
3160
|
+
/**
|
|
3161
|
+
* - **ThreadSafety**: ReadSafe
|
|
3162
|
+
* - **Tags**: NotReplicated
|
|
3163
|
+
*
|
|
3164
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AdPlacement#RewardImageContent)
|
|
3165
|
+
*/
|
|
3166
|
+
readonly RewardImageContent: Content;
|
|
3167
|
+
/**
|
|
3168
|
+
* - **ThreadSafety**: ReadSafe
|
|
3169
|
+
* - **Tags**: NotReplicated
|
|
3170
|
+
*
|
|
3171
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AdPlacement#RewardName)
|
|
3172
|
+
*/
|
|
3173
|
+
readonly RewardName: string;
|
|
3174
|
+
/**
|
|
3175
|
+
* - **ThreadSafety**: ReadSafe
|
|
3176
|
+
* - **Tags**: NotReplicated
|
|
3177
|
+
*
|
|
3178
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AdPlacement#Visible)
|
|
3179
|
+
*/
|
|
3180
|
+
readonly Visible: boolean;
|
|
3181
|
+
}
|
|
3098
3182
|
/**
|
|
3099
3183
|
* A portal that teleports players to a sponsored experience as part of immersive ads.
|
|
3100
3184
|
*
|
|
@@ -4746,10 +4830,20 @@ interface AssetService extends Instance {
|
|
|
4746
4830
|
*/
|
|
4747
4831
|
CreateDataModelContentAsync(this: AssetService, content: Content, options?: object): unknown;
|
|
4748
4832
|
/**
|
|
4833
|
+
* Creates a new `Decal` object using the provided `EditableImage` content maps.
|
|
4834
|
+
*
|
|
4749
4835
|
* - **ThreadSafety**: Unsafe
|
|
4750
4836
|
* - **Tags**: Yields
|
|
4751
4837
|
*
|
|
4752
4838
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AssetService#CreateDecalAsync)
|
|
4839
|
+
* @param this A non-replicated service that handles asset-related queries to the Roblox web API.
|
|
4840
|
+
* @param content Dictionary containing one or more of the following key-value pairs. Each value must be a `Content` object containing a `EditableImage`: - `TextureContent` — The decal's color texture.
|
|
4841
|
+
* - `NormalMapContent` — The decal's normal map.
|
|
4842
|
+
* - `MetalnessMapContent` — The decal's metalness map.
|
|
4843
|
+
* - `RoughnessMapContent` — The decal's roughness map.
|
|
4844
|
+
*
|
|
4845
|
+
*
|
|
4846
|
+
* @returns A new `Decal` instance with the given maps from the `content` parameter.
|
|
4753
4847
|
*/
|
|
4754
4848
|
CreateDecalAsync(this: AssetService, content: object): Decal;
|
|
4755
4849
|
/**
|
|
@@ -4961,10 +5055,17 @@ interface AssetService extends Instance {
|
|
|
4961
5055
|
*/
|
|
4962
5056
|
LoadAssetAsync(this: AssetService, assetId: number): Instance | undefined;
|
|
4963
5057
|
/**
|
|
5058
|
+
* Allows in-experience asset creation for users by prompting a publish dialog.
|
|
5059
|
+
*
|
|
4964
5060
|
* - **ThreadSafety**: Unsafe
|
|
4965
5061
|
* - **Tags**: Yields
|
|
4966
5062
|
*
|
|
4967
5063
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AssetService#PromptCreatePlatformContentAsync)
|
|
5064
|
+
* @param this A non-replicated service that handles asset-related queries to the Roblox web API.
|
|
5065
|
+
* @param player The user who submits an asset creation.
|
|
5066
|
+
* @param object The asset to be created. Currently can't contain scripts or nest non-public assets.
|
|
5067
|
+
* @param assetType The asset type. Currently can only be `AssetType.Model`.
|
|
5068
|
+
* @returns The `PromptCreatePlatformContentResult` and asset ID pair if successful.
|
|
4968
5069
|
*/
|
|
4969
5070
|
PromptCreatePlatformContentAsync(this: AssetService, player: Player, object: RBXObject, assetType: CastsToEnum<Enum.AssetType>): unknown;
|
|
4970
5071
|
/**
|
|
@@ -6123,8 +6224,6 @@ interface AudioEmitter extends Instance {
|
|
|
6123
6224
|
*/
|
|
6124
6225
|
AudioInteractionGroup: string;
|
|
6125
6226
|
/**
|
|
6126
|
-
* Controls whether sound from this `AudioEmitter` bends around corners when acoustic simulation is active.
|
|
6127
|
-
*
|
|
6128
6227
|
* - **ThreadSafety**: ReadSafe
|
|
6129
6228
|
*
|
|
6130
6229
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioEmitter#DiffractionEnabled)
|
|
@@ -6147,8 +6246,6 @@ interface AudioEmitter extends Instance {
|
|
|
6147
6246
|
*/
|
|
6148
6247
|
DistanceAttenuationMode: Enum.DistanceAttenuationMode;
|
|
6149
6248
|
/**
|
|
6150
|
-
* Controls whether sound from this `AudioEmitter` is muffled when obstructed by geometry.
|
|
6151
|
-
*
|
|
6152
6249
|
* - **ThreadSafety**: ReadSafe
|
|
6153
6250
|
*
|
|
6154
6251
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioEmitter#OcclusionEnabled)
|
|
@@ -6171,8 +6268,6 @@ interface AudioEmitter extends Instance {
|
|
|
6171
6268
|
*/
|
|
6172
6269
|
PositionType: Enum.EmitterPositionType;
|
|
6173
6270
|
/**
|
|
6174
|
-
* Controls whether sound from this `AudioEmitter` receives environmental reverb when acoustic simulation is active.
|
|
6175
|
-
*
|
|
6176
6271
|
* - **ThreadSafety**: ReadSafe
|
|
6177
6272
|
*
|
|
6178
6273
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioEmitter#ReverbEnabled)
|
|
@@ -6861,16 +6956,12 @@ interface AudioListener extends Instance {
|
|
|
6861
6956
|
*/
|
|
6862
6957
|
AudioInteractionGroup: string;
|
|
6863
6958
|
/**
|
|
6864
|
-
* Controls whether sound heard by this `AudioListener` bends around corners when acoustic simulation is active.
|
|
6865
|
-
*
|
|
6866
6959
|
* - **ThreadSafety**: ReadSafe
|
|
6867
6960
|
*
|
|
6868
6961
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioListener#DiffractionEnabled)
|
|
6869
6962
|
*/
|
|
6870
6963
|
DiffractionEnabled: Enum.SimulationMode;
|
|
6871
6964
|
/**
|
|
6872
|
-
* Controls whether sound heard by this `AudioListener` is muffled when obstructed by geometry.
|
|
6873
|
-
*
|
|
6874
6965
|
* - **ThreadSafety**: ReadSafe
|
|
6875
6966
|
*
|
|
6876
6967
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioListener#OcclusionEnabled)
|
|
@@ -6893,8 +6984,6 @@ interface AudioListener extends Instance {
|
|
|
6893
6984
|
*/
|
|
6894
6985
|
PositionType: Enum.ListenerPositionType;
|
|
6895
6986
|
/**
|
|
6896
|
-
* Controls whether sound heard by this `AudioListener` receives environmental reverb when acoustic simulation is active.
|
|
6897
|
-
*
|
|
6898
6987
|
* - **ThreadSafety**: ReadSafe
|
|
6899
6988
|
*
|
|
6900
6989
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioListener#ReverbEnabled)
|
|
@@ -7810,6 +7899,12 @@ interface AudioTextToSpeech extends Instance {
|
|
|
7810
7899
|
* @deprecated
|
|
7811
7900
|
*/
|
|
7812
7901
|
readonly _nominal_AudioTextToSpeech: unique symbol;
|
|
7902
|
+
/**
|
|
7903
|
+
* - **ThreadSafety**: ReadSafe
|
|
7904
|
+
*
|
|
7905
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioTextToSpeech#AutoLocalize)
|
|
7906
|
+
*/
|
|
7907
|
+
AutoLocalize: boolean;
|
|
7813
7908
|
/**
|
|
7814
7909
|
* Denotes whether the `AudioTextToSpeech` object is loaded, buffered, and ready to play.
|
|
7815
7910
|
*
|
|
@@ -8757,6 +8852,8 @@ interface AvatarCreationService extends Instance {
|
|
|
8757
8852
|
*/
|
|
8758
8853
|
readonly AvatarModerationCompleted: RBXScriptSignal<(outfitId: number, moderationStatus: Enum.ModerationStatus) => void>;
|
|
8759
8854
|
/**
|
|
8855
|
+
* Fires on the client when moderation completes for an in-experience-created outfit.
|
|
8856
|
+
*
|
|
8760
8857
|
* - **ThreadSafety**: Unsafe
|
|
8761
8858
|
*
|
|
8762
8859
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AvatarCreationService#AvatarOutfitModerationCompleted)
|
|
@@ -9507,6 +9604,8 @@ interface BadgeService extends Instance {
|
|
|
9507
9604
|
UserHasBadgeAsync(this: BadgeService, userId: number, badgeId: number): boolean;
|
|
9508
9605
|
}
|
|
9509
9606
|
/**
|
|
9607
|
+
* Base class for the configuration objects that control individual built-in `CoreGui` elements.
|
|
9608
|
+
*
|
|
9510
9609
|
* - **Tags**: NotCreatable, NotReplicated
|
|
9511
9610
|
*
|
|
9512
9611
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/BaseCoreGuiConfiguration)
|
|
@@ -9521,6 +9620,8 @@ interface BaseCoreGuiConfiguration extends Instance {
|
|
|
9521
9620
|
*/
|
|
9522
9621
|
readonly _nominal_BaseCoreGuiConfiguration: unique symbol;
|
|
9523
9622
|
/**
|
|
9623
|
+
* Determines whether the built-in `CoreGui` element controlled by this configuration object is enabled.
|
|
9624
|
+
*
|
|
9524
9625
|
* - **ThreadSafety**: ReadSafe
|
|
9525
9626
|
*
|
|
9526
9627
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/BaseCoreGuiConfiguration#Enabled)
|
|
@@ -9528,6 +9629,8 @@ interface BaseCoreGuiConfiguration extends Instance {
|
|
|
9528
9629
|
Enabled: boolean;
|
|
9529
9630
|
}
|
|
9530
9631
|
/**
|
|
9632
|
+
* Controls the built-in captures view, the `CoreGui` element that lets players browse and manage screenshots and video captures they take within an experience.
|
|
9633
|
+
*
|
|
9531
9634
|
* - **Tags**: NotCreatable, NotReplicated
|
|
9532
9635
|
*
|
|
9533
9636
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CapturesViewConfiguration)
|
|
@@ -9542,6 +9645,8 @@ interface CapturesViewConfiguration extends BaseCoreGuiConfiguration {
|
|
|
9542
9645
|
*/
|
|
9543
9646
|
readonly _nominal_CapturesViewConfiguration: unique symbol;
|
|
9544
9647
|
/**
|
|
9648
|
+
* Determines whether the built-in captures view is currently open.
|
|
9649
|
+
*
|
|
9545
9650
|
* - **ThreadSafety**: ReadSafe
|
|
9546
9651
|
*
|
|
9547
9652
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CapturesViewConfiguration#Open)
|
|
@@ -9549,6 +9654,8 @@ interface CapturesViewConfiguration extends BaseCoreGuiConfiguration {
|
|
|
9549
9654
|
Open: boolean;
|
|
9550
9655
|
}
|
|
9551
9656
|
/**
|
|
9657
|
+
* Controls the built-in player list, the `CoreGui` element that displays the players currently in the experience.
|
|
9658
|
+
*
|
|
9552
9659
|
* - **Tags**: NotCreatable, NotReplicated
|
|
9553
9660
|
*
|
|
9554
9661
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PlayerListConfiguration)
|
|
@@ -9563,6 +9670,8 @@ interface PlayerListConfiguration extends BaseCoreGuiConfiguration {
|
|
|
9563
9670
|
*/
|
|
9564
9671
|
readonly _nominal_PlayerListConfiguration: unique symbol;
|
|
9565
9672
|
/**
|
|
9673
|
+
* Determines whether the built-in player list is currently open.
|
|
9674
|
+
*
|
|
9566
9675
|
* - **ThreadSafety**: ReadSafe
|
|
9567
9676
|
*
|
|
9568
9677
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PlayerListConfiguration#Open)
|
|
@@ -9570,6 +9679,8 @@ interface PlayerListConfiguration extends BaseCoreGuiConfiguration {
|
|
|
9570
9679
|
Open: boolean;
|
|
9571
9680
|
}
|
|
9572
9681
|
/**
|
|
9682
|
+
* Controls the built-in self view, the `CoreGui` element that shows a player a preview of their own character within an experience.
|
|
9683
|
+
*
|
|
9573
9684
|
* - **Tags**: NotCreatable, NotReplicated
|
|
9574
9685
|
*
|
|
9575
9686
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SelfViewConfiguration)
|
|
@@ -9584,6 +9695,8 @@ interface SelfViewConfiguration extends BaseCoreGuiConfiguration {
|
|
|
9584
9695
|
*/
|
|
9585
9696
|
readonly _nominal_SelfViewConfiguration: unique symbol;
|
|
9586
9697
|
/**
|
|
9698
|
+
* Determines whether the built-in self view is currently open.
|
|
9699
|
+
*
|
|
9587
9700
|
* - **ThreadSafety**: ReadSafe
|
|
9588
9701
|
*
|
|
9589
9702
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SelfViewConfiguration#Open)
|
|
@@ -10727,17 +10840,32 @@ interface WrapTarget extends BaseWrap {
|
|
|
10727
10840
|
*/
|
|
10728
10841
|
get Stiffness(): number;
|
|
10729
10842
|
/**
|
|
10843
|
+
* Creates a new `EditableImage` in cage UV space from a texture in the parent `MeshPart`'s UV space.
|
|
10844
|
+
*
|
|
10730
10845
|
* - **ThreadSafety**: Unsafe
|
|
10731
10846
|
* - **Tags**: Yields
|
|
10732
10847
|
*
|
|
10733
10848
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/WrapTarget#CreateTextureInCageSpaceAsync)
|
|
10849
|
+
* @param this The WrapTarget object defines a target. A target is the 3D body with only an outer surface, or an Outer Cage.
|
|
10850
|
+
* @param texture The `EditableImage` in the UV space of this `WrapTarget`'s parent `MeshPart`.
|
|
10851
|
+
* @param options Optional dictionary containing controls for the transfer: - `MinUVBounds` – A `Vector2` specifying the minimum cage UV bound.
|
|
10852
|
+
* - `MaxUVBounds` – A `Vector2` specifying the maximum cage UV bound.
|
|
10853
|
+
*
|
|
10854
|
+
* Each omitted bound is calculated from the cage mesh. If neither is specified, the bounds include the entire cage.
|
|
10855
|
+
* @returns A new `EditableImage` in cage UV space, or `nil` if the device-specific editable memory budget is exhausted.
|
|
10734
10856
|
*/
|
|
10735
10857
|
CreateTextureInCageSpaceAsync(this: WrapTarget, texture: EditableImage, options?: object): EditableImage;
|
|
10736
10858
|
/**
|
|
10859
|
+
* Creates a new `EditableImage` in the parent `MeshPart`'s UV space from a texture in cage UV space.
|
|
10860
|
+
*
|
|
10737
10861
|
* - **ThreadSafety**: Unsafe
|
|
10738
10862
|
* - **Tags**: Yields
|
|
10739
10863
|
*
|
|
10740
10864
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/WrapTarget#CreateTextureInTargetSpaceAsync)
|
|
10865
|
+
* @param this The WrapTarget object defines a target. A target is the 3D body with only an outer surface, or an Outer Cage.
|
|
10866
|
+
* @param texture The `EditableImage` in cage UV space.
|
|
10867
|
+
* @param wrapTextureTransfer The `WrapTextureTransfer` associated with the same parent `MeshPart` as this `WrapTarget`.
|
|
10868
|
+
* @returns A new `EditableImage` in the parent `MeshPart`'s UV space, or `nil` if the device-specific editable memory budget is exhausted.
|
|
10741
10869
|
*/
|
|
10742
10870
|
CreateTextureInTargetSpaceAsync(this: WrapTarget, texture: EditableImage, wrapTextureTransfer: WrapTextureTransfer): EditableImage;
|
|
10743
10871
|
}
|
|
@@ -10861,6 +10989,8 @@ interface Beam extends Instance {
|
|
|
10861
10989
|
*/
|
|
10862
10990
|
Texture: ContentId;
|
|
10863
10991
|
/**
|
|
10992
|
+
* The texture displayed on the beam. Supports [asset URIs](../../../projects/assets/index.md#asset-uris).
|
|
10993
|
+
*
|
|
10864
10994
|
* - **ThreadSafety**: ReadSafe
|
|
10865
10995
|
*
|
|
10866
10996
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Beam#TextureContent)
|
|
@@ -12124,7 +12254,7 @@ interface Pants extends Clothing {
|
|
|
12124
12254
|
*/
|
|
12125
12255
|
PantsTemplate: ContentId;
|
|
12126
12256
|
/**
|
|
12127
|
-
*
|
|
12257
|
+
* Specifies the asset URI of the pants texture.
|
|
12128
12258
|
*
|
|
12129
12259
|
* - **ThreadSafety**: ReadSafe
|
|
12130
12260
|
*
|
|
@@ -12155,7 +12285,7 @@ interface Shirt extends Clothing {
|
|
|
12155
12285
|
*/
|
|
12156
12286
|
ShirtTemplate: ContentId;
|
|
12157
12287
|
/**
|
|
12158
|
-
*
|
|
12288
|
+
* Specifies the asset URI of the shirt texture.
|
|
12159
12289
|
*
|
|
12160
12290
|
* - **ThreadSafety**: ReadSafe
|
|
12161
12291
|
*
|
|
@@ -12194,7 +12324,7 @@ interface ShirtGraphic extends CharacterAppearance {
|
|
|
12194
12324
|
*/
|
|
12195
12325
|
Graphic: ContentId;
|
|
12196
12326
|
/**
|
|
12197
|
-
*
|
|
12327
|
+
* Specifies the asset URI of the t-shirt texture.
|
|
12198
12328
|
*
|
|
12199
12329
|
* - **ThreadSafety**: ReadSafe
|
|
12200
12330
|
*
|
|
@@ -15540,8 +15670,8 @@ interface Controller extends Instance {
|
|
|
15540
15670
|
*
|
|
15541
15671
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Controller#BindButton)
|
|
15542
15672
|
* @param this The base class for controller objects, such as the `HumanoidController` object.
|
|
15543
|
-
* @param button
|
|
15544
|
-
* @param caption
|
|
15673
|
+
* @param button The `Button` to bind.
|
|
15674
|
+
* @param caption The text to display for the bound button.
|
|
15545
15675
|
*/
|
|
15546
15676
|
BindButton(this: Controller, button: CastsToEnum<Enum.Button>, caption: string): void;
|
|
15547
15677
|
/**
|
|
@@ -15551,7 +15681,8 @@ interface Controller extends Instance {
|
|
|
15551
15681
|
*
|
|
15552
15682
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Controller#GetButton)
|
|
15553
15683
|
* @param this The base class for controller objects, such as the `HumanoidController` object.
|
|
15554
|
-
* @param button
|
|
15684
|
+
* @param button The `Button` whose pressed state to check.
|
|
15685
|
+
* @returns Whether the specified button is currently pressed.
|
|
15555
15686
|
*/
|
|
15556
15687
|
GetButton(this: Controller, button: CastsToEnum<Enum.Button>): boolean;
|
|
15557
15688
|
/**
|
|
@@ -15561,7 +15692,7 @@ interface Controller extends Instance {
|
|
|
15561
15692
|
*
|
|
15562
15693
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Controller#UnbindButton)
|
|
15563
15694
|
* @param this The base class for controller objects, such as the `HumanoidController` object.
|
|
15564
|
-
* @param button
|
|
15695
|
+
* @param button The `Button` to unbind.
|
|
15565
15696
|
*/
|
|
15566
15697
|
UnbindButton(this: Controller, button: CastsToEnum<Enum.Button>): void;
|
|
15567
15698
|
/**
|
|
@@ -15574,6 +15705,8 @@ interface Controller extends Instance {
|
|
|
15574
15705
|
readonly ButtonChanged: RBXScriptSignal<(button: Enum.Button) => void>;
|
|
15575
15706
|
}
|
|
15576
15707
|
/**
|
|
15708
|
+
* A `Controller` held within `ControllerService` that translates player input into movement for the user's character `Humanoid`.
|
|
15709
|
+
*
|
|
15577
15710
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidController)
|
|
15578
15711
|
*/
|
|
15579
15712
|
interface HumanoidController extends Controller {
|
|
@@ -15587,6 +15720,8 @@ interface HumanoidController extends Controller {
|
|
|
15587
15720
|
readonly _nominal_HumanoidController: unique symbol;
|
|
15588
15721
|
}
|
|
15589
15722
|
/**
|
|
15723
|
+
* Translates player input into throttle and steer axis values for a `SkateboardPlatform`.
|
|
15724
|
+
*
|
|
15590
15725
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SkateboardController)
|
|
15591
15726
|
*/
|
|
15592
15727
|
interface SkateboardController extends Controller {
|
|
@@ -15626,6 +15761,8 @@ interface SkateboardController extends Controller {
|
|
|
15626
15761
|
readonly AxisChanged: RBXScriptSignal<(axis: string) => void>;
|
|
15627
15762
|
}
|
|
15628
15763
|
/**
|
|
15764
|
+
* An object responsible for translating a seated player's directional input into throttle and steering for a `VehicleSeat`.
|
|
15765
|
+
*
|
|
15629
15766
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VehicleController)
|
|
15630
15767
|
*/
|
|
15631
15768
|
interface VehicleController extends Controller {
|
|
@@ -18277,6 +18414,21 @@ interface Explosion extends Instance {
|
|
|
18277
18414
|
*/
|
|
18278
18415
|
readonly Hit: RBXScriptSignal<(part: BasePart, distance: number) => void>;
|
|
18279
18416
|
}
|
|
18417
|
+
/**
|
|
18418
|
+
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
18419
|
+
*
|
|
18420
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ExternalIdentityService)
|
|
18421
|
+
*/
|
|
18422
|
+
interface ExternalIdentityService extends Instance {
|
|
18423
|
+
/**
|
|
18424
|
+
* **DO NOT USE!**
|
|
18425
|
+
*
|
|
18426
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
18427
|
+
* @hidden
|
|
18428
|
+
* @deprecated
|
|
18429
|
+
*/
|
|
18430
|
+
readonly _nominal_ExternalIdentityService: unique symbol;
|
|
18431
|
+
}
|
|
18280
18432
|
/**
|
|
18281
18433
|
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
18282
18434
|
*
|
|
@@ -20222,6 +20374,7 @@ interface GroupService extends Instance {
|
|
|
20222
20374
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GroupService#GetAlliesAsync)
|
|
20223
20375
|
* @param this GroupService is a service that allows developers to fetch information about a Roblox group from within a game.
|
|
20224
20376
|
* @param groupId The group's ID.
|
|
20377
|
+
* @returns A `StandardPages` object containing group information tables for each of the specified group's allies.
|
|
20225
20378
|
*/
|
|
20226
20379
|
GetAlliesAsync(this: GroupService, groupId: number): StandardPages<GroupInfo>;
|
|
20227
20380
|
/**
|
|
@@ -20233,6 +20386,7 @@ interface GroupService extends Instance {
|
|
|
20233
20386
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GroupService#GetEnemiesAsync)
|
|
20234
20387
|
* @param this GroupService is a service that allows developers to fetch information about a Roblox group from within a game.
|
|
20235
20388
|
* @param groupId The group's ID.
|
|
20389
|
+
* @returns A `StandardPages` object containing group information tables for each of the specified group's enemies.
|
|
20236
20390
|
*/
|
|
20237
20391
|
GetEnemiesAsync(this: GroupService, groupId: number): StandardPages<GroupInfo>;
|
|
20238
20392
|
/**
|
|
@@ -20269,7 +20423,7 @@ interface GroupService extends Instance {
|
|
|
20269
20423
|
* @param this GroupService is a service that allows developers to fetch information about a Roblox group from within a game.
|
|
20270
20424
|
* @param userId The user's ID.
|
|
20271
20425
|
* @param groupId The group's ID.
|
|
20272
|
-
* @returns A table with two fields: `IsMember` (boolean) and `Roles` (array of public role tables). Each role table contains `Id` (
|
|
20426
|
+
* @returns A table with two fields: `IsMember` (boolean) and `Roles` (array of public role tables). Each role table contains `Id` (integer), `Name` (string), and `Rank` (integer). The array is ordered from highest to lowest role.
|
|
20273
20427
|
*/
|
|
20274
20428
|
GetRolesInGroupAsync(this: GroupService, userId: User, groupId: number): unknown;
|
|
20275
20429
|
/**
|
|
@@ -20688,6 +20842,8 @@ interface GuiObject extends GuiBase2d {
|
|
|
20688
20842
|
*/
|
|
20689
20843
|
SizeConstraint: Enum.SizeConstraint;
|
|
20690
20844
|
/**
|
|
20845
|
+
* **Deprecated:** This property is deprecated and indexing it will return `BackgroundTransparency`.
|
|
20846
|
+
*
|
|
20691
20847
|
* A mixed property of `BackgroundTransparency` and `TextTransparency`.
|
|
20692
20848
|
*
|
|
20693
20849
|
* - **ThreadSafety**: ReadSafe
|
|
@@ -20715,8 +20871,14 @@ interface GuiObject extends GuiBase2d {
|
|
|
20715
20871
|
*/
|
|
20716
20872
|
ZIndex: number;
|
|
20717
20873
|
/**
|
|
20874
|
+
* **Deprecated:** This function is deprecated in favor of using `TweenService`, which allows for better customization using an object-oriented and event-based approach. - The `easingDirection`, `easingStyle`, and `time` parameters are handled by a `TweenInfo`
|
|
20875
|
+
* - The `override` parameter is no longer relevant; tweens always override previous tweens on the same property.
|
|
20876
|
+
* - The `callback` parameter is better suited by the `Tween.Completed` event. The `PlaybackState` enum passed by that event provides a more detailed description of the tween's completion state.
|
|
20877
|
+
*
|
|
20718
20878
|
* Smoothly moves a GUI to a new `UDim2`.
|
|
20719
20879
|
*
|
|
20880
|
+
*
|
|
20881
|
+
*
|
|
20720
20882
|
* - **ThreadSafety**: Unsafe
|
|
20721
20883
|
* - **Tags**:
|
|
20722
20884
|
*
|
|
@@ -20734,8 +20896,14 @@ interface GuiObject extends GuiBase2d {
|
|
|
20734
20896
|
*/
|
|
20735
20897
|
TweenPosition(this: GuiObject, endPosition: UDim2, easingDirection?: CastsToEnum<Enum.EasingDirection>, easingStyle?: CastsToEnum<Enum.EasingStyle>, time?: number, override?: boolean, callback?: (finishedTween: Enum.TweenStatus) => void): boolean;
|
|
20736
20898
|
/**
|
|
20899
|
+
* **Deprecated:** This function is deprecated in favor of using `TweenService`, which allows for better customization using an object-oriented and event-based approach. - The `easingDirection`, `easingStyle`, and `time` parameters are handled by a `TweenInfo`
|
|
20900
|
+
* - The `override` parameter is no longer relevant; tweens always override previous tweens on the same property.
|
|
20901
|
+
* - The `callback` parameter is better suited by the `Tween.Completed` event. The `PlaybackState` enum passed by that event provides a more detailed description of the tween's completion state.
|
|
20902
|
+
*
|
|
20737
20903
|
* Smoothly resizes a `GuiObject` to a new `UDim2`.
|
|
20738
20904
|
*
|
|
20905
|
+
*
|
|
20906
|
+
*
|
|
20739
20907
|
* - **ThreadSafety**: Unsafe
|
|
20740
20908
|
* - **Tags**:
|
|
20741
20909
|
*
|
|
@@ -20753,8 +20921,14 @@ interface GuiObject extends GuiBase2d {
|
|
|
20753
20921
|
*/
|
|
20754
20922
|
TweenSize(this: GuiObject, endSize: UDim2, easingDirection?: CastsToEnum<Enum.EasingDirection>, easingStyle?: CastsToEnum<Enum.EasingStyle>, time?: number, override?: boolean, callback?: (finishedTween: Enum.TweenStatus) => void): boolean;
|
|
20755
20923
|
/**
|
|
20924
|
+
* **Deprecated:** This function is deprecated in favor of using `TweenService`, which allows for better customization using an object-oriented and event-based approach. - The `easingDirection`, `easingStyle`, and `time` parameters are handled by a `TweenInfo`
|
|
20925
|
+
* - The `override` parameter is no longer relevant; tweens always override previous tweens on the same property.
|
|
20926
|
+
* - The `callback` parameter is better suited by the `Tween.Completed` event. The `PlaybackState` enum passed by that event provides a more detailed description of the tween's completion state.
|
|
20927
|
+
*
|
|
20756
20928
|
* Smoothly moves a GUI to a new size and position.
|
|
20757
20929
|
*
|
|
20930
|
+
*
|
|
20931
|
+
*
|
|
20758
20932
|
* - **ThreadSafety**: Unsafe
|
|
20759
20933
|
* - **Tags**:
|
|
20760
20934
|
*
|
|
@@ -25210,6 +25384,8 @@ interface HeatmapService extends Instance {
|
|
|
25210
25384
|
readonly _nominal_HeatmapService: unique symbol;
|
|
25211
25385
|
}
|
|
25212
25386
|
/**
|
|
25387
|
+
* A Studio-only service that backs the Terrain Editor's heightmap import tool, converting heightmap and colormap images into voxel `Terrain`.
|
|
25388
|
+
*
|
|
25213
25389
|
* - **Tags**: Service, NotReplicated
|
|
25214
25390
|
*
|
|
25215
25391
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HeightmapImporterService)
|
|
@@ -28159,6 +28335,12 @@ interface InputAction extends Instance {
|
|
|
28159
28335
|
* @deprecated
|
|
28160
28336
|
*/
|
|
28161
28337
|
readonly _nominal_InputAction: unique symbol;
|
|
28338
|
+
/**
|
|
28339
|
+
* - **ThreadSafety**: ReadSafe
|
|
28340
|
+
*
|
|
28341
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputAction#DisplayName)
|
|
28342
|
+
*/
|
|
28343
|
+
DisplayName: string;
|
|
28162
28344
|
/**
|
|
28163
28345
|
* Determines if the `InputAction` is enabled or not.
|
|
28164
28346
|
*
|
|
@@ -29901,7 +30083,7 @@ interface Lighting extends Instance {
|
|
|
29901
30083
|
*
|
|
29902
30084
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Lighting#LightingStyle)
|
|
29903
30085
|
*/
|
|
29904
|
-
|
|
30086
|
+
LightingStyle: Enum.LightingStyle;
|
|
29905
30087
|
/**
|
|
29906
30088
|
* The lighting hue applied to outdoor areas.
|
|
29907
30089
|
*
|
|
@@ -29930,7 +30112,7 @@ interface Lighting extends Instance {
|
|
|
29930
30112
|
*
|
|
29931
30113
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Lighting#PrioritizeLightingQuality)
|
|
29932
30114
|
*/
|
|
29933
|
-
|
|
30115
|
+
PrioritizeLightingQuality: boolean;
|
|
29934
30116
|
/**
|
|
29935
30117
|
* **Deprecated:** This item is deprecated and has no current functionality. Do not use it for new work.
|
|
29936
30118
|
*
|
|
@@ -30141,11 +30323,14 @@ interface LocalizationService extends Instance {
|
|
|
30141
30323
|
* Returns a `Translator` to be used for translations using the locale data loaded.
|
|
30142
30324
|
*
|
|
30143
30325
|
* - **ThreadSafety**: Unsafe
|
|
30326
|
+
* - **Tags**:
|
|
30144
30327
|
*
|
|
30145
30328
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/LocalizationService#GetTranslatorForPlayer)
|
|
30146
30329
|
* @param this Handles automated translation.
|
|
30147
30330
|
* @param player The `Player` that you are getting the `Translator` for.
|
|
30148
30331
|
* @returns The `Translator` instance for the specified locale.
|
|
30332
|
+
*
|
|
30333
|
+
* @deprecated GetTranslatorForPlayerAsync
|
|
30149
30334
|
*/
|
|
30150
30335
|
GetTranslatorForPlayer(this: LocalizationService, player: Player): Translator;
|
|
30151
30336
|
/**
|
|
@@ -31097,9 +31282,13 @@ interface MarketplaceService extends Instance {
|
|
|
31097
31282
|
*/
|
|
31098
31283
|
BindReceiptHandler(this: MarketplaceService, transactionType: CastsToEnum<Enum.ReceiptType>, handler: Callback, filter?: Array<unknown>): RBXScriptConnection;
|
|
31099
31284
|
/**
|
|
31285
|
+
* Opens a personalized in-game Shop for the given player.
|
|
31286
|
+
*
|
|
31100
31287
|
* - **ThreadSafety**: Unsafe
|
|
31101
31288
|
*
|
|
31102
31289
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MarketplaceService#OpenShop)
|
|
31290
|
+
* @param this The service responsible for in-experience transactions.
|
|
31291
|
+
* @param player The `Player` for whom to open the shop. If called from a `LocalScript`, this must be the local player.
|
|
31103
31292
|
*/
|
|
31104
31293
|
OpenShop(this: MarketplaceService, player: Player): void;
|
|
31105
31294
|
/**
|
|
@@ -31128,8 +31317,8 @@ interface MarketplaceService extends Instance {
|
|
|
31128
31317
|
*
|
|
31129
31318
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MarketplaceService#PromptBundlePurchase)
|
|
31130
31319
|
* @param this The service responsible for in-experience transactions.
|
|
31131
|
-
* @param player
|
|
31132
|
-
* @param bundleId
|
|
31320
|
+
* @param player The `Player` to prompt.
|
|
31321
|
+
* @param bundleId The ID of the bundle to purchase.
|
|
31133
31322
|
*/
|
|
31134
31323
|
PromptBundlePurchase(this: MarketplaceService, player: Player, bundleId: number): void;
|
|
31135
31324
|
/**
|
|
@@ -31139,8 +31328,8 @@ interface MarketplaceService extends Instance {
|
|
|
31139
31328
|
*
|
|
31140
31329
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MarketplaceService#PromptCancelSubscription)
|
|
31141
31330
|
* @param this The service responsible for in-experience transactions.
|
|
31142
|
-
* @param user
|
|
31143
|
-
* @param subscriptionId
|
|
31331
|
+
* @param user The `Player` to prompt.
|
|
31332
|
+
* @param subscriptionId The ID of the subscription to cancel.
|
|
31144
31333
|
*/
|
|
31145
31334
|
PromptCancelSubscription(this: MarketplaceService, user: Player, subscriptionId: string): void;
|
|
31146
31335
|
/**
|
|
@@ -31150,8 +31339,8 @@ interface MarketplaceService extends Instance {
|
|
|
31150
31339
|
*
|
|
31151
31340
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MarketplaceService#PromptGamePassPurchase)
|
|
31152
31341
|
* @param this The service responsible for in-experience transactions.
|
|
31153
|
-
* @param player
|
|
31154
|
-
* @param gamePassId
|
|
31342
|
+
* @param player The `Player` to prompt.
|
|
31343
|
+
* @param gamePassId The pass ID to purchase. This is the `TargetId` returned by `GetProductInfo()` when `InfoType` is `GamePass`. It is not the pass's asset ID and not its `ProductId`.
|
|
31155
31344
|
*/
|
|
31156
31345
|
PromptGamePassPurchase(this: MarketplaceService, player: Player, gamePassId: number): void;
|
|
31157
31346
|
/**
|
|
@@ -31176,10 +31365,10 @@ interface MarketplaceService extends Instance {
|
|
|
31176
31365
|
*
|
|
31177
31366
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MarketplaceService#PromptProductPurchase)
|
|
31178
31367
|
* @param this The service responsible for in-experience transactions.
|
|
31179
|
-
* @param player
|
|
31180
|
-
* @param productId
|
|
31181
|
-
* @param equipIfPurchased
|
|
31182
|
-
* @param currencyType
|
|
31368
|
+
* @param player The `Player` to prompt.
|
|
31369
|
+
* @param productId The ID of the developer product to purchase.
|
|
31370
|
+
* @param equipIfPurchased Ignored.
|
|
31371
|
+
* @param currencyType Ignored.
|
|
31183
31372
|
*/
|
|
31184
31373
|
PromptProductPurchase(this: MarketplaceService, player: Player, productId: number, equipIfPurchased?: boolean, currencyType?: CastsToEnum<Enum.CurrencyType>): void;
|
|
31185
31374
|
/**
|
|
@@ -31189,9 +31378,9 @@ interface MarketplaceService extends Instance {
|
|
|
31189
31378
|
*
|
|
31190
31379
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MarketplaceService#PromptPurchase)
|
|
31191
31380
|
* @param this The service responsible for in-experience transactions.
|
|
31192
|
-
* @param player
|
|
31193
|
-
* @param assetId
|
|
31194
|
-
* @param equipIfPurchased
|
|
31381
|
+
* @param player The `Player` to prompt.
|
|
31382
|
+
* @param assetId The ID of the asset to purchase.
|
|
31383
|
+
* @param equipIfPurchased Ignored.
|
|
31195
31384
|
* @param currencyType Ignored.
|
|
31196
31385
|
*/
|
|
31197
31386
|
PromptPurchase(this: MarketplaceService, player: Player, assetId: number, equipIfPurchased?: boolean, currencyType?: CastsToEnum<Enum.CurrencyType>): void;
|
|
@@ -31224,6 +31413,7 @@ interface MarketplaceService extends Instance {
|
|
|
31224
31413
|
*
|
|
31225
31414
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MarketplaceService#GetDeveloperProductsAsync)
|
|
31226
31415
|
* @param this The service responsible for in-experience transactions.
|
|
31416
|
+
* @returns A `Pages` object whose entries describe the current experience's developer products.
|
|
31227
31417
|
*/
|
|
31228
31418
|
GetDeveloperProductsAsync(this: MarketplaceService): StandardPages<{
|
|
31229
31419
|
Description: string;
|
|
@@ -31289,6 +31479,7 @@ interface MarketplaceService extends Instance {
|
|
|
31289
31479
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MarketplaceService#GetSubscriptionProductInfoAsync)
|
|
31290
31480
|
* @param this The service responsible for in-experience transactions.
|
|
31291
31481
|
* @param subscriptionId The ID of the subscription to check.
|
|
31482
|
+
* @returns A dictionary containing the subscription product information described in the following table.
|
|
31292
31483
|
*/
|
|
31293
31484
|
GetSubscriptionProductInfoAsync(this: MarketplaceService, subscriptionId: string): SubscriptionInfo;
|
|
31294
31485
|
/**
|
|
@@ -31301,6 +31492,7 @@ interface MarketplaceService extends Instance {
|
|
|
31301
31492
|
* @param this The service responsible for in-experience transactions.
|
|
31302
31493
|
* @param user The `Player` object whose subscription details you want to check.
|
|
31303
31494
|
* @param subscriptionId The ID of the subscription to check.
|
|
31495
|
+
* @returns A dictionary containing the user's subscription details described in the following table.
|
|
31304
31496
|
*/
|
|
31305
31497
|
GetUserSubscriptionDetailsAsync(this: MarketplaceService, user: Player, subscriptionId: string): UserSubscriptionDetails;
|
|
31306
31498
|
/**
|
|
@@ -31311,8 +31503,9 @@ interface MarketplaceService extends Instance {
|
|
|
31311
31503
|
*
|
|
31312
31504
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MarketplaceService#GetUserSubscriptionPaymentHistoryAsync)
|
|
31313
31505
|
* @param this The service responsible for in-experience transactions.
|
|
31314
|
-
* @param user
|
|
31315
|
-
* @param subscriptionId
|
|
31506
|
+
* @param user The `Player` whose subscription payment history you want to retrieve.
|
|
31507
|
+
* @param subscriptionId The ID of the subscription whose payment history you want to retrieve.
|
|
31508
|
+
* @returns An array of payment-history entries, ordered from most recent to least recent, as described in the following table.
|
|
31316
31509
|
*/
|
|
31317
31510
|
GetUserSubscriptionPaymentHistoryAsync(this: MarketplaceService, user: Player, subscriptionId: string): Array<UserSubscriptionPaymentHistory>;
|
|
31318
31511
|
/**
|
|
@@ -31325,6 +31518,7 @@ interface MarketplaceService extends Instance {
|
|
|
31325
31518
|
* @param this The service responsible for in-experience transactions.
|
|
31326
31519
|
* @param user The `Player` object whose subscription status you want to check.
|
|
31327
31520
|
* @param subscriptionId The ID of the subscription to check for.
|
|
31521
|
+
* @returns A dictionary containing the user's subscription status described in the following table.
|
|
31328
31522
|
*/
|
|
31329
31523
|
GetUserSubscriptionStatusAsync(this: MarketplaceService, user: Player, subscriptionId: string): UserSubscriptionStatus;
|
|
31330
31524
|
/**
|
|
@@ -31461,6 +31655,7 @@ interface MarketplaceService extends Instance {
|
|
|
31461
31655
|
* @param this The service responsible for in-experience transactions.
|
|
31462
31656
|
* @param userId The `UserId` of the `Player` whose inventory you're checking.
|
|
31463
31657
|
* @param gamePassId The pass ID you want to check for. Not to be confused with an asset ID.
|
|
31658
|
+
* @returns Whether the user owns the pass.
|
|
31464
31659
|
*/
|
|
31465
31660
|
UserOwnsGamePassAsync(this: MarketplaceService, userId: User, gamePassId: number): boolean;
|
|
31466
31661
|
/**
|
|
@@ -31472,6 +31667,8 @@ interface MarketplaceService extends Instance {
|
|
|
31472
31667
|
*/
|
|
31473
31668
|
readonly PromptBulkPurchaseFinished: RBXScriptSignal<(player: Player, status: Enum.MarketplaceBulkPurchasePromptStatus, results: PromptBulkPurchaseFinishedResults) => void>;
|
|
31474
31669
|
/**
|
|
31670
|
+
* Fires when a bundle purchase prompt closes.
|
|
31671
|
+
*
|
|
31475
31672
|
* - **ThreadSafety**: Unsafe
|
|
31476
31673
|
*
|
|
31477
31674
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MarketplaceService#PromptBundlePurchaseFinished)
|
|
@@ -32202,8 +32399,6 @@ interface MetaBreakpointManager extends Instance {
|
|
|
32202
32399
|
readonly _nominal_MetaBreakpointManager: unique symbol;
|
|
32203
32400
|
}
|
|
32204
32401
|
/**
|
|
32205
|
-
* A service that connects the engine's MicroProfiler to the data model, feeding context into profile dumps and letting privileged scripts capture them to disk.
|
|
32206
|
-
*
|
|
32207
32402
|
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
32208
32403
|
*
|
|
32209
32404
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MicroProfilerService)
|
|
@@ -32218,52 +32413,26 @@ interface MicroProfilerService extends Instance {
|
|
|
32218
32413
|
*/
|
|
32219
32414
|
readonly _nominal_MicroProfilerService: unique symbol;
|
|
32220
32415
|
/**
|
|
32221
|
-
* Reads profiling capture data from a slot into a provided Luau buffer.
|
|
32222
|
-
*
|
|
32223
32416
|
* - **ThreadSafety**: Unsafe
|
|
32224
32417
|
* - **Tags**: CustomLuaState
|
|
32225
32418
|
*
|
|
32226
32419
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MicroProfilerService#GetDataInRange)
|
|
32227
|
-
* @param this A service that connects the engine's MicroProfiler to the data model, feeding context into profile dumps and letting privileged scripts capture them to disk.
|
|
32228
|
-
* @param slotId
|
|
32229
|
-
* @param offset
|
|
32230
|
-
* @param size
|
|
32231
|
-
* @param destBuffer
|
|
32232
|
-
* @param destBufferOffset
|
|
32233
|
-
* @returns The number of bytes actually copied into `destBuffer` starting at `destBufferOffset`. Returns `0` if the read fails.
|
|
32234
32420
|
*/
|
|
32235
32421
|
GetDataInRange(this: MicroProfilerService, slotId: number, offset: number, size: number, destBuffer: buffer, destBufferOffset: number): number;
|
|
32236
32422
|
/**
|
|
32237
|
-
* Returns the total byte count of profiling data stored in a slot.
|
|
32238
|
-
*
|
|
32239
32423
|
* - **ThreadSafety**: Unsafe
|
|
32240
32424
|
*
|
|
32241
32425
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MicroProfilerService#GetDataSize)
|
|
32242
|
-
* @param this A service that connects the engine's MicroProfiler to the data model, feeding context into profile dumps and letting privileged scripts capture them to disk.
|
|
32243
|
-
* @param slotId
|
|
32244
|
-
* @returns The total size, in bytes, of the profiling data available in the slot. Returns `0` when no data is available.
|
|
32245
32426
|
*/
|
|
32246
32427
|
GetDataSize(this: MicroProfilerService, slotId: number): number;
|
|
32247
32428
|
/**
|
|
32248
|
-
* Dispatches a binary command to the MicroProfiler control channel and writes the response into a buffer.
|
|
32249
|
-
*
|
|
32250
32429
|
* - **ThreadSafety**: Unsafe
|
|
32251
32430
|
* - **Tags**: CustomLuaState
|
|
32252
32431
|
*
|
|
32253
32432
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MicroProfilerService#ProcessCommand)
|
|
32254
|
-
* @param this A service that connects the engine's MicroProfiler to the data model, feeding context into profile dumps and letting privileged scripts capture them to disk.
|
|
32255
|
-
* @param cmdBuf
|
|
32256
|
-
* @param cmdOffset
|
|
32257
|
-
* @param cmdSize
|
|
32258
|
-
* @param respBuf
|
|
32259
|
-
* @param respOffset
|
|
32260
|
-
* @param respSize
|
|
32261
|
-
* @returns The number of bytes written into `respBuf` as the command response. Returns `0` if the command is not run.
|
|
32262
32433
|
*/
|
|
32263
32434
|
ProcessCommand(this: MicroProfilerService, cmdBuf: buffer, cmdOffset: number, cmdSize: number, respBuf: buffer, respOffset: number, respSize: number): number;
|
|
32264
32435
|
/**
|
|
32265
|
-
* Fires when profiling data in a slot has changed since the last frame.
|
|
32266
|
-
*
|
|
32267
32436
|
* - **ThreadSafety**: Unsafe
|
|
32268
32437
|
*
|
|
32269
32438
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MicroProfilerService#DataChanged)
|
|
@@ -33911,6 +34080,8 @@ interface BasePart extends PVInstance {
|
|
|
33911
34080
|
readonly Touched: RBXScriptSignal<(otherPart: BasePart) => void>;
|
|
33912
34081
|
}
|
|
33913
34082
|
/**
|
|
34083
|
+
* A type of `BasePart` that has a corner wedge shape.
|
|
34084
|
+
*
|
|
33914
34085
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CornerWedgePart)
|
|
33915
34086
|
*/
|
|
33916
34087
|
interface CornerWedgePart extends BasePart {
|
|
@@ -34788,7 +34959,7 @@ interface TriangleMeshPart extends BasePart {
|
|
|
34788
34959
|
*
|
|
34789
34960
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TriangleMeshPart#CollisionFidelity)
|
|
34790
34961
|
*/
|
|
34791
|
-
|
|
34962
|
+
CollisionFidelity: Enum.CollisionFidelity;
|
|
34792
34963
|
/**
|
|
34793
34964
|
* - **ThreadSafety**: ReadSafe
|
|
34794
34965
|
* - **Tags**: NotReplicated
|
|
@@ -34804,7 +34975,7 @@ interface TriangleMeshPart extends BasePart {
|
|
|
34804
34975
|
*
|
|
34805
34976
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TriangleMeshPart#FluidFidelity)
|
|
34806
34977
|
*/
|
|
34807
|
-
|
|
34978
|
+
FluidFidelity: Enum.FluidFidelity;
|
|
34808
34979
|
/**
|
|
34809
34980
|
* The original size of the part's source mesh geometry, before any scaling applied through `BasePart.Size`.
|
|
34810
34981
|
*
|
|
@@ -34945,7 +35116,7 @@ interface PartOperation extends TriangleMeshPart {
|
|
|
34945
35116
|
*
|
|
34946
35117
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PartOperation#RenderFidelity)
|
|
34947
35118
|
*/
|
|
34948
|
-
|
|
35119
|
+
RenderFidelity: Enum.RenderFidelity;
|
|
34949
35120
|
/**
|
|
34950
35121
|
* An angle in degrees which affects the smooth shading of a solid modeled part.
|
|
34951
35122
|
*
|
|
@@ -34953,7 +35124,7 @@ interface PartOperation extends TriangleMeshPart {
|
|
|
34953
35124
|
*
|
|
34954
35125
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PartOperation#SmoothingAngle)
|
|
34955
35126
|
*/
|
|
34956
|
-
|
|
35127
|
+
SmoothingAngle: number;
|
|
34957
35128
|
/**
|
|
34958
35129
|
* The number of polygons in this solid model.
|
|
34959
35130
|
*
|
|
@@ -35652,6 +35823,7 @@ interface Model extends PVInstance {
|
|
|
35652
35823
|
*
|
|
35653
35824
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Model#GetModelCFrame)
|
|
35654
35825
|
* @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.
|
|
35826
|
+
* @returns A `CFrame` representing a central position in the model.
|
|
35655
35827
|
*
|
|
35656
35828
|
* @deprecated GetPrimaryPartCFrame
|
|
35657
35829
|
*/
|
|
@@ -35666,6 +35838,7 @@ interface Model extends PVInstance {
|
|
|
35666
35838
|
*
|
|
35667
35839
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Model#GetModelSize)
|
|
35668
35840
|
* @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.
|
|
35841
|
+
* @returns The `Vector3` size of the `Model`.
|
|
35669
35842
|
*
|
|
35670
35843
|
* @deprecated GetExtentsSize
|
|
35671
35844
|
*/
|
|
@@ -35690,6 +35863,7 @@ interface Model extends PVInstance {
|
|
|
35690
35863
|
*
|
|
35691
35864
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Model#GetPrimaryPartCFrame)
|
|
35692
35865
|
* @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.
|
|
35866
|
+
* @returns The `CFrame` of the model's `Model.PrimaryPart`.
|
|
35693
35867
|
*
|
|
35694
35868
|
* @deprecated GetPivot
|
|
35695
35869
|
*/
|
|
@@ -35759,7 +35933,7 @@ interface Model extends PVInstance {
|
|
|
35759
35933
|
*
|
|
35760
35934
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Model#ScaleTo)
|
|
35761
35935
|
* @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.
|
|
35762
|
-
* @param newScaleFactor
|
|
35936
|
+
* @param newScaleFactor The new scale factor for the model, which must be a positive non-zero number. A value of 1 represents the model's original size.
|
|
35763
35937
|
*/
|
|
35764
35938
|
ScaleTo(this: Model, newScaleFactor: number): void;
|
|
35765
35939
|
/**
|
|
@@ -36150,15 +36324,26 @@ interface WorldRoot extends Model {
|
|
|
36150
36324
|
*/
|
|
36151
36325
|
BulkMoveTo(this: WorldRoot, partList: Array<Instance>, cframeList: Array<unknown>, eventMode?: CastsToEnum<Enum.BulkMoveMode>): void;
|
|
36152
36326
|
/**
|
|
36327
|
+
* Sets the collision status between two groups in this world.
|
|
36328
|
+
*
|
|
36153
36329
|
* - **ThreadSafety**: Unsafe
|
|
36154
36330
|
*
|
|
36155
36331
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/WorldRoot#CollisionGroupSetCollidable)
|
|
36332
|
+
* @param this Base class for handling physics simulation and 3D spatial queries.
|
|
36333
|
+
* @param name1
|
|
36334
|
+
* @param name2
|
|
36335
|
+
* @param collidable
|
|
36156
36336
|
*/
|
|
36157
36337
|
CollisionGroupSetCollidable(this: WorldRoot, name1: string, name2: string, collidable: boolean): void;
|
|
36158
36338
|
/**
|
|
36339
|
+
* Returns whether the two groups will collide in this world.
|
|
36340
|
+
*
|
|
36159
36341
|
* - **ThreadSafety**: Unsafe
|
|
36160
36342
|
*
|
|
36161
36343
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/WorldRoot#CollisionGroupsAreCollidable)
|
|
36344
|
+
* @param this Base class for handling physics simulation and 3D spatial queries.
|
|
36345
|
+
* @param name1
|
|
36346
|
+
* @param name2
|
|
36162
36347
|
*/
|
|
36163
36348
|
CollisionGroupsAreCollidable(this: WorldRoot, name1: string, name2: string): boolean;
|
|
36164
36349
|
/**
|
|
@@ -36287,9 +36472,12 @@ interface WorldRoot extends Model {
|
|
|
36287
36472
|
*/
|
|
36288
36473
|
FindPartsInRegion3WithWhiteList(this: WorldRoot, region: Region3, whitelistDescendantsTable: Array<Instance>, maxParts?: number): Array<BasePart>;
|
|
36289
36474
|
/**
|
|
36475
|
+
* Returns the maximum number of collision groups in this world.
|
|
36476
|
+
*
|
|
36290
36477
|
* - **ThreadSafety**: Unsafe
|
|
36291
36478
|
*
|
|
36292
36479
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/WorldRoot#GetMaxCollisionGroups)
|
|
36480
|
+
* @param this Base class for handling physics simulation and 3D spatial queries.
|
|
36293
36481
|
*/
|
|
36294
36482
|
GetMaxCollisionGroups(this: WorldRoot): number;
|
|
36295
36483
|
/**
|
|
@@ -36334,15 +36522,22 @@ interface WorldRoot extends Model {
|
|
|
36334
36522
|
*/
|
|
36335
36523
|
GetPartsInPart(this: WorldRoot, part: BasePart, overlapParams?: OverlapParams): Array<BasePart>;
|
|
36336
36524
|
/**
|
|
36525
|
+
* Returns a table with info on all of this world's collision groups.
|
|
36526
|
+
*
|
|
36337
36527
|
* - **ThreadSafety**: Unsafe
|
|
36338
36528
|
*
|
|
36339
36529
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/WorldRoot#GetRegisteredCollisionGroups)
|
|
36530
|
+
* @param this Base class for handling physics simulation and 3D spatial queries.
|
|
36340
36531
|
*/
|
|
36341
36532
|
GetRegisteredCollisionGroups(this: WorldRoot): Array<unknown>;
|
|
36342
36533
|
/**
|
|
36534
|
+
* Checks if a collision group is registered in this world.
|
|
36535
|
+
*
|
|
36343
36536
|
* - **ThreadSafety**: Unsafe
|
|
36344
36537
|
*
|
|
36345
36538
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/WorldRoot#IsCollisionGroupRegistered)
|
|
36539
|
+
* @param this Base class for handling physics simulation and 3D spatial queries.
|
|
36540
|
+
* @param name
|
|
36346
36541
|
*/
|
|
36347
36542
|
IsCollisionGroupRegistered(this: WorldRoot, name: string): boolean;
|
|
36348
36543
|
/**
|
|
@@ -36393,15 +36588,24 @@ interface WorldRoot extends Model {
|
|
|
36393
36588
|
*/
|
|
36394
36589
|
Raycast(this: WorldRoot, origin: Vector3, direction: Vector3, raycastParams?: RaycastParams): RaycastResult | undefined;
|
|
36395
36590
|
/**
|
|
36591
|
+
* Registers a new collision group in this world with the given name.
|
|
36592
|
+
*
|
|
36396
36593
|
* - **ThreadSafety**: Unsafe
|
|
36397
36594
|
*
|
|
36398
36595
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/WorldRoot#RegisterCollisionGroup)
|
|
36596
|
+
* @param this Base class for handling physics simulation and 3D spatial queries.
|
|
36597
|
+
* @param name
|
|
36399
36598
|
*/
|
|
36400
36599
|
RegisterCollisionGroup(this: WorldRoot, name: string): void;
|
|
36401
36600
|
/**
|
|
36601
|
+
* Renames specified collision group in this world.
|
|
36602
|
+
*
|
|
36402
36603
|
* - **ThreadSafety**: Unsafe
|
|
36403
36604
|
*
|
|
36404
36605
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/WorldRoot#RenameCollisionGroup)
|
|
36606
|
+
* @param this Base class for handling physics simulation and 3D spatial queries.
|
|
36607
|
+
* @param from
|
|
36608
|
+
* @param to
|
|
36405
36609
|
*/
|
|
36406
36610
|
RenameCollisionGroup(this: WorldRoot, from: string, to: string): void;
|
|
36407
36611
|
/**
|
|
@@ -36432,9 +36636,13 @@ interface WorldRoot extends Model {
|
|
|
36432
36636
|
*/
|
|
36433
36637
|
Spherecast(this: WorldRoot, position: Vector3, radius: number, direction: Vector3, raycastParams?: RaycastParams): RaycastResult | undefined;
|
|
36434
36638
|
/**
|
|
36639
|
+
* Unregisters the collision group for the given name in this world.
|
|
36640
|
+
*
|
|
36435
36641
|
* - **ThreadSafety**: Unsafe
|
|
36436
36642
|
*
|
|
36437
36643
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/WorldRoot#UnregisterCollisionGroup)
|
|
36644
|
+
* @param this Base class for handling physics simulation and 3D spatial queries.
|
|
36645
|
+
* @param name
|
|
36438
36646
|
*/
|
|
36439
36647
|
UnregisterCollisionGroup(this: WorldRoot, name: string): void;
|
|
36440
36648
|
}
|
|
@@ -36549,6 +36757,8 @@ interface Workspace extends WorldRoot {
|
|
|
36549
36757
|
/**
|
|
36550
36758
|
* **Deprecated:** This property should not be used for new work.
|
|
36551
36759
|
*
|
|
36760
|
+
* Deprecated setting that configured the interpolation throttling mode; it no longer takes effect.
|
|
36761
|
+
*
|
|
36552
36762
|
* - **ThreadSafety**: ReadSafe
|
|
36553
36763
|
* - **Tags**: Hidden, NotReplicated
|
|
36554
36764
|
*
|
|
@@ -36669,7 +36879,7 @@ interface Workspace extends WorldRoot {
|
|
|
36669
36879
|
readonly PersistentLoaded: RBXScriptSignal<(player: Player) => void>;
|
|
36670
36880
|
}
|
|
36671
36881
|
/**
|
|
36672
|
-
* Extends limited physics
|
|
36882
|
+
* Extends limited physics to its children.
|
|
36673
36883
|
*
|
|
36674
36884
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/WorldModel)
|
|
36675
36885
|
*/
|
|
@@ -36683,6 +36893,8 @@ interface WorldModel extends WorldRoot {
|
|
|
36683
36893
|
*/
|
|
36684
36894
|
readonly _nominal_WorldModel: unique symbol;
|
|
36685
36895
|
/**
|
|
36896
|
+
* Determines whether this `WorldModel` uses `Workspace` collision groups or its own independent collision groups for queries.
|
|
36897
|
+
*
|
|
36686
36898
|
* - **ThreadSafety**: ReadSafe
|
|
36687
36899
|
*
|
|
36688
36900
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/WorldModel#UseWorkspaceCollisionGroups)
|
|
@@ -37358,6 +37570,8 @@ interface ParticleEmitter extends Instance {
|
|
|
37358
37570
|
*/
|
|
37359
37571
|
Texture: ContentId;
|
|
37360
37572
|
/**
|
|
37573
|
+
* The image rendered on particles. Supports [asset URIs](../../../projects/assets/index.md#asset-uris).
|
|
37574
|
+
*
|
|
37361
37575
|
* - **ThreadSafety**: ReadSafe
|
|
37362
37576
|
*
|
|
37363
37577
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ParticleEmitter#TextureContent)
|
|
@@ -38841,7 +39055,7 @@ interface Player extends Instance {
|
|
|
38841
39055
|
*/
|
|
38842
39056
|
GetRankInGroup(this: Player, groupId: number): number;
|
|
38843
39057
|
/**
|
|
38844
|
-
* **Deprecated:** This method
|
|
39058
|
+
* **Deprecated:** This method returns only the rank value of the member's highest public role. Use `GroupService:GetRolesInGroupAsync()` instead, which returns all public roles.
|
|
38845
39059
|
*
|
|
38846
39060
|
* Returns the player's rank in the group as an integer.
|
|
38847
39061
|
*
|
|
@@ -38873,7 +39087,7 @@ interface Player extends Instance {
|
|
|
38873
39087
|
*/
|
|
38874
39088
|
GetRoleInGroup(this: Player, groupId: number): string;
|
|
38875
39089
|
/**
|
|
38876
|
-
* **Deprecated:** This method
|
|
39090
|
+
* **Deprecated:** This method returns only the member's highest public role. Use `GroupService:GetRolesInGroupAsync()` instead, which returns all public roles.
|
|
38877
39091
|
*
|
|
38878
39092
|
* Returns the player's role in the group as a string, or `Guest` if the player isn't part of the group.
|
|
38879
39093
|
*
|
|
@@ -40765,6 +40979,27 @@ interface PublishService extends Instance {
|
|
|
40765
40979
|
*/
|
|
40766
40980
|
readonly _nominal_PublishService: unique symbol;
|
|
40767
40981
|
}
|
|
40982
|
+
/**
|
|
40983
|
+
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
40984
|
+
*
|
|
40985
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/QueueService)
|
|
40986
|
+
*/
|
|
40987
|
+
interface QueueService extends Instance {
|
|
40988
|
+
/**
|
|
40989
|
+
* **DO NOT USE!**
|
|
40990
|
+
*
|
|
40991
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
40992
|
+
* @hidden
|
|
40993
|
+
* @deprecated
|
|
40994
|
+
*/
|
|
40995
|
+
readonly _nominal_QueueService: unique symbol;
|
|
40996
|
+
/**
|
|
40997
|
+
* - **ThreadSafety**: Unsafe
|
|
40998
|
+
*
|
|
40999
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/QueueService#GetStandardQueue)
|
|
41000
|
+
*/
|
|
41001
|
+
GetStandardQueue(this: QueueService, name: string): StandardQueue;
|
|
41002
|
+
}
|
|
40768
41003
|
/**
|
|
40769
41004
|
* - **Tags**: NotReplicated
|
|
40770
41005
|
*
|
|
@@ -41057,6 +41292,8 @@ interface RecommendationService extends Instance {
|
|
|
41057
41292
|
UpdateItemAsync(this: RecommendationService, updateRecommendationItemRequest: object): void;
|
|
41058
41293
|
}
|
|
41059
41294
|
/**
|
|
41295
|
+
* A service that allows scripts to query the engine's API at runtime for information about classes, properties, methods, and events.
|
|
41296
|
+
*
|
|
41060
41297
|
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
41061
41298
|
*
|
|
41062
41299
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ReflectionService)
|
|
@@ -41077,7 +41314,7 @@ interface ReflectionService extends Instance {
|
|
|
41077
41314
|
* - **Tags**: CustomLuaState
|
|
41078
41315
|
*
|
|
41079
41316
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ReflectionService#GetClass)
|
|
41080
|
-
* @param this
|
|
41317
|
+
* @param this A service that allows scripts to query the engine's API at runtime for information about classes, properties, methods, and events.
|
|
41081
41318
|
* @param className The name of the class for which you wish to retrieve information.
|
|
41082
41319
|
* @param filter An optional filter to restrict or expand the set of classes that this method can return and change the method's behavior.
|
|
41083
41320
|
* @returns A `ReflectedClass` dictionary with reflection information if the class exists; otherwise, `nil`.
|
|
@@ -41090,7 +41327,7 @@ interface ReflectionService extends Instance {
|
|
|
41090
41327
|
* - **Tags**: CustomLuaState
|
|
41091
41328
|
*
|
|
41092
41329
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ReflectionService#GetClasses)
|
|
41093
|
-
* @param this
|
|
41330
|
+
* @param this A service that allows scripts to query the engine's API at runtime for information about classes, properties, methods, and events.
|
|
41094
41331
|
* @param filter An optional filter to restrict or expand the set of classes that this method can return and change the method's behavior.
|
|
41095
41332
|
* @returns A list of `ReflectedClass` dictionaries with reflection information for each class that matches the filter criteria.
|
|
41096
41333
|
*/
|
|
@@ -41102,7 +41339,7 @@ interface ReflectionService extends Instance {
|
|
|
41102
41339
|
* - **Tags**: CustomLuaState
|
|
41103
41340
|
*
|
|
41104
41341
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ReflectionService#GetEventsOfClass)
|
|
41105
|
-
* @param this
|
|
41342
|
+
* @param this A service that allows scripts to query the engine's API at runtime for information about classes, properties, methods, and events.
|
|
41106
41343
|
* @param className The name of the class for which you wish to retrieve events.
|
|
41107
41344
|
* @param filter An optional filter to restrict or expand the set of events that this method can return and change the method's behavior.
|
|
41108
41345
|
* @returns A list of `ReflectedEvent` dictionaries with reflection information for each event of the class that matches the filter criteria.
|
|
@@ -41115,7 +41352,7 @@ interface ReflectionService extends Instance {
|
|
|
41115
41352
|
* - **Tags**: CustomLuaState
|
|
41116
41353
|
*
|
|
41117
41354
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ReflectionService#GetMethodsOfClass)
|
|
41118
|
-
* @param this
|
|
41355
|
+
* @param this A service that allows scripts to query the engine's API at runtime for information about classes, properties, methods, and events.
|
|
41119
41356
|
* @param className The name of the class for which you wish to retrieve methods.
|
|
41120
41357
|
* @param filter An optional filter to restrict or expand the set of methods that this method can return and change the method's behavior.
|
|
41121
41358
|
* @returns A list of `ReflectedMethod` dictionaries with reflection information for each method of the class that matches the filter criteria.
|
|
@@ -41128,7 +41365,7 @@ interface ReflectionService extends Instance {
|
|
|
41128
41365
|
* - **Tags**: CustomLuaState
|
|
41129
41366
|
*
|
|
41130
41367
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ReflectionService#GetPropertiesOfClass)
|
|
41131
|
-
* @param this
|
|
41368
|
+
* @param this A service that allows scripts to query the engine's API at runtime for information about classes, properties, methods, and events.
|
|
41132
41369
|
* @param className The name of the class for which you wish to retrieve properties.
|
|
41133
41370
|
* @param filter An optional filter to restrict or expand the set of properties that this method can return and change the method's behavior.
|
|
41134
41371
|
* @returns A list of `ReflectedProperty` dictionaries with reflection information for each property of the class that matches the filter criteria.
|
|
@@ -41622,9 +41859,16 @@ interface RunService extends Instance {
|
|
|
41622
41859
|
*/
|
|
41623
41860
|
readonly FrameNumber: number;
|
|
41624
41861
|
/**
|
|
41862
|
+
* Binds a custom function to be called at a fixed frequency before Animators update when fixed simulation is enabled, or immediately before `BindToSimulation` callbacks otherwise.
|
|
41863
|
+
*
|
|
41625
41864
|
* - **ThreadSafety**: Unsafe
|
|
41626
41865
|
*
|
|
41627
41866
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RunService#BindToAnimation)
|
|
41867
|
+
* @param this Service responsible for all runtime activity and progression of time.
|
|
41868
|
+
* @param function The function to call. This function will be passed one parameter called `deltaTime`, which shows the elapsed time since the callback's previous invocation.
|
|
41869
|
+
* @param frequency Optional `StepFrequency` value indicating the frequency at which to call the bound function. Defaults to `StepFrequency.Hz30`.
|
|
41870
|
+
* @param priority Optional priority of the binding as an integer; it determines the order in which bound functions are called within a simulation step. Lower numbers are called first. If two bindings have the same priority, the order between them is unspecified. Defaults to 2000.
|
|
41871
|
+
* @returns A `RBXScriptConnection` that can be disconnected to unregister the callback.
|
|
41628
41872
|
*/
|
|
41629
41873
|
BindToAnimation(this: RunService, callback: Callback, frequency?: CastsToEnum<Enum.StepFrequency>, priority?: number): RBXScriptConnection;
|
|
41630
41874
|
/**
|
|
@@ -42108,8 +42352,6 @@ interface SyncScriptBuilder extends ScriptBuilder {
|
|
|
42108
42352
|
*/
|
|
42109
42353
|
PackAsSource: boolean;
|
|
42110
42354
|
/**
|
|
42111
|
-
* **Deprecated:**
|
|
42112
|
-
*
|
|
42113
42355
|
* - **ThreadSafety**: ReadSafe
|
|
42114
42356
|
* - **Tags**:
|
|
42115
42357
|
*
|
|
@@ -43082,7 +43324,8 @@ interface UserSettings extends GenericSettings<{
|
|
|
43082
43324
|
*
|
|
43083
43325
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UserSettings#IsUserFeatureEnabled)
|
|
43084
43326
|
* @param this A singleton object that houses basic user settings, which persist across all games on Roblox.
|
|
43085
|
-
* @param name
|
|
43327
|
+
* @param name The name of the user feature to check. Must begin with the `User` prefix.
|
|
43328
|
+
* @returns `true` if the named user feature exists and is enabled; otherwise `false`.
|
|
43086
43329
|
*/
|
|
43087
43330
|
IsUserFeatureEnabled(this: UserSettings, name: string): boolean;
|
|
43088
43331
|
/**
|
|
@@ -43194,7 +43437,7 @@ interface Sky extends Instance {
|
|
|
43194
43437
|
*/
|
|
43195
43438
|
readonly _nominal_Sky: unique symbol;
|
|
43196
43439
|
/**
|
|
43197
|
-
* Sets whether the sun, moon, and stars will
|
|
43440
|
+
* Sets whether the sun, moon, and stars will render in the skybox.
|
|
43198
43441
|
*
|
|
43199
43442
|
* - **ThreadSafety**: ReadSafe
|
|
43200
43443
|
*
|
|
@@ -43202,7 +43445,7 @@ interface Sky extends Instance {
|
|
|
43202
43445
|
*/
|
|
43203
43446
|
CelestialBodiesShown: boolean;
|
|
43204
43447
|
/**
|
|
43205
|
-
* The perceived angular size of the moon while using this skybox, in degrees.
|
|
43448
|
+
* The perceived angular size of the moon while using this skybox, in degrees. Defaults to `11` and is clamped to the range `[0, 60]`.
|
|
43206
43449
|
*
|
|
43207
43450
|
* - **ThreadSafety**: ReadSafe
|
|
43208
43451
|
*
|
|
@@ -43210,6 +43453,8 @@ interface Sky extends Instance {
|
|
|
43210
43453
|
*/
|
|
43211
43454
|
MoonAngularSize: number;
|
|
43212
43455
|
/**
|
|
43456
|
+
* The image displayed for the moon while using this skybox.
|
|
43457
|
+
*
|
|
43213
43458
|
* - **ThreadSafety**: ReadSafe
|
|
43214
43459
|
*
|
|
43215
43460
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Sky#MoonTextureContent)
|
|
@@ -43224,6 +43469,8 @@ interface Sky extends Instance {
|
|
|
43224
43469
|
*/
|
|
43225
43470
|
MoonTextureId: ContentId;
|
|
43226
43471
|
/**
|
|
43472
|
+
* The image displayed on the back surface of the skybox.
|
|
43473
|
+
*
|
|
43227
43474
|
* - **ThreadSafety**: ReadSafe
|
|
43228
43475
|
*
|
|
43229
43476
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Sky#SkyboxBackContent)
|
|
@@ -43246,12 +43493,16 @@ interface Sky extends Instance {
|
|
|
43246
43493
|
*/
|
|
43247
43494
|
SkyboxDn: ContentId;
|
|
43248
43495
|
/**
|
|
43496
|
+
* The image displayed on the bottom surface of the skybox.
|
|
43497
|
+
*
|
|
43249
43498
|
* - **ThreadSafety**: ReadSafe
|
|
43250
43499
|
*
|
|
43251
43500
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Sky#SkyboxDownContent)
|
|
43252
43501
|
*/
|
|
43253
43502
|
SkyboxDownContent: Content;
|
|
43254
43503
|
/**
|
|
43504
|
+
* The image displayed on the front surface of the skybox.
|
|
43505
|
+
*
|
|
43255
43506
|
* - **ThreadSafety**: ReadSafe
|
|
43256
43507
|
*
|
|
43257
43508
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Sky#SkyboxFrontContent)
|
|
@@ -43266,6 +43517,8 @@ interface Sky extends Instance {
|
|
|
43266
43517
|
*/
|
|
43267
43518
|
SkyboxFt: ContentId;
|
|
43268
43519
|
/**
|
|
43520
|
+
* The image displayed on the left surface of the skybox.
|
|
43521
|
+
*
|
|
43269
43522
|
* - **ThreadSafety**: ReadSafe
|
|
43270
43523
|
*
|
|
43271
43524
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Sky#SkyboxLeftContent)
|
|
@@ -43288,6 +43541,8 @@ interface Sky extends Instance {
|
|
|
43288
43541
|
*/
|
|
43289
43542
|
SkyboxOrientation: Vector3;
|
|
43290
43543
|
/**
|
|
43544
|
+
* The image displayed on the right surface of the skybox.
|
|
43545
|
+
*
|
|
43291
43546
|
* - **ThreadSafety**: ReadSafe
|
|
43292
43547
|
*
|
|
43293
43548
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Sky#SkyboxRightContent)
|
|
@@ -43310,6 +43565,8 @@ interface Sky extends Instance {
|
|
|
43310
43565
|
*/
|
|
43311
43566
|
SkyboxUp: ContentId;
|
|
43312
43567
|
/**
|
|
43568
|
+
* The image displayed on the top surface of the skybox.
|
|
43569
|
+
*
|
|
43313
43570
|
* - **ThreadSafety**: ReadSafe
|
|
43314
43571
|
*
|
|
43315
43572
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Sky#SkyboxUpContent)
|
|
@@ -43332,6 +43589,8 @@ interface Sky extends Instance {
|
|
|
43332
43589
|
*/
|
|
43333
43590
|
SunAngularSize: number;
|
|
43334
43591
|
/**
|
|
43592
|
+
* The image displayed for the sun while using this skybox.
|
|
43593
|
+
*
|
|
43335
43594
|
* - **ThreadSafety**: ReadSafe
|
|
43336
43595
|
*
|
|
43337
43596
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Sky#SunTextureContent)
|
|
@@ -43509,21 +43768,6 @@ interface SmoothVoxelsUpgraderService extends Instance {
|
|
|
43509
43768
|
*/
|
|
43510
43769
|
readonly _nominal_SmoothVoxelsUpgraderService: unique symbol;
|
|
43511
43770
|
}
|
|
43512
|
-
/**
|
|
43513
|
-
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
43514
|
-
*
|
|
43515
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SnippetService)
|
|
43516
|
-
*/
|
|
43517
|
-
interface SnippetService extends Instance {
|
|
43518
|
-
/**
|
|
43519
|
-
* **DO NOT USE!**
|
|
43520
|
-
*
|
|
43521
|
-
* This field exists to force TypeScript to recognize this as a nominal type
|
|
43522
|
-
* @hidden
|
|
43523
|
-
* @deprecated
|
|
43524
|
-
*/
|
|
43525
|
-
readonly _nominal_SnippetService: unique symbol;
|
|
43526
|
-
}
|
|
43527
43771
|
/**
|
|
43528
43772
|
* Facilitates social functions that impact relationships made on the Roblox platform.
|
|
43529
43773
|
*
|
|
@@ -44622,8 +44866,6 @@ interface SoundService extends Instance {
|
|
|
44622
44866
|
*/
|
|
44623
44867
|
get CharacterSoundsUseNewApi(): Enum.RolloutState;
|
|
44624
44868
|
/**
|
|
44625
|
-
* Controls whether sound bends around corners globally when acoustic simulation is active.
|
|
44626
|
-
*
|
|
44627
44869
|
* - **ThreadSafety**: ReadSafe
|
|
44628
44870
|
*
|
|
44629
44871
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SoundService#DiffractionEnabled)
|
|
@@ -44670,8 +44912,6 @@ interface SoundService extends Instance {
|
|
|
44670
44912
|
*/
|
|
44671
44913
|
ListenerType: Enum.ListenerType;
|
|
44672
44914
|
/**
|
|
44673
|
-
* Controls whether sound is muffled through walls globally when acoustic simulation is active.
|
|
44674
|
-
*
|
|
44675
44915
|
* - **ThreadSafety**: ReadSafe
|
|
44676
44916
|
*
|
|
44677
44917
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SoundService#OcclusionEnabled)
|
|
@@ -44686,8 +44926,6 @@ interface SoundService extends Instance {
|
|
|
44686
44926
|
*/
|
|
44687
44927
|
RespectFilteringEnabled: boolean;
|
|
44688
44928
|
/**
|
|
44689
|
-
* Controls whether sound receives environmental reverb globally when acoustic simulation is active.
|
|
44690
|
-
*
|
|
44691
44929
|
* - **ThreadSafety**: ReadSafe
|
|
44692
44930
|
*
|
|
44693
44931
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SoundService#ReverbEnabled)
|
|
@@ -44831,6 +45069,8 @@ interface Sparkles extends Instance {
|
|
|
44831
45069
|
*/
|
|
44832
45070
|
SparkleColor: Color3;
|
|
44833
45071
|
/**
|
|
45072
|
+
* Controls the speed of the sparkle effect.
|
|
45073
|
+
*
|
|
44834
45074
|
* - **ThreadSafety**: ReadSafe
|
|
44835
45075
|
*
|
|
44836
45076
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Sparkles#TimeScale)
|
|
@@ -44852,6 +45092,42 @@ interface StackFrame extends Instance {
|
|
|
44852
45092
|
*/
|
|
44853
45093
|
readonly _nominal_StackFrame: unique symbol;
|
|
44854
45094
|
}
|
|
45095
|
+
/**
|
|
45096
|
+
* - **Tags**: NotCreatable, NotReplicated
|
|
45097
|
+
*
|
|
45098
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StandardQueue)
|
|
45099
|
+
*/
|
|
45100
|
+
interface StandardQueue extends Instance {
|
|
45101
|
+
/**
|
|
45102
|
+
* **DO NOT USE!**
|
|
45103
|
+
*
|
|
45104
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
45105
|
+
* @hidden
|
|
45106
|
+
* @deprecated
|
|
45107
|
+
*/
|
|
45108
|
+
readonly _nominal_StandardQueue: unique symbol;
|
|
45109
|
+
/**
|
|
45110
|
+
* - **ThreadSafety**: Unsafe
|
|
45111
|
+
* - **Tags**: Yields
|
|
45112
|
+
*
|
|
45113
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StandardQueue#BatchCommitAsync)
|
|
45114
|
+
*/
|
|
45115
|
+
BatchCommitAsync(this: StandardQueue, group: string, messageIds: Array<unknown>): void;
|
|
45116
|
+
/**
|
|
45117
|
+
* - **ThreadSafety**: Unsafe
|
|
45118
|
+
* - **Tags**: Yields
|
|
45119
|
+
*
|
|
45120
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StandardQueue#PublishAsync)
|
|
45121
|
+
*/
|
|
45122
|
+
PublishAsync(this: StandardQueue, data: unknown, messageKey?: string): void;
|
|
45123
|
+
/**
|
|
45124
|
+
* - **ThreadSafety**: Unsafe
|
|
45125
|
+
* - **Tags**: Yields
|
|
45126
|
+
*
|
|
45127
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StandardQueue#SubscribeAsync)
|
|
45128
|
+
*/
|
|
45129
|
+
SubscribeAsync(this: StandardQueue, group: string, callback: Callback): RBXScriptConnection;
|
|
45130
|
+
}
|
|
44855
45131
|
/**
|
|
44856
45132
|
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
44857
45133
|
*
|
|
@@ -45166,8 +45442,6 @@ interface StateMachineDefinition extends Instance {
|
|
|
45166
45442
|
readonly _nominal_StateMachineDefinition: unique symbol;
|
|
45167
45443
|
}
|
|
45168
45444
|
/**
|
|
45169
|
-
* - **Tags**: NotReplicated
|
|
45170
|
-
*
|
|
45171
45445
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StateMachineTransitionDefinition)
|
|
45172
45446
|
*/
|
|
45173
45447
|
interface StateMachineTransitionDefinition extends Instance {
|
|
@@ -45179,6 +45453,24 @@ interface StateMachineTransitionDefinition extends Instance {
|
|
|
45179
45453
|
* @deprecated
|
|
45180
45454
|
*/
|
|
45181
45455
|
readonly _nominal_StateMachineTransitionDefinition: unique symbol;
|
|
45456
|
+
/**
|
|
45457
|
+
* - **ThreadSafety**: ReadSafe
|
|
45458
|
+
*
|
|
45459
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StateMachineTransitionDefinition#From)
|
|
45460
|
+
*/
|
|
45461
|
+
From: Instance | undefined;
|
|
45462
|
+
/**
|
|
45463
|
+
* - **ThreadSafety**: ReadSafe
|
|
45464
|
+
*
|
|
45465
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StateMachineTransitionDefinition#Priority)
|
|
45466
|
+
*/
|
|
45467
|
+
Priority: number;
|
|
45468
|
+
/**
|
|
45469
|
+
* - **ThreadSafety**: ReadSafe
|
|
45470
|
+
*
|
|
45471
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StateMachineTransitionDefinition#To)
|
|
45472
|
+
*/
|
|
45473
|
+
To: Instance | undefined;
|
|
45182
45474
|
}
|
|
45183
45475
|
/**
|
|
45184
45476
|
* Performance metrics for a game.
|
|
@@ -46530,6 +46822,12 @@ interface TeleportOptions extends Instance {
|
|
|
46530
46822
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TeleportOptions#ReservedServerAccessCode)
|
|
46531
46823
|
*/
|
|
46532
46824
|
ReservedServerAccessCode: string;
|
|
46825
|
+
/**
|
|
46826
|
+
* - **ThreadSafety**: ReadSafe
|
|
46827
|
+
*
|
|
46828
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TeleportOptions#ReservedServerId)
|
|
46829
|
+
*/
|
|
46830
|
+
ReservedServerId: string;
|
|
46533
46831
|
/**
|
|
46534
46832
|
* The `DataModel.JobId` of the server instance to teleport to.
|
|
46535
46833
|
*
|
|
@@ -46546,6 +46844,12 @@ interface TeleportOptions extends Instance {
|
|
|
46546
46844
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TeleportOptions#ShouldReserveServer)
|
|
46547
46845
|
*/
|
|
46548
46846
|
ShouldReserveServer: boolean;
|
|
46847
|
+
/**
|
|
46848
|
+
* - **ThreadSafety**: ReadSafe
|
|
46849
|
+
*
|
|
46850
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TeleportOptions#VipServerId)
|
|
46851
|
+
*/
|
|
46852
|
+
VipServerId: string;
|
|
46549
46853
|
/**
|
|
46550
46854
|
* Returns the teleport data stored in the `TeleportOptions` instance by `TeleportOptions:SetTeleportData()`.
|
|
46551
46855
|
*
|
|
@@ -46917,6 +47221,8 @@ interface TerrainDetail extends Instance {
|
|
|
46917
47221
|
StudsPerTile: number;
|
|
46918
47222
|
}
|
|
46919
47223
|
/**
|
|
47224
|
+
* An object that stores a chunk of terrain voxel data, produced by `Terrain:CopyRegion()` and consumed by `Terrain:PasteRegion()`.
|
|
47225
|
+
*
|
|
46920
47226
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TerrainRegion)
|
|
46921
47227
|
*/
|
|
46922
47228
|
interface TerrainRegion extends Instance {
|
|
@@ -47213,14 +47519,9 @@ interface TestService extends Instance {
|
|
|
47213
47519
|
*/
|
|
47214
47520
|
Message(this: TestService, text: string, source?: Instance, line?: number): void;
|
|
47215
47521
|
/**
|
|
47216
|
-
* Registers a test case with the service and returns the resulting `TestCase`.
|
|
47217
|
-
*
|
|
47218
47522
|
* - **ThreadSafety**: Unsafe
|
|
47219
47523
|
*
|
|
47220
47524
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TestService#RegisterTest)
|
|
47221
|
-
* @param this A service used by Roblox to run controlled tests of the engine. It is available for developers to use, to a limited degree.
|
|
47222
|
-
* @param testOptions A dictionary describing the test, requiring the string fields `SuiteName` and `TestCaseName` and optionally a numeric `Timeout` field.
|
|
47223
|
-
* @returns The registered `TestCase`, or no value when registration isn't supported in the current context.
|
|
47224
47525
|
*/
|
|
47225
47526
|
RegisterTest(this: TestService, testOptions: object): TestCase;
|
|
47226
47527
|
/**
|
|
@@ -47295,14 +47596,9 @@ interface TestService extends Instance {
|
|
|
47295
47596
|
*/
|
|
47296
47597
|
StopTestSession(this: TestService): void;
|
|
47297
47598
|
/**
|
|
47298
|
-
* Captures a named screenshot snapshot during a test run.
|
|
47299
|
-
*
|
|
47300
47599
|
* - **ThreadSafety**: Unsafe
|
|
47301
47600
|
*
|
|
47302
47601
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TestService#TakeSnapshot)
|
|
47303
|
-
* @param this A service used by Roblox to run controlled tests of the engine. It is available for developers to use, to a limited degree.
|
|
47304
|
-
* @param snapshotname The name to associate with the captured snapshot.
|
|
47305
|
-
* @param source An optional script instance whose `Suite` and `TestName` attributes name the snapshot; defaults to `nil`.
|
|
47306
47602
|
*/
|
|
47307
47603
|
TakeSnapshot(this: TestService, snapshotname: string, source?: Instance): void;
|
|
47308
47604
|
/**
|
|
@@ -48082,6 +48378,12 @@ interface ChatWindowConfiguration extends TextChatConfigurations {
|
|
|
48082
48378
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ChatWindowConfiguration#HorizontalAlignment)
|
|
48083
48379
|
*/
|
|
48084
48380
|
HorizontalAlignment: Enum.HorizontalAlignment;
|
|
48381
|
+
/**
|
|
48382
|
+
* - **ThreadSafety**: ReadSafe
|
|
48383
|
+
*
|
|
48384
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ChatWindowConfiguration#TextChannelDisplayMode)
|
|
48385
|
+
*/
|
|
48386
|
+
TextChannelDisplayMode: Enum.TextChannelDisplayMode;
|
|
48085
48387
|
/**
|
|
48086
48388
|
* Color of the text in default chat window.
|
|
48087
48389
|
*
|
|
@@ -49176,6 +49478,8 @@ interface Trail extends Instance {
|
|
|
49176
49478
|
*/
|
|
49177
49479
|
Texture: ContentId;
|
|
49178
49480
|
/**
|
|
49481
|
+
* The texture displayed on the trail. Supports [asset URIs](../../../projects/assets/index.md#asset-uris).
|
|
49482
|
+
*
|
|
49179
49483
|
* - **ThreadSafety**: ReadSafe
|
|
49180
49484
|
*
|
|
49181
49485
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Trail#TextureContent)
|
|
@@ -50930,6 +51234,7 @@ interface UserGameSettings extends Instance {
|
|
|
50930
51234
|
*
|
|
50931
51235
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UserGameSettings#GetCameraYInvertValue)
|
|
50932
51236
|
* @param this `UserGameSettings` is a singleton class found inside of the `UserSettings` singleton. It holds various persistent settings relating to how the user wants to control their camera, and their character.
|
|
51237
|
+
* @returns The camera's current Y-axis inversion multiplier.
|
|
50933
51238
|
*/
|
|
50934
51239
|
GetCameraYInvertValue(this: UserGameSettings): number;
|
|
50935
51240
|
/**
|
|
@@ -50950,6 +51255,7 @@ interface UserGameSettings extends Instance {
|
|
|
50950
51255
|
*
|
|
50951
51256
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UserGameSettings#InFullScreen)
|
|
50952
51257
|
* @param this `UserGameSettings` is a singleton class found inside of the `UserSettings` singleton. It holds various persistent settings relating to how the user wants to control their camera, and their character.
|
|
51258
|
+
* @returns Whether the user's Roblox window is in full screen mode.
|
|
50953
51259
|
*/
|
|
50954
51260
|
InFullScreen(this: UserGameSettings): boolean;
|
|
50955
51261
|
/**
|
|
@@ -50959,6 +51265,7 @@ interface UserGameSettings extends Instance {
|
|
|
50959
51265
|
*
|
|
50960
51266
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UserGameSettings#InStudioMode)
|
|
50961
51267
|
* @param this `UserGameSettings` is a singleton class found inside of the `UserSettings` singleton. It holds various persistent settings relating to how the user wants to control their camera, and their character.
|
|
51268
|
+
* @returns Whether the current client session is running in Roblox Studio.
|
|
50962
51269
|
*/
|
|
50963
51270
|
InStudioMode(this: UserGameSettings): boolean;
|
|
50964
51271
|
/**
|
|
@@ -53394,6 +53701,13 @@ interface WrapTextureTransfer extends Instance {
|
|
|
53394
53701
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/WrapTextureTransfer#UVMinBound)
|
|
53395
53702
|
*/
|
|
53396
53703
|
UVMinBound: Vector2;
|
|
53704
|
+
/**
|
|
53705
|
+
* - **ThreadSafety**: Unsafe
|
|
53706
|
+
* - **Tags**: Yields
|
|
53707
|
+
*
|
|
53708
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/WrapTextureTransfer#PrepareProjectionMeshDataAsync)
|
|
53709
|
+
*/
|
|
53710
|
+
PrepareProjectionMeshDataAsync(this: WrapTextureTransfer): void;
|
|
53397
53711
|
}
|
|
53398
53712
|
/**
|
|
53399
53713
|
* - **Tags**: NotCreatable, NotReplicated
|