@rbxts/types 1.0.943 → 1.0.944
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 +1136 -341
- package/include/generated/PluginSecurity.d.ts +453 -155
- package/include/generated/enums.d.ts +1809 -83
- package/package.json +1 -1
|
@@ -31,6 +31,7 @@ interface Services {
|
|
|
31
31
|
AvatarImportService: AvatarImportService;
|
|
32
32
|
AvatarSettings: AvatarSettings;
|
|
33
33
|
BadgeService: BadgeService;
|
|
34
|
+
BranchService: BranchService;
|
|
34
35
|
BugReporterService: BugReporterService;
|
|
35
36
|
BulkImportService: BulkImportService;
|
|
36
37
|
CacheableContentProvider: CacheableContentProvider;
|
|
@@ -105,6 +106,7 @@ interface Services {
|
|
|
105
106
|
InsertService: InsertService;
|
|
106
107
|
InstanceExtensionsService: InstanceExtensionsService;
|
|
107
108
|
InstanceFileSyncService: InstanceFileSyncService;
|
|
109
|
+
IntentService: IntentService;
|
|
108
110
|
InternalMessagingService: InternalMessagingService;
|
|
109
111
|
InternalMessagingServiceVerifier: InternalMessagingServiceVerifier;
|
|
110
112
|
InternalSyncService: InternalSyncService;
|
|
@@ -191,6 +193,7 @@ interface Services {
|
|
|
191
193
|
ScriptDebuggerService: ScriptDebuggerService;
|
|
192
194
|
ScriptProfilerService: ScriptProfilerService;
|
|
193
195
|
ScriptRegistrationService: ScriptRegistrationService;
|
|
196
|
+
ScriptScannerService: ScriptScannerService;
|
|
194
197
|
SelectionHighlightManager: SelectionHighlightManager;
|
|
195
198
|
SerializationService: SerializationService;
|
|
196
199
|
ServerScriptService: ServerScriptService;
|
|
@@ -465,6 +468,7 @@ interface CreatableInstances {
|
|
|
465
468
|
PitchShiftSoundEffect: PitchShiftSoundEffect;
|
|
466
469
|
Plane: Plane;
|
|
467
470
|
PlaneConstraint: PlaneConstraint;
|
|
471
|
+
PlayerControlState: PlayerControlState;
|
|
468
472
|
PluginCapabilities: PluginCapabilities;
|
|
469
473
|
PointLight: PointLight;
|
|
470
474
|
Pose: Pose;
|
|
@@ -951,6 +955,8 @@ interface VideoCapture extends Capture {
|
|
|
951
955
|
*/
|
|
952
956
|
readonly _nominal_VideoCapture: unique symbol;
|
|
953
957
|
/**
|
|
958
|
+
* The length of the recorded video, in seconds.
|
|
959
|
+
*
|
|
954
960
|
* - **ThreadSafety**: ReadSafe
|
|
955
961
|
* - **Tags**: NotReplicated
|
|
956
962
|
*
|
|
@@ -1311,66 +1317,116 @@ interface EditableMesh extends RBXObject {
|
|
|
1311
1317
|
*/
|
|
1312
1318
|
AddVertex(this: EditableMesh, p: Vector3): number;
|
|
1313
1319
|
/**
|
|
1320
|
+
* Creates new mesh elements of the given attribute type and returns their IDs.
|
|
1321
|
+
*
|
|
1314
1322
|
* - **ThreadSafety**: Unsafe
|
|
1315
1323
|
* - **Tags**: CustomLuaState
|
|
1316
1324
|
*
|
|
1317
1325
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#BatchAdd)
|
|
1326
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1327
|
+
* @param attr The `MeshAttribute` type of element to create.
|
|
1328
|
+
* @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 an optional array of alpha numbers for `Color`; a 2D array of vertex-ID arrays for `Face`.
|
|
1329
|
+
* @returns Ordered array of new element IDs matching the input order.
|
|
1318
1330
|
*/
|
|
1319
1331
|
BatchAdd(this: EditableMesh, attr: CastsToEnum<Enum.MeshAttribute>, data: Array<unknown>): Array<unknown>;
|
|
1320
1332
|
/**
|
|
1333
|
+
* Returns the per-corner attribute IDs for each face in a batch.
|
|
1334
|
+
*
|
|
1321
1335
|
* - **ThreadSafety**: Safe
|
|
1322
1336
|
* - **Tags**: CustomLuaState
|
|
1323
1337
|
*
|
|
1324
1338
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#BatchGetFaceAttributes)
|
|
1339
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1340
|
+
* @param attr The attribute to retrieve for each face's corners, for example `MeshAttribute.Normal`, `MeshAttribute.UV`, or `MeshAttribute.Color`.
|
|
1341
|
+
* @param faceIds Faces to query.
|
|
1342
|
+
* @returns 2D array where `result[i]` is the array of attribute IDs at the corners of `faceIds[i]`.
|
|
1325
1343
|
*/
|
|
1326
1344
|
BatchGetFaceAttributes(this: EditableMesh, attr: CastsToEnum<Enum.MeshAttribute>, faceIds: Array<unknown>): Array<unknown>;
|
|
1327
1345
|
/**
|
|
1346
|
+
* Returns attribute values for each ID in a batch.
|
|
1347
|
+
*
|
|
1328
1348
|
* - **ThreadSafety**: Safe
|
|
1329
1349
|
* - **Tags**: CustomLuaState
|
|
1330
1350
|
*
|
|
1331
1351
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#BatchGetValues)
|
|
1352
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1353
|
+
* @param ids IDs of the elements to read. All must be the same type.
|
|
1354
|
+
* @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.
|
|
1332
1355
|
*/
|
|
1333
1356
|
BatchGetValues(this: EditableMesh, ids: Array<unknown>): unknown;
|
|
1334
1357
|
/**
|
|
1358
|
+
* Returns the attribute IDs associated with each vertex in a batch.
|
|
1359
|
+
*
|
|
1335
1360
|
* - **ThreadSafety**: Safe
|
|
1336
1361
|
* - **Tags**: CustomLuaState
|
|
1337
1362
|
*
|
|
1338
1363
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#BatchGetVertexAttributes)
|
|
1364
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1365
|
+
* @param attr The attribute type to look up, for example `MeshAttribute.Face` to get every face that references each vertex.
|
|
1366
|
+
* @param vertexIds Vertices to query.
|
|
1367
|
+
* @returns 2D array where `result[i]` is the array of attribute IDs associated with `vertexIds[i]`.
|
|
1339
1368
|
*/
|
|
1340
1369
|
BatchGetVertexAttributes(this: EditableMesh, attr: CastsToEnum<Enum.MeshAttribute>, vertexIds: Array<unknown>): Array<unknown>;
|
|
1341
1370
|
/**
|
|
1371
|
+
* Returns the attribute ID at each specified corner for a batch of vertex–face pairs.
|
|
1372
|
+
*
|
|
1342
1373
|
* - **ThreadSafety**: Safe
|
|
1343
1374
|
* - **Tags**: CustomLuaState
|
|
1344
1375
|
*
|
|
1345
1376
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#BatchGetVertexFaceAttributes)
|
|
1377
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1378
|
+
* @param attr The attribute to retrieve.
|
|
1379
|
+
* @param vertexIds Vertices that identify each corner.
|
|
1380
|
+
* @param faceIds Faces that identify each corner.
|
|
1381
|
+
* @returns Array of attribute IDs at each corner, in the same order as the inputs.
|
|
1346
1382
|
*/
|
|
1347
1383
|
BatchGetVertexFaceAttributes(this: EditableMesh, attr: CastsToEnum<Enum.MeshAttribute>, vertexIds: Array<unknown>, faceIds: Array<unknown>): Array<unknown>;
|
|
1348
1384
|
/**
|
|
1385
|
+
* Removes a batch of faces.
|
|
1386
|
+
*
|
|
1349
1387
|
* - **ThreadSafety**: Unsafe
|
|
1350
1388
|
* - **Tags**: CustomLuaState
|
|
1351
1389
|
*
|
|
1352
1390
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#BatchRemove)
|
|
1391
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1392
|
+
* @param faceIds Face IDs to remove.
|
|
1353
1393
|
*/
|
|
1354
1394
|
BatchRemove(this: EditableMesh, ids: Array<unknown>): void;
|
|
1355
1395
|
/**
|
|
1396
|
+
* Sets the per-corner attribute IDs for each face in a batch.
|
|
1397
|
+
*
|
|
1356
1398
|
* - **ThreadSafety**: Unsafe
|
|
1357
1399
|
* - **Tags**: CustomLuaState
|
|
1358
1400
|
*
|
|
1359
1401
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#BatchSetFaceAttributes)
|
|
1402
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1403
|
+
* @param faceIds Faces to update.
|
|
1404
|
+
* @param attrIdArrays 2D array. `attrIdArrays[i]` is the list of attribute IDs for the corners of `faceIds[i]`. Each inner array must have one entry per corner of the face.
|
|
1360
1405
|
*/
|
|
1361
1406
|
BatchSetFaceAttributes(this: EditableMesh, faceIds: Array<unknown>, attrIdArrays: Array<unknown>): void;
|
|
1362
1407
|
/**
|
|
1408
|
+
* Writes attribute values to a batch of mesh element IDs.
|
|
1409
|
+
*
|
|
1363
1410
|
* - **ThreadSafety**: Unsafe
|
|
1364
1411
|
* - **Tags**: CustomLuaState
|
|
1365
1412
|
*
|
|
1366
1413
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#BatchSetValues)
|
|
1414
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1415
|
+
* @param ids IDs of the elements to write. All must be the same type.
|
|
1416
|
+
* @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.
|
|
1367
1417
|
*/
|
|
1368
1418
|
BatchSetValues(this: EditableMesh, ids: Array<unknown>, values: Array<unknown>): void;
|
|
1369
1419
|
/**
|
|
1420
|
+
* Sets the attribute at a specific corner for each vertex–face pair in a batch.
|
|
1421
|
+
*
|
|
1370
1422
|
* - **ThreadSafety**: Unsafe
|
|
1371
1423
|
* - **Tags**: CustomLuaState
|
|
1372
1424
|
*
|
|
1373
1425
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#BatchSetVertexFaceAttributes)
|
|
1426
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1427
|
+
* @param vertexIds Vertices that identify each corner.
|
|
1428
|
+
* @param faceIds Faces that identify each corner.
|
|
1429
|
+
* @param attrIds Attribute IDs to assign.
|
|
1374
1430
|
*/
|
|
1375
1431
|
BatchSetVertexFaceAttributes(this: EditableMesh, vertexIds: Array<unknown>, faceIds: Array<unknown>, attrIds: Array<unknown>): void;
|
|
1376
1432
|
/**
|
|
@@ -2369,7 +2425,7 @@ interface Instance extends RBXObject {
|
|
|
2369
2425
|
*
|
|
2370
2426
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Instance#AddTag)
|
|
2371
2427
|
* @param this `Instance` is the base class for all classes in the Roblox class hierarchy which can be part of the `DataModel` tree.
|
|
2372
|
-
* @param tag
|
|
2428
|
+
* @param tag The tag to apply to the instance.
|
|
2373
2429
|
*/
|
|
2374
2430
|
AddTag(this: Instance, tag: string): void;
|
|
2375
2431
|
/**
|
|
@@ -2388,6 +2444,7 @@ interface Instance extends RBXObject {
|
|
|
2388
2444
|
*
|
|
2389
2445
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Instance#Clone)
|
|
2390
2446
|
* @param this `Instance` is the base class for all classes in the Roblox class hierarchy which can be part of the `DataModel` tree.
|
|
2447
|
+
* @returns A copy of the instance, or `nil` if the instance is not `Archivable`.
|
|
2391
2448
|
*/
|
|
2392
2449
|
Clone<T extends Instance>(this: T): T;
|
|
2393
2450
|
/**
|
|
@@ -2565,6 +2622,8 @@ interface Instance extends RBXObject {
|
|
|
2565
2622
|
*/
|
|
2566
2623
|
GetStyled(this: Instance, name: string, selector?: string): unknown;
|
|
2567
2624
|
/**
|
|
2625
|
+
* Returns an event that fires when the given style property changes on the instance.
|
|
2626
|
+
*
|
|
2568
2627
|
* - **ThreadSafety**: Unsafe
|
|
2569
2628
|
*
|
|
2570
2629
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Instance#GetStyledPropertyChangedSignal)
|
|
@@ -2580,6 +2639,7 @@ interface Instance extends RBXObject {
|
|
|
2580
2639
|
*
|
|
2581
2640
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Instance#GetTags)
|
|
2582
2641
|
* @param this `Instance` is the base class for all classes in the Roblox class hierarchy which can be part of the `DataModel` tree.
|
|
2642
|
+
* @returns An array of strings, each representing a tag applied to the instance.
|
|
2583
2643
|
*/
|
|
2584
2644
|
GetTags(this: Instance): Array<string>;
|
|
2585
2645
|
/**
|
|
@@ -2589,7 +2649,8 @@ interface Instance extends RBXObject {
|
|
|
2589
2649
|
*
|
|
2590
2650
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Instance#HasTag)
|
|
2591
2651
|
* @param this `Instance` is the base class for all classes in the Roblox class hierarchy which can be part of the `DataModel` tree.
|
|
2592
|
-
* @param tag
|
|
2652
|
+
* @param tag The tag to check for on the instance.
|
|
2653
|
+
* @returns `true` if the instance has the given tag, `false` otherwise.
|
|
2593
2654
|
*/
|
|
2594
2655
|
HasTag(this: Instance, tag: string): boolean;
|
|
2595
2656
|
/**
|
|
@@ -2644,7 +2705,7 @@ interface Instance extends RBXObject {
|
|
|
2644
2705
|
*
|
|
2645
2706
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Instance#RemoveTag)
|
|
2646
2707
|
* @param this `Instance` is the base class for all classes in the Roblox class hierarchy which can be part of the `DataModel` tree.
|
|
2647
|
-
* @param tag
|
|
2708
|
+
* @param tag The tag to remove from the instance.
|
|
2648
2709
|
*/
|
|
2649
2710
|
RemoveTag(this: Instance, tag: string): void;
|
|
2650
2711
|
/**
|
|
@@ -2845,6 +2906,7 @@ interface AccessoryDescription extends Instance {
|
|
|
2845
2906
|
*
|
|
2846
2907
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AccessoryDescription#GetAppliedInstance)
|
|
2847
2908
|
* @param this Describes the appearance of an `Accessory` for the `HumanoidDescription`.
|
|
2909
|
+
* @returns The applied `Accessory`.
|
|
2848
2910
|
*/
|
|
2849
2911
|
GetAppliedInstance(this: AccessoryDescription): Instance | undefined;
|
|
2850
2912
|
}
|
|
@@ -2948,6 +3010,8 @@ interface Accessory extends Accoutrement {
|
|
|
2948
3010
|
/**
|
|
2949
3011
|
* **Deprecated:** This class has been superseded by the `Accessory` class. Do not use it for new work.
|
|
2950
3012
|
*
|
|
3013
|
+
* A deprecated accessory container superseded by `Accessory`.
|
|
3014
|
+
*
|
|
2951
3015
|
* - **Tags**:
|
|
2952
3016
|
*
|
|
2953
3017
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Hat)
|
|
@@ -3112,6 +3176,9 @@ interface AdService extends Instance {
|
|
|
3112
3176
|
RegisterAdOpportunityAsync(this: AdService, instance: Instance, placementId?: number): void;
|
|
3113
3177
|
/**
|
|
3114
3178
|
* Plays the video ad to the current user inside the experience.
|
|
3179
|
+
* ```
|
|
3180
|
+
* **Warning**: Rewarded Video ads must be user opt-in and clearly disclosed. For details, review our [eligibility requirements](../../../production/promotion/rewarded-video-ads.md#eligibility-requirements) and [advertising standards](https://en.help.roblox.com/hc/en-us/articles/13722260778260-Advertising-Standards).
|
|
3181
|
+
* ```
|
|
3115
3182
|
*
|
|
3116
3183
|
* - **ThreadSafety**: Unsafe
|
|
3117
3184
|
* - **Tags**: Yields
|
|
@@ -3738,6 +3805,36 @@ interface AnimationNodeDefinition extends Instance {
|
|
|
3738
3805
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AnimationNodeDefinition#NodeType)
|
|
3739
3806
|
*/
|
|
3740
3807
|
NodeType: Enum.AnimationNodeType;
|
|
3808
|
+
/**
|
|
3809
|
+
* - **ThreadSafety**: Unsafe
|
|
3810
|
+
*
|
|
3811
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AnimationNodeDefinition#AddInputPin)
|
|
3812
|
+
*/
|
|
3813
|
+
AddInputPin(this: AnimationNodeDefinition, pin: string): void;
|
|
3814
|
+
/**
|
|
3815
|
+
* - **ThreadSafety**: Unsafe
|
|
3816
|
+
*
|
|
3817
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AnimationNodeDefinition#GetOrderedInputPinNames)
|
|
3818
|
+
*/
|
|
3819
|
+
GetOrderedInputPinNames(this: AnimationNodeDefinition): Array<unknown>;
|
|
3820
|
+
/**
|
|
3821
|
+
* - **ThreadSafety**: Unsafe
|
|
3822
|
+
*
|
|
3823
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AnimationNodeDefinition#RemoveInputPin)
|
|
3824
|
+
*/
|
|
3825
|
+
RemoveInputPin(this: AnimationNodeDefinition, pin: string): void;
|
|
3826
|
+
/**
|
|
3827
|
+
* - **ThreadSafety**: Unsafe
|
|
3828
|
+
*
|
|
3829
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AnimationNodeDefinition#SetOrderedInputPinNames)
|
|
3830
|
+
*/
|
|
3831
|
+
SetOrderedInputPinNames(this: AnimationNodeDefinition, pins: Array<unknown>): void;
|
|
3832
|
+
/**
|
|
3833
|
+
* - **ThreadSafety**: Unsafe
|
|
3834
|
+
*
|
|
3835
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AnimationNodeDefinition#InputPinsChanged)
|
|
3836
|
+
*/
|
|
3837
|
+
readonly InputPinsChanged: RBXScriptSignal<() => void>;
|
|
3741
3838
|
}
|
|
3742
3839
|
/**
|
|
3743
3840
|
* Used to store information regarding the model an animation was authored for.
|
|
@@ -4275,6 +4372,8 @@ interface AssetCounterService extends Instance {
|
|
|
4275
4372
|
readonly _nominal_AssetCounterService: unique symbol;
|
|
4276
4373
|
}
|
|
4277
4374
|
/**
|
|
4375
|
+
* Runs a local HTTP server that serves assets to real devices.
|
|
4376
|
+
*
|
|
4278
4377
|
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
4279
4378
|
*
|
|
4280
4379
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AssetDeliveryProxy)
|
|
@@ -4289,18 +4388,24 @@ interface AssetDeliveryProxy extends Instance {
|
|
|
4289
4388
|
*/
|
|
4290
4389
|
readonly _nominal_AssetDeliveryProxy: unique symbol;
|
|
4291
4390
|
/**
|
|
4391
|
+
* The network interface address that the asset-delivery HTTP server binds to.
|
|
4392
|
+
*
|
|
4292
4393
|
* - **ThreadSafety**: ReadSafe
|
|
4293
4394
|
*
|
|
4294
4395
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AssetDeliveryProxy#Interface)
|
|
4295
4396
|
*/
|
|
4296
4397
|
Interface: string;
|
|
4297
4398
|
/**
|
|
4399
|
+
* The TCP port that the asset-delivery HTTP server listens on.
|
|
4400
|
+
*
|
|
4298
4401
|
* - **ThreadSafety**: ReadSafe
|
|
4299
4402
|
*
|
|
4300
4403
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AssetDeliveryProxy#Port)
|
|
4301
4404
|
*/
|
|
4302
4405
|
Port: number;
|
|
4303
4406
|
/**
|
|
4407
|
+
* Controls whether the asset-delivery HTTP server is running.
|
|
4408
|
+
*
|
|
4304
4409
|
* - **ThreadSafety**: ReadSafe
|
|
4305
4410
|
*
|
|
4306
4411
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AssetDeliveryProxy#StartServer)
|
|
@@ -4338,6 +4443,8 @@ interface AssetManagerService extends Instance {
|
|
|
4338
4443
|
readonly _nominal_AssetManagerService: unique symbol;
|
|
4339
4444
|
}
|
|
4340
4445
|
/**
|
|
4446
|
+
* Configures a single patch asset built by `IncrementalPatchBuilder` and served through `AssetDeliveryProxy`.
|
|
4447
|
+
*
|
|
4341
4448
|
* - **Tags**: NotCreatable, NotReplicated
|
|
4342
4449
|
*
|
|
4343
4450
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AssetPatchSettings)
|
|
@@ -4352,18 +4459,24 @@ interface AssetPatchSettings extends Instance {
|
|
|
4352
4459
|
*/
|
|
4353
4460
|
readonly _nominal_AssetPatchSettings: unique symbol;
|
|
4354
4461
|
/**
|
|
4462
|
+
* The content ID used to override this patch asset when it is served by `AssetDeliveryProxy`.
|
|
4463
|
+
*
|
|
4355
4464
|
* - **ThreadSafety**: ReadSafe
|
|
4356
4465
|
*
|
|
4357
4466
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AssetPatchSettings#ContentId)
|
|
4358
4467
|
*/
|
|
4359
4468
|
ContentId: string;
|
|
4360
4469
|
/**
|
|
4470
|
+
* The filesystem path where the built patch asset is cached; when empty, an in-memory cache is used instead.
|
|
4471
|
+
*
|
|
4361
4472
|
* - **ThreadSafety**: ReadSafe
|
|
4362
4473
|
*
|
|
4363
4474
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AssetPatchSettings#OutputPath)
|
|
4364
4475
|
*/
|
|
4365
4476
|
OutputPath: string;
|
|
4366
4477
|
/**
|
|
4478
|
+
* An identifier for distinguishing patches under a single `IncrementalPatchBuilder`. Has no effect.
|
|
4479
|
+
*
|
|
4367
4480
|
* - **ThreadSafety**: ReadSafe
|
|
4368
4481
|
*
|
|
4369
4482
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AssetPatchSettings#PatchId)
|
|
@@ -4409,6 +4522,9 @@ interface AssetService extends Instance {
|
|
|
4409
4522
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AssetService#CreateEditableImage)
|
|
4410
4523
|
* @param this A non-replicated service that handles asset-related queries to the Roblox web API.
|
|
4411
4524
|
* @param editableImageOptions Options table containing controls for the method: - `Size` – A `Vector2` that specifies the image's desired width and height.
|
|
4525
|
+
*
|
|
4526
|
+
*
|
|
4527
|
+
* @returns The new `EditableImage`, or `nil` if the device-specific editable memory budget is exhausted.
|
|
4412
4528
|
*/
|
|
4413
4529
|
CreateEditableImage(this: AssetService, editableImageOptions?: object): EditableImage;
|
|
4414
4530
|
/**
|
|
@@ -4419,6 +4535,7 @@ interface AssetService extends Instance {
|
|
|
4419
4535
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AssetService#CreateEditableMesh)
|
|
4420
4536
|
* @param this A non-replicated service that handles asset-related queries to the Roblox web API.
|
|
4421
4537
|
* @param editableMeshOptions Table containing options for the created `EditableMesh`. Currently no options are available since `FixedSize` will always be `false` for empty editable meshes.
|
|
4538
|
+
* @returns The new `EditableMesh`, or `nil` if the device-specific editable memory budget is exhausted.
|
|
4422
4539
|
*/
|
|
4423
4540
|
CreateEditableMesh(this: AssetService, editableMeshOptions?: object): EditableMesh;
|
|
4424
4541
|
/**
|
|
@@ -4537,6 +4654,9 @@ interface AssetService extends Instance {
|
|
|
4537
4654
|
* @param options Options table containing one or more controls for the method: - `CollisionFidelity` – The value of `CollisionFidelity` in the resulting part. Defaults to `CollisionFidelity.Default` if the option is absent or the `options` table is `nil`.
|
|
4538
4655
|
* - `RenderFidelity` – The value of `RenderFidelity` in the resulting part. Defaults to `RenderFidelity.Automatic` if the option is absent or the `options` table is `nil`.
|
|
4539
4656
|
* - `FluidFidelity` – The value of `FluidFidelity` in the resulting part. Defaults to `FluidFidelity.Automatic` if the option is absent or the `options` table is `nil`.
|
|
4657
|
+
*
|
|
4658
|
+
*
|
|
4659
|
+
* @returns The new `MeshPart` with the specified mesh and fidelity settings applied.
|
|
4540
4660
|
*/
|
|
4541
4661
|
CreateMeshPartAsync(this: AssetService, meshContent: Content, options?: CreateMeshPartAsyncOptions): MeshPart;
|
|
4542
4662
|
/**
|
|
@@ -4561,10 +4681,11 @@ interface AssetService extends Instance {
|
|
|
4561
4681
|
*
|
|
4562
4682
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AssetService#CreatePlaceInPlayerInventoryAsync)
|
|
4563
4683
|
* @param this A non-replicated service that handles asset-related queries to the Roblox web API.
|
|
4564
|
-
* @param player
|
|
4565
|
-
* @param placeName
|
|
4566
|
-
* @param templatePlaceID
|
|
4567
|
-
* @param description
|
|
4684
|
+
* @param player The `Player` whose inventory receives the cloned place.
|
|
4685
|
+
* @param placeName Name for the new place.
|
|
4686
|
+
* @param templatePlaceID `PlaceId` of the place to clone.
|
|
4687
|
+
* @param description Description for the new place.
|
|
4688
|
+
* @returns `PlaceId` of the new place.
|
|
4568
4689
|
*/
|
|
4569
4690
|
CreatePlaceInPlayerInventoryAsync(this: AssetService, player: Player, placeName: string, templatePlaceID: number, description: string): number;
|
|
4570
4691
|
/**
|
|
@@ -4595,7 +4716,7 @@ interface AssetService extends Instance {
|
|
|
4595
4716
|
*
|
|
4596
4717
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AssetService#GetAssetIdsForPackage)
|
|
4597
4718
|
* @param this A non-replicated service that handles asset-related queries to the Roblox web API.
|
|
4598
|
-
* @param packageAssetId
|
|
4719
|
+
* @param packageAssetId The asset ID of the package to query.
|
|
4599
4720
|
* @returns Asset IDs that are contained in a specified package.
|
|
4600
4721
|
*
|
|
4601
4722
|
* @deprecated GetAssetIdsForPackageAsync
|
|
@@ -4609,7 +4730,7 @@ interface AssetService extends Instance {
|
|
|
4609
4730
|
*
|
|
4610
4731
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AssetService#GetAssetIdsForPackageAsync)
|
|
4611
4732
|
* @param this A non-replicated service that handles asset-related queries to the Roblox web API.
|
|
4612
|
-
* @param packageAssetId
|
|
4733
|
+
* @param packageAssetId The asset ID of the package to query.
|
|
4613
4734
|
* @returns Asset IDs that are contained in a specified package.
|
|
4614
4735
|
*/
|
|
4615
4736
|
GetAssetIdsForPackageAsync(this: AssetService, packageAssetId: number): Array<unknown>;
|
|
@@ -4662,7 +4783,8 @@ interface AssetService extends Instance {
|
|
|
4662
4783
|
*
|
|
4663
4784
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AssetService#GetCreatorAssetID)
|
|
4664
4785
|
* @param this A non-replicated service that handles asset-related queries to the Roblox web API.
|
|
4665
|
-
* @param creationID
|
|
4786
|
+
* @param creationID The asset ID to look up for creator information.
|
|
4787
|
+
* @returns The `Player.UserId` of the account that created the asset.
|
|
4666
4788
|
*
|
|
4667
4789
|
* @deprecated GetProductInfo
|
|
4668
4790
|
*/
|
|
@@ -4675,6 +4797,7 @@ interface AssetService extends Instance {
|
|
|
4675
4797
|
*
|
|
4676
4798
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AssetService#GetGamePlacesAsync)
|
|
4677
4799
|
* @param this A non-replicated service that handles asset-related queries to the Roblox web API.
|
|
4800
|
+
* @returns A `StandardPages` object whose pages contain the name and `PlaceId` of each place in the current experience.
|
|
4678
4801
|
*/
|
|
4679
4802
|
GetGamePlacesAsync(this: AssetService): StandardPages<{
|
|
4680
4803
|
Name: string;
|
|
@@ -4707,13 +4830,16 @@ interface AssetService extends Instance {
|
|
|
4707
4830
|
*/
|
|
4708
4831
|
PromptCreateAssetAsync(this: AssetService, player: Player, instance: Instance, assetType: CastsToEnum<Enum.AssetType>): unknown;
|
|
4709
4832
|
/**
|
|
4833
|
+
* Prompts the specified player to select and upload a video, which is then converted into an `AnimationClip`.
|
|
4834
|
+
*
|
|
4710
4835
|
* - **ThreadSafety**: Unsafe
|
|
4711
4836
|
* - **Tags**: Yields
|
|
4712
4837
|
*
|
|
4713
4838
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AssetService#PromptImportAnimationClipFromVideoAsync)
|
|
4714
4839
|
* @param this A non-replicated service that handles asset-related queries to the Roblox web API.
|
|
4715
|
-
* @param player
|
|
4716
|
-
* @param progressCallback
|
|
4840
|
+
* @param player The player who is prompted, on their own client, to select and upload a video. The player's consent is required before the video is uploaded.
|
|
4841
|
+
* @param progressCallback A function that receives status updates (an `AnimationClipFromVideoStatus` value) while the video is uploaded and processed.
|
|
4842
|
+
* @returns A tuple containing an `AnimationClipFromVideoStatus` describing the outcome and, on success, the resulting `AnimationClip` (`nil` otherwise).
|
|
4717
4843
|
*/
|
|
4718
4844
|
PromptImportAnimationClipFromVideoAsync(this: AssetService, player: Player, progressCallback: Callback): unknown;
|
|
4719
4845
|
/**
|
|
@@ -4737,7 +4863,8 @@ interface AssetService extends Instance {
|
|
|
4737
4863
|
*
|
|
4738
4864
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AssetService#SearchAudio)
|
|
4739
4865
|
* @param this A non-replicated service that handles asset-related queries to the Roblox web API.
|
|
4740
|
-
* @param searchParameters
|
|
4866
|
+
* @param searchParameters A `AudioSearchParams` object defining the search criteria such as keyword, title, artist, audio type, and duration range.
|
|
4867
|
+
* @returns An `AudioPages` object containing the paginated results of the audio search.
|
|
4741
4868
|
*
|
|
4742
4869
|
* @deprecated SearchAudioAsync
|
|
4743
4870
|
*/
|
|
@@ -4750,7 +4877,8 @@ interface AssetService extends Instance {
|
|
|
4750
4877
|
*
|
|
4751
4878
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AssetService#SearchAudioAsync)
|
|
4752
4879
|
* @param this A non-replicated service that handles asset-related queries to the Roblox web API.
|
|
4753
|
-
* @param searchParameters
|
|
4880
|
+
* @param searchParameters A `AudioSearchParams` object defining the search criteria such as keyword, title, artist, audio type, and duration range.
|
|
4881
|
+
* @returns An `AudioPages` object containing the paginated results of the audio search.
|
|
4754
4882
|
*/
|
|
4755
4883
|
SearchAudioAsync(this: AssetService, searchParameters: AudioSearchParams): AudioPages;
|
|
4756
4884
|
}
|
|
@@ -4964,6 +5092,7 @@ interface Attachment extends Instance {
|
|
|
4964
5092
|
*
|
|
4965
5093
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Attachment#GetAxis)
|
|
4966
5094
|
* @param this Defines a point and orientation relative to an ancestor `PVInstance`, `Bone`, or another `Attachment`.
|
|
5095
|
+
* @returns The direction of the X axis as a unit `Vector3` in the attachment's local space.
|
|
4967
5096
|
*
|
|
4968
5097
|
* @deprecated Axis
|
|
4969
5098
|
*/
|
|
@@ -4975,6 +5104,7 @@ interface Attachment extends Instance {
|
|
|
4975
5104
|
*
|
|
4976
5105
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Attachment#GetConstraints)
|
|
4977
5106
|
* @param this Defines a point and orientation relative to an ancestor `PVInstance`, `Bone`, or another `Attachment`.
|
|
5107
|
+
* @returns An array of `Constraint` objects that are connected to this attachment.
|
|
4978
5108
|
*/
|
|
4979
5109
|
GetConstraints(this: Attachment): Array<Instance>;
|
|
4980
5110
|
/**
|
|
@@ -4987,6 +5117,7 @@ interface Attachment extends Instance {
|
|
|
4987
5117
|
*
|
|
4988
5118
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Attachment#GetSecondaryAxis)
|
|
4989
5119
|
* @param this Defines a point and orientation relative to an ancestor `PVInstance`, `Bone`, or another `Attachment`.
|
|
5120
|
+
* @returns The direction of the Y axis as a unit `Vector3` in the attachment's local space.
|
|
4990
5121
|
*
|
|
4991
5122
|
* @deprecated SecondaryAxis
|
|
4992
5123
|
*/
|
|
@@ -5001,7 +5132,7 @@ interface Attachment extends Instance {
|
|
|
5001
5132
|
*
|
|
5002
5133
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Attachment#SetAxis)
|
|
5003
5134
|
* @param this Defines a point and orientation relative to an ancestor `PVInstance`, `Bone`, or another `Attachment`.
|
|
5004
|
-
* @param axis
|
|
5135
|
+
* @param axis The `Vector3` to set as the X-axis direction of the attachment.
|
|
5005
5136
|
*
|
|
5006
5137
|
* @deprecated Axis
|
|
5007
5138
|
*/
|
|
@@ -5016,7 +5147,7 @@ interface Attachment extends Instance {
|
|
|
5016
5147
|
*
|
|
5017
5148
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Attachment#SetSecondaryAxis)
|
|
5018
5149
|
* @param this Defines a point and orientation relative to an ancestor `PVInstance`, `Bone`, or another `Attachment`.
|
|
5019
|
-
* @param axis
|
|
5150
|
+
* @param axis The `Vector3` to set as the Y-axis direction of the attachment.
|
|
5020
5151
|
*
|
|
5021
5152
|
* @deprecated SecondaryAxis
|
|
5022
5153
|
*/
|
|
@@ -5567,6 +5698,7 @@ interface AudioDeviceInput extends Instance {
|
|
|
5567
5698
|
*
|
|
5568
5699
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioDeviceInput#GetUserIdAccessList)
|
|
5569
5700
|
* @param this Produces audio streams from physical devices, such as microphones.
|
|
5701
|
+
* @returns An array of user IDs that are either in the allow-list or the deny-list.
|
|
5570
5702
|
*/
|
|
5571
5703
|
GetUserIdAccessList(this: AudioDeviceInput): Array<unknown>;
|
|
5572
5704
|
/**
|
|
@@ -5576,7 +5708,7 @@ interface AudioDeviceInput extends Instance {
|
|
|
5576
5708
|
*
|
|
5577
5709
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioDeviceInput#SetUserIdAccessList)
|
|
5578
5710
|
* @param this Produces audio streams from physical devices, such as microphones.
|
|
5579
|
-
* @param userIds
|
|
5711
|
+
* @param userIds An array of user IDs to apply to this `AudioDeviceInput`.
|
|
5580
5712
|
*/
|
|
5581
5713
|
SetUserIdAccessList(this: AudioDeviceInput, userIds: Array<unknown>): void;
|
|
5582
5714
|
/**
|
|
@@ -5853,24 +5985,32 @@ interface AudioEmitter extends Instance {
|
|
|
5853
5985
|
*/
|
|
5854
5986
|
AudioInteractionGroup: string;
|
|
5855
5987
|
/**
|
|
5988
|
+
* Controls whether sound from this `AudioEmitter` bends around corners when acoustic simulation is active.
|
|
5989
|
+
*
|
|
5856
5990
|
* - **ThreadSafety**: ReadSafe
|
|
5857
5991
|
*
|
|
5858
5992
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioEmitter#DiffractionEnabled)
|
|
5859
5993
|
*/
|
|
5860
5994
|
DiffractionEnabled: Enum.SimulationMode;
|
|
5861
5995
|
/**
|
|
5996
|
+
* The minimum and maximum distance range used by the selected `DistanceAttenuationMode` preset.
|
|
5997
|
+
*
|
|
5862
5998
|
* - **ThreadSafety**: ReadSafe
|
|
5863
5999
|
*
|
|
5864
6000
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioEmitter#DistanceAttenuationBounds)
|
|
5865
6001
|
*/
|
|
5866
6002
|
DistanceAttenuationBounds: NumberRange;
|
|
5867
6003
|
/**
|
|
6004
|
+
* Determines how the volume of this `AudioEmitter` attenuates over distance.
|
|
6005
|
+
*
|
|
5868
6006
|
* - **ThreadSafety**: ReadSafe
|
|
5869
6007
|
*
|
|
5870
6008
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioEmitter#DistanceAttenuationMode)
|
|
5871
6009
|
*/
|
|
5872
6010
|
DistanceAttenuationMode: Enum.DistanceAttenuationMode;
|
|
5873
6011
|
/**
|
|
6012
|
+
* Controls whether sound from this `AudioEmitter` is muffled when obstructed by geometry.
|
|
6013
|
+
*
|
|
5874
6014
|
* - **ThreadSafety**: ReadSafe
|
|
5875
6015
|
*
|
|
5876
6016
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioEmitter#OcclusionEnabled)
|
|
@@ -5893,6 +6033,8 @@ interface AudioEmitter extends Instance {
|
|
|
5893
6033
|
*/
|
|
5894
6034
|
PositionType: Enum.EmitterPositionType;
|
|
5895
6035
|
/**
|
|
6036
|
+
* Controls whether sound from this `AudioEmitter` receives environmental reverb when acoustic simulation is active.
|
|
6037
|
+
*
|
|
5896
6038
|
* - **ThreadSafety**: ReadSafe
|
|
5897
6039
|
*
|
|
5898
6040
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioEmitter#ReverbEnabled)
|
|
@@ -5929,7 +6071,8 @@ interface AudioEmitter extends Instance {
|
|
|
5929
6071
|
*
|
|
5930
6072
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioEmitter#GetAudibilityFor)
|
|
5931
6073
|
* @param this Emits audio streams into the world.
|
|
5932
|
-
* @param listener
|
|
6074
|
+
* @param listener The `AudioListener` to calculate audibility for.
|
|
6075
|
+
* @returns A number between `0` and `1` representing the combined volume after distance and angle attenuation.
|
|
5933
6076
|
*/
|
|
5934
6077
|
GetAudibilityFor(this: AudioEmitter, listener: AudioListener): number;
|
|
5935
6078
|
/**
|
|
@@ -5951,6 +6094,7 @@ interface AudioEmitter extends Instance {
|
|
|
5951
6094
|
*
|
|
5952
6095
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioEmitter#GetDistanceAttenuation)
|
|
5953
6096
|
* @param this Emits audio streams into the world.
|
|
6097
|
+
* @returns A table mapping distance to volume, as described above.
|
|
5954
6098
|
*/
|
|
5955
6099
|
GetDistanceAttenuation(this: AudioEmitter): object;
|
|
5956
6100
|
/**
|
|
@@ -5970,6 +6114,7 @@ interface AudioEmitter extends Instance {
|
|
|
5970
6114
|
*
|
|
5971
6115
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioEmitter#GetInteractingListeners)
|
|
5972
6116
|
* @param this Emits audio streams into the world.
|
|
6117
|
+
* @returns An array of `AudioListeners`.
|
|
5973
6118
|
*/
|
|
5974
6119
|
GetInteractingListeners(this: AudioEmitter): Array<Instance>;
|
|
5975
6120
|
/**
|
|
@@ -5990,7 +6135,7 @@ interface AudioEmitter extends Instance {
|
|
|
5990
6135
|
*
|
|
5991
6136
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioEmitter#SetAngleAttenuation)
|
|
5992
6137
|
* @param this Emits audio streams into the world.
|
|
5993
|
-
* @param curve
|
|
6138
|
+
* @param curve A table mapping angle to volume. Keys are numbers between `0` and `180`, values are numbers between `0` and `1`.
|
|
5994
6139
|
*/
|
|
5995
6140
|
SetAngleAttenuation(this: AudioEmitter, curve: object): void;
|
|
5996
6141
|
/**
|
|
@@ -6001,7 +6146,7 @@ interface AudioEmitter extends Instance {
|
|
|
6001
6146
|
*
|
|
6002
6147
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioEmitter#SetDistanceAttenuation)
|
|
6003
6148
|
* @param this Emits audio streams into the world.
|
|
6004
|
-
* @param curve
|
|
6149
|
+
* @param curve A table mapping distance to volume. Keys are numbers greater than or equal to `0`, values are numbers between `0` and `1`.
|
|
6005
6150
|
*/
|
|
6006
6151
|
SetDistanceAttenuation(this: AudioEmitter, curve: DistanceAttenuationCurve): void;
|
|
6007
6152
|
/**
|
|
@@ -6578,12 +6723,16 @@ interface AudioListener extends Instance {
|
|
|
6578
6723
|
*/
|
|
6579
6724
|
AudioInteractionGroup: string;
|
|
6580
6725
|
/**
|
|
6726
|
+
* Controls whether sound heard by this `AudioListener` bends around corners when acoustic simulation is active.
|
|
6727
|
+
*
|
|
6581
6728
|
* - **ThreadSafety**: ReadSafe
|
|
6582
6729
|
*
|
|
6583
6730
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioListener#DiffractionEnabled)
|
|
6584
6731
|
*/
|
|
6585
6732
|
DiffractionEnabled: Enum.SimulationMode;
|
|
6586
6733
|
/**
|
|
6734
|
+
* Controls whether sound heard by this `AudioListener` is muffled when obstructed by geometry.
|
|
6735
|
+
*
|
|
6587
6736
|
* - **ThreadSafety**: ReadSafe
|
|
6588
6737
|
*
|
|
6589
6738
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioListener#OcclusionEnabled)
|
|
@@ -6606,6 +6755,8 @@ interface AudioListener extends Instance {
|
|
|
6606
6755
|
*/
|
|
6607
6756
|
PositionType: Enum.ListenerPositionType;
|
|
6608
6757
|
/**
|
|
6758
|
+
* Controls whether sound heard by this `AudioListener` receives environmental reverb when acoustic simulation is active.
|
|
6759
|
+
*
|
|
6609
6760
|
* - **ThreadSafety**: ReadSafe
|
|
6610
6761
|
*
|
|
6611
6762
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioListener#ReverbEnabled)
|
|
@@ -6642,7 +6793,8 @@ interface AudioListener extends Instance {
|
|
|
6642
6793
|
*
|
|
6643
6794
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioListener#GetAudibilityFor)
|
|
6644
6795
|
* @param this Records an audio stream from its surrounding `AudioEmitters` in the 3D world.
|
|
6645
|
-
* @param emitter
|
|
6796
|
+
* @param emitter The `AudioEmitter` whose audibility should be calculated relative to this listener.
|
|
6797
|
+
* @returns A number between 0 and 1 representing the combined volume after distance and angle attenuation from both the emitter and listener.
|
|
6646
6798
|
*/
|
|
6647
6799
|
GetAudibilityFor(this: AudioListener, emitter: AudioEmitter): number;
|
|
6648
6800
|
/**
|
|
@@ -6664,6 +6816,7 @@ interface AudioListener extends Instance {
|
|
|
6664
6816
|
*
|
|
6665
6817
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioListener#GetDistanceAttenuation)
|
|
6666
6818
|
* @param this Records an audio stream from its surrounding `AudioEmitters` in the 3D world.
|
|
6819
|
+
* @returns A table mapping distance keys to volume values, or an empty table if the default curve is being used.
|
|
6667
6820
|
*/
|
|
6668
6821
|
GetDistanceAttenuation(this: AudioListener): object;
|
|
6669
6822
|
/**
|
|
@@ -6683,6 +6836,7 @@ interface AudioListener extends Instance {
|
|
|
6683
6836
|
*
|
|
6684
6837
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioListener#GetInteractingEmitters)
|
|
6685
6838
|
* @param this Records an audio stream from its surrounding `AudioEmitters` in the 3D world.
|
|
6839
|
+
* @returns An array of `AudioEmitters` that share an `AudioInteractionGroup` with this listener.
|
|
6686
6840
|
*/
|
|
6687
6841
|
GetInteractingEmitters(this: AudioListener): Array<Instance>;
|
|
6688
6842
|
/**
|
|
@@ -6703,7 +6857,7 @@ interface AudioListener extends Instance {
|
|
|
6703
6857
|
*
|
|
6704
6858
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioListener#SetAngleAttenuation)
|
|
6705
6859
|
* @param this Records an audio stream from its surrounding `AudioEmitters` in the 3D world.
|
|
6706
|
-
* @param curve
|
|
6860
|
+
* @param curve A table mapping angle keys (0 to 180) to volume values (0 to 1), or an empty/nil table to use the default constant volume of 1.
|
|
6707
6861
|
*/
|
|
6708
6862
|
SetAngleAttenuation(this: AudioListener, curve: object): void;
|
|
6709
6863
|
/**
|
|
@@ -6714,7 +6868,7 @@ interface AudioListener extends Instance {
|
|
|
6714
6868
|
*
|
|
6715
6869
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioListener#SetDistanceAttenuation)
|
|
6716
6870
|
* @param this Records an audio stream from its surrounding `AudioEmitters` in the 3D world.
|
|
6717
|
-
* @param curve
|
|
6871
|
+
* @param curve A table mapping distance keys (greater than or equal to 0) to volume values (0 to 1), or an empty/nil table to use the default constant volume of 1 everywhere.
|
|
6718
6872
|
*/
|
|
6719
6873
|
SetDistanceAttenuation(this: AudioListener, curve: object): void;
|
|
6720
6874
|
/**
|
|
@@ -7687,6 +7841,7 @@ interface AudioTextToSpeech extends Instance {
|
|
|
7687
7841
|
*
|
|
7688
7842
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioTextToSpeech#LoadAsync)
|
|
7689
7843
|
* @param this Plays text as speech audio.
|
|
7844
|
+
* @returns An `AssetFetchStatus` — `Success` once the speech audio has been generated, or `Failure` if generation could not be completed.
|
|
7690
7845
|
*/
|
|
7691
7846
|
LoadAsync(this: AudioTextToSpeech): Enum.AssetFetchStatus;
|
|
7692
7847
|
/**
|
|
@@ -8487,11 +8642,14 @@ interface AvatarEditorService extends Instance {
|
|
|
8487
8642
|
*/
|
|
8488
8643
|
readonly _nominal_AvatarEditorService: unique symbol;
|
|
8489
8644
|
/**
|
|
8645
|
+
* Returns the `AccessoryType` that corresponds to the given `AvatarAssetType`.
|
|
8646
|
+
*
|
|
8490
8647
|
* - **ThreadSafety**: Unsafe
|
|
8491
8648
|
*
|
|
8492
8649
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AvatarEditorService#GetAccessoryType)
|
|
8493
8650
|
* @param this A service to support developer Avatar Editors.
|
|
8494
|
-
* @param avatarAssetType
|
|
8651
|
+
* @param avatarAssetType The `AvatarAssetType` to convert to its corresponding `AccessoryType`.
|
|
8652
|
+
* @returns The `AccessoryType` corresponding to the given `AvatarAssetType`, or `AccessoryType.Unknown` if the asset type has no matching accessory type.
|
|
8495
8653
|
*/
|
|
8496
8654
|
GetAccessoryType(this: AvatarEditorService, avatarAssetType: CastsToEnum<Enum.AvatarAssetType>): Enum.AccessoryType;
|
|
8497
8655
|
/**
|
|
@@ -8556,7 +8714,7 @@ interface AvatarEditorService extends Instance {
|
|
|
8556
8714
|
* @param this A service to support developer Avatar Editors.
|
|
8557
8715
|
* @param itemId The ItemId of the item being prompted to favorite.
|
|
8558
8716
|
* @param itemType The type of item being prompted to favorite.
|
|
8559
|
-
* @param shouldFavorite
|
|
8717
|
+
* @param shouldFavorite Whether to favorite (`true`) or unfavorite (`false`) the item.
|
|
8560
8718
|
*/
|
|
8561
8719
|
PromptSetFavorite(this: AvatarEditorService, itemId: number, itemType: CastsToEnum<Enum.AvatarItemType>, shouldFavorite: boolean): void;
|
|
8562
8720
|
/**
|
|
@@ -8602,12 +8760,15 @@ interface AvatarEditorService extends Instance {
|
|
|
8602
8760
|
/**
|
|
8603
8761
|
* **Deprecated:**
|
|
8604
8762
|
*
|
|
8763
|
+
* Deprecated. Returns a copy of the given `HumanoidDescription` that conforms to the platform Avatar rules.
|
|
8764
|
+
*
|
|
8605
8765
|
* - **ThreadSafety**: Unsafe
|
|
8606
8766
|
* - **Tags**: Yields
|
|
8607
8767
|
*
|
|
8608
8768
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AvatarEditorService#ConformToAvatarRules)
|
|
8609
8769
|
* @param this A service to support developer Avatar Editors.
|
|
8610
|
-
* @param humanoidDescription
|
|
8770
|
+
* @param humanoidDescription The `HumanoidDescription` to conform to the platform Avatar rules.
|
|
8771
|
+
* @returns A new `HumanoidDescription` that conforms to the platform Avatar rules.
|
|
8611
8772
|
*
|
|
8612
8773
|
* @deprecated ConformToAvatarRulesAsync
|
|
8613
8774
|
*/
|
|
@@ -8747,6 +8908,7 @@ interface AvatarEditorService extends Instance {
|
|
|
8747
8908
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AvatarEditorService#GetInventory)
|
|
8748
8909
|
* @param this A service to support developer Avatar Editors.
|
|
8749
8910
|
* @param assetTypes The `AvatarAssetType` that can will be checked for in the player's inventory.
|
|
8911
|
+
* @returns An `InventoryPages` object containing information about owned items matching the given asset types.
|
|
8750
8912
|
*
|
|
8751
8913
|
* @deprecated GetInventoryAsync
|
|
8752
8914
|
*/
|
|
@@ -8765,6 +8927,7 @@ interface AvatarEditorService extends Instance {
|
|
|
8765
8927
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AvatarEditorService#GetInventoryAsync)
|
|
8766
8928
|
* @param this A service to support developer Avatar Editors.
|
|
8767
8929
|
* @param assetTypes The `AvatarAssetType` that can will be checked for in the player's inventory.
|
|
8930
|
+
* @returns An `InventoryPages` object containing information about owned items matching the given asset types.
|
|
8768
8931
|
*/
|
|
8769
8932
|
GetInventoryAsync(this: AvatarEditorService, assetTypes: Array<unknown>): InventoryPages;
|
|
8770
8933
|
/**
|
|
@@ -8837,8 +9000,9 @@ interface AvatarEditorService extends Instance {
|
|
|
8837
9000
|
*
|
|
8838
9001
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AvatarEditorService#GetOutfits)
|
|
8839
9002
|
* @param this A service to support developer Avatar Editors.
|
|
8840
|
-
* @param outfitSource
|
|
8841
|
-
* @param outfitType
|
|
9003
|
+
* @param outfitSource An `OutfitSource` filter specifying which outfits to include. Defaults to `OutfitSource.All`.
|
|
9004
|
+
* @param outfitType An `OutfitType` filter specifying the type of outfits to return. Defaults to `OutfitType.All`.
|
|
9005
|
+
* @returns An `OutfitPages` object containing the outfit data for the local player.
|
|
8842
9006
|
*
|
|
8843
9007
|
* @deprecated GetOutfitsAsync
|
|
8844
9008
|
*/
|
|
@@ -8851,8 +9015,9 @@ interface AvatarEditorService extends Instance {
|
|
|
8851
9015
|
*
|
|
8852
9016
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AvatarEditorService#GetOutfitsAsync)
|
|
8853
9017
|
* @param this A service to support developer Avatar Editors.
|
|
8854
|
-
* @param outfitSource
|
|
8855
|
-
* @param outfitType
|
|
9018
|
+
* @param outfitSource An `OutfitSource` filter specifying which outfits to include. Defaults to `OutfitSource.All`.
|
|
9019
|
+
* @param outfitType An `OutfitType` filter specifying the type of outfits to return. Defaults to `OutfitType.All`.
|
|
9020
|
+
* @returns An `OutfitPages` object containing the outfit data for the local player.
|
|
8856
9021
|
*/
|
|
8857
9022
|
GetOutfitsAsync(this: AvatarEditorService, outfitSource?: CastsToEnum<Enum.OutfitSource>, outfitType?: CastsToEnum<Enum.OutfitType>): OutfitPages;
|
|
8858
9023
|
/**
|
|
@@ -8924,6 +9089,7 @@ interface AvatarEditorService extends Instance {
|
|
|
8924
9089
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AvatarEditorService#SearchCatalog)
|
|
8925
9090
|
* @param this A service to support developer Avatar Editors.
|
|
8926
9091
|
* @param searchParameters An object containing the parameters used for the search.
|
|
9092
|
+
* @returns A `CatalogPages` object containing the search results.
|
|
8927
9093
|
*
|
|
8928
9094
|
* @deprecated SearchCatalogAsync
|
|
8929
9095
|
*/
|
|
@@ -9889,6 +10055,7 @@ interface PlayerGui extends BasePlayerGui {
|
|
|
9889
10055
|
*
|
|
9890
10056
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PlayerGui#GetTopbarTransparency)
|
|
9891
10057
|
* @param this A container that holds a player's UI.
|
|
10058
|
+
* @returns The current topbar transparency, a number between 0 (completely opaque) and 1 (completely transparent).
|
|
9892
10059
|
*
|
|
9893
10060
|
* @deprecated
|
|
9894
10061
|
*/
|
|
@@ -9903,7 +10070,7 @@ interface PlayerGui extends BasePlayerGui {
|
|
|
9903
10070
|
*
|
|
9904
10071
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PlayerGui#SetTopbarTransparency)
|
|
9905
10072
|
* @param this A container that holds a player's UI.
|
|
9906
|
-
* @param transparency
|
|
10073
|
+
* @param transparency A number between 0 (completely opaque) and 1 (completely transparent). Values outside this range are clamped.
|
|
9907
10074
|
*
|
|
9908
10075
|
* @deprecated
|
|
9909
10076
|
*/
|
|
@@ -10008,11 +10175,14 @@ interface StarterGui extends BasePlayerGui {
|
|
|
10008
10175
|
*
|
|
10009
10176
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StarterGui#GetCore)
|
|
10010
10177
|
* @param this A container for `LayerCollector` objects to be copied into the `PlayerGui` of `Players`. Also provides a range of functions for interacting with the `CoreGui`.
|
|
10011
|
-
* @param parameterName
|
|
10178
|
+
* @param parameterName The name of the core parameter to retrieve, such as `"PointsNotificationsActive"` or `"ChatActive"`.
|
|
10179
|
+
* @returns The value associated with the specified core parameter name, whose type depends on the parameter queried.
|
|
10012
10180
|
*/
|
|
10013
10181
|
GetCore<T extends keyof GettableCores>(this: StarterGui, parameter: T): GettableCores[T];
|
|
10014
10182
|
}
|
|
10015
10183
|
/**
|
|
10184
|
+
* Abstract base class inherited by `RemoteEvent` and `UnreliableRemoteEvent` for asynchronous, one-way communication across the client-server boundary.
|
|
10185
|
+
*
|
|
10016
10186
|
* - **Tags**: NotCreatable
|
|
10017
10187
|
*
|
|
10018
10188
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/BaseRemoteEvent)
|
|
@@ -10152,6 +10322,8 @@ interface UnreliableRemoteEvent<T extends Callback = Callback> extends BaseRemot
|
|
|
10152
10322
|
readonly OnServerEvent: RBXScriptSignal<(player: Player, ...args: Array<unknown>) => void>;
|
|
10153
10323
|
}
|
|
10154
10324
|
/**
|
|
10325
|
+
* Abstract base class for `WrapTarget` and `WrapLayer` that stores cage mesh data for layered clothing deformation.
|
|
10326
|
+
*
|
|
10155
10327
|
* - **Tags**: NotCreatable
|
|
10156
10328
|
*
|
|
10157
10329
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/BaseWrap)
|
|
@@ -10166,6 +10338,8 @@ interface BaseWrap extends Instance {
|
|
|
10166
10338
|
*/
|
|
10167
10339
|
readonly _nominal_BaseWrap: unique symbol;
|
|
10168
10340
|
/**
|
|
10341
|
+
* The cage mesh this wrap uses to deform geometry, stored as a `Content` value.
|
|
10342
|
+
*
|
|
10169
10343
|
* - **ThreadSafety**: ReadSafe
|
|
10170
10344
|
*
|
|
10171
10345
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/BaseWrap#CageMeshContent)
|
|
@@ -10235,8 +10409,8 @@ interface WrapDeformer extends BaseWrap {
|
|
|
10235
10409
|
*
|
|
10236
10410
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/WrapDeformer#SetCageMeshContent)
|
|
10237
10411
|
* @param this Allows for the real-time deformation of a `MeshPart`.
|
|
10238
|
-
* @param content
|
|
10239
|
-
* @param cageOrigin
|
|
10412
|
+
* @param content A Roblox mesh asset ID or an `EditableMesh` reference specifying the cage mesh to deform against the sibling `WrapTarget`.
|
|
10413
|
+
* @param cageOrigin An optional `CFrame`, in the parent `MeshPart` space, that sets the cage's `CageOrigin`. When omitted, the existing `CageOrigin` is left unchanged.
|
|
10240
10414
|
*/
|
|
10241
10415
|
SetCageMeshContent(this: WrapDeformer, content: Content, cageOrigin?: CFrame): void;
|
|
10242
10416
|
/**
|
|
@@ -10247,6 +10421,7 @@ interface WrapDeformer extends BaseWrap {
|
|
|
10247
10421
|
*
|
|
10248
10422
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/WrapDeformer#CreateEditableMeshAsync)
|
|
10249
10423
|
* @param this Allows for the real-time deformation of a `MeshPart`.
|
|
10424
|
+
* @returns An `EditableMesh` matching the deformed parent mesh geometry, with its `FixedSize` set to `true`.
|
|
10250
10425
|
*/
|
|
10251
10426
|
CreateEditableMeshAsync(this: WrapDeformer): EditableMesh;
|
|
10252
10427
|
/**
|
|
@@ -10257,7 +10432,8 @@ interface WrapDeformer extends BaseWrap {
|
|
|
10257
10432
|
*
|
|
10258
10433
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/WrapDeformer#GetDeformedCFrameAsync)
|
|
10259
10434
|
* @param this Allows for the real-time deformation of a `MeshPart`.
|
|
10260
|
-
* @param originalCFrame
|
|
10435
|
+
* @param originalCFrame The `CFrame`, expressed in the local space of the parent `MeshPart`, whose position is deformed.
|
|
10436
|
+
* @returns A `CFrame` in the parent `MeshPart` space with its position displaced by the same deformation field applied to the parent mesh; rotation is unchanged.
|
|
10261
10437
|
*/
|
|
10262
10438
|
GetDeformedCFrameAsync(this: WrapDeformer, originalCFrame: CFrame): CFrame;
|
|
10263
10439
|
}
|
|
@@ -10321,6 +10497,8 @@ interface WrapLayer extends BaseWrap {
|
|
|
10321
10497
|
*/
|
|
10322
10498
|
Puffiness: number;
|
|
10323
10499
|
/**
|
|
10500
|
+
* The reference mesh that defines the Inner Cage of the `WrapLayer`, stored as a `Content` value.
|
|
10501
|
+
*
|
|
10324
10502
|
* - **ThreadSafety**: ReadSafe
|
|
10325
10503
|
*
|
|
10326
10504
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/WrapLayer#ReferenceMeshContent)
|
|
@@ -11173,6 +11351,21 @@ interface BodyPartDescription extends Instance {
|
|
|
11173
11351
|
*/
|
|
11174
11352
|
Instance: Instance | undefined;
|
|
11175
11353
|
}
|
|
11354
|
+
/**
|
|
11355
|
+
* - **Tags**: NotCreatable, Service
|
|
11356
|
+
*
|
|
11357
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/BranchService)
|
|
11358
|
+
*/
|
|
11359
|
+
interface BranchService extends Instance {
|
|
11360
|
+
/**
|
|
11361
|
+
* **DO NOT USE!**
|
|
11362
|
+
*
|
|
11363
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
11364
|
+
* @hidden
|
|
11365
|
+
* @deprecated
|
|
11366
|
+
*/
|
|
11367
|
+
readonly _nominal_BranchService: unique symbol;
|
|
11368
|
+
}
|
|
11176
11369
|
/**
|
|
11177
11370
|
* - **Tags**: NotReplicated
|
|
11178
11371
|
*
|
|
@@ -11236,6 +11429,8 @@ interface CacheableContentProvider extends Instance {
|
|
|
11236
11429
|
readonly _nominal_CacheableContentProvider: unique symbol;
|
|
11237
11430
|
}
|
|
11238
11431
|
/**
|
|
11432
|
+
* A service that fetches and caches SLIM (Scalable Lightweight Interactive Models) asset content representations for model rendering.
|
|
11433
|
+
*
|
|
11239
11434
|
* - **Tags**: NotCreatable, Service
|
|
11240
11435
|
*
|
|
11241
11436
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SlimContentProvider)
|
|
@@ -11610,6 +11805,8 @@ interface CharacterMesh extends CharacterAppearance {
|
|
|
11610
11805
|
*/
|
|
11611
11806
|
readonly _nominal_CharacterMesh: unique symbol;
|
|
11612
11807
|
/**
|
|
11808
|
+
* The base texture applied to the mesh, as a `Content` value.
|
|
11809
|
+
*
|
|
11613
11810
|
* - **ThreadSafety**: ReadSafe
|
|
11614
11811
|
*
|
|
11615
11812
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CharacterMesh#BaseTextureContent)
|
|
@@ -11632,6 +11829,8 @@ interface CharacterMesh extends CharacterAppearance {
|
|
|
11632
11829
|
*/
|
|
11633
11830
|
BodyPart: Enum.BodyPart;
|
|
11634
11831
|
/**
|
|
11832
|
+
* The mesh applied to the body part given by `CharacterMesh.BodyPart`, as a `Content` value.
|
|
11833
|
+
*
|
|
11635
11834
|
* - **ThreadSafety**: ReadSafe
|
|
11636
11835
|
*
|
|
11637
11836
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CharacterMesh#MeshContent)
|
|
@@ -11646,6 +11845,8 @@ interface CharacterMesh extends CharacterAppearance {
|
|
|
11646
11845
|
*/
|
|
11647
11846
|
MeshId: number;
|
|
11648
11847
|
/**
|
|
11848
|
+
* The overlay texture that covers Shirts, Pants, T-Shirts, and the base texture, as a `Content` value.
|
|
11849
|
+
*
|
|
11649
11850
|
* - **ThreadSafety**: ReadSafe
|
|
11650
11851
|
*
|
|
11651
11852
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CharacterMesh#OverlayTextureContent)
|
|
@@ -11708,6 +11909,8 @@ interface Pants extends Clothing {
|
|
|
11708
11909
|
*/
|
|
11709
11910
|
PantsTemplate: ContentId;
|
|
11710
11911
|
/**
|
|
11912
|
+
* A `Content` property that references the pants texture image, supporting asset URIs and `EditableImage` objects.
|
|
11913
|
+
*
|
|
11711
11914
|
* - **ThreadSafety**: ReadSafe
|
|
11712
11915
|
*
|
|
11713
11916
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Pants#PantsTemplateContent)
|
|
@@ -11737,6 +11940,8 @@ interface Shirt extends Clothing {
|
|
|
11737
11940
|
*/
|
|
11738
11941
|
ShirtTemplate: ContentId;
|
|
11739
11942
|
/**
|
|
11943
|
+
* A `Content` property that references the shirt texture image, supporting asset URIs and `EditableImage` objects.
|
|
11944
|
+
*
|
|
11740
11945
|
* - **ThreadSafety**: ReadSafe
|
|
11741
11946
|
*
|
|
11742
11947
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Shirt#ShirtTemplateContent)
|
|
@@ -11774,6 +11979,8 @@ interface ShirtGraphic extends CharacterAppearance {
|
|
|
11774
11979
|
*/
|
|
11775
11980
|
Graphic: ContentId;
|
|
11776
11981
|
/**
|
|
11982
|
+
* A `Content` property that references the t-shirt texture image, supporting asset URIs and `EditableImage` objects.
|
|
11983
|
+
*
|
|
11777
11984
|
* - **ThreadSafety**: ReadSafe
|
|
11778
11985
|
*
|
|
11779
11986
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ShirtGraphic#TextureContent)
|
|
@@ -12552,15 +12759,21 @@ interface CollectionService extends Instance {
|
|
|
12552
12759
|
*
|
|
12553
12760
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CollectionService#AddTag)
|
|
12554
12761
|
* @param this A service which manages instance collections using assigned tags.
|
|
12555
|
-
* @param instance
|
|
12556
|
-
* @param tag
|
|
12762
|
+
* @param instance The `Instance` to apply the tag to.
|
|
12763
|
+
* @param tag The tag string to apply to the instance.
|
|
12557
12764
|
*/
|
|
12558
12765
|
AddTag(this: CollectionService, instance: Instance, tag: string): void;
|
|
12559
12766
|
AddTag(this: Instance, tag: string): void;
|
|
12560
12767
|
/**
|
|
12768
|
+
* Creates a `Collection` that tracks every instance matching a query.
|
|
12769
|
+
*
|
|
12561
12770
|
* - **ThreadSafety**: Unsafe
|
|
12562
12771
|
*
|
|
12563
12772
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CollectionService#CreateCollection)
|
|
12773
|
+
* @param this A service which manages instance collections using assigned tags.
|
|
12774
|
+
* @param query A selector string describing which instances to match. See the description for the supported syntax.
|
|
12775
|
+
* @param root The instance whose descendants are searched. Pass this to restrict the search to a subtree, such that instances outside that subtree never match and an instance is removed from the collection if it is reparented out of `root`. Defaults to `Workspace` when omitted.
|
|
12776
|
+
* @returns A `Collection` that reactively tracks the instances matching `query`.
|
|
12564
12777
|
*/
|
|
12565
12778
|
CreateCollection(this: CollectionService, query: string, root?: Instance): CollectionHandle;
|
|
12566
12779
|
/**
|
|
@@ -12570,6 +12783,7 @@ interface CollectionService extends Instance {
|
|
|
12570
12783
|
*
|
|
12571
12784
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CollectionService#GetAllTags)
|
|
12572
12785
|
* @param this A service which manages instance collections using assigned tags.
|
|
12786
|
+
* @returns An array of all tags that currently have at least one tagged instance in the `DataModel`.
|
|
12573
12787
|
*/
|
|
12574
12788
|
GetAllTags(this: CollectionService): Array<string>;
|
|
12575
12789
|
/**
|
|
@@ -12872,6 +13086,8 @@ interface Configuration extends Instance {
|
|
|
12872
13086
|
readonly _nominal_Configuration: unique symbol;
|
|
12873
13087
|
}
|
|
12874
13088
|
/**
|
|
13089
|
+
* Configures a server's `DataModel` for a place session during game-server startup.
|
|
13090
|
+
*
|
|
12875
13091
|
* - **Tags**: NotCreatable, Service
|
|
12876
13092
|
*
|
|
12877
13093
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ConfigureServerService)
|
|
@@ -13249,6 +13465,8 @@ interface AngularVelocity extends Constraint {
|
|
|
13249
13465
|
*/
|
|
13250
13466
|
ReactionTorqueEnabled: boolean;
|
|
13251
13467
|
/**
|
|
13468
|
+
* The `ActuatorRelativeTo` value specifying the coordinate frame in which the `AngularVelocity` vector is expressed; defaults to `World`.
|
|
13469
|
+
*
|
|
13252
13470
|
* - **ThreadSafety**: ReadSafe
|
|
13253
13471
|
*
|
|
13254
13472
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AngularVelocity#RelativeTo)
|
|
@@ -13730,6 +13948,8 @@ interface LinearVelocity extends Constraint {
|
|
|
13730
13948
|
*/
|
|
13731
13949
|
PrimaryTangentAxis: Vector3;
|
|
13732
13950
|
/**
|
|
13951
|
+
* Determines whether an equal and opposite reaction force is also applied to the assembly of `Attachment1` when `RelativeTo` is `Attachment1`.
|
|
13952
|
+
*
|
|
13733
13953
|
* - **ThreadSafety**: ReadSafe
|
|
13734
13954
|
*
|
|
13735
13955
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/LinearVelocity#ReactionForceEnabled)
|
|
@@ -14817,7 +15037,7 @@ interface ContextActionService extends Instance {
|
|
|
14817
15037
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ContextActionService#BindActivate)
|
|
14818
15038
|
* @param this A service used to bind user input to contextual actions.
|
|
14819
15039
|
* @param userInputTypeForActivation Must be Keyboard or Gamepad1 through Gamepad8.
|
|
14820
|
-
* @param keyCodesForActivation
|
|
15040
|
+
* @param keyCodesForActivation Any number of `KeyCode` values that trigger `Tool` activation for the specified `UserInputType`.
|
|
14821
15041
|
*/
|
|
14822
15042
|
BindActivate(this: ContextActionService, userInputTypeForActivation: CastsToEnum<Enum.UserInputType>, keyCodesForActivation: unknown): void;
|
|
14823
15043
|
/**
|
|
@@ -14827,6 +15047,7 @@ interface ContextActionService extends Instance {
|
|
|
14827
15047
|
*
|
|
14828
15048
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ContextActionService#GetAllBoundActionInfo)
|
|
14829
15049
|
* @param this A service used to bind user input to contextual actions.
|
|
15050
|
+
* @returns A dictionary mapping each bound action name to its info table.
|
|
14830
15051
|
*/
|
|
14831
15052
|
GetAllBoundActionInfo(this: ContextActionService): Map<string, BoundActionInfo>;
|
|
14832
15053
|
/**
|
|
@@ -14836,7 +15057,8 @@ interface ContextActionService extends Instance {
|
|
|
14836
15057
|
*
|
|
14837
15058
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ContextActionService#GetBoundActionInfo)
|
|
14838
15059
|
* @param this A service used to bind user input to contextual actions.
|
|
14839
|
-
* @param actionName
|
|
15060
|
+
* @param actionName The name of the action originally passed to BindAction.
|
|
15061
|
+
* @returns A dictionary with keys describing the bound action, including stackOrder, priorityLevel, createTouchButton, inputTypes, description, title, and image.
|
|
14840
15062
|
*/
|
|
14841
15063
|
GetBoundActionInfo(this: ContextActionService, actionName: string): BoundActionInfo | {};
|
|
14842
15064
|
/**
|
|
@@ -14900,7 +15122,7 @@ interface ContextActionService extends Instance {
|
|
|
14900
15122
|
*
|
|
14901
15123
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ContextActionService#UnbindAction)
|
|
14902
15124
|
* @param this A service used to bind user input to contextual actions.
|
|
14903
|
-
* @param actionName
|
|
15125
|
+
* @param actionName The name of the action to unbind, as originally passed to BindAction.
|
|
14904
15126
|
*/
|
|
14905
15127
|
UnbindAction(this: ContextActionService, actionName: string): void;
|
|
14906
15128
|
/**
|
|
@@ -15074,6 +15296,8 @@ interface VehicleController extends Controller {
|
|
|
15074
15296
|
readonly _nominal_VehicleController: unique symbol;
|
|
15075
15297
|
}
|
|
15076
15298
|
/**
|
|
15299
|
+
* Abstract base class for the controllers that a `ControllerManager` uses to move its character.
|
|
15300
|
+
*
|
|
15077
15301
|
* - **Tags**: NotCreatable
|
|
15078
15302
|
*
|
|
15079
15303
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ControllerBase)
|
|
@@ -15088,6 +15312,8 @@ interface ControllerBase extends Instance {
|
|
|
15088
15312
|
*/
|
|
15089
15313
|
readonly _nominal_ControllerBase: unique symbol;
|
|
15090
15314
|
/**
|
|
15315
|
+
* Whether this controller is currently the active controller of its `ControllerManager`.
|
|
15316
|
+
*
|
|
15091
15317
|
* - **ThreadSafety**: ReadSafe
|
|
15092
15318
|
* - **Tags**: NotReplicated
|
|
15093
15319
|
*
|
|
@@ -15095,6 +15321,8 @@ interface ControllerBase extends Instance {
|
|
|
15095
15321
|
*/
|
|
15096
15322
|
readonly Active: boolean;
|
|
15097
15323
|
/**
|
|
15324
|
+
* Whether the controller holds its balance orientation rigidly instead of with a spring response.
|
|
15325
|
+
*
|
|
15098
15326
|
* - **ThreadSafety**: ReadSafe
|
|
15099
15327
|
*
|
|
15100
15328
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ControllerBase#BalanceRigidityEnabled)
|
|
@@ -15110,6 +15338,8 @@ interface ControllerBase extends Instance {
|
|
|
15110
15338
|
MoveSpeedFactor: number;
|
|
15111
15339
|
}
|
|
15112
15340
|
/**
|
|
15341
|
+
* A physics character controller that governs movement while a character is airborne.
|
|
15342
|
+
*
|
|
15113
15343
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AirController)
|
|
15114
15344
|
*/
|
|
15115
15345
|
interface AirController extends ControllerBase {
|
|
@@ -15186,6 +15416,8 @@ interface AirController extends ControllerBase {
|
|
|
15186
15416
|
TurnSpeedFactor: number;
|
|
15187
15417
|
}
|
|
15188
15418
|
/**
|
|
15419
|
+
* A physics character controller that moves its `ControllerManager.RootPart` along a climbable surface, such as a ladder.
|
|
15420
|
+
*
|
|
15189
15421
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ClimbController)
|
|
15190
15422
|
*/
|
|
15191
15423
|
interface ClimbController extends ControllerBase {
|
|
@@ -15198,7 +15430,7 @@ interface ClimbController extends ControllerBase {
|
|
|
15198
15430
|
*/
|
|
15199
15431
|
readonly _nominal_ClimbController: unique symbol;
|
|
15200
15432
|
/**
|
|
15201
|
-
*
|
|
15433
|
+
* Currently unused; reserved for future climb acceleration ramp timing.
|
|
15202
15434
|
*
|
|
15203
15435
|
* - **ThreadSafety**: ReadSafe
|
|
15204
15436
|
*
|
|
@@ -15231,6 +15463,8 @@ interface ClimbController extends ControllerBase {
|
|
|
15231
15463
|
MoveMaxForce: number;
|
|
15232
15464
|
}
|
|
15233
15465
|
/**
|
|
15466
|
+
* The `ControllerBase` that moves a `ControllerManager` character while it is walking or standing on the ground.
|
|
15467
|
+
*
|
|
15234
15468
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GroundController)
|
|
15235
15469
|
*/
|
|
15236
15470
|
interface GroundController extends ControllerBase {
|
|
@@ -15326,6 +15560,8 @@ interface GroundController extends ControllerBase {
|
|
|
15326
15560
|
TurnSpeedFactor: number;
|
|
15327
15561
|
}
|
|
15328
15562
|
/**
|
|
15563
|
+
* The `ControllerBase` that moves a `ControllerManager` character while it is swimming.
|
|
15564
|
+
*
|
|
15329
15565
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SwimController)
|
|
15330
15566
|
*/
|
|
15331
15567
|
interface SwimController extends ControllerBase {
|
|
@@ -15455,6 +15691,8 @@ interface ControllerManager extends Instance {
|
|
|
15455
15691
|
*/
|
|
15456
15692
|
RootPart: BasePart | undefined;
|
|
15457
15693
|
/**
|
|
15694
|
+
* The unit vector describing the up direction for the character.
|
|
15695
|
+
*
|
|
15458
15696
|
* - **ThreadSafety**: ReadSafe
|
|
15459
15697
|
*
|
|
15460
15698
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ControllerManager#UpDirection)
|
|
@@ -15542,6 +15780,8 @@ interface CreationDBService extends Instance {
|
|
|
15542
15780
|
readonly _nominal_CreationDBService: unique symbol;
|
|
15543
15781
|
}
|
|
15544
15782
|
/**
|
|
15783
|
+
* Provides methods for querying Creator Store product information and purchasing assets.
|
|
15784
|
+
*
|
|
15545
15785
|
* - **Tags**: NotCreatable, Service
|
|
15546
15786
|
*
|
|
15547
15787
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CreatorStoreService)
|
|
@@ -15572,6 +15812,8 @@ interface CrossDMScriptChangeListener extends Instance {
|
|
|
15572
15812
|
readonly _nominal_CrossDMScriptChangeListener: unique symbol;
|
|
15573
15813
|
}
|
|
15574
15814
|
/**
|
|
15815
|
+
* Internal-only instance that writes text to a file in the engine's logs directory.
|
|
15816
|
+
*
|
|
15575
15817
|
* - **Tags**: NotReplicated
|
|
15576
15818
|
*
|
|
15577
15819
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CustomLog)
|
|
@@ -15586,32 +15828,41 @@ interface CustomLog extends Instance {
|
|
|
15586
15828
|
*/
|
|
15587
15829
|
readonly _nominal_CustomLog: unique symbol;
|
|
15588
15830
|
/**
|
|
15831
|
+
* Closes the open log file.
|
|
15832
|
+
*
|
|
15589
15833
|
* - **ThreadSafety**: Unsafe
|
|
15590
15834
|
*
|
|
15591
15835
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CustomLog#Close)
|
|
15592
|
-
* @param this
|
|
15836
|
+
* @param this Internal-only instance that writes text to a file in the engine's logs directory.
|
|
15593
15837
|
*/
|
|
15594
15838
|
Close(this: CustomLog): void;
|
|
15595
15839
|
/**
|
|
15840
|
+
* Returns the full filesystem path of the log file.
|
|
15841
|
+
*
|
|
15596
15842
|
* - **ThreadSafety**: Unsafe
|
|
15597
15843
|
*
|
|
15598
15844
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CustomLog#GetLogPath)
|
|
15599
|
-
* @param this
|
|
15845
|
+
* @param this Internal-only instance that writes text to a file in the engine's logs directory.
|
|
15846
|
+
* @returns The absolute filesystem path of the log file.
|
|
15600
15847
|
*/
|
|
15601
15848
|
GetLogPath(this: CustomLog): string;
|
|
15602
15849
|
/**
|
|
15850
|
+
* Opens the log file for writing, creating or truncating it.
|
|
15851
|
+
*
|
|
15603
15852
|
* - **ThreadSafety**: Unsafe
|
|
15604
15853
|
*
|
|
15605
15854
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CustomLog#Open)
|
|
15606
|
-
* @param this
|
|
15855
|
+
* @param this Internal-only instance that writes text to a file in the engine's logs directory.
|
|
15607
15856
|
*/
|
|
15608
15857
|
Open(this: CustomLog): void;
|
|
15609
15858
|
/**
|
|
15859
|
+
* Appends a string to the open log file.
|
|
15860
|
+
*
|
|
15610
15861
|
* - **ThreadSafety**: Unsafe
|
|
15611
15862
|
*
|
|
15612
15863
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CustomLog#WriteAppend)
|
|
15613
|
-
* @param this
|
|
15614
|
-
* @param append
|
|
15864
|
+
* @param this Internal-only instance that writes text to a file in the engine's logs directory.
|
|
15865
|
+
* @param append The text to append to the log file.
|
|
15615
15866
|
*/
|
|
15616
15867
|
WriteAppend(this: CustomLog, append: string): void;
|
|
15617
15868
|
}
|
|
@@ -15728,6 +15979,8 @@ interface FileMesh extends DataModelMesh {
|
|
|
15728
15979
|
*/
|
|
15729
15980
|
readonly _nominal_FileMesh: unique symbol;
|
|
15730
15981
|
/**
|
|
15982
|
+
* The mesh content applied to the parent `BasePart`, supporting asset URIs and `EditableMesh` objects.
|
|
15983
|
+
*
|
|
15731
15984
|
* - **ThreadSafety**: ReadSafe
|
|
15732
15985
|
*
|
|
15733
15986
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/FileMesh#MeshContent)
|
|
@@ -15742,6 +15995,8 @@ interface FileMesh extends DataModelMesh {
|
|
|
15742
15995
|
*/
|
|
15743
15996
|
MeshId: ContentId;
|
|
15744
15997
|
/**
|
|
15998
|
+
* The texture content applied to the mesh, supporting asset URIs and `EditableImage` objects.
|
|
15999
|
+
*
|
|
15745
16000
|
* - **ThreadSafety**: ReadSafe
|
|
15746
16001
|
*
|
|
15747
16002
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/FileMesh#TextureContent)
|
|
@@ -15795,6 +16050,8 @@ interface DataModelPatchService extends Instance {
|
|
|
15795
16050
|
readonly _nominal_DataModelPatchService: unique symbol;
|
|
15796
16051
|
}
|
|
15797
16052
|
/**
|
|
16053
|
+
* Specifies additional parameters for a `GlobalDataStore:GetAsync()` call.
|
|
16054
|
+
*
|
|
15798
16055
|
* - **Tags**: NotReplicated
|
|
15799
16056
|
*
|
|
15800
16057
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DataStoreGetOptions)
|
|
@@ -15809,6 +16066,8 @@ interface DataStoreGetOptions extends Instance {
|
|
|
15809
16066
|
*/
|
|
15810
16067
|
readonly _nominal_DataStoreGetOptions: unique symbol;
|
|
15811
16068
|
/**
|
|
16069
|
+
* Specifies whether `GlobalDataStore:GetAsync()` can return a locally cached value.
|
|
16070
|
+
*
|
|
15812
16071
|
* - **ThreadSafety**: ReadSafe
|
|
15813
16072
|
*
|
|
15814
16073
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DataStoreGetOptions#UseCache)
|
|
@@ -16055,6 +16314,8 @@ interface DataStoreOptions extends Instance {
|
|
|
16055
16314
|
*/
|
|
16056
16315
|
AllScopes: boolean;
|
|
16057
16316
|
/**
|
|
16317
|
+
* Currently has no observable effect on data store behavior.
|
|
16318
|
+
*
|
|
16058
16319
|
* - **ThreadSafety**: Unsafe
|
|
16059
16320
|
*
|
|
16060
16321
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DataStoreOptions#SetExperimentalFeatures)
|
|
@@ -16099,6 +16360,7 @@ interface DataStoreService extends Instance {
|
|
|
16099
16360
|
*
|
|
16100
16361
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DataStoreService#GetGlobalDataStore)
|
|
16101
16362
|
* @param this A game service that gives access to persistent data storage across places in a game.
|
|
16363
|
+
* @returns The default `GlobalDataStore` instance.
|
|
16102
16364
|
*/
|
|
16103
16365
|
GetGlobalDataStore(this: DataStoreService): DataStore;
|
|
16104
16366
|
/**
|
|
@@ -16108,8 +16370,9 @@ interface DataStoreService extends Instance {
|
|
|
16108
16370
|
*
|
|
16109
16371
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DataStoreService#GetOrderedDataStore)
|
|
16110
16372
|
* @param this A game service that gives access to persistent data storage across places in a game.
|
|
16111
|
-
* @param name
|
|
16112
|
-
* @param scope
|
|
16373
|
+
* @param name Name of the ordered data store.
|
|
16374
|
+
* @param scope **(Optional)** A string specifying the scope. Default is "global".
|
|
16375
|
+
* @returns An `OrderedDataStore` instance with the provided name and scope.
|
|
16113
16376
|
*/
|
|
16114
16377
|
GetOrderedDataStore(this: DataStoreService, name: string, scope?: string): OrderedDataStore;
|
|
16115
16378
|
/**
|
|
@@ -16119,7 +16382,8 @@ interface DataStoreService extends Instance {
|
|
|
16119
16382
|
*
|
|
16120
16383
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DataStoreService#GetRequestBudgetForRequestType)
|
|
16121
16384
|
* @param this A game service that gives access to persistent data storage across places in a game.
|
|
16122
|
-
* @param requestType
|
|
16385
|
+
* @param requestType The `DataStoreRequestType` to check the budget for.
|
|
16386
|
+
* @returns The number of data store requests that can currently be made for the specified request type.
|
|
16123
16387
|
*/
|
|
16124
16388
|
GetRequestBudgetForRequestType(this: DataStoreService, requestType: CastsToEnum<Enum.DataStoreRequestType>): number;
|
|
16125
16389
|
/**
|
|
@@ -16129,9 +16393,9 @@ interface DataStoreService extends Instance {
|
|
|
16129
16393
|
*
|
|
16130
16394
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DataStoreService#SetRateLimitForRequestType)
|
|
16131
16395
|
* @param this A game service that gives access to persistent data storage across places in a game.
|
|
16132
|
-
* @param requestType
|
|
16133
|
-
* @param baseLimit
|
|
16134
|
-
* @param perPlayerLimit
|
|
16396
|
+
* @param requestType The `DataStoreRequestType` to configure the rate limit for.
|
|
16397
|
+
* @param baseLimit The base number of requests allowed per minute regardless of player count.
|
|
16398
|
+
* @param perPlayerLimit The additional number of requests per minute granted for each connected player.
|
|
16135
16399
|
*/
|
|
16136
16400
|
SetRateLimitForRequestType(this: DataStoreService, requestType: CastsToEnum<Enum.DataStoreRequestType>, baseLimit: number, perPlayerLimit: number): void;
|
|
16137
16401
|
/**
|
|
@@ -16480,6 +16744,7 @@ interface Dialog extends Instance {
|
|
|
16480
16744
|
*
|
|
16481
16745
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Dialog#GetCurrentPlayers)
|
|
16482
16746
|
* @param this Creates NPC billboard-style dialog bubbles.
|
|
16747
|
+
* @returns A list of `Player` objects currently engaged in the Dialog.
|
|
16483
16748
|
*/
|
|
16484
16749
|
GetCurrentPlayers(this: Dialog): Array<Player>;
|
|
16485
16750
|
/**
|
|
@@ -16869,7 +17134,7 @@ interface Dragger extends Instance {
|
|
|
16869
17134
|
*
|
|
16870
17135
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Dragger#AxisRotate)
|
|
16871
17136
|
* @param this A helper object used to create tools that can drag parts.
|
|
16872
|
-
* @param axis
|
|
17137
|
+
* @param axis The `Axis` (`X`, `Y`, or `Z`) around which to rotate.
|
|
16873
17138
|
*/
|
|
16874
17139
|
AxisRotate(this: Dragger, axis?: CastsToEnum<Enum.Axis>): void;
|
|
16875
17140
|
/**
|
|
@@ -16879,9 +17144,9 @@ interface Dragger extends Instance {
|
|
|
16879
17144
|
*
|
|
16880
17145
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Dragger#MouseDown)
|
|
16881
17146
|
* @param this A helper object used to create tools that can drag parts.
|
|
16882
|
-
* @param mousePart
|
|
16883
|
-
* @param pointOnMousePart
|
|
16884
|
-
* @param parts
|
|
17147
|
+
* @param mousePart The `BasePart` under the mouse that serves as the drag handle. Must be a member of `parts` and must be in the `Workspace`.
|
|
17148
|
+
* @param pointOnMousePart A `Vector3` in the local coordinate space of `mousePart` indicating where the mouse initially contacted the part.
|
|
17149
|
+
* @param parts An array of `BaseParts` to move together during the drag. Must include `mousePart` and contain at least one element.
|
|
16885
17150
|
*/
|
|
16886
17151
|
MouseDown(this: Dragger, mousePart: BasePart, pointOnMousePart: Vector3, parts: Array<BasePart>): void;
|
|
16887
17152
|
/**
|
|
@@ -16891,7 +17156,7 @@ interface Dragger extends Instance {
|
|
|
16891
17156
|
*
|
|
16892
17157
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Dragger#MouseMove)
|
|
16893
17158
|
* @param this A helper object used to create tools that can drag parts.
|
|
16894
|
-
* @param mouseRay
|
|
17159
|
+
* @param mouseRay A `Ray` representing the current mouse position in world space (origin at the camera, direction toward the pointer).
|
|
16895
17160
|
*/
|
|
16896
17161
|
MouseMove(this: Dragger, mouseRay: Ray): void;
|
|
16897
17162
|
/**
|
|
@@ -16905,6 +17170,8 @@ interface Dragger extends Instance {
|
|
|
16905
17170
|
MouseUp(this: Dragger): void;
|
|
16906
17171
|
}
|
|
16907
17172
|
/**
|
|
17173
|
+
* A service that centralizes the global dragger settings that Studio's dragging tools read so they move, snap, and highlight objects consistently.
|
|
17174
|
+
*
|
|
16908
17175
|
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
16909
17176
|
*
|
|
16910
17177
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DraggerService)
|
|
@@ -16919,6 +17186,8 @@ interface DraggerService extends Instance {
|
|
|
16919
17186
|
*/
|
|
16920
17187
|
readonly _nominal_DraggerService: unique symbol;
|
|
16921
17188
|
/**
|
|
17189
|
+
* Whether a dragged object is re-aligned to the surface it is dropped onto.
|
|
17190
|
+
*
|
|
16922
17191
|
* - **ThreadSafety**: ReadSafe
|
|
16923
17192
|
* - **Tags**: NotReplicated
|
|
16924
17193
|
*
|
|
@@ -16926,6 +17195,8 @@ interface DraggerService extends Instance {
|
|
|
16926
17195
|
*/
|
|
16927
17196
|
AlignDraggedObjects: boolean;
|
|
16928
17197
|
/**
|
|
17198
|
+
* Whether rotation drags snap to multiples of `DraggerService.AngleSnapIncrement`.
|
|
17199
|
+
*
|
|
16929
17200
|
* - **ThreadSafety**: ReadSafe
|
|
16930
17201
|
* - **Tags**: NotReplicated
|
|
16931
17202
|
*
|
|
@@ -16933,6 +17204,8 @@ interface DraggerService extends Instance {
|
|
|
16933
17204
|
*/
|
|
16934
17205
|
AngleSnapEnabled: boolean;
|
|
16935
17206
|
/**
|
|
17207
|
+
* The angle, in degrees, that rotation drags snap to.
|
|
17208
|
+
*
|
|
16936
17209
|
* - **ThreadSafety**: ReadSafe
|
|
16937
17210
|
* - **Tags**: NotReplicated
|
|
16938
17211
|
*
|
|
@@ -16940,6 +17213,8 @@ interface DraggerService extends Instance {
|
|
|
16940
17213
|
*/
|
|
16941
17214
|
AngleSnapIncrement: number;
|
|
16942
17215
|
/**
|
|
17216
|
+
* Whether the hover highlight pulses instead of staying static.
|
|
17217
|
+
*
|
|
16943
17218
|
* - **ThreadSafety**: ReadSafe
|
|
16944
17219
|
* - **Tags**: NotReplicated
|
|
16945
17220
|
*
|
|
@@ -16947,6 +17222,8 @@ interface DraggerService extends Instance {
|
|
|
16947
17222
|
*/
|
|
16948
17223
|
AnimateHover: boolean;
|
|
16949
17224
|
/**
|
|
17225
|
+
* Whether draggers prevent a moved object from overlapping other geometry.
|
|
17226
|
+
*
|
|
16950
17227
|
* - **ThreadSafety**: ReadSafe
|
|
16951
17228
|
* - **Tags**: NotReplicated
|
|
16952
17229
|
*
|
|
@@ -16954,6 +17231,8 @@ interface DraggerService extends Instance {
|
|
|
16954
17231
|
*/
|
|
16955
17232
|
CollisionsEnabled: boolean;
|
|
16956
17233
|
/**
|
|
17234
|
+
* Whether drag transforms are applied in the object's local space or in world space.
|
|
17235
|
+
*
|
|
16957
17236
|
* - **ThreadSafety**: ReadSafe
|
|
16958
17237
|
* - **Tags**: NotReplicated
|
|
16959
17238
|
*
|
|
@@ -16961,6 +17240,8 @@ interface DraggerService extends Instance {
|
|
|
16961
17240
|
*/
|
|
16962
17241
|
DraggerCoordinateSpace: Enum.DraggerCoordinateSpace;
|
|
16963
17242
|
/**
|
|
17243
|
+
* Whether dragging moves objects geometrically or by respecting physical constraints.
|
|
17244
|
+
*
|
|
16964
17245
|
* - **ThreadSafety**: ReadSafe
|
|
16965
17246
|
* - **Tags**: NotReplicated
|
|
16966
17247
|
*
|
|
@@ -16968,6 +17249,8 @@ interface DraggerService extends Instance {
|
|
|
16968
17249
|
*/
|
|
16969
17250
|
DraggerMovementMode: Enum.DraggerMovementMode;
|
|
16970
17251
|
/**
|
|
17252
|
+
* The color of the on-screen indicators drawn when a drag snaps to geometry.
|
|
17253
|
+
*
|
|
16971
17254
|
* - **ThreadSafety**: ReadSafe
|
|
16972
17255
|
* - **Tags**: NotReplicated
|
|
16973
17256
|
*
|
|
@@ -16975,6 +17258,8 @@ interface DraggerService extends Instance {
|
|
|
16975
17258
|
*/
|
|
16976
17259
|
GeometrySnapColor: Color3;
|
|
16977
17260
|
/**
|
|
17261
|
+
* The frequency, in hertz, at which the hover highlight animates.
|
|
17262
|
+
*
|
|
16978
17263
|
* - **ThreadSafety**: ReadSafe
|
|
16979
17264
|
* - **Tags**: NotReplicated
|
|
16980
17265
|
*
|
|
@@ -16982,6 +17267,8 @@ interface DraggerService extends Instance {
|
|
|
16982
17267
|
*/
|
|
16983
17268
|
HoverAnimateFrequency: number;
|
|
16984
17269
|
/**
|
|
17270
|
+
* The thickness of the highlight outline drawn around the object under the cursor.
|
|
17271
|
+
*
|
|
16985
17272
|
* - **ThreadSafety**: ReadSafe
|
|
16986
17273
|
* - **Tags**: NotReplicated
|
|
16987
17274
|
*
|
|
@@ -16989,6 +17276,8 @@ interface DraggerService extends Instance {
|
|
|
16989
17276
|
*/
|
|
16990
17277
|
HoverThickness: number;
|
|
16991
17278
|
/**
|
|
17279
|
+
* Whether draggers create surface joints between touching parts when a drag ends.
|
|
17280
|
+
*
|
|
16992
17281
|
* - **ThreadSafety**: ReadSafe
|
|
16993
17282
|
* - **Tags**: NotReplicated
|
|
16994
17283
|
*
|
|
@@ -16996,6 +17285,8 @@ interface DraggerService extends Instance {
|
|
|
16996
17285
|
*/
|
|
16997
17286
|
JointsEnabled: boolean;
|
|
16998
17287
|
/**
|
|
17288
|
+
* Whether positional drags snap to a grid of `DraggerService.LinearSnapIncrement`.
|
|
17289
|
+
*
|
|
16999
17290
|
* - **ThreadSafety**: ReadSafe
|
|
17000
17291
|
* - **Tags**: NotReplicated
|
|
17001
17292
|
*
|
|
@@ -17003,6 +17294,8 @@ interface DraggerService extends Instance {
|
|
|
17003
17294
|
*/
|
|
17004
17295
|
LinearSnapEnabled: boolean;
|
|
17005
17296
|
/**
|
|
17297
|
+
* The grid size, in studs, that positional drags snap to.
|
|
17298
|
+
*
|
|
17006
17299
|
* - **ThreadSafety**: ReadSafe
|
|
17007
17300
|
* - **Tags**: NotReplicated
|
|
17008
17301
|
*
|
|
@@ -17010,6 +17303,8 @@ interface DraggerService extends Instance {
|
|
|
17010
17303
|
*/
|
|
17011
17304
|
LinearSnapIncrement: number;
|
|
17012
17305
|
/**
|
|
17306
|
+
* Whether a highlight is drawn over the object currently under the cursor.
|
|
17307
|
+
*
|
|
17013
17308
|
* - **ThreadSafety**: ReadSafe
|
|
17014
17309
|
* - **Tags**: NotReplicated
|
|
17015
17310
|
*
|
|
@@ -17017,6 +17312,8 @@ interface DraggerService extends Instance {
|
|
|
17017
17312
|
*/
|
|
17018
17313
|
ShowHover: boolean;
|
|
17019
17314
|
/**
|
|
17315
|
+
* Whether to show the pivot indicator for a selected object as it's being dragged.
|
|
17316
|
+
*
|
|
17020
17317
|
* - **ThreadSafety**: ReadSafe
|
|
17021
17318
|
* - **Tags**: NotReplicated
|
|
17022
17319
|
*
|
|
@@ -17071,6 +17368,8 @@ interface EncodingService extends Instance {
|
|
|
17071
17368
|
*/
|
|
17072
17369
|
readonly _nominal_EncodingService: unique symbol;
|
|
17073
17370
|
/**
|
|
17371
|
+
* Decodes a Base64-encoded buffer into a new buffer containing the original binary data.
|
|
17372
|
+
*
|
|
17074
17373
|
* - **ThreadSafety**: Safe
|
|
17075
17374
|
*
|
|
17076
17375
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EncodingService#Base64Decode)
|
|
@@ -17080,6 +17379,8 @@ interface EncodingService extends Instance {
|
|
|
17080
17379
|
*/
|
|
17081
17380
|
Base64Decode(this: EncodingService, input: buffer): buffer;
|
|
17082
17381
|
/**
|
|
17382
|
+
* Encodes binary data from a buffer into Base64 format, returning the result as a new buffer.
|
|
17383
|
+
*
|
|
17083
17384
|
* - **ThreadSafety**: Safe
|
|
17084
17385
|
*
|
|
17085
17386
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EncodingService#Base64Encode)
|
|
@@ -17089,6 +17390,8 @@ interface EncodingService extends Instance {
|
|
|
17089
17390
|
*/
|
|
17090
17391
|
Base64Encode(this: EncodingService, input: buffer): buffer;
|
|
17091
17392
|
/**
|
|
17393
|
+
* Compresses binary buffer data using the specified algorithm and compression level.
|
|
17394
|
+
*
|
|
17092
17395
|
* - **ThreadSafety**: Safe
|
|
17093
17396
|
*
|
|
17094
17397
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EncodingService#CompressBuffer)
|
|
@@ -17100,6 +17403,8 @@ interface EncodingService extends Instance {
|
|
|
17100
17403
|
*/
|
|
17101
17404
|
CompressBuffer(this: EncodingService, input: buffer, algorithm: CastsToEnum<Enum.CompressionAlgorithm>, compressionLevel?: number): buffer;
|
|
17102
17405
|
/**
|
|
17406
|
+
* Computes a cryptographic hash of a buffer's binary data using the specified algorithm.
|
|
17407
|
+
*
|
|
17103
17408
|
* - **ThreadSafety**: Safe
|
|
17104
17409
|
*
|
|
17105
17410
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EncodingService#ComputeBufferHash)
|
|
@@ -17110,6 +17415,8 @@ interface EncodingService extends Instance {
|
|
|
17110
17415
|
*/
|
|
17111
17416
|
ComputeBufferHash(this: EncodingService, input: buffer, algorithm: CastsToEnum<Enum.HashAlgorithm>): buffer;
|
|
17112
17417
|
/**
|
|
17418
|
+
* Computes a cryptographic hash of a string using the specified algorithm.
|
|
17419
|
+
*
|
|
17113
17420
|
* - **ThreadSafety**: Safe
|
|
17114
17421
|
*
|
|
17115
17422
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EncodingService#ComputeStringHash)
|
|
@@ -17120,6 +17427,8 @@ interface EncodingService extends Instance {
|
|
|
17120
17427
|
*/
|
|
17121
17428
|
ComputeStringHash(this: EncodingService, input: string, algorithm: CastsToEnum<Enum.HashAlgorithm>): string;
|
|
17122
17429
|
/**
|
|
17430
|
+
* Decompresses binary buffer data that was compressed with the specified algorithm.
|
|
17431
|
+
*
|
|
17123
17432
|
* - **ThreadSafety**: Safe
|
|
17124
17433
|
*
|
|
17125
17434
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EncodingService#DecompressBuffer)
|
|
@@ -17130,6 +17439,8 @@ interface EncodingService extends Instance {
|
|
|
17130
17439
|
*/
|
|
17131
17440
|
DecompressBuffer(this: EncodingService, input: buffer, algorithm: CastsToEnum<Enum.CompressionAlgorithm>): buffer;
|
|
17132
17441
|
/**
|
|
17442
|
+
* Returns the expected decompressed size of a compressed buffer, or nil if the size is unknown or invalid.
|
|
17443
|
+
*
|
|
17133
17444
|
* - **ThreadSafety**: Safe
|
|
17134
17445
|
*
|
|
17135
17446
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EncodingService#GetDecompressedBufferSize)
|
|
@@ -17492,6 +17803,8 @@ interface Explosion extends Instance {
|
|
|
17492
17803
|
*/
|
|
17493
17804
|
ExplosionType: Enum.ExplosionType;
|
|
17494
17805
|
/**
|
|
17806
|
+
* A multiplier for the transparency of the `Explosion` visual effect that is only visible to the local client.
|
|
17807
|
+
*
|
|
17495
17808
|
* - **ThreadSafety**: ReadSafe
|
|
17496
17809
|
* - **Tags**: Hidden, NotReplicated
|
|
17497
17810
|
*
|
|
@@ -18308,7 +18621,7 @@ interface GamepadService extends Instance {
|
|
|
18308
18621
|
*
|
|
18309
18622
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GamepadService#EnableGamepadCursor)
|
|
18310
18623
|
* @param this The GamepadService is internally responsible for handling inputs from various controllers, such as Xbox One or PlayStation DualShock controllers.
|
|
18311
|
-
* @param guiObject
|
|
18624
|
+
* @param guiObject A `GuiObject` to center the virtual cursor on when enabled, or `nil` to use the default cursor position.
|
|
18312
18625
|
*/
|
|
18313
18626
|
EnableGamepadCursor(this: GamepadService, guiObject: GuiObject | undefined): void;
|
|
18314
18627
|
}
|
|
@@ -18475,7 +18788,7 @@ interface GeometryService extends Instance {
|
|
|
18475
18788
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GeometryService#CalculateConstraintsToPreserve)
|
|
18476
18789
|
* @param this Service containing geometric operations.
|
|
18477
18790
|
* @param source An original object that the solid modeling operation was performed on, for example `part` in `UnionAsync()`.
|
|
18478
|
-
* @param destination
|
|
18791
|
+
* @param destination Array of resulting `BaseParts` from the solid modeling operation, for example the results of `UnionAsync()`.
|
|
18479
18792
|
* @param options Options dictionary for the method: - `tolerance` — The distance tolerance, in regards to `Attachment` preservation, between the attachment and the closest point on the original part's surface versus the closest point on the resulting part's surface. If the resulting distance following the solid modeling operation is greater than this value, the `Parent` of attachments and their associated constraints will be `nil` in the returned recommendation table.
|
|
18480
18793
|
* - `weldConstraintPreserve` — A `WeldConstraintPreserve` enum value describing how `WeldConstraints` are preserved in the resulting recommendation table.
|
|
18481
18794
|
* - `dropAttachmentsWithoutConstraints` — Boolean with default of `true`. If set to `false`, `Attachments` that have no `Constraints` will be preserved.
|
|
@@ -18643,6 +18956,8 @@ interface GetTextBoundsParams extends Instance {
|
|
|
18643
18956
|
*/
|
|
18644
18957
|
Font: Font;
|
|
18645
18958
|
/**
|
|
18959
|
+
* Determines whether the measured text is interpreted using rich text markup.
|
|
18960
|
+
*
|
|
18646
18961
|
* - **ThreadSafety**: ReadSafe
|
|
18647
18962
|
*
|
|
18648
18963
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GetTextBoundsParams#RichText)
|
|
@@ -18715,7 +19030,7 @@ interface GlobalDataStore extends Instance {
|
|
|
18715
19030
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GlobalDataStore#BatchGetAsync)
|
|
18716
19031
|
* @param this An object that exposes methods to access a single data store.
|
|
18717
19032
|
* @param keys An array of key name strings to retrieve. The maximum number of keys per request is determined by a server-side limit (default 100).
|
|
18718
|
-
* @param options
|
|
19033
|
+
* @param options **(Optional)** Unused; has no effect.
|
|
18719
19034
|
* @returns A dictionary mapping each requested key (string) to a table containing a `value` field with the key's current value. Keys that don't exist or have no value are omitted from the result.
|
|
18720
19035
|
*/
|
|
18721
19036
|
BatchGetAsync(this: GlobalDataStore, keys: Array<unknown>, options?: object): object;
|
|
@@ -18728,7 +19043,7 @@ interface GlobalDataStore extends Instance {
|
|
|
18728
19043
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GlobalDataStore#GetAsync)
|
|
18729
19044
|
* @param this An object that exposes methods to access a single data store.
|
|
18730
19045
|
* @param key The key name for which the value is requested. If `DataStoreOptions.AllScopes` was set to true when accessing the data store through `DataStoreService:GetDataStore()`, this key name must be prepended with the original scope as in "scope/key".
|
|
18731
|
-
* @param options
|
|
19046
|
+
* @param options **(Optional)** A `DataStoreGetOptions` instance that controls aspects of the read, such as whether to bypass the locally cached value via its `DataStoreGetOptions.UseCache` property.
|
|
18732
19047
|
* @returns The value of the entry in the data store with the given key and a `DataStoreKeyInfo` instance that includes the version number, date and time the version was created, and functions to retrieve `UserIds` and metadata.
|
|
18733
19048
|
*/
|
|
18734
19049
|
readonly GetAsync: unknown;
|
|
@@ -18789,6 +19104,8 @@ interface GlobalDataStore extends Instance {
|
|
|
18789
19104
|
readonly UpdateAsync: unknown;
|
|
18790
19105
|
}
|
|
18791
19106
|
/**
|
|
19107
|
+
* A `GlobalDataStore` that also supports versioning, key metadata, and enumerating keys.
|
|
19108
|
+
*
|
|
18792
19109
|
* - **Tags**: NotCreatable, NotReplicated
|
|
18793
19110
|
*
|
|
18794
19111
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DataStore)
|
|
@@ -18809,7 +19126,7 @@ interface DataStore extends GlobalDataStore {
|
|
|
18809
19126
|
* - **Tags**: Yields
|
|
18810
19127
|
*
|
|
18811
19128
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DataStore#GetVersionAsync)
|
|
18812
|
-
* @param this
|
|
19129
|
+
* @param this A `GlobalDataStore` that also supports versioning, key metadata, and enumerating keys.
|
|
18813
19130
|
* @param key Key name for which the version info is requested. If `DataStoreOptions.AllScopes` was set to true when accessing the data store through `DataStoreService:GetDataStore()`, this key name must be prepended with the original scope as in "scope/key".
|
|
18814
19131
|
* @param version Version number of the key for which the version info is requested.
|
|
18815
19132
|
* @returns The value of the key at the specified version and a `DataStoreKeyInfo` instance that includes the version number, date and time the version was created, and functions to retrieve `UserIds` and metadata.
|
|
@@ -18825,7 +19142,7 @@ interface DataStore extends GlobalDataStore {
|
|
|
18825
19142
|
* - **Tags**: Yields
|
|
18826
19143
|
*
|
|
18827
19144
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DataStore#GetVersionAtTimeAsync)
|
|
18828
|
-
* @param this
|
|
19145
|
+
* @param this A `GlobalDataStore` that also supports versioning, key metadata, and enumerating keys.
|
|
18829
19146
|
* @param key Key name for which the version info is requested. If `DataStoreOptions.AllScopes` was set to true when accessing the data store through `DataStoreService:GetDataStore()`, this key name must be prepended with the original scope as in "scope/key".
|
|
18830
19147
|
* @param timestamp Unix timestamp in milliseconds for which the requested version was current. Must be greater than zero. Must not be more than ten minutes in the future.
|
|
18831
19148
|
* @returns The value of the key that was current at the specified time and a `DataStoreKeyInfo` instance that includes the version number, date and time the version was created, and functions to retrieve `UserIds` and metadata. `nil` if no available version was current at the requested time.
|
|
@@ -18838,7 +19155,7 @@ interface DataStore extends GlobalDataStore {
|
|
|
18838
19155
|
* - **Tags**: Yields
|
|
18839
19156
|
*
|
|
18840
19157
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DataStore#ListKeysAsync)
|
|
18841
|
-
* @param this
|
|
19158
|
+
* @param this A `GlobalDataStore` that also supports versioning, key metadata, and enumerating keys.
|
|
18842
19159
|
* @param prefix **(Optional)** Prefix to use for locating keys.
|
|
18843
19160
|
* @param pageSize **(Optional)** Number of items to be returned in each page. If no value is given, the engine sends a default value of 0 to the data store web service, which in turn defaults to 50 items per page.
|
|
18844
19161
|
* @param cursor **(Optional)** Cursor to continue iteration.
|
|
@@ -18853,7 +19170,7 @@ interface DataStore extends GlobalDataStore {
|
|
|
18853
19170
|
* - **Tags**: Yields
|
|
18854
19171
|
*
|
|
18855
19172
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DataStore#ListVersionsAsync)
|
|
18856
|
-
* @param this
|
|
19173
|
+
* @param this A `GlobalDataStore` that also supports versioning, key metadata, and enumerating keys.
|
|
18857
19174
|
* @param key Key name for the versions to list. If `DataStoreOptions.AllScopes` was set to true when accessing the data store through `DataStoreService:GetDataStore()`, this key name must be prepended with the original scope as in "scope/key".
|
|
18858
19175
|
* @param sortDirection **(Optional)** Enum specifying ascending or descending sort order.
|
|
18859
19176
|
* @param minDate **(Optional)** Unix timestamp in milliseconds after which the versions should be listed.
|
|
@@ -18871,7 +19188,7 @@ interface DataStore extends GlobalDataStore {
|
|
|
18871
19188
|
* - **Tags**: Yields
|
|
18872
19189
|
*
|
|
18873
19190
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DataStore#RemoveVersionAsync)
|
|
18874
|
-
* @param this
|
|
19191
|
+
* @param this A `GlobalDataStore` that also supports versioning, key metadata, and enumerating keys.
|
|
18875
19192
|
* @param key Key name for which a version is to be removed. If `DataStoreOptions.AllScopes` was set to true when accessing the data store through `DataStoreService:GetDataStore()`, this key name must be prepended with the original scope as in "scope/key".
|
|
18876
19193
|
* @param version Version number of the key to remove.
|
|
18877
19194
|
*
|
|
@@ -19315,6 +19632,8 @@ interface GuiObject extends GuiBase2d {
|
|
|
19315
19632
|
*/
|
|
19316
19633
|
readonly GuiState: Enum.GuiState;
|
|
19317
19634
|
/**
|
|
19635
|
+
* Controls whether, and how, the `GuiObject` sinks input that occurs over it.
|
|
19636
|
+
*
|
|
19318
19637
|
* - **ThreadSafety**: ReadSafe
|
|
19319
19638
|
*
|
|
19320
19639
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GuiObject#InputSink)
|
|
@@ -20059,12 +20378,16 @@ interface TextButton extends GuiButton {
|
|
|
20059
20378
|
*/
|
|
20060
20379
|
MaxVisibleGraphemes: number;
|
|
20061
20380
|
/**
|
|
20381
|
+
* Applies OpenType font features, such as stylistic sets, to the text rendered by the `TextButton`.
|
|
20382
|
+
*
|
|
20062
20383
|
* - **ThreadSafety**: ReadSafe
|
|
20063
20384
|
*
|
|
20064
20385
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TextButton#OpenTypeFeatures)
|
|
20065
20386
|
*/
|
|
20066
20387
|
OpenTypeFeatures: string;
|
|
20067
20388
|
/**
|
|
20389
|
+
* Read-only property that contains the error message, if any, produced while applying `OpenTypeFeatures`.
|
|
20390
|
+
*
|
|
20068
20391
|
* - **ThreadSafety**: ReadSafe
|
|
20069
20392
|
* - **Tags**: NotReplicated
|
|
20070
20393
|
*
|
|
@@ -20411,7 +20734,7 @@ interface TextLabel extends GuiLabel {
|
|
|
20411
20734
|
*/
|
|
20412
20735
|
LineHeight: number;
|
|
20413
20736
|
/**
|
|
20414
|
-
*
|
|
20737
|
+
* Read-only string containing the automatically-localized text that the `TextLabel` renders.
|
|
20415
20738
|
*
|
|
20416
20739
|
* - **ThreadSafety**: ReadSafe
|
|
20417
20740
|
* - **Tags**: Hidden, NotReplicated
|
|
@@ -20428,12 +20751,16 @@ interface TextLabel extends GuiLabel {
|
|
|
20428
20751
|
*/
|
|
20429
20752
|
MaxVisibleGraphemes: number;
|
|
20430
20753
|
/**
|
|
20754
|
+
* Applies OpenType typographic features to the text rendered by the `TextLabel`.
|
|
20755
|
+
*
|
|
20431
20756
|
* - **ThreadSafety**: ReadSafe
|
|
20432
20757
|
*
|
|
20433
20758
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TextLabel#OpenTypeFeatures)
|
|
20434
20759
|
*/
|
|
20435
20760
|
OpenTypeFeatures: string;
|
|
20436
20761
|
/**
|
|
20762
|
+
* Read-only property that describes why the `TextLabel.OpenTypeFeatures` string could not be applied.
|
|
20763
|
+
*
|
|
20437
20764
|
* - **ThreadSafety**: ReadSafe
|
|
20438
20765
|
* - **Tags**: NotReplicated
|
|
20439
20766
|
*
|
|
@@ -20766,7 +21093,7 @@ interface ScrollingFrame extends GuiObject {
|
|
|
20766
21093
|
*/
|
|
20767
21094
|
BottomImage: ContentId;
|
|
20768
21095
|
/**
|
|
20769
|
-
*
|
|
21096
|
+
* The `Content`-typed equivalent of `BottomImage`.
|
|
20770
21097
|
*
|
|
20771
21098
|
* - **ThreadSafety**: ReadSafe
|
|
20772
21099
|
*
|
|
@@ -20814,7 +21141,7 @@ interface ScrollingFrame extends GuiObject {
|
|
|
20814
21141
|
*/
|
|
20815
21142
|
MidImage: ContentId;
|
|
20816
21143
|
/**
|
|
20817
|
-
*
|
|
21144
|
+
* The `Content`-typed equivalent of `MidImage`.
|
|
20818
21145
|
*
|
|
20819
21146
|
* - **ThreadSafety**: ReadSafe
|
|
20820
21147
|
*
|
|
@@ -20870,6 +21197,8 @@ interface ScrollingFrame extends GuiObject {
|
|
|
20870
21197
|
*/
|
|
20871
21198
|
TopImage: ContentId;
|
|
20872
21199
|
/**
|
|
21200
|
+
* The `Content`-typed equivalent of `TopImage`.
|
|
21201
|
+
*
|
|
20873
21202
|
* - **ThreadSafety**: ReadSafe
|
|
20874
21203
|
*
|
|
20875
21204
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScrollingFrame#TopImageContent)
|
|
@@ -20898,6 +21227,7 @@ interface ScrollingFrame extends GuiObject {
|
|
|
20898
21227
|
*
|
|
20899
21228
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScrollingFrame#GetScrollVelocity)
|
|
20900
21229
|
* @param this `ScrollingFrame` is a special `Frame` type with built-in scrolling interactivity and different ways to customize how the scrolling works.
|
|
21230
|
+
* @returns The current inertial scroll velocity in pixels per second on each axis, or `(0, 0)` if the frame is not coasting.
|
|
20901
21231
|
*/
|
|
20902
21232
|
GetScrollVelocity(this: ScrollingFrame): Vector2;
|
|
20903
21233
|
/**
|
|
@@ -21301,6 +21631,8 @@ interface VideoDisplay extends GuiObject {
|
|
|
21301
21631
|
*/
|
|
21302
21632
|
ScaleType: Enum.ScaleType;
|
|
21303
21633
|
/**
|
|
21634
|
+
* Sets the tiling size of the `VideoDisplay`.
|
|
21635
|
+
*
|
|
21304
21636
|
* - **ThreadSafety**: ReadSafe
|
|
21305
21637
|
*
|
|
21306
21638
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VideoDisplay#TileSize)
|
|
@@ -21417,6 +21749,8 @@ interface VideoFrame extends GuiObject {
|
|
|
21417
21749
|
*/
|
|
21418
21750
|
Looped: boolean;
|
|
21419
21751
|
/**
|
|
21752
|
+
* Internal-only. Caps the resolution the video is allowed to stream at, expressed as an `VideoSampleSize`.
|
|
21753
|
+
*
|
|
21420
21754
|
* - **ThreadSafety**: ReadSafe
|
|
21421
21755
|
* - **Tags**: Hidden
|
|
21422
21756
|
*
|
|
@@ -21442,18 +21776,24 @@ interface VideoFrame extends GuiObject {
|
|
|
21442
21776
|
*/
|
|
21443
21777
|
readonly Resolution: Vector2;
|
|
21444
21778
|
/**
|
|
21779
|
+
* The maximum distance, in studs, a listener can be from the video's part and still hear its audio.
|
|
21780
|
+
*
|
|
21445
21781
|
* - **ThreadSafety**: ReadSafe
|
|
21446
21782
|
*
|
|
21447
21783
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VideoFrame#RollOffMaxDistance)
|
|
21448
21784
|
*/
|
|
21449
21785
|
RollOffMaxDistance: number;
|
|
21450
21786
|
/**
|
|
21787
|
+
* The minimum distance, in studs, at which the video's audio starts to attenuate.
|
|
21788
|
+
*
|
|
21451
21789
|
* - **ThreadSafety**: ReadSafe
|
|
21452
21790
|
*
|
|
21453
21791
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VideoFrame#RollOffMinDistance)
|
|
21454
21792
|
*/
|
|
21455
21793
|
RollOffMinDistance: number;
|
|
21456
21794
|
/**
|
|
21795
|
+
* Controls how the video's audio volume attenuates with distance.
|
|
21796
|
+
*
|
|
21457
21797
|
* - **ThreadSafety**: ReadSafe
|
|
21458
21798
|
*
|
|
21459
21799
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VideoFrame#RollOffMode)
|
|
@@ -21486,6 +21826,8 @@ interface VideoFrame extends GuiObject {
|
|
|
21486
21826
|
*/
|
|
21487
21827
|
Video: ContentId;
|
|
21488
21828
|
/**
|
|
21829
|
+
* The video content a `VideoFrame` is associated with, as either an asset content ID (same value as `Video`) or a direct reference to a `VideoCapture` object for local screen recordings.
|
|
21830
|
+
*
|
|
21489
21831
|
* - **ThreadSafety**: ReadSafe
|
|
21490
21832
|
*
|
|
21491
21833
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VideoFrame#VideoContent)
|
|
@@ -21891,6 +22233,8 @@ interface ScreenGui extends LayerCollector {
|
|
|
21891
22233
|
ScreenInsets: Enum.ScreenInsets;
|
|
21892
22234
|
}
|
|
21893
22235
|
/**
|
|
22236
|
+
* Base class for containers that render `GuiObjects` onto a face of a `BasePart` in the 3D world.
|
|
22237
|
+
*
|
|
21894
22238
|
* - **Tags**: NotCreatable
|
|
21895
22239
|
*
|
|
21896
22240
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SurfaceGuiBase)
|
|
@@ -21905,6 +22249,8 @@ interface SurfaceGuiBase extends LayerCollector {
|
|
|
21905
22249
|
*/
|
|
21906
22250
|
readonly _nominal_SurfaceGuiBase: unique symbol;
|
|
21907
22251
|
/**
|
|
22252
|
+
* Determines whether the `SurfaceGui` sinks user input; `true` by default.
|
|
22253
|
+
*
|
|
21908
22254
|
* - **ThreadSafety**: ReadSafe
|
|
21909
22255
|
*
|
|
21910
22256
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SurfaceGuiBase#Active)
|
|
@@ -21973,6 +22319,8 @@ interface AdGui extends SurfaceGuiBase {
|
|
|
21973
22319
|
*/
|
|
21974
22320
|
readonly Status: Enum.AdUnitStatus;
|
|
21975
22321
|
/**
|
|
22322
|
+
* **Deprecated:** This callback has been deprecated and will never be called.
|
|
22323
|
+
*
|
|
21976
22324
|
* Used to react to the AdGui events.
|
|
21977
22325
|
*
|
|
21978
22326
|
* - **ThreadSafety**: Unsafe
|
|
@@ -23636,6 +23984,8 @@ interface GuiService extends Instance {
|
|
|
23636
23984
|
readonly MenuOpened: RBXScriptSignal<() => void>;
|
|
23637
23985
|
}
|
|
23638
23986
|
/**
|
|
23987
|
+
* An object that provides waveform-based haptic feedback (vibrations and rumbles) on supported controllers and mobile devices.
|
|
23988
|
+
*
|
|
23639
23989
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HapticEffect)
|
|
23640
23990
|
*/
|
|
23641
23991
|
interface HapticEffect extends Instance {
|
|
@@ -23685,7 +24035,7 @@ interface HapticEffect extends Instance {
|
|
|
23685
24035
|
* - **ThreadSafety**: Unsafe
|
|
23686
24036
|
*
|
|
23687
24037
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HapticEffect#Play)
|
|
23688
|
-
* @param this
|
|
24038
|
+
* @param this An object that provides waveform-based haptic feedback (vibrations and rumbles) on supported controllers and mobile devices.
|
|
23689
24039
|
*/
|
|
23690
24040
|
Play(this: HapticEffect): void;
|
|
23691
24041
|
/**
|
|
@@ -23697,8 +24047,8 @@ interface HapticEffect extends Instance {
|
|
|
23697
24047
|
* - **ThreadSafety**: Unsafe
|
|
23698
24048
|
*
|
|
23699
24049
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HapticEffect#SetWaveformKeys)
|
|
23700
|
-
* @param this
|
|
23701
|
-
* @param keys
|
|
24050
|
+
* @param this An object that provides waveform-based haptic feedback (vibrations and rumbles) on supported controllers and mobile devices.
|
|
24051
|
+
* @param keys An array of `FloatCurveKey` objects defining the custom haptic waveform, where each key specifies a time in milliseconds, an intensity value from 0 (no haptic) to 1 (full intensity), and an `KeyInterpolationMode` for interpolation between keys.
|
|
23702
24052
|
*/
|
|
23703
24053
|
SetWaveformKeys(this: HapticEffect, keys: Array<unknown>): void;
|
|
23704
24054
|
/**
|
|
@@ -23707,7 +24057,7 @@ interface HapticEffect extends Instance {
|
|
|
23707
24057
|
* - **ThreadSafety**: Unsafe
|
|
23708
24058
|
*
|
|
23709
24059
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HapticEffect#Stop)
|
|
23710
|
-
* @param this
|
|
24060
|
+
* @param this An object that provides waveform-based haptic feedback (vibrations and rumbles) on supported controllers and mobile devices.
|
|
23711
24061
|
*/
|
|
23712
24062
|
Stop(this: HapticEffect): void;
|
|
23713
24063
|
/**
|
|
@@ -23799,7 +24149,7 @@ interface HarmonyService extends Instance {
|
|
|
23799
24149
|
readonly _nominal_HarmonyService: unique symbol;
|
|
23800
24150
|
}
|
|
23801
24151
|
/**
|
|
23802
|
-
*
|
|
24152
|
+
* Generates and retrieves Luau heap memory profiles from the client and server Luau virtual machines for memory debugging.
|
|
23803
24153
|
*
|
|
23804
24154
|
* - **Tags**: NotCreatable, Service
|
|
23805
24155
|
*
|
|
@@ -23861,6 +24211,8 @@ interface HeightmapImporterService extends Instance {
|
|
|
23861
24211
|
readonly _nominal_HeightmapImporterService: unique symbol;
|
|
23862
24212
|
}
|
|
23863
24213
|
/**
|
|
24214
|
+
* Stores the precomputed hidden surface removal (HSR) data for a layered-clothing wrap, marking the mesh faces that are hidden by higher clothing layers so the engine can cull them.
|
|
24215
|
+
*
|
|
23864
24216
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HiddenSurfaceRemovalAsset)
|
|
23865
24217
|
*/
|
|
23866
24218
|
interface HiddenSurfaceRemovalAsset extends Instance {
|
|
@@ -23998,7 +24350,8 @@ interface HttpService extends Instance {
|
|
|
23998
24350
|
*
|
|
23999
24351
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HttpService#GetSecret)
|
|
24000
24352
|
* @param this Allows sending HTTP requests and provides various web-related and JSON methods.
|
|
24001
|
-
* @param key
|
|
24353
|
+
* @param key The name of the secret to fetch, matching the identifier under which it was added to the experience's secrets store.
|
|
24354
|
+
* @returns A `Secret` wrapping the stored value associated with `key`.
|
|
24002
24355
|
*/
|
|
24003
24356
|
GetSecret(this: HttpService, key: string): Secret;
|
|
24004
24357
|
/**
|
|
@@ -24427,7 +24780,8 @@ interface Humanoid extends Instance {
|
|
|
24427
24780
|
*
|
|
24428
24781
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Humanoid#AddCustomStatus)
|
|
24429
24782
|
* @param this A special object that gives models the functionality of a character.
|
|
24430
|
-
* @param status
|
|
24783
|
+
* @param status The custom status name to add to the Humanoid.
|
|
24784
|
+
* @returns Whether the custom status was successfully added; returns false if it already exists.
|
|
24431
24785
|
*
|
|
24432
24786
|
* @deprecated
|
|
24433
24787
|
*/
|
|
@@ -24442,7 +24796,8 @@ interface Humanoid extends Instance {
|
|
|
24442
24796
|
*
|
|
24443
24797
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Humanoid#AddStatus)
|
|
24444
24798
|
* @param this A special object that gives models the functionality of a character.
|
|
24445
|
-
* @param status
|
|
24799
|
+
* @param status The `Status` value to add to the Humanoid.
|
|
24800
|
+
* @returns Whether the status was successfully added; returns false if it already exists.
|
|
24446
24801
|
*
|
|
24447
24802
|
* @deprecated
|
|
24448
24803
|
*/
|
|
@@ -24493,6 +24848,7 @@ interface Humanoid extends Instance {
|
|
|
24493
24848
|
*
|
|
24494
24849
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Humanoid#GetAppliedDescription)
|
|
24495
24850
|
* @param this A special object that gives models the functionality of a character.
|
|
24851
|
+
* @returns A copy of the `HumanoidDescription` currently applied to the humanoid.
|
|
24496
24852
|
*/
|
|
24497
24853
|
GetAppliedDescription(this: Humanoid): HumanoidDescription;
|
|
24498
24854
|
/**
|
|
@@ -24549,6 +24905,7 @@ interface Humanoid extends Instance {
|
|
|
24549
24905
|
*
|
|
24550
24906
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Humanoid#GetRelativeVelocityAtFloor)
|
|
24551
24907
|
* @param this A special object that gives models the functionality of a character.
|
|
24908
|
+
* @returns The humanoid's velocity relative to the floor surface, as a `Vector3` in world-space orientation. Returns `(0, 0, 0)` if the humanoid has no root part.
|
|
24552
24909
|
*/
|
|
24553
24910
|
GetRelativeVelocityAtFloor(this: Humanoid): Vector3;
|
|
24554
24911
|
/**
|
|
@@ -24582,6 +24939,7 @@ interface Humanoid extends Instance {
|
|
|
24582
24939
|
*
|
|
24583
24940
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Humanoid#GetStatuses)
|
|
24584
24941
|
* @param this A special object that gives models the functionality of a character.
|
|
24942
|
+
* @returns An array of strings representing the names of all statuses currently applied to the Humanoid.
|
|
24585
24943
|
*
|
|
24586
24944
|
* @deprecated
|
|
24587
24945
|
*/
|
|
@@ -24596,7 +24954,8 @@ interface Humanoid extends Instance {
|
|
|
24596
24954
|
*
|
|
24597
24955
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Humanoid#HasCustomStatus)
|
|
24598
24956
|
* @param this A special object that gives models the functionality of a character.
|
|
24599
|
-
* @param status
|
|
24957
|
+
* @param status The custom status name to check for.
|
|
24958
|
+
* @returns Whether the specified custom status exists on the Humanoid.
|
|
24600
24959
|
*
|
|
24601
24960
|
* @deprecated
|
|
24602
24961
|
*/
|
|
@@ -24611,7 +24970,8 @@ interface Humanoid extends Instance {
|
|
|
24611
24970
|
*
|
|
24612
24971
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Humanoid#HasStatus)
|
|
24613
24972
|
* @param this A special object that gives models the functionality of a character.
|
|
24614
|
-
* @param status
|
|
24973
|
+
* @param status The `Status` value to check for.
|
|
24974
|
+
* @returns Whether the specified status exists on the Humanoid.
|
|
24615
24975
|
*
|
|
24616
24976
|
* @deprecated
|
|
24617
24977
|
*/
|
|
@@ -24627,6 +24987,7 @@ interface Humanoid extends Instance {
|
|
|
24627
24987
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Humanoid#LoadAnimation)
|
|
24628
24988
|
* @param this A special object that gives models the functionality of a character.
|
|
24629
24989
|
* @param animation The `Animation` to load.
|
|
24990
|
+
* @returns The `AnimationTrack` created from the loaded `Animation`.
|
|
24630
24991
|
*
|
|
24631
24992
|
* @deprecated
|
|
24632
24993
|
*/
|
|
@@ -24672,7 +25033,8 @@ interface Humanoid extends Instance {
|
|
|
24672
25033
|
*
|
|
24673
25034
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Humanoid#RemoveCustomStatus)
|
|
24674
25035
|
* @param this A special object that gives models the functionality of a character.
|
|
24675
|
-
* @param status
|
|
25036
|
+
* @param status The custom status name to remove from the Humanoid.
|
|
25037
|
+
* @returns Whether the custom status was successfully removed; returns false if it does not exist.
|
|
24676
25038
|
*
|
|
24677
25039
|
* @deprecated
|
|
24678
25040
|
*/
|
|
@@ -24687,7 +25049,8 @@ interface Humanoid extends Instance {
|
|
|
24687
25049
|
*
|
|
24688
25050
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Humanoid#RemoveStatus)
|
|
24689
25051
|
* @param this A special object that gives models the functionality of a character.
|
|
24690
|
-
* @param status
|
|
25052
|
+
* @param status The `Status` value to remove from the Humanoid.
|
|
25053
|
+
* @returns Whether the status was successfully removed; returns false if it does not exist.
|
|
24691
25054
|
*
|
|
24692
25055
|
* @deprecated
|
|
24693
25056
|
*/
|
|
@@ -24701,6 +25064,7 @@ interface Humanoid extends Instance {
|
|
|
24701
25064
|
* @param this A special object that gives models the functionality of a character.
|
|
24702
25065
|
* @param bodyPart The body part to replace. `BodyPartR15.Unknown` will fail.
|
|
24703
25066
|
* @param part The `Part` `Instance` which will be parented to the character.
|
|
25067
|
+
* @returns Whether the body part replacement was successful; returns false if the specified body part could not be found in the character.
|
|
24704
25068
|
*/
|
|
24705
25069
|
ReplaceBodyPartR15(this: Humanoid, bodyPart: CastsToEnum<Enum.BodyPartR15>, part: BasePart): boolean;
|
|
24706
25070
|
/**
|
|
@@ -24831,6 +25195,8 @@ interface Humanoid extends Instance {
|
|
|
24831
25195
|
*/
|
|
24832
25196
|
readonly AnimationPlayed: RBXScriptSignal<(animationTrack: AnimationTrack) => void>;
|
|
24833
25197
|
/**
|
|
25198
|
+
* Fires when a `HumanoidDescription` has finished being applied to the `Humanoid`.
|
|
25199
|
+
*
|
|
24834
25200
|
* - **ThreadSafety**: Unsafe
|
|
24835
25201
|
*
|
|
24836
25202
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Humanoid#ApplyDescriptionFinished)
|
|
@@ -25219,6 +25585,8 @@ interface HumanoidDescription extends Instance {
|
|
|
25219
25585
|
*/
|
|
25220
25586
|
LeftLegColor: Color3;
|
|
25221
25587
|
/**
|
|
25588
|
+
* When this description is `applied` to a `Humanoid`, this determines the asset ID of the mood animation that gives the character's face its persistent expression.
|
|
25589
|
+
*
|
|
25222
25590
|
* - **ThreadSafety**: ReadSafe
|
|
25223
25591
|
*
|
|
25224
25592
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidDescription#MoodAnimation)
|
|
@@ -25345,6 +25713,8 @@ interface HumanoidDescription extends Instance {
|
|
|
25345
25713
|
*/
|
|
25346
25714
|
TorsoColor: Color3;
|
|
25347
25715
|
/**
|
|
25716
|
+
* When `true`, applying this description also applies the experience's Avatar Settings to the resulting model. Defaults to `false`.
|
|
25717
|
+
*
|
|
25348
25718
|
* - **ThreadSafety**: ReadSafe
|
|
25349
25719
|
*
|
|
25350
25720
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidDescription#UseAvatarSettings)
|
|
@@ -26347,6 +26717,8 @@ interface IKControl extends Instance {
|
|
|
26347
26717
|
GetSmoothedFinalTarget(this: IKControl): CFrame;
|
|
26348
26718
|
}
|
|
26349
26719
|
/**
|
|
26720
|
+
* Internal Studio-only base interface for a Studio bridge service. Declares no scriptable members.
|
|
26721
|
+
*
|
|
26350
26722
|
* - **Tags**: NotCreatable, Service
|
|
26351
26723
|
*
|
|
26352
26724
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ILegacyStudioBridge)
|
|
@@ -26449,6 +26821,8 @@ interface AssetImportSession extends ImportSession {
|
|
|
26449
26821
|
readonly _nominal_AssetImportSession: unique symbol;
|
|
26450
26822
|
}
|
|
26451
26823
|
/**
|
|
26824
|
+
* Builds signed incremental patches for hot-reloading a running client from script changes detected by a separate file watcher.
|
|
26825
|
+
*
|
|
26452
26826
|
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
26453
26827
|
*
|
|
26454
26828
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/IncrementalPatchBuilder)
|
|
@@ -26463,36 +26837,48 @@ interface IncrementalPatchBuilder extends Instance {
|
|
|
26463
26837
|
*/
|
|
26464
26838
|
readonly _nominal_IncrementalPatchBuilder: unique symbol;
|
|
26465
26839
|
/**
|
|
26840
|
+
* Whether each script in the patch is tagged with a `FilePath` attribute recording its on-disk source path.
|
|
26841
|
+
*
|
|
26466
26842
|
* - **ThreadSafety**: ReadSafe
|
|
26467
26843
|
*
|
|
26468
26844
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/IncrementalPatchBuilder#AddPathsToBundle)
|
|
26469
26845
|
*/
|
|
26470
26846
|
AddPathsToBundle: boolean;
|
|
26471
26847
|
/**
|
|
26848
|
+
* The interval, in seconds, used to debounce rebuilds so that rapid script changes are coalesced into a single patch build.
|
|
26849
|
+
*
|
|
26472
26850
|
* - **ThreadSafety**: ReadSafe
|
|
26473
26851
|
*
|
|
26474
26852
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/IncrementalPatchBuilder#BuildDebouncePeriod)
|
|
26475
26853
|
*/
|
|
26476
26854
|
BuildDebouncePeriod: number;
|
|
26477
26855
|
/**
|
|
26856
|
+
* Whether the serialized patch is written with high-compression settings.
|
|
26857
|
+
*
|
|
26478
26858
|
* - **ThreadSafety**: ReadSafe
|
|
26479
26859
|
*
|
|
26480
26860
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/IncrementalPatchBuilder#HighCompression)
|
|
26481
26861
|
*/
|
|
26482
26862
|
HighCompression: boolean;
|
|
26483
26863
|
/**
|
|
26864
|
+
* Whether a completed build is serialized into a signed binary patch.
|
|
26865
|
+
*
|
|
26484
26866
|
* - **ThreadSafety**: ReadSafe
|
|
26485
26867
|
*
|
|
26486
26868
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/IncrementalPatchBuilder#SerializePatch)
|
|
26487
26869
|
*/
|
|
26488
26870
|
SerializePatch: boolean;
|
|
26489
26871
|
/**
|
|
26872
|
+
* Whether per-chunk compression is skipped so that the patch is compressed at the file level instead.
|
|
26873
|
+
*
|
|
26490
26874
|
* - **ThreadSafety**: ReadSafe
|
|
26491
26875
|
*
|
|
26492
26876
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/IncrementalPatchBuilder#UseFileLevelCompressionInsteadOfChunk)
|
|
26493
26877
|
*/
|
|
26494
26878
|
UseFileLevelCompressionInsteadOfChunk: boolean;
|
|
26495
26879
|
/**
|
|
26880
|
+
* Whether per-chunk compression of the patch uses the Zstandard algorithm.
|
|
26881
|
+
*
|
|
26496
26882
|
* - **ThreadSafety**: ReadSafe
|
|
26497
26883
|
*
|
|
26498
26884
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/IncrementalPatchBuilder#ZstdCompression)
|
|
@@ -26889,7 +27275,7 @@ interface InputObject extends Instance {
|
|
|
26889
27275
|
*
|
|
26890
27276
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputObject#IsModifierKeyDown)
|
|
26891
27277
|
* @param this An object created when an input begins that describes a particular user input.
|
|
26892
|
-
* @param modifierKey
|
|
27278
|
+
* @param modifierKey The `ModifierKey` to check.
|
|
26893
27279
|
* @returns `true` if the passed in `modifierKey` is being held down; `false` otherwise.
|
|
26894
27280
|
*/
|
|
26895
27281
|
IsModifierKeyDown(this: InputObject, modifierKey: CastsToEnum<Enum.ModifierKey>): boolean;
|
|
@@ -26926,12 +27312,14 @@ interface InsertService extends Instance {
|
|
|
26926
27312
|
/**
|
|
26927
27313
|
* **Deprecated:** This item is deprecated. Do not use it for new work.
|
|
26928
27314
|
*
|
|
27315
|
+
* Deprecated. Accepts an asset ID for InsertService approval; calling it has no effect.
|
|
27316
|
+
*
|
|
26929
27317
|
* - **ThreadSafety**: Unsafe
|
|
26930
27318
|
* - **Tags**:
|
|
26931
27319
|
*
|
|
26932
27320
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InsertService#ApproveAssetId)
|
|
26933
27321
|
* @param this Used to insert assets from the Roblox website.
|
|
26934
|
-
* @param assetId
|
|
27322
|
+
* @param assetId The ID of the asset.
|
|
26935
27323
|
*
|
|
26936
27324
|
* @deprecated
|
|
26937
27325
|
*/
|
|
@@ -26939,12 +27327,14 @@ interface InsertService extends Instance {
|
|
|
26939
27327
|
/**
|
|
26940
27328
|
* **Deprecated:** This item is deprecated. Do not use it for new work.
|
|
26941
27329
|
*
|
|
27330
|
+
* Deprecated. Accepts an asset version ID for InsertService approval; calling it has no effect.
|
|
27331
|
+
*
|
|
26942
27332
|
* - **ThreadSafety**: Unsafe
|
|
26943
27333
|
* - **Tags**:
|
|
26944
27334
|
*
|
|
26945
27335
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InsertService#ApproveAssetVersionId)
|
|
26946
27336
|
* @param this Used to insert assets from the Roblox website.
|
|
26947
|
-
* @param assetVersionId
|
|
27337
|
+
* @param assetVersionId The version ID of the asset.
|
|
26948
27338
|
*
|
|
26949
27339
|
* @deprecated
|
|
26950
27340
|
*/
|
|
@@ -26959,7 +27349,7 @@ interface InsertService extends Instance {
|
|
|
26959
27349
|
*
|
|
26960
27350
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InsertService#Insert)
|
|
26961
27351
|
* @param this Used to insert assets from the Roblox website.
|
|
26962
|
-
* @param instance
|
|
27352
|
+
* @param instance The `Instance` to insert into `Workspace`.
|
|
26963
27353
|
*
|
|
26964
27354
|
* @deprecated
|
|
26965
27355
|
*/
|
|
@@ -27000,6 +27390,7 @@ interface InsertService extends Instance {
|
|
|
27000
27390
|
*
|
|
27001
27391
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InsertService#GetBaseSets)
|
|
27002
27392
|
* @param this Used to insert assets from the Roblox website.
|
|
27393
|
+
* @returns An array of dictionaries containing information about Roblox-approved sets.
|
|
27003
27394
|
*
|
|
27004
27395
|
* @deprecated
|
|
27005
27396
|
*/
|
|
@@ -27014,7 +27405,8 @@ interface InsertService extends Instance {
|
|
|
27014
27405
|
*
|
|
27015
27406
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InsertService#GetCollection)
|
|
27016
27407
|
* @param this Used to insert assets from the Roblox website.
|
|
27017
|
-
* @param categoryId
|
|
27408
|
+
* @param categoryId The ID of the set (category) to retrieve models from.
|
|
27409
|
+
* @returns An array of the most recently uploaded models in the specified set.
|
|
27018
27410
|
*
|
|
27019
27411
|
* @deprecated
|
|
27020
27412
|
*/
|
|
@@ -27091,7 +27483,8 @@ interface InsertService extends Instance {
|
|
|
27091
27483
|
*
|
|
27092
27484
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InsertService#GetLatestAssetVersionAsync)
|
|
27093
27485
|
* @param this Used to insert assets from the Roblox website.
|
|
27094
|
-
* @param assetId
|
|
27486
|
+
* @param assetId The ID of the asset to retrieve the latest version for.
|
|
27487
|
+
* @returns The latest asset version ID for the specified asset.
|
|
27095
27488
|
*/
|
|
27096
27489
|
GetLatestAssetVersionAsync(this: InsertService, assetId: number): number;
|
|
27097
27490
|
/**
|
|
@@ -27117,7 +27510,8 @@ interface InsertService extends Instance {
|
|
|
27117
27510
|
*
|
|
27118
27511
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InsertService#GetUserSets)
|
|
27119
27512
|
* @param this Used to insert assets from the Roblox website.
|
|
27120
|
-
* @param userId
|
|
27513
|
+
* @param userId The ID of the user whose sets to retrieve.
|
|
27514
|
+
* @returns An array of dictionaries containing information about the user's sets.
|
|
27121
27515
|
*
|
|
27122
27516
|
* @deprecated
|
|
27123
27517
|
*/
|
|
@@ -27142,7 +27536,8 @@ interface InsertService extends Instance {
|
|
|
27142
27536
|
*
|
|
27143
27537
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InsertService#LoadAssetVersion)
|
|
27144
27538
|
* @param this Used to insert assets from the Roblox website.
|
|
27145
|
-
* @param assetVersionId
|
|
27539
|
+
* @param assetVersionId The version ID of the asset to load.
|
|
27540
|
+
* @returns A `Model` containing the asset at the specified version.
|
|
27146
27541
|
*/
|
|
27147
27542
|
LoadAssetVersion(this: InsertService, assetVersionId: number): Model;
|
|
27148
27543
|
/**
|
|
@@ -27185,6 +27580,21 @@ interface InstanceFileSyncService extends Instance {
|
|
|
27185
27580
|
*/
|
|
27186
27581
|
readonly _nominal_InstanceFileSyncService: unique symbol;
|
|
27187
27582
|
}
|
|
27583
|
+
/**
|
|
27584
|
+
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
27585
|
+
*
|
|
27586
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/IntentService)
|
|
27587
|
+
*/
|
|
27588
|
+
interface IntentService extends Instance {
|
|
27589
|
+
/**
|
|
27590
|
+
* **DO NOT USE!**
|
|
27591
|
+
*
|
|
27592
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
27593
|
+
* @hidden
|
|
27594
|
+
* @deprecated
|
|
27595
|
+
*/
|
|
27596
|
+
readonly _nominal_IntentService: unique symbol;
|
|
27597
|
+
}
|
|
27188
27598
|
/**
|
|
27189
27599
|
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
27190
27600
|
*
|
|
@@ -27358,6 +27768,8 @@ interface RotateP extends DynamicRotate {
|
|
|
27358
27768
|
/**
|
|
27359
27769
|
* **Deprecated:** This class works alongside the deprecated `SurfaceType` and should not be used for future work; use `HingeConstraint` instead.
|
|
27360
27770
|
*
|
|
27771
|
+
* Joins two parts and allows rotation driven by angular velocity from the Motor surface type.
|
|
27772
|
+
*
|
|
27361
27773
|
* - **Tags**:
|
|
27362
27774
|
*
|
|
27363
27775
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RotateV)
|
|
@@ -27536,7 +27948,7 @@ interface Motor extends JointInstance {
|
|
|
27536
27948
|
*
|
|
27537
27949
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Motor#SetDesiredAngle)
|
|
27538
27950
|
* @param this Makes a movable `JointInstance` between two parts.
|
|
27539
|
-
* @param value
|
|
27951
|
+
* @param value The target angle, in radians, to set as the motor's `Motor.DesiredAngle`.
|
|
27540
27952
|
*/
|
|
27541
27953
|
SetDesiredAngle(this: Motor, value: number): void;
|
|
27542
27954
|
}
|
|
@@ -27605,6 +28017,8 @@ interface Snap extends JointInstance {
|
|
|
27605
28017
|
readonly _nominal_Snap: unique symbol;
|
|
27606
28018
|
}
|
|
27607
28019
|
/**
|
|
28020
|
+
* A `Motor`-like `JointInstance` that forms its connection using a `MotorFeature` and a `Hole`.
|
|
28021
|
+
*
|
|
27608
28022
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VelocityMotor)
|
|
27609
28023
|
*/
|
|
27610
28024
|
interface VelocityMotor extends JointInstance {
|
|
@@ -27650,6 +28064,8 @@ interface VelocityMotor extends JointInstance {
|
|
|
27650
28064
|
MaxVelocity: number;
|
|
27651
28065
|
}
|
|
27652
28066
|
/**
|
|
28067
|
+
* Holds two `BaseParts` together in a fixed relative position, regardless of whether they're touching.
|
|
28068
|
+
*
|
|
27653
28069
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Weld)
|
|
27654
28070
|
*/
|
|
27655
28071
|
interface Weld extends JointInstance {
|
|
@@ -27713,7 +28129,7 @@ interface JointsService extends Instance {
|
|
|
27713
28129
|
* @param this **Deprecated:** This service has been deprecated in favor of [constraints](../../../physics/mechanical-constraints.md) which should be used for surface connections instead
|
|
27714
28130
|
*
|
|
27715
28131
|
* A service that stores joints created by surface connections.
|
|
27716
|
-
* @param joinInstance
|
|
28132
|
+
* @param joinInstance The `PVInstance` to be joined to the target set by `JointsService:SetJoinAfterMoveTarget()`.
|
|
27717
28133
|
*/
|
|
27718
28134
|
SetJoinAfterMoveInstance(this: JointsService, joinInstance: PVInstance): void;
|
|
27719
28135
|
/**
|
|
@@ -27725,7 +28141,7 @@ interface JointsService extends Instance {
|
|
|
27725
28141
|
* @param this **Deprecated:** This service has been deprecated in favor of [constraints](../../../physics/mechanical-constraints.md) which should be used for surface connections instead
|
|
27726
28142
|
*
|
|
27727
28143
|
* A service that stores joints created by surface connections.
|
|
27728
|
-
* @param joinTarget
|
|
28144
|
+
* @param joinTarget The `PVInstance` to serve as the connection target for the instance set by `JointsService:SetJoinAfterMoveInstance()`.
|
|
27729
28145
|
*/
|
|
27730
28146
|
SetJoinAfterMoveTarget(this: JointsService, joinTarget: PVInstance): void;
|
|
27731
28147
|
/**
|
|
@@ -28447,6 +28863,7 @@ interface LocalizationService extends Instance {
|
|
|
28447
28863
|
*
|
|
28448
28864
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/LocalizationService#GetCorescriptLocalizations)
|
|
28449
28865
|
* @param this Handles automated translation.
|
|
28866
|
+
* @returns A list of `LocalizationTable` objects used for localizing CoreScripts.
|
|
28450
28867
|
*/
|
|
28451
28868
|
GetCorescriptLocalizations(this: LocalizationService): Array<Instance>;
|
|
28452
28869
|
/**
|
|
@@ -28456,7 +28873,7 @@ interface LocalizationService extends Instance {
|
|
|
28456
28873
|
*
|
|
28457
28874
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/LocalizationService#GetTableEntries)
|
|
28458
28875
|
* @param this Handles automated translation.
|
|
28459
|
-
* @param instance
|
|
28876
|
+
* @param instance The `Instance` for which to retrieve the ordered localization table entries. If nil, only entries from the `LocalizationService` hierarchy and the cloud `LocalizationTable` are returned.
|
|
28460
28877
|
* @returns An array of arrays, where each array is in the same format as described in `LocalizationTable:GetEntries()`.
|
|
28461
28878
|
*/
|
|
28462
28879
|
GetTableEntries(this: LocalizationService, instance?: Instance): Array<unknown>;
|
|
@@ -28559,11 +28976,14 @@ interface LocalizationTable extends Instance {
|
|
|
28559
28976
|
/**
|
|
28560
28977
|
* **Deprecated:** This item has been superseded by `LocalizationTable:GetEntries()` which should be used in all new work.
|
|
28561
28978
|
*
|
|
28979
|
+
* Returns the contents of the `LocalizationTable` serialized as a JSON string.
|
|
28980
|
+
*
|
|
28562
28981
|
* - **ThreadSafety**: Unsafe
|
|
28563
28982
|
* - **Tags**:
|
|
28564
28983
|
*
|
|
28565
28984
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/LocalizationTable#GetContents)
|
|
28566
28985
|
* @param this A LocalizationTable is a database of translations. It contains source strings and translations for various languages.
|
|
28986
|
+
* @returns The table's entries encoded as a JSON-formatted string.
|
|
28567
28987
|
*
|
|
28568
28988
|
* @deprecated GetEntries
|
|
28569
28989
|
*/
|
|
@@ -28602,7 +29022,7 @@ interface LocalizationTable extends Instance {
|
|
|
28602
29022
|
*
|
|
28603
29023
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/LocalizationTable#GetTranslator)
|
|
28604
29024
|
* @param this A LocalizationTable is a database of translations. It contains source strings and translations for various languages.
|
|
28605
|
-
* @param localeId
|
|
29025
|
+
* @param localeId A Roblox locale identifier (for example, "en-us" or "es-es") specifying the language the returned Translator should target.
|
|
28606
29026
|
* @returns The `Translator` instance for the specified locale.
|
|
28607
29027
|
*/
|
|
28608
29028
|
GetTranslator(this: LocalizationTable, localeId: string): Translator;
|
|
@@ -28613,9 +29033,9 @@ interface LocalizationTable extends Instance {
|
|
|
28613
29033
|
*
|
|
28614
29034
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/LocalizationTable#RemoveEntry)
|
|
28615
29035
|
* @param this A LocalizationTable is a database of translations. It contains source strings and translations for various languages.
|
|
28616
|
-
* @param key
|
|
28617
|
-
* @param source
|
|
28618
|
-
* @param context
|
|
29036
|
+
* @param key The unique key of the entry to remove. If non-empty, identifies the entry by itself.
|
|
29037
|
+
* @param source The source text of the entry. Used with context to identify the entry when key is empty.
|
|
29038
|
+
* @param context The `Instance:GetFullName()` path used for disambiguation. Used with source to identify the entry when key is empty.
|
|
28619
29039
|
*/
|
|
28620
29040
|
RemoveEntry(this: LocalizationTable, key: string, source: string, context: string): void;
|
|
28621
29041
|
/**
|
|
@@ -28625,10 +29045,10 @@ interface LocalizationTable extends Instance {
|
|
|
28625
29045
|
*
|
|
28626
29046
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/LocalizationTable#RemoveEntryValue)
|
|
28627
29047
|
* @param this A LocalizationTable is a database of translations. It contains source strings and translations for various languages.
|
|
28628
|
-
* @param key
|
|
28629
|
-
* @param source
|
|
28630
|
-
* @param context
|
|
28631
|
-
* @param localeId
|
|
29048
|
+
* @param key The unique key of the entry. If non-empty, identifies the entry by itself.
|
|
29049
|
+
* @param source The source text of the entry. Used with context to identify the entry when key is empty.
|
|
29050
|
+
* @param context The `Instance:GetFullName()` path used for disambiguation. Used with source to identify the entry when key is empty.
|
|
29051
|
+
* @param localeId The locale identifier (for example, "fr-fr") whose translation should be removed from the entry.
|
|
28632
29052
|
*/
|
|
28633
29053
|
RemoveEntryValue(this: LocalizationTable, key: string, source: string, context: string, localeId: string): void;
|
|
28634
29054
|
/**
|
|
@@ -28641,7 +29061,7 @@ interface LocalizationTable extends Instance {
|
|
|
28641
29061
|
*
|
|
28642
29062
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/LocalizationTable#RemoveKey)
|
|
28643
29063
|
* @param this A LocalizationTable is a database of translations. It contains source strings and translations for various languages.
|
|
28644
|
-
* @param key
|
|
29064
|
+
* @param key The unique key of the entry to remove.
|
|
28645
29065
|
*
|
|
28646
29066
|
* @deprecated RemoveEntry
|
|
28647
29067
|
*/
|
|
@@ -28653,7 +29073,7 @@ interface LocalizationTable extends Instance {
|
|
|
28653
29073
|
*
|
|
28654
29074
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/LocalizationTable#RemoveTargetLocale)
|
|
28655
29075
|
* @param this A LocalizationTable is a database of translations. It contains source strings and translations for various languages.
|
|
28656
|
-
* @param localeId
|
|
29076
|
+
* @param localeId A Roblox locale identifier (for example, "fr-fr") specifying which language's translations to remove from all entries.
|
|
28657
29077
|
*/
|
|
28658
29078
|
RemoveTargetLocale(this: LocalizationTable, localeId: string): void;
|
|
28659
29079
|
/**
|
|
@@ -28666,7 +29086,7 @@ interface LocalizationTable extends Instance {
|
|
|
28666
29086
|
*
|
|
28667
29087
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/LocalizationTable#SetContents)
|
|
28668
29088
|
* @param this A LocalizationTable is a database of translations. It contains source strings and translations for various languages.
|
|
28669
|
-
* @param contents
|
|
29089
|
+
* @param contents A JSON-formatted string encoding the table's entries, in the same format returned by `LocalizationTable:GetContents()`.
|
|
28670
29090
|
*
|
|
28671
29091
|
* @deprecated SetEntries
|
|
28672
29092
|
*/
|
|
@@ -28678,20 +29098,22 @@ interface LocalizationTable extends Instance {
|
|
|
28678
29098
|
*
|
|
28679
29099
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/LocalizationTable#SetEntries)
|
|
28680
29100
|
* @param this A LocalizationTable is a database of translations. It contains source strings and translations for various languages.
|
|
28681
|
-
* @param entries
|
|
29101
|
+
* @param entries An array of dictionaries in the same format returned by `LocalizationTable:GetEntries()`, each containing Key, Source, Context, Example, and Values fields.
|
|
28682
29102
|
*/
|
|
28683
29103
|
SetEntries(this: LocalizationTable, entries: Array<LocalizationEntry>): void;
|
|
28684
29104
|
/**
|
|
28685
|
-
* **Deprecated:** This item has been superseded by `LocalizationTable:SetEntries()` which should be used in all new work
|
|
29105
|
+
* **Deprecated:** This item has been superseded by `LocalizationTable:SetEntries()` which should be used in all new work.
|
|
29106
|
+
*
|
|
29107
|
+
* Sets the translation `text` for the `targetLocaleId` locale on the entry identified by `key`, creating the entry if it doesn't exist.
|
|
28686
29108
|
*
|
|
28687
29109
|
* - **ThreadSafety**: Unsafe
|
|
28688
29110
|
* - **Tags**:
|
|
28689
29111
|
*
|
|
28690
29112
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/LocalizationTable#SetEntry)
|
|
28691
29113
|
* @param this A LocalizationTable is a database of translations. It contains source strings and translations for various languages.
|
|
28692
|
-
* @param key
|
|
28693
|
-
* @param targetLocaleId
|
|
28694
|
-
* @param text
|
|
29114
|
+
* @param key The unique key identifying the entry. If no entry with this key exists, a new entry is created.
|
|
29115
|
+
* @param targetLocaleId The Roblox locale identifier (for example, "en-us" or "fr-fr") for the translation to set.
|
|
29116
|
+
* @param text The translation text to store for the specified locale.
|
|
28695
29117
|
*
|
|
28696
29118
|
* @deprecated SetEntryValue
|
|
28697
29119
|
*/
|
|
@@ -28703,10 +29125,10 @@ interface LocalizationTable extends Instance {
|
|
|
28703
29125
|
*
|
|
28704
29126
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/LocalizationTable#SetEntryContext)
|
|
28705
29127
|
* @param this A LocalizationTable is a database of translations. It contains source strings and translations for various languages.
|
|
28706
|
-
* @param key
|
|
28707
|
-
* @param source
|
|
28708
|
-
* @param context
|
|
28709
|
-
* @param newContext
|
|
29128
|
+
* @param key The unique key of the entry. If non-empty, identifies the entry by itself.
|
|
29129
|
+
* @param source The source text of the entry. Used with context to identify the entry when key is empty.
|
|
29130
|
+
* @param context The current `Instance:GetFullName()` path of the entry. Used with source to identify the entry when key is empty.
|
|
29131
|
+
* @param newContext The new context string to assign to the entry.
|
|
28710
29132
|
*/
|
|
28711
29133
|
SetEntryContext(this: LocalizationTable, key: string, source: string, context: string, newContext: string): void;
|
|
28712
29134
|
/**
|
|
@@ -28716,10 +29138,10 @@ interface LocalizationTable extends Instance {
|
|
|
28716
29138
|
*
|
|
28717
29139
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/LocalizationTable#SetEntryExample)
|
|
28718
29140
|
* @param this A LocalizationTable is a database of translations. It contains source strings and translations for various languages.
|
|
28719
|
-
* @param key
|
|
28720
|
-
* @param source
|
|
28721
|
-
* @param context
|
|
28722
|
-
* @param example
|
|
29141
|
+
* @param key The unique key of the entry. If non-empty, identifies the entry by itself.
|
|
29142
|
+
* @param source The source text of the entry. Used with context to identify the entry when key is empty.
|
|
29143
|
+
* @param context The `Instance:GetFullName()` path of the entry. Used with source to identify the entry when key is empty.
|
|
29144
|
+
* @param example The new example text to assign to the entry, typically a sample of parameterized content in context.
|
|
28723
29145
|
*/
|
|
28724
29146
|
SetEntryExample(this: LocalizationTable, key: string, source: string, context: string, example: string): void;
|
|
28725
29147
|
/**
|
|
@@ -28729,10 +29151,10 @@ interface LocalizationTable extends Instance {
|
|
|
28729
29151
|
*
|
|
28730
29152
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/LocalizationTable#SetEntryKey)
|
|
28731
29153
|
* @param this A LocalizationTable is a database of translations. It contains source strings and translations for various languages.
|
|
28732
|
-
* @param key
|
|
28733
|
-
* @param source
|
|
28734
|
-
* @param context
|
|
28735
|
-
* @param newKey
|
|
29154
|
+
* @param key The current unique key of the entry. If non-empty, identifies the entry by itself.
|
|
29155
|
+
* @param source The source text of the entry. Used with context to identify the entry when key is empty.
|
|
29156
|
+
* @param context The `Instance:GetFullName()` path of the entry. Used with source to identify the entry when key is empty.
|
|
29157
|
+
* @param newKey The new key string to assign to the entry. Must be unique within the table if non-empty.
|
|
28736
29158
|
*/
|
|
28737
29159
|
SetEntryKey(this: LocalizationTable, key: string, source: string, context: string, newKey: string): void;
|
|
28738
29160
|
/**
|
|
@@ -28742,10 +29164,10 @@ interface LocalizationTable extends Instance {
|
|
|
28742
29164
|
*
|
|
28743
29165
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/LocalizationTable#SetEntrySource)
|
|
28744
29166
|
* @param this A LocalizationTable is a database of translations. It contains source strings and translations for various languages.
|
|
28745
|
-
* @param key
|
|
28746
|
-
* @param source
|
|
28747
|
-
* @param context
|
|
28748
|
-
* @param newSource
|
|
29167
|
+
* @param key The unique key of the entry. If non-empty, identifies the entry by itself.
|
|
29168
|
+
* @param source The current source text of the entry. Used with context to identify the entry when key is empty.
|
|
29169
|
+
* @param context The `Instance:GetFullName()` path of the entry. Used with source to identify the entry when key is empty.
|
|
29170
|
+
* @param newSource The new source text to assign to the entry. Used by the automatic text replacement system for matching GUI text at runtime.
|
|
28749
29171
|
*/
|
|
28750
29172
|
SetEntrySource(this: LocalizationTable, key: string, source: string, context: string, newSource: string): void;
|
|
28751
29173
|
/**
|
|
@@ -28755,11 +29177,11 @@ interface LocalizationTable extends Instance {
|
|
|
28755
29177
|
*
|
|
28756
29178
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/LocalizationTable#SetEntryValue)
|
|
28757
29179
|
* @param this A LocalizationTable is a database of translations. It contains source strings and translations for various languages.
|
|
28758
|
-
* @param key
|
|
28759
|
-
* @param source
|
|
28760
|
-
* @param context
|
|
28761
|
-
* @param localeId
|
|
28762
|
-
* @param text
|
|
29180
|
+
* @param key The unique key of the entry. If non-empty, identifies the entry by itself.
|
|
29181
|
+
* @param source The source text of the entry. Used with context to identify the entry when key is empty.
|
|
29182
|
+
* @param context The `Instance:GetFullName()` path of the entry. Used with source to identify the entry when key is empty.
|
|
29183
|
+
* @param localeId The Roblox locale identifier (for example, "fr-fr") for the translation to set or remove.
|
|
29184
|
+
* @param text The translation text to store. If empty, the translation for the specified locale is removed from the entry.
|
|
28763
29185
|
*/
|
|
28764
29186
|
SetEntryValue(this: LocalizationTable, key: string, source: string, context: string, localeId: string, text: string): void;
|
|
28765
29187
|
}
|
|
@@ -28932,6 +29354,13 @@ interface LogService extends Instance {
|
|
|
28932
29354
|
* @param context An optional dictionary of key-value pairs. When provided, `{key}` placeholders in the message are replaced with the corresponding values.
|
|
28933
29355
|
*/
|
|
28934
29356
|
Warn(this: LogService, message: string, context?: object): void;
|
|
29357
|
+
/**
|
|
29358
|
+
* - **ThreadSafety**: Unsafe
|
|
29359
|
+
* - **Tags**: Yields
|
|
29360
|
+
*
|
|
29361
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/LogService#GetLogHistoryAsync)
|
|
29362
|
+
*/
|
|
29363
|
+
GetLogHistoryAsync(this: LogService, user: User): Array<unknown>;
|
|
28935
29364
|
/**
|
|
28936
29365
|
* Fires when the client outputs text.
|
|
28937
29366
|
*
|
|
@@ -29299,6 +29728,7 @@ interface MakeupDescription extends Instance {
|
|
|
29299
29728
|
*
|
|
29300
29729
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MakeupDescription#GetAppliedInstance)
|
|
29301
29730
|
* @param this Describes the appearance of a makeup item for the `HumanoidDescription`.
|
|
29731
|
+
* @returns The single composed makeup `Decal` parented under the character's head.
|
|
29302
29732
|
*/
|
|
29303
29733
|
GetAppliedInstance(this: MakeupDescription): Instance | undefined;
|
|
29304
29734
|
}
|
|
@@ -30000,6 +30430,8 @@ interface MaterialVariant extends Instance {
|
|
|
30000
30430
|
*/
|
|
30001
30431
|
get BaseMaterial(): Enum.Material;
|
|
30002
30432
|
/**
|
|
30433
|
+
* Determines the physical properties of parts whose material resolves to this variant.
|
|
30434
|
+
*
|
|
30003
30435
|
* - **ThreadSafety**: ReadSafe
|
|
30004
30436
|
*
|
|
30005
30437
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MaterialVariant#CustomPhysicalProperties)
|
|
@@ -30129,6 +30561,7 @@ interface MemoryStoreHashMap extends Instance {
|
|
|
30129
30561
|
* @param key The key whose value to set.
|
|
30130
30562
|
* @param value The value to set.
|
|
30131
30563
|
* @param expiration Item expiration in seconds, after which the item is automatically removed from the hash map. The maximum expiration time is 45 days (3,888,000 seconds).
|
|
30564
|
+
* @returns `true` if the key already had a value that was overwritten, or `false` if the key was newly created.
|
|
30132
30565
|
*/
|
|
30133
30566
|
SetAsync(this: MemoryStoreHashMap, key: string, value: unknown, expiration: number): boolean;
|
|
30134
30567
|
/**
|
|
@@ -30184,6 +30617,7 @@ interface MemoryStoreQueue extends Instance {
|
|
|
30184
30617
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MemoryStoreQueue#GetSizeAsync)
|
|
30185
30618
|
* @param this Provides access to a queue within MemoryStore.
|
|
30186
30619
|
* @param excludeInvisible Determines whether to exclude invisible items from the size count.
|
|
30620
|
+
* @returns The number of items currently in the queue. Items that have been read but not yet removed (invisible items) are included in the count unless `excludeInvisible` is `true`.
|
|
30187
30621
|
*/
|
|
30188
30622
|
GetSizeAsync(this: MemoryStoreQueue, excludeInvisible?: boolean): number;
|
|
30189
30623
|
/**
|
|
@@ -30337,6 +30771,7 @@ interface MemoryStoreSortedMap extends Instance {
|
|
|
30337
30771
|
*
|
|
30338
30772
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MemoryStoreSortedMap#GetSizeAsync)
|
|
30339
30773
|
* @param this Provides access to a sorted map within `MemoryStoreService`.
|
|
30774
|
+
* @returns The number of items currently stored in the sorted map.
|
|
30340
30775
|
*/
|
|
30341
30776
|
GetSizeAsync(this: MemoryStoreSortedMap): number;
|
|
30342
30777
|
/**
|
|
@@ -30362,6 +30797,7 @@ interface MemoryStoreSortedMap extends Instance {
|
|
|
30362
30797
|
* @param value Key value to set.
|
|
30363
30798
|
* @param expiration Item expiration, in seconds. The item is automatically removed from the sorted map once the expiration duration is reached. The maximum expiration time is 45 days (3,888,000 seconds).
|
|
30364
30799
|
* @param sortKey **(Optional)** Sort key to set for this key. Accepted types are a number (integer or decimal) or a string.
|
|
30800
|
+
* @returns `true` if the value of an existing key was overwritten, or `false` if a new key was added to the sorted map.
|
|
30365
30801
|
*/
|
|
30366
30802
|
SetAsync(this: MemoryStoreSortedMap, key: string, value: unknown, expiration: number, sortKey?: string | number): boolean;
|
|
30367
30803
|
/**
|
|
@@ -31042,6 +31478,7 @@ interface PVInstance extends Instance {
|
|
|
31042
31478
|
*
|
|
31043
31479
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PVInstance#GetPivot)
|
|
31044
31480
|
* @param this Abstract class for all objects that have a physical location in the world.
|
|
31481
|
+
* @returns The world-space `CFrame` of the instance's pivot.
|
|
31045
31482
|
*/
|
|
31046
31483
|
GetPivot(this: PVInstance): CFrame;
|
|
31047
31484
|
/**
|
|
@@ -31863,6 +32300,7 @@ interface BasePart extends PVInstance {
|
|
|
31863
32300
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/BasePart#GetConnectedParts)
|
|
31864
32301
|
* @param this The abstract base class for in-world objects that physically interact.
|
|
31865
32302
|
* @param recursive A table of parts connected to the object by any kind of `joint`.
|
|
32303
|
+
* @returns An array of `BaseParts` connected to this part by rigid joints. If `recursive` is true, includes all parts in the assembly.
|
|
31866
32304
|
*/
|
|
31867
32305
|
GetConnectedParts(this: BasePart, recursive?: boolean): Array<BasePart>;
|
|
31868
32306
|
/**
|
|
@@ -31906,10 +32344,13 @@ interface BasePart extends PVInstance {
|
|
|
31906
32344
|
*/
|
|
31907
32345
|
GetNetworkOwnershipAuto(this: BasePart): boolean;
|
|
31908
32346
|
/**
|
|
32347
|
+
* Returns the enabled `NoCollisionConstraint` objects currently registered for this part in its physics world.
|
|
32348
|
+
*
|
|
31909
32349
|
* - **ThreadSafety**: Unsafe
|
|
31910
32350
|
*
|
|
31911
32351
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/BasePart#GetNoCollisionConstraints)
|
|
31912
32352
|
* @param this The abstract base class for in-world objects that physically interact.
|
|
32353
|
+
* @returns An array of the enabled `NoCollisionConstraint` objects currently registered for this part in its physics world.
|
|
31913
32354
|
*/
|
|
31914
32355
|
GetNoCollisionConstraints(this: BasePart): Array<Instance>;
|
|
31915
32356
|
/**
|
|
@@ -31922,6 +32363,7 @@ interface BasePart extends PVInstance {
|
|
|
31922
32363
|
*
|
|
31923
32364
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/BasePart#GetRenderCFrame)
|
|
31924
32365
|
* @param this The abstract base class for in-world objects that physically interact.
|
|
32366
|
+
* @returns The `CFrame` representing where the part is being rendered, which is now equivalent to the part's `CFrame`.
|
|
31925
32367
|
*
|
|
31926
32368
|
* @deprecated
|
|
31927
32369
|
*/
|
|
@@ -31958,7 +32400,8 @@ interface BasePart extends PVInstance {
|
|
|
31958
32400
|
*
|
|
31959
32401
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/BasePart#GetVelocityAtPosition)
|
|
31960
32402
|
* @param this The abstract base class for in-world objects that physically interact.
|
|
31961
|
-
* @param position
|
|
32403
|
+
* @param position The world-space position at which to compute the assembly's linear velocity.
|
|
32404
|
+
* @returns A `Vector3` representing the linear velocity of the assembly at the specified world-space position.
|
|
31962
32405
|
*/
|
|
31963
32406
|
GetVelocityAtPosition(this: BasePart, position: Vector3): Vector3;
|
|
31964
32407
|
/**
|
|
@@ -32029,12 +32472,7 @@ interface BasePart extends PVInstance {
|
|
|
32029
32472
|
*/
|
|
32030
32473
|
TorqueToAngularAcceleration(this: BasePart, torque: Vector3, angVelocity?: Vector3): Vector3;
|
|
32031
32474
|
/**
|
|
32032
|
-
*
|
|
32033
|
-
* - The input parts do not need to be parented to the scene, allowing for background operations.
|
|
32034
|
-
* - When the `SplitApart` option is set to `true` (default), each distinct body will be returned in its own `PartOperation`.
|
|
32035
|
-
* - All the returned parts are in the coordinate space of the main part, so their `PVInstance.Origin` positions are the same as the main part's. This keeps the vertices of the mesh in the same position relative to the object as before the operation, but it does also mean the `(0, 0, 0)` of a returned part is not necessarily at the center of its body.
|
|
32036
|
-
*
|
|
32037
|
-
* Creates a new `IntersectOperation` from the overlapping geometry of the part and the other parts in the given array.
|
|
32475
|
+
* Creates a new `IntersectOperation` from the overlapping geometry of the part and the other parts in the given array.
|
|
32038
32476
|
*
|
|
32039
32477
|
* - **ThreadSafety**: Unsafe
|
|
32040
32478
|
* - **Tags**: Yields
|
|
@@ -32048,12 +32486,7 @@ interface BasePart extends PVInstance {
|
|
|
32048
32486
|
*/
|
|
32049
32487
|
IntersectAsync(this: BasePart, parts: Array<Instance>, collisionfidelity?: CastsToEnum<Enum.CollisionFidelity>, renderFidelity?: CastsToEnum<Enum.RenderFidelity>): Instance | undefined;
|
|
32050
32488
|
/**
|
|
32051
|
-
*
|
|
32052
|
-
* - The input parts do not need to be parented to the scene, allowing for background operations.
|
|
32053
|
-
* - When the `SplitApart` option is set to `true` (default), each distinct body will be returned in its own `PartOperation`.
|
|
32054
|
-
* - All the returned parts are in the coordinate space of the main part, so their `PVInstance.Origin` positions are the same as the main part's. This keeps the vertices of the mesh in the same position relative to the object as before the operation, but it does also mean the `(0, 0, 0)` of a returned part is not necessarily at the center of its body.
|
|
32055
|
-
*
|
|
32056
|
-
* Creates a new `UnionOperation` from the part, minus the geometry occupied by the parts in the given array.
|
|
32489
|
+
* Creates a new `UnionOperation` from the part, minus the geometry occupied by the parts in the given array.
|
|
32057
32490
|
*
|
|
32058
32491
|
* - **ThreadSafety**: Unsafe
|
|
32059
32492
|
* - **Tags**: Yields
|
|
@@ -32067,15 +32500,7 @@ interface BasePart extends PVInstance {
|
|
|
32067
32500
|
*/
|
|
32068
32501
|
SubtractAsync(this: BasePart, parts: Array<BasePart>, collisionfidelity?: CastsToEnum<Enum.CollisionFidelity>): UnionOperation | undefined;
|
|
32069
32502
|
/**
|
|
32070
|
-
*
|
|
32071
|
-
* - The input parts do not need to be parented to the scene, allowing for background operations.
|
|
32072
|
-
* - When the `SplitApart` option is set to `true` (default), each distinct body will be returned in its own `PartOperation`.
|
|
32073
|
-
* - All the returned parts are in the coordinate space of the main part, so their `PVInstance.Origin` positions are the same as the main part's. This keeps the vertices of the mesh in the same position relative to the object as before the operation, but it does also mean the `(0, 0, 0)` of a returned part is not necessarily at the center of its body.
|
|
32074
|
-
* ```
|
|
32075
|
-
* Creates a new `UnionOperation` from the part, plus the geometry
|
|
32076
|
-
* ```
|
|
32077
|
-
*
|
|
32078
|
-
* occupied by the parts in the given array.
|
|
32503
|
+
* Creates a new `UnionOperation` from the part, plus the geometry occupied by the parts in the given array.
|
|
32079
32504
|
*
|
|
32080
32505
|
* - **ThreadSafety**: Unsafe
|
|
32081
32506
|
* - **Tags**: Yields
|
|
@@ -32091,6 +32516,8 @@ interface BasePart extends PVInstance {
|
|
|
32091
32516
|
/**
|
|
32092
32517
|
* **Deprecated:** This event is deprecated in favor of `BasePart.Touched`.
|
|
32093
32518
|
*
|
|
32519
|
+
* Fires on the local client when another part comes in contact with this part.
|
|
32520
|
+
*
|
|
32094
32521
|
* - **ThreadSafety**: Unsafe
|
|
32095
32522
|
* - **Tags**:
|
|
32096
32523
|
*
|
|
@@ -32102,6 +32529,8 @@ interface BasePart extends PVInstance {
|
|
|
32102
32529
|
/**
|
|
32103
32530
|
* **Deprecated:** This event is deprecated. Do not use it for new work.
|
|
32104
32531
|
*
|
|
32532
|
+
* Fires when the part's appearance changes due to a `Shirt`.
|
|
32533
|
+
*
|
|
32105
32534
|
* - **ThreadSafety**: Unsafe
|
|
32106
32535
|
* - **Tags**:
|
|
32107
32536
|
*
|
|
@@ -32113,6 +32542,8 @@ interface BasePart extends PVInstance {
|
|
|
32113
32542
|
/**
|
|
32114
32543
|
* **Deprecated:** This event is deprecated in favor of `BasePart.TouchEnded`, which should be used instead.
|
|
32115
32544
|
*
|
|
32545
|
+
* Fires on the local client when a part stops touching another part.
|
|
32546
|
+
*
|
|
32116
32547
|
* - **ThreadSafety**: Unsafe
|
|
32117
32548
|
* - **Tags**:
|
|
32118
32549
|
*
|
|
@@ -32272,7 +32703,7 @@ interface Seat extends Part {
|
|
|
32272
32703
|
*
|
|
32273
32704
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Seat#Sit)
|
|
32274
32705
|
* @param this A type of `BasePart` that characters can 'sit' in. When a character touches an enabled Seat object, it will be attached to the part by a `Weld` and the default character scripts will play a sitting animation.
|
|
32275
|
-
* @param humanoid
|
|
32706
|
+
* @param humanoid The `Humanoid` being forced to sit in the `Seat`.
|
|
32276
32707
|
*/
|
|
32277
32708
|
Sit(this: Seat, humanoid: Humanoid | undefined): void;
|
|
32278
32709
|
/**
|
|
@@ -32561,9 +32992,10 @@ interface Terrain extends BasePart {
|
|
|
32561
32992
|
*
|
|
32562
32993
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Terrain#AutowedgeCell)
|
|
32563
32994
|
* @param this `Terrain` lets you to create dynamically morphable environments.
|
|
32564
|
-
* @param x
|
|
32565
|
-
* @param y
|
|
32566
|
-
* @param z
|
|
32995
|
+
* @param x The X coordinate of the terrain cell.
|
|
32996
|
+
* @param y The Y coordinate of the terrain cell.
|
|
32997
|
+
* @param z The Z coordinate of the terrain cell.
|
|
32998
|
+
* @returns Always returns `true`; the function no longer performs any operation.
|
|
32567
32999
|
*
|
|
32568
33000
|
* @deprecated
|
|
32569
33001
|
*/
|
|
@@ -32578,7 +33010,7 @@ interface Terrain extends BasePart {
|
|
|
32578
33010
|
*
|
|
32579
33011
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Terrain#AutowedgeCells)
|
|
32580
33012
|
* @param this `Terrain` lets you to create dynamically morphable environments.
|
|
32581
|
-
* @param region
|
|
33013
|
+
* @param region The `Region3int16` specifying the region of terrain cells to process.
|
|
32582
33014
|
*
|
|
32583
33015
|
* @deprecated
|
|
32584
33016
|
*/
|
|
@@ -32590,9 +33022,10 @@ interface Terrain extends BasePart {
|
|
|
32590
33022
|
*
|
|
32591
33023
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Terrain#CellCenterToWorld)
|
|
32592
33024
|
* @param this `Terrain` lets you to create dynamically morphable environments.
|
|
32593
|
-
* @param x
|
|
32594
|
-
* @param y
|
|
32595
|
-
* @param z
|
|
33025
|
+
* @param x The X coordinate of the terrain cell in grid space.
|
|
33026
|
+
* @param y The Y coordinate of the terrain cell in grid space.
|
|
33027
|
+
* @param z The Z coordinate of the terrain cell in grid space.
|
|
33028
|
+
* @returns The world-space `Vector3` position at the center of the specified cell.
|
|
32596
33029
|
*/
|
|
32597
33030
|
CellCenterToWorld(this: Terrain, x: number, y: number, z: number): Vector3;
|
|
32598
33031
|
/**
|
|
@@ -32602,9 +33035,10 @@ interface Terrain extends BasePart {
|
|
|
32602
33035
|
*
|
|
32603
33036
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Terrain#CellCornerToWorld)
|
|
32604
33037
|
* @param this `Terrain` lets you to create dynamically morphable environments.
|
|
32605
|
-
* @param x
|
|
32606
|
-
* @param y
|
|
32607
|
-
* @param z
|
|
33038
|
+
* @param x The X coordinate of the terrain cell in grid space.
|
|
33039
|
+
* @param y The Y coordinate of the terrain cell in grid space.
|
|
33040
|
+
* @param z The Z coordinate of the terrain cell in grid space.
|
|
33041
|
+
* @returns The world-space `Vector3` position of the lower-left-forward corner of the specified cell.
|
|
32608
33042
|
*/
|
|
32609
33043
|
CellCornerToWorld(this: Terrain, x: number, y: number, z: number): Vector3;
|
|
32610
33044
|
/**
|
|
@@ -32630,7 +33064,8 @@ interface Terrain extends BasePart {
|
|
|
32630
33064
|
*
|
|
32631
33065
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Terrain#CopyRegion)
|
|
32632
33066
|
* @param this `Terrain` lets you to create dynamically morphable environments.
|
|
32633
|
-
* @param region
|
|
33067
|
+
* @param region The `Region3int16` defining the area of terrain to copy, in cell coordinates.
|
|
33068
|
+
* @returns A `TerrainRegion` containing the copied voxel data from the specified region.
|
|
32634
33069
|
*/
|
|
32635
33070
|
CopyRegion(this: Terrain, region: Region3int16): TerrainRegion;
|
|
32636
33071
|
/**
|
|
@@ -32640,6 +33075,7 @@ interface Terrain extends BasePart {
|
|
|
32640
33075
|
*
|
|
32641
33076
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Terrain#CountCells)
|
|
32642
33077
|
* @param this `Terrain` lets you to create dynamically morphable environments.
|
|
33078
|
+
* @returns The approximate number of non-empty terrain cells.
|
|
32643
33079
|
*/
|
|
32644
33080
|
CountCells(this: Terrain): number;
|
|
32645
33081
|
/**
|
|
@@ -32686,9 +33122,9 @@ interface Terrain extends BasePart {
|
|
|
32686
33122
|
*
|
|
32687
33123
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Terrain#FillRegion)
|
|
32688
33124
|
* @param this `Terrain` lets you to create dynamically morphable environments.
|
|
32689
|
-
* @param region
|
|
32690
|
-
* @param resolution
|
|
32691
|
-
* @param material
|
|
33125
|
+
* @param region The `Region3` to fill, which must be aligned to the voxel grid.
|
|
33126
|
+
* @param resolution The voxel resolution; must be exactly `4`.
|
|
33127
|
+
* @param material The `Material` to fill the region with.
|
|
32692
33128
|
*/
|
|
32693
33129
|
FillRegion(this: Terrain, region: Region3, resolution: number, material: CastsToEnum<Enum.Material>): void;
|
|
32694
33130
|
/**
|
|
@@ -32713,9 +33149,10 @@ interface Terrain extends BasePart {
|
|
|
32713
33149
|
*
|
|
32714
33150
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Terrain#GetCell)
|
|
32715
33151
|
* @param this `Terrain` lets you to create dynamically morphable environments.
|
|
32716
|
-
* @param x
|
|
32717
|
-
* @param y
|
|
32718
|
-
* @param z
|
|
33152
|
+
* @param x The X coordinate of the terrain cell.
|
|
33153
|
+
* @param y The Y coordinate of the terrain cell.
|
|
33154
|
+
* @param z The Z coordinate of the terrain cell.
|
|
33155
|
+
* @returns A tuple containing the legacy cell material, block type, and orientation of the specified cell.
|
|
32719
33156
|
*
|
|
32720
33157
|
* @deprecated
|
|
32721
33158
|
*/
|
|
@@ -32727,7 +33164,8 @@ interface Terrain extends BasePart {
|
|
|
32727
33164
|
*
|
|
32728
33165
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Terrain#GetMaterialColor)
|
|
32729
33166
|
* @param this `Terrain` lets you to create dynamically morphable environments.
|
|
32730
|
-
* @param material
|
|
33167
|
+
* @param material The `Material` whose terrain color to retrieve.
|
|
33168
|
+
* @returns The `Color3` representing the current color tint of the specified material.
|
|
32731
33169
|
*/
|
|
32732
33170
|
GetMaterialColor(this: Terrain, material: CastsToEnum<Enum.Material>): Color3;
|
|
32733
33171
|
/**
|
|
@@ -32746,9 +33184,10 @@ interface Terrain extends BasePart {
|
|
|
32746
33184
|
*
|
|
32747
33185
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Terrain#GetWaterCell)
|
|
32748
33186
|
* @param this `Terrain` lets you to create dynamically morphable environments.
|
|
32749
|
-
* @param x
|
|
32750
|
-
* @param y
|
|
32751
|
-
* @param z
|
|
33187
|
+
* @param x The X coordinate of the terrain cell.
|
|
33188
|
+
* @param y The Y coordinate of the terrain cell.
|
|
33189
|
+
* @param z The Z coordinate of the terrain cell.
|
|
33190
|
+
* @returns A tuple containing whether the cell has water, the water force, and the water direction.
|
|
32752
33191
|
*
|
|
32753
33192
|
* @deprecated
|
|
32754
33193
|
*/
|
|
@@ -32774,9 +33213,9 @@ interface Terrain extends BasePart {
|
|
|
32774
33213
|
*
|
|
32775
33214
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Terrain#PasteRegion)
|
|
32776
33215
|
* @param this `Terrain` lets you to create dynamically morphable environments.
|
|
32777
|
-
* @param region
|
|
32778
|
-
* @param corner
|
|
32779
|
-
* @param pasteEmptyCells
|
|
33216
|
+
* @param region The `TerrainRegion` to paste, previously obtained from `Terrain:CopyRegion()`.
|
|
33217
|
+
* @param corner The `Vector3int16` cell coordinate at which to place the lower-left-forward corner of the region.
|
|
33218
|
+
* @param pasteEmptyCells Whether to overwrite existing terrain with empty (air) cells from the region.
|
|
32780
33219
|
*/
|
|
32781
33220
|
PasteRegion(this: Terrain, region: TerrainRegion, corner: Vector3int16, pasteEmptyCells: boolean): void;
|
|
32782
33221
|
/**
|
|
@@ -32850,12 +33289,12 @@ interface Terrain extends BasePart {
|
|
|
32850
33289
|
*
|
|
32851
33290
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Terrain#SetCell)
|
|
32852
33291
|
* @param this `Terrain` lets you to create dynamically morphable environments.
|
|
32853
|
-
* @param x
|
|
32854
|
-
* @param y
|
|
32855
|
-
* @param z
|
|
32856
|
-
* @param material
|
|
32857
|
-
* @param block
|
|
32858
|
-
* @param orientation
|
|
33292
|
+
* @param x The X coordinate of the terrain cell.
|
|
33293
|
+
* @param y The Y coordinate of the terrain cell.
|
|
33294
|
+
* @param z The Z coordinate of the terrain cell.
|
|
33295
|
+
* @param material The `CellMaterial` to set for the cell.
|
|
33296
|
+
* @param block The `CellBlock` shape type for the cell.
|
|
33297
|
+
* @param orientation The `CellOrientation` rotation for the cell.
|
|
32859
33298
|
*
|
|
32860
33299
|
* @deprecated
|
|
32861
33300
|
*/
|
|
@@ -32870,10 +33309,10 @@ interface Terrain extends BasePart {
|
|
|
32870
33309
|
*
|
|
32871
33310
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Terrain#SetCells)
|
|
32872
33311
|
* @param this `Terrain` lets you to create dynamically morphable environments.
|
|
32873
|
-
* @param region
|
|
32874
|
-
* @param material
|
|
32875
|
-
* @param block
|
|
32876
|
-
* @param orientation
|
|
33312
|
+
* @param region The `Region3int16` specifying the area of terrain cells to set.
|
|
33313
|
+
* @param material The `CellMaterial` to apply to all cells in the region.
|
|
33314
|
+
* @param block The `CellBlock` shape type to apply to all cells in the region.
|
|
33315
|
+
* @param orientation The `CellOrientation` rotation to apply to all cells in the region.
|
|
32877
33316
|
*
|
|
32878
33317
|
* @deprecated
|
|
32879
33318
|
*/
|
|
@@ -32885,8 +33324,8 @@ interface Terrain extends BasePart {
|
|
|
32885
33324
|
*
|
|
32886
33325
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Terrain#SetMaterialColor)
|
|
32887
33326
|
* @param this `Terrain` lets you to create dynamically morphable environments.
|
|
32888
|
-
* @param material
|
|
32889
|
-
* @param value
|
|
33327
|
+
* @param material The `Material` whose terrain color to change.
|
|
33328
|
+
* @param value The `Color3` to apply as the new color tint for the material.
|
|
32890
33329
|
*/
|
|
32891
33330
|
SetMaterialColor(this: Terrain, material: CastsToEnum<Enum.Material>, value: Color3): void;
|
|
32892
33331
|
/**
|
|
@@ -32905,11 +33344,11 @@ interface Terrain extends BasePart {
|
|
|
32905
33344
|
*
|
|
32906
33345
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Terrain#SetWaterCell)
|
|
32907
33346
|
* @param this `Terrain` lets you to create dynamically morphable environments.
|
|
32908
|
-
* @param x
|
|
32909
|
-
* @param y
|
|
32910
|
-
* @param z
|
|
32911
|
-
* @param force
|
|
32912
|
-
* @param direction
|
|
33347
|
+
* @param x The X coordinate of the terrain cell.
|
|
33348
|
+
* @param y The Y coordinate of the terrain cell.
|
|
33349
|
+
* @param z The Z coordinate of the terrain cell.
|
|
33350
|
+
* @param force The `WaterForce` value representing the water force in the cell.
|
|
33351
|
+
* @param direction The `WaterDirection` value representing the water flow direction.
|
|
32913
33352
|
*
|
|
32914
33353
|
* @deprecated
|
|
32915
33354
|
*/
|
|
@@ -32921,7 +33360,8 @@ interface Terrain extends BasePart {
|
|
|
32921
33360
|
*
|
|
32922
33361
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Terrain#WorldToCell)
|
|
32923
33362
|
* @param this `Terrain` lets you to create dynamically morphable environments.
|
|
32924
|
-
* @param position
|
|
33363
|
+
* @param position The world-space `Vector3` to convert to a cell coordinate.
|
|
33364
|
+
* @returns A `Vector3` representing the grid cell coordinates containing the given position.
|
|
32925
33365
|
*/
|
|
32926
33366
|
WorldToCell(this: Terrain, position: Vector3): Vector3;
|
|
32927
33367
|
/**
|
|
@@ -32931,7 +33371,8 @@ interface Terrain extends BasePart {
|
|
|
32931
33371
|
*
|
|
32932
33372
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Terrain#WorldToCellPreferEmpty)
|
|
32933
33373
|
* @param this `Terrain` lets you to create dynamically morphable environments.
|
|
32934
|
-
* @param position
|
|
33374
|
+
* @param position The world-space `Vector3` to convert to a cell coordinate.
|
|
33375
|
+
* @returns A `Vector3` representing the grid cell coordinates, biased toward an empty (air) neighbor when the position lies on a cell boundary.
|
|
32935
33376
|
*/
|
|
32936
33377
|
WorldToCellPreferEmpty(this: Terrain, position: Vector3): Vector3;
|
|
32937
33378
|
/**
|
|
@@ -32941,7 +33382,8 @@ interface Terrain extends BasePart {
|
|
|
32941
33382
|
*
|
|
32942
33383
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Terrain#WorldToCellPreferSolid)
|
|
32943
33384
|
* @param this `Terrain` lets you to create dynamically morphable environments.
|
|
32944
|
-
* @param position
|
|
33385
|
+
* @param position The world-space `Vector3` to convert to a cell coordinate.
|
|
33386
|
+
* @returns A `Vector3` representing the grid cell coordinates, biased toward a non-empty (solid) neighbor when the position lies on a cell boundary.
|
|
32945
33387
|
*/
|
|
32946
33388
|
WorldToCellPreferSolid(this: Terrain, position: Vector3): Vector3;
|
|
32947
33389
|
/**
|
|
@@ -33016,6 +33458,8 @@ interface TriangleMeshPart extends BasePart {
|
|
|
33016
33458
|
*/
|
|
33017
33459
|
get FluidFidelity(): Enum.FluidFidelity;
|
|
33018
33460
|
/**
|
|
33461
|
+
* The original size of the part's source mesh geometry, before any scaling applied through `BasePart.Size`.
|
|
33462
|
+
*
|
|
33019
33463
|
* - **ThreadSafety**: ReadSafe
|
|
33020
33464
|
* - **Tags**: NotReplicated
|
|
33021
33465
|
*
|
|
@@ -33046,7 +33490,9 @@ interface MeshPart extends TriangleMeshPart {
|
|
|
33046
33490
|
*/
|
|
33047
33491
|
DoubleSided: boolean;
|
|
33048
33492
|
/**
|
|
33049
|
-
* **Deprecated:**
|
|
33493
|
+
* **Deprecated:** This property is deprecated and should not be used in new work.
|
|
33494
|
+
*
|
|
33495
|
+
* Deprecated legacy flag associated with the part's `JointOffset`.
|
|
33050
33496
|
*
|
|
33051
33497
|
* - **ThreadSafety**: ReadSafe
|
|
33052
33498
|
* - **Tags**: Hidden
|
|
@@ -33057,6 +33503,8 @@ interface MeshPart extends TriangleMeshPart {
|
|
|
33057
33503
|
*/
|
|
33058
33504
|
get HasJointOffset(): boolean;
|
|
33059
33505
|
/**
|
|
33506
|
+
* Indicates whether the mesh currently applied to the `MeshPart` contains skinning (bone and joint) data.
|
|
33507
|
+
*
|
|
33060
33508
|
* - **ThreadSafety**: ReadSafe
|
|
33061
33509
|
* - **Tags**: Hidden
|
|
33062
33510
|
*
|
|
@@ -33064,7 +33512,9 @@ interface MeshPart extends TriangleMeshPart {
|
|
|
33064
33512
|
*/
|
|
33065
33513
|
get HasSkinnedMesh(): boolean;
|
|
33066
33514
|
/**
|
|
33067
|
-
* **Deprecated:**
|
|
33515
|
+
* **Deprecated:** This property is deprecated and should not be used in new work.
|
|
33516
|
+
*
|
|
33517
|
+
* Deprecated. An offset once used to position a skinned mesh's joints.
|
|
33068
33518
|
*
|
|
33069
33519
|
* - **ThreadSafety**: ReadSafe
|
|
33070
33520
|
* - **Tags**: Hidden
|
|
@@ -33122,7 +33572,7 @@ interface MeshPart extends TriangleMeshPart {
|
|
|
33122
33572
|
*
|
|
33123
33573
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MeshPart#ApplyMesh)
|
|
33124
33574
|
* @param this A form of `BasePart` that includes a physically simulated custom mesh.
|
|
33125
|
-
* @param meshPart
|
|
33575
|
+
* @param meshPart The source `MeshPart` whose `MeshContent`, `TextureContent`, and collision geometry (along with `RenderFidelity`, `CollisionFidelity`, `FluidFidelity`, and `MeshSize`) are copied onto this part. The object must be a `MeshPart`, otherwise the call throws an error.
|
|
33126
33576
|
*/
|
|
33127
33577
|
ApplyMesh(this: MeshPart, meshPart: Instance): void;
|
|
33128
33578
|
}
|
|
@@ -34026,7 +34476,7 @@ interface Actor extends Model {
|
|
|
34026
34476
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Actor#BindToMessage)
|
|
34027
34477
|
* @param this An `Actor` is a container for code that can be safely split into its own thread.
|
|
34028
34478
|
* @param topic The topic used to identify the type of message.
|
|
34029
|
-
* @param function
|
|
34479
|
+
* @param function The Luau callback to invoke when a message with the specified topic is received. The callback receives the message contents as its arguments.
|
|
34030
34480
|
* @returns This connection object may be used to disconnect the Luau callback from receiving messages.
|
|
34031
34481
|
*/
|
|
34032
34482
|
BindToMessage(this: Actor, topic: string, callback: Callback): RBXScriptConnection;
|
|
@@ -34038,7 +34488,7 @@ interface Actor extends Model {
|
|
|
34038
34488
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Actor#BindToMessageParallel)
|
|
34039
34489
|
* @param this An `Actor` is a container for code that can be safely split into its own thread.
|
|
34040
34490
|
* @param topic The topic used to identify the type of message.
|
|
34041
|
-
* @param function
|
|
34491
|
+
* @param function The Luau callback to invoke when a message with the specified topic is received. The callback receives the message contents as its arguments.
|
|
34042
34492
|
* @returns This connection object may be used to disconnect the Luau callback from receiving messages.
|
|
34043
34493
|
*/
|
|
34044
34494
|
BindToMessageParallel(this: Actor, topic: string, callback: Callback): RBXScriptConnection;
|
|
@@ -34332,7 +34782,7 @@ interface WorldRoot extends Model {
|
|
|
34332
34782
|
* @param cframe The initial position and rotation of the cast block shape.
|
|
34333
34783
|
* @param size The size of the cast block shape in studs. The maximum size is 512 studs.
|
|
34334
34784
|
* @param direction Direction of the shapecast, with the magnitude representing the maximum distance the shape can travel. The maximum distance is 1024 studs.
|
|
34335
|
-
* @param params
|
|
34785
|
+
* @param params An object used to specify hit eligibility in the shapecast operation. If not provided, default values are used where all parts are considered and `Terrain` water is not ignored.
|
|
34336
34786
|
* @returns Contains the result of the shapecast operation, or `nil` if no eligible `BasePart` or `Terrain` cell was hit.
|
|
34337
34787
|
*/
|
|
34338
34788
|
Blockcast(this: WorldRoot, cframe: CFrame, size: Vector3, direction: Vector3, raycastParams?: RaycastParams): RaycastResult | undefined;
|
|
@@ -34343,9 +34793,9 @@ interface WorldRoot extends Model {
|
|
|
34343
34793
|
*
|
|
34344
34794
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/WorldRoot#BulkMoveTo)
|
|
34345
34795
|
* @param this Base class for handling physics simulation and 3D spatial queries.
|
|
34346
|
-
* @param partList
|
|
34347
|
-
* @param cframeList
|
|
34348
|
-
* @param eventMode
|
|
34796
|
+
* @param partList A table of `BaseParts` to be moved.
|
|
34797
|
+
* @param cframeList A table of `CFrames` that the parts will be moved to, matched by index to `partList`.
|
|
34798
|
+
* @param eventMode An `BulkMoveMode` enum specifying which `Changed` events fire during the move. Default is `FireAllEvents`.
|
|
34349
34799
|
*/
|
|
34350
34800
|
BulkMoveTo(this: WorldRoot, partList: Array<Instance>, cframeList: Array<unknown>, eventMode?: CastsToEnum<Enum.BulkMoveMode>): void;
|
|
34351
34801
|
/**
|
|
@@ -34370,10 +34820,10 @@ interface WorldRoot extends Model {
|
|
|
34370
34820
|
*
|
|
34371
34821
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/WorldRoot#FindPartOnRay)
|
|
34372
34822
|
* @param this Base class for handling physics simulation and 3D spatial queries.
|
|
34373
|
-
* @param ray
|
|
34374
|
-
* @param ignoreDescendantsInstance
|
|
34375
|
-
* @param terrainCellsAreCubes
|
|
34376
|
-
* @param ignoreWater
|
|
34823
|
+
* @param ray A `Ray` whose origin and direction define the raycast.
|
|
34824
|
+
* @param ignoreDescendantsInstance An `Instance` whose descendants are ignored in the raycast.
|
|
34825
|
+
* @param terrainCellsAreCubes Whether `Terrain` cells are treated as full cubes when calculating intersection. Default is false.
|
|
34826
|
+
* @param ignoreWater Whether `Terrain` water cells are ignored by the ray. Default is false.
|
|
34377
34827
|
* @returns The `BasePart` or `Terrain` cell hit, the `Vector3` point of intersection, the `Vector3` surface normal at the point of intersection, and the `Material` of the `BasePart` or terrain cell hit.
|
|
34378
34828
|
*
|
|
34379
34829
|
* @deprecated Raycast
|
|
@@ -34394,10 +34844,10 @@ interface WorldRoot extends Model {
|
|
|
34394
34844
|
*
|
|
34395
34845
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/WorldRoot#FindPartOnRayWithIgnoreList)
|
|
34396
34846
|
* @param this Base class for handling physics simulation and 3D spatial queries.
|
|
34397
|
-
* @param ray
|
|
34398
|
-
* @param ignoreDescendantsTable
|
|
34399
|
-
* @param terrainCellsAreCubes
|
|
34400
|
-
* @param ignoreWater
|
|
34847
|
+
* @param ray A `Ray` whose origin and direction define the raycast.
|
|
34848
|
+
* @param ignoreDescendantsTable An array of objects whose descendants are excluded from the raycast.
|
|
34849
|
+
* @param terrainCellsAreCubes Whether `Terrain` cells are treated as full cubes when calculating intersection. Default is false.
|
|
34850
|
+
* @param ignoreWater Whether `Terrain` water cells are ignored by the ray. Default is false.
|
|
34401
34851
|
* @returns The `BasePart` or `Terrain` cell hit, the `Vector3` point of intersection, the `Vector3` surface normal at the point of intersection, and the `Material` of the `BasePart` or terrain cell hit.
|
|
34402
34852
|
*
|
|
34403
34853
|
* @deprecated Raycast
|
|
@@ -34418,9 +34868,9 @@ interface WorldRoot extends Model {
|
|
|
34418
34868
|
*
|
|
34419
34869
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/WorldRoot#FindPartOnRayWithWhitelist)
|
|
34420
34870
|
* @param this Base class for handling physics simulation and 3D spatial queries.
|
|
34421
|
-
* @param ray
|
|
34422
|
-
* @param whitelistDescendantsTable
|
|
34423
|
-
* @param ignoreWater
|
|
34871
|
+
* @param ray A `Ray` whose origin and direction define the raycast.
|
|
34872
|
+
* @param whitelistDescendantsTable An array of objects whose descendants are the only candidates considered in the raycast.
|
|
34873
|
+
* @param ignoreWater Whether `Terrain` water cells are ignored by the ray. Default is false.
|
|
34424
34874
|
* @returns The `BasePart` or `Terrain` cell hit, the `Vector3` point of intersection, the `Vector3` surface normal at the point of intersection, and the `Material` of the `BasePart` or terrain cell hit.
|
|
34425
34875
|
*
|
|
34426
34876
|
* @deprecated Raycast
|
|
@@ -34604,13 +35054,16 @@ interface WorldRoot extends Model {
|
|
|
34604
35054
|
*/
|
|
34605
35055
|
RenameCollisionGroup(this: WorldRoot, from: string, to: string): void;
|
|
34606
35056
|
/**
|
|
35057
|
+
* Casts the shape of a given `BasePart` in a direction and returns a `RaycastResult` if the shape hits a `BasePart` or `Terrain` cell.
|
|
35058
|
+
*
|
|
34607
35059
|
* - **ThreadSafety**: Unsafe
|
|
34608
35060
|
*
|
|
34609
35061
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/WorldRoot#Shapecast)
|
|
34610
35062
|
* @param this Base class for handling physics simulation and 3D spatial queries.
|
|
34611
|
-
* @param part
|
|
34612
|
-
* @param direction
|
|
34613
|
-
* @param params
|
|
35063
|
+
* @param part The part whose shape is cast. The cast uses this part's geometry (block, ball, mesh, and so on) and size; excessively large parts may not be supported, and it cannot be a `Terrain` part.
|
|
35064
|
+
* @param direction Direction of the shapecast, with the magnitude representing the maximum distance the shape can travel. The maximum distance is 1024 studs.
|
|
35065
|
+
* @param params An object used to specify hit eligibility in the shapecast operation. If not provided, default values are used where all other parts are considered and `Terrain` water is not ignored. The part being cast is always excluded from the results.
|
|
35066
|
+
* @returns Contains the result of the shapecast operation, or `nil` if no eligible `BasePart` or `Terrain` cell was hit.
|
|
34614
35067
|
*/
|
|
34615
35068
|
Shapecast(this: WorldRoot, part: BasePart, direction: Vector3, params?: RaycastParams): RaycastResult | undefined;
|
|
34616
35069
|
/**
|
|
@@ -34623,7 +35076,7 @@ interface WorldRoot extends Model {
|
|
|
34623
35076
|
* @param position The initial position of the cast spherical shape.
|
|
34624
35077
|
* @param radius The radius of the cast spherical shape in studs. The maximum radius is 256 studs.
|
|
34625
35078
|
* @param direction Direction of the shapecast, with the magnitude representing the maximum distance the shape can travel. The maximum distance is 1024 studs.
|
|
34626
|
-
* @param params
|
|
35079
|
+
* @param params An object used to specify hit eligibility in the shapecast operation. If not provided, default values are used where all parts are considered and `Terrain` water is not ignored.
|
|
34627
35080
|
* @returns Contains the result of the shapecast operation, or `nil` if no eligible `BasePart` or `Terrain` cell was hit.
|
|
34628
35081
|
*/
|
|
34629
35082
|
Spherecast(this: WorldRoot, position: Vector3, radius: number, direction: Vector3, raycastParams?: RaycastParams): RaycastResult | undefined;
|
|
@@ -34896,12 +35349,16 @@ interface PackageLink extends Instance {
|
|
|
34896
35349
|
*/
|
|
34897
35350
|
readonly _nominal_PackageLink: unique symbol;
|
|
34898
35351
|
/**
|
|
35352
|
+
* Engine-managed name of the package's root instance as it was last published, kept as a baseline for detecting local name changes.
|
|
35353
|
+
*
|
|
34899
35354
|
* - **ThreadSafety**: ReadSafe
|
|
34900
35355
|
*
|
|
34901
35356
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PackageLink#DefaultName)
|
|
34902
35357
|
*/
|
|
34903
35358
|
get DefaultName(): string;
|
|
34904
35359
|
/**
|
|
35360
|
+
* Read-only `Content` URL for the model asset backing this package.
|
|
35361
|
+
*
|
|
34905
35362
|
* - **ThreadSafety**: ReadSafe
|
|
34906
35363
|
* - **Tags**: NotReplicated
|
|
34907
35364
|
*
|
|
@@ -34989,6 +35446,7 @@ interface Pages<T = unknown> extends Instance {
|
|
|
34989
35446
|
*
|
|
34990
35447
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Pages#GetCurrentPage)
|
|
34991
35448
|
* @param this An abstract class for pages objects.
|
|
35449
|
+
* @returns An array of entries on the current page, where the keys in each entry are determined by the service that originally provided this Pages object.
|
|
34992
35450
|
*/
|
|
34993
35451
|
GetCurrentPage(this: Pages): Array<T>;
|
|
34994
35452
|
/**
|
|
@@ -35054,6 +35512,8 @@ interface CapturesPages extends Pages {
|
|
|
35054
35512
|
readonly _nominal_CapturesPages: unique symbol;
|
|
35055
35513
|
}
|
|
35056
35514
|
/**
|
|
35515
|
+
* A special version of `Pages` that stores the results of an Avatar Editor catalog search.
|
|
35516
|
+
*
|
|
35057
35517
|
* - **Tags**: NotCreatable, NotReplicated
|
|
35058
35518
|
*
|
|
35059
35519
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CatalogPages)
|
|
@@ -35085,6 +35545,8 @@ interface DataStoreKeyPages extends Pages {
|
|
|
35085
35545
|
*/
|
|
35086
35546
|
readonly _nominal_DataStoreKeyPages: unique symbol;
|
|
35087
35547
|
/**
|
|
35548
|
+
* Marks the position from which the next page of keys is retrieved.
|
|
35549
|
+
*
|
|
35088
35550
|
* - **ThreadSafety**: ReadSafe
|
|
35089
35551
|
* - **Tags**: NotReplicated
|
|
35090
35552
|
*
|
|
@@ -35109,6 +35571,8 @@ interface DataStoreListingPages extends Pages {
|
|
|
35109
35571
|
*/
|
|
35110
35572
|
readonly _nominal_DataStoreListingPages: unique symbol;
|
|
35111
35573
|
/**
|
|
35574
|
+
* Marks the position from which the next page of data stores is retrieved.
|
|
35575
|
+
*
|
|
35112
35576
|
* - **ThreadSafety**: ReadSafe
|
|
35113
35577
|
* - **Tags**: NotReplicated
|
|
35114
35578
|
*
|
|
@@ -35177,6 +35641,8 @@ interface FriendPages extends Pages<{
|
|
|
35177
35641
|
readonly _nominal_FriendPages: unique symbol;
|
|
35178
35642
|
}
|
|
35179
35643
|
/**
|
|
35644
|
+
* A special version of `Pages` that contains information about a specific category of a user's inventory.
|
|
35645
|
+
*
|
|
35180
35646
|
* - **Tags**: NotCreatable, NotReplicated
|
|
35181
35647
|
*
|
|
35182
35648
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InventoryPages)
|
|
@@ -35247,6 +35713,8 @@ interface RecommendationPages extends Pages {
|
|
|
35247
35713
|
readonly _nominal_RecommendationPages: unique symbol;
|
|
35248
35714
|
}
|
|
35249
35715
|
/**
|
|
35716
|
+
* A generic Pages object that can contain variable data depending on the method that returned it.
|
|
35717
|
+
*
|
|
35250
35718
|
* - **Tags**: NotCreatable, NotReplicated
|
|
35251
35719
|
*
|
|
35252
35720
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StandardPages)
|
|
@@ -36016,6 +36484,8 @@ interface PerformanceControlService extends Instance {
|
|
|
36016
36484
|
readonly _nominal_PerformanceControlService: unique symbol;
|
|
36017
36485
|
}
|
|
36018
36486
|
/**
|
|
36487
|
+
* Service that provides methods for creating and managing collision groups, which control whether sets of `BaseParts` collide with each other.
|
|
36488
|
+
*
|
|
36019
36489
|
* - **Tags**: NotCreatable, Service
|
|
36020
36490
|
*
|
|
36021
36491
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PhysicsService)
|
|
@@ -36038,9 +36508,10 @@ interface PhysicsService extends Instance {
|
|
|
36038
36508
|
* - **Tags**:
|
|
36039
36509
|
*
|
|
36040
36510
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PhysicsService#CollisionGroupContainsPart)
|
|
36041
|
-
* @param this
|
|
36042
|
-
* @param name
|
|
36043
|
-
* @param part
|
|
36511
|
+
* @param this Service that provides methods for creating and managing collision groups, which control whether sets of `BaseParts` collide with each other.
|
|
36512
|
+
* @param name The name of the collision group to check.
|
|
36513
|
+
* @param part The `BasePart` to check for membership in the collision group.
|
|
36514
|
+
* @returns `true` if the part belongs to the specified collision group, `false` otherwise.
|
|
36044
36515
|
*
|
|
36045
36516
|
* @deprecated CollisionGroup
|
|
36046
36517
|
*/
|
|
@@ -36051,10 +36522,10 @@ interface PhysicsService extends Instance {
|
|
|
36051
36522
|
* - **ThreadSafety**: Unsafe
|
|
36052
36523
|
*
|
|
36053
36524
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PhysicsService#CollisionGroupSetCollidable)
|
|
36054
|
-
* @param this
|
|
36055
|
-
* @param name1
|
|
36056
|
-
* @param name2
|
|
36057
|
-
* @param collidable
|
|
36525
|
+
* @param this Service that provides methods for creating and managing collision groups, which control whether sets of `BaseParts` collide with each other.
|
|
36526
|
+
* @param name1 The name of the first collision group.
|
|
36527
|
+
* @param name2 The name of the second collision group.
|
|
36528
|
+
* @param collidable Whether the two groups should collide with each other.
|
|
36058
36529
|
*/
|
|
36059
36530
|
CollisionGroupSetCollidable(this: PhysicsService, name1: string, name2: string, collidable: boolean): void;
|
|
36060
36531
|
/**
|
|
@@ -36063,9 +36534,10 @@ interface PhysicsService extends Instance {
|
|
|
36063
36534
|
* - **ThreadSafety**: Unsafe
|
|
36064
36535
|
*
|
|
36065
36536
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PhysicsService#CollisionGroupsAreCollidable)
|
|
36066
|
-
* @param this
|
|
36067
|
-
* @param name1
|
|
36068
|
-
* @param name2
|
|
36537
|
+
* @param this Service that provides methods for creating and managing collision groups, which control whether sets of `BaseParts` collide with each other.
|
|
36538
|
+
* @param name1 The name of the first collision group.
|
|
36539
|
+
* @param name2 The name of the second collision group.
|
|
36540
|
+
* @returns `true` if the two groups are set to collide, `false` otherwise. Also returns `true` if either group is unregistered.
|
|
36069
36541
|
*/
|
|
36070
36542
|
CollisionGroupsAreCollidable(this: PhysicsService, name1: string, name2: string): boolean;
|
|
36071
36543
|
/**
|
|
@@ -36077,8 +36549,9 @@ interface PhysicsService extends Instance {
|
|
|
36077
36549
|
* - **Tags**:
|
|
36078
36550
|
*
|
|
36079
36551
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PhysicsService#CreateCollisionGroup)
|
|
36080
|
-
* @param this
|
|
36081
|
-
* @param name
|
|
36552
|
+
* @param this Service that provides methods for creating and managing collision groups, which control whether sets of `BaseParts` collide with each other.
|
|
36553
|
+
* @param name The name of the new collision group to create.
|
|
36554
|
+
* @returns The integer ID assigned to the newly created collision group.
|
|
36082
36555
|
*
|
|
36083
36556
|
* @deprecated RegisterCollisionGroup
|
|
36084
36557
|
*/
|
|
@@ -36092,7 +36565,7 @@ interface PhysicsService extends Instance {
|
|
|
36092
36565
|
* - **Tags**:
|
|
36093
36566
|
*
|
|
36094
36567
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PhysicsService#GetCollisionGroupId)
|
|
36095
|
-
* @param this
|
|
36568
|
+
* @param this Service that provides methods for creating and managing collision groups, which control whether sets of `BaseParts` collide with each other.
|
|
36096
36569
|
* @param name The name of the collision group being retrieved.
|
|
36097
36570
|
* @returns The ID of the retrieved collision group, or `nil` if no such group exists.
|
|
36098
36571
|
*
|
|
@@ -36108,8 +36581,9 @@ interface PhysicsService extends Instance {
|
|
|
36108
36581
|
* - **Tags**:
|
|
36109
36582
|
*
|
|
36110
36583
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PhysicsService#GetCollisionGroupName)
|
|
36111
|
-
* @param this
|
|
36112
|
-
* @param name
|
|
36584
|
+
* @param this Service that provides methods for creating and managing collision groups, which control whether sets of `BaseParts` collide with each other.
|
|
36585
|
+
* @param name The integer ID of the collision group to look up.
|
|
36586
|
+
* @returns The name of the collision group with the given ID, or an empty string if the ID has not been assigned to a group.
|
|
36113
36587
|
*
|
|
36114
36588
|
* @deprecated CollisionGroup
|
|
36115
36589
|
*/
|
|
@@ -36123,7 +36597,8 @@ interface PhysicsService extends Instance {
|
|
|
36123
36597
|
* - **Tags**:
|
|
36124
36598
|
*
|
|
36125
36599
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PhysicsService#GetCollisionGroups)
|
|
36126
|
-
* @param this
|
|
36600
|
+
* @param this Service that provides methods for creating and managing collision groups, which control whether sets of `BaseParts` collide with each other.
|
|
36601
|
+
* @returns An array of tables, each containing `name` (string), `id` (integer), and `mask` (integer) fields for a registered collision group.
|
|
36127
36602
|
*
|
|
36128
36603
|
* @deprecated GetRegisteredCollisionGroups
|
|
36129
36604
|
*/
|
|
@@ -36136,7 +36611,8 @@ interface PhysicsService extends Instance {
|
|
|
36136
36611
|
* - **ThreadSafety**: Unsafe
|
|
36137
36612
|
*
|
|
36138
36613
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PhysicsService#GetMaxCollisionGroups)
|
|
36139
|
-
* @param this
|
|
36614
|
+
* @param this Service that provides methods for creating and managing collision groups, which control whether sets of `BaseParts` collide with each other.
|
|
36615
|
+
* @returns The maximum number of collision groups supported, currently 32.
|
|
36140
36616
|
*/
|
|
36141
36617
|
GetMaxCollisionGroups(this: PhysicsService): number;
|
|
36142
36618
|
/**
|
|
@@ -36145,7 +36621,8 @@ interface PhysicsService extends Instance {
|
|
|
36145
36621
|
* - **ThreadSafety**: Unsafe
|
|
36146
36622
|
*
|
|
36147
36623
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PhysicsService#GetRegisteredCollisionGroups)
|
|
36148
|
-
* @param this
|
|
36624
|
+
* @param this Service that provides methods for creating and managing collision groups, which control whether sets of `BaseParts` collide with each other.
|
|
36625
|
+
* @returns An array of tables, each containing `name` (string) and `mask` (integer) fields for a registered collision group.
|
|
36149
36626
|
*/
|
|
36150
36627
|
GetRegisteredCollisionGroups(this: PhysicsService): Array<CollisionGroupInfo>;
|
|
36151
36628
|
/**
|
|
@@ -36154,8 +36631,9 @@ interface PhysicsService extends Instance {
|
|
|
36154
36631
|
* - **ThreadSafety**: Unsafe
|
|
36155
36632
|
*
|
|
36156
36633
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PhysicsService#IsCollisionGroupRegistered)
|
|
36157
|
-
* @param this
|
|
36158
|
-
* @param name
|
|
36634
|
+
* @param this Service that provides methods for creating and managing collision groups, which control whether sets of `BaseParts` collide with each other.
|
|
36635
|
+
* @param name The name of the collision group to check.
|
|
36636
|
+
* @returns `true` if a collision group with the given name is registered, `false` otherwise.
|
|
36159
36637
|
*/
|
|
36160
36638
|
IsCollisionGroupRegistered(this: PhysicsService, name: string): boolean;
|
|
36161
36639
|
/**
|
|
@@ -36164,8 +36642,8 @@ interface PhysicsService extends Instance {
|
|
|
36164
36642
|
* - **ThreadSafety**: Unsafe
|
|
36165
36643
|
*
|
|
36166
36644
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PhysicsService#RegisterCollisionGroup)
|
|
36167
|
-
* @param this
|
|
36168
|
-
* @param name
|
|
36645
|
+
* @param this Service that provides methods for creating and managing collision groups, which control whether sets of `BaseParts` collide with each other.
|
|
36646
|
+
* @param name The name of the collision group to register.
|
|
36169
36647
|
*/
|
|
36170
36648
|
RegisterCollisionGroup(this: PhysicsService, name: string): void;
|
|
36171
36649
|
/**
|
|
@@ -36177,8 +36655,8 @@ interface PhysicsService extends Instance {
|
|
|
36177
36655
|
* - **Tags**:
|
|
36178
36656
|
*
|
|
36179
36657
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PhysicsService#RemoveCollisionGroup)
|
|
36180
|
-
* @param this
|
|
36181
|
-
* @param name
|
|
36658
|
+
* @param this Service that provides methods for creating and managing collision groups, which control whether sets of `BaseParts` collide with each other.
|
|
36659
|
+
* @param name The name of the collision group to remove.
|
|
36182
36660
|
*
|
|
36183
36661
|
* @deprecated UnregisterCollisionGroup
|
|
36184
36662
|
*/
|
|
@@ -36189,9 +36667,9 @@ interface PhysicsService extends Instance {
|
|
|
36189
36667
|
* - **ThreadSafety**: Unsafe
|
|
36190
36668
|
*
|
|
36191
36669
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PhysicsService#RenameCollisionGroup)
|
|
36192
|
-
* @param this
|
|
36193
|
-
* @param from
|
|
36194
|
-
* @param to
|
|
36670
|
+
* @param this Service that provides methods for creating and managing collision groups, which control whether sets of `BaseParts` collide with each other.
|
|
36671
|
+
* @param from The current name of the collision group to rename.
|
|
36672
|
+
* @param to The new name for the collision group.
|
|
36195
36673
|
*/
|
|
36196
36674
|
RenameCollisionGroup(this: PhysicsService, from: string, to: string): void;
|
|
36197
36675
|
/**
|
|
@@ -36203,7 +36681,7 @@ interface PhysicsService extends Instance {
|
|
|
36203
36681
|
* - **Tags**:
|
|
36204
36682
|
*
|
|
36205
36683
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PhysicsService#SetPartCollisionGroup)
|
|
36206
|
-
* @param this
|
|
36684
|
+
* @param this Service that provides methods for creating and managing collision groups, which control whether sets of `BaseParts` collide with each other.
|
|
36207
36685
|
* @param part The part being set.
|
|
36208
36686
|
* @param name The name of collision group that the part's collision group is being set to.
|
|
36209
36687
|
*
|
|
@@ -36216,8 +36694,8 @@ interface PhysicsService extends Instance {
|
|
|
36216
36694
|
* - **ThreadSafety**: Unsafe
|
|
36217
36695
|
*
|
|
36218
36696
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PhysicsService#UnregisterCollisionGroup)
|
|
36219
|
-
* @param this
|
|
36220
|
-
* @param name
|
|
36697
|
+
* @param this Service that provides methods for creating and managing collision groups, which control whether sets of `BaseParts` collide with each other.
|
|
36698
|
+
* @param name The name of the collision group to unregister.
|
|
36221
36699
|
*/
|
|
36222
36700
|
UnregisterCollisionGroup(this: PhysicsService, name: string): void;
|
|
36223
36701
|
}
|
|
@@ -36350,6 +36828,8 @@ interface Player extends Instance {
|
|
|
36350
36828
|
*/
|
|
36351
36829
|
readonly AccountAge: number;
|
|
36352
36830
|
/**
|
|
36831
|
+
* Indicates whether the player has completed an age verification check.
|
|
36832
|
+
*
|
|
36353
36833
|
* - **ThreadSafety**: ReadSafe
|
|
36354
36834
|
*
|
|
36355
36835
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#AgeChecked)
|
|
@@ -36720,6 +37200,7 @@ interface Player extends Instance {
|
|
|
36720
37200
|
*
|
|
36721
37201
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#GetMouse)
|
|
36722
37202
|
* @param this An object that represents a presently connected client to the experience.
|
|
37203
|
+
* @returns The player's `Mouse` instance.
|
|
36723
37204
|
*/
|
|
36724
37205
|
GetMouse(this: Player): PlayerMouse;
|
|
36725
37206
|
/**
|
|
@@ -36729,6 +37210,7 @@ interface Player extends Instance {
|
|
|
36729
37210
|
*
|
|
36730
37211
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#GetNetworkPing)
|
|
36731
37212
|
* @param this An object that represents a presently connected client to the experience.
|
|
37213
|
+
* @returns The round-trip network latency of the player in seconds.
|
|
36732
37214
|
*/
|
|
36733
37215
|
GetNetworkPing(this: Player): number;
|
|
36734
37216
|
/**
|
|
@@ -36772,7 +37254,8 @@ interface Player extends Instance {
|
|
|
36772
37254
|
*
|
|
36773
37255
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#LoadBoolean)
|
|
36774
37256
|
* @param this An object that represents a presently connected client to the experience.
|
|
36775
|
-
* @param key
|
|
37257
|
+
* @param key The string key under which the boolean was previously saved.
|
|
37258
|
+
* @returns The saved boolean value, or `false` if the key does not exist.
|
|
36776
37259
|
*
|
|
36777
37260
|
* @deprecated
|
|
36778
37261
|
*/
|
|
@@ -36802,7 +37285,8 @@ interface Player extends Instance {
|
|
|
36802
37285
|
*
|
|
36803
37286
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#LoadInstance)
|
|
36804
37287
|
* @param this An object that represents a presently connected client to the experience.
|
|
36805
|
-
* @param key
|
|
37288
|
+
* @param key The string key under which the instance was previously saved.
|
|
37289
|
+
* @returns The saved `Instance`, or `nil` if the key does not exist.
|
|
36806
37290
|
*
|
|
36807
37291
|
* @deprecated
|
|
36808
37292
|
*/
|
|
@@ -36817,7 +37301,8 @@ interface Player extends Instance {
|
|
|
36817
37301
|
*
|
|
36818
37302
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#LoadNumber)
|
|
36819
37303
|
* @param this An object that represents a presently connected client to the experience.
|
|
36820
|
-
* @param key
|
|
37304
|
+
* @param key The string key under which the number was previously saved.
|
|
37305
|
+
* @returns The saved number value, or `0` if the key does not exist.
|
|
36821
37306
|
*
|
|
36822
37307
|
* @deprecated
|
|
36823
37308
|
*/
|
|
@@ -36832,7 +37317,8 @@ interface Player extends Instance {
|
|
|
36832
37317
|
*
|
|
36833
37318
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#LoadString)
|
|
36834
37319
|
* @param this An object that represents a presently connected client to the experience.
|
|
36835
|
-
* @param key
|
|
37320
|
+
* @param key The string key under which the string was previously saved.
|
|
37321
|
+
* @returns The saved string value, or an empty string if the key does not exist.
|
|
36836
37322
|
*
|
|
36837
37323
|
* @deprecated
|
|
36838
37324
|
*/
|
|
@@ -36849,9 +37335,12 @@ interface Player extends Instance {
|
|
|
36849
37335
|
*/
|
|
36850
37336
|
Move(this: Player, walkDirection: Vector3, relativeToCamera?: boolean): void;
|
|
36851
37337
|
/**
|
|
37338
|
+
* Prompts the player to complete age verification.
|
|
37339
|
+
*
|
|
36852
37340
|
* - **ThreadSafety**: Unsafe
|
|
36853
37341
|
*
|
|
36854
37342
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#PromptAgeCheck)
|
|
37343
|
+
* @param this An object that represents a presently connected client to the experience.
|
|
36855
37344
|
*/
|
|
36856
37345
|
PromptAgeCheck(this: Player): void;
|
|
36857
37346
|
/**
|
|
@@ -36874,8 +37363,8 @@ interface Player extends Instance {
|
|
|
36874
37363
|
*
|
|
36875
37364
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#SaveBoolean)
|
|
36876
37365
|
* @param this An object that represents a presently connected client to the experience.
|
|
36877
|
-
* @param key
|
|
36878
|
-
* @param value
|
|
37366
|
+
* @param key The string key to associate with the saved boolean value.
|
|
37367
|
+
* @param value The boolean value to save.
|
|
36879
37368
|
*
|
|
36880
37369
|
* @deprecated
|
|
36881
37370
|
*/
|
|
@@ -36890,8 +37379,8 @@ interface Player extends Instance {
|
|
|
36890
37379
|
*
|
|
36891
37380
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#SaveInstance)
|
|
36892
37381
|
* @param this An object that represents a presently connected client to the experience.
|
|
36893
|
-
* @param key
|
|
36894
|
-
* @param value
|
|
37382
|
+
* @param key The string key to associate with the saved instance.
|
|
37383
|
+
* @param value The `Instance` to save.
|
|
36895
37384
|
*
|
|
36896
37385
|
* @deprecated
|
|
36897
37386
|
*/
|
|
@@ -36906,8 +37395,8 @@ interface Player extends Instance {
|
|
|
36906
37395
|
*
|
|
36907
37396
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#SaveNumber)
|
|
36908
37397
|
* @param this An object that represents a presently connected client to the experience.
|
|
36909
|
-
* @param key
|
|
36910
|
-
* @param value
|
|
37398
|
+
* @param key The string key to associate with the saved number value.
|
|
37399
|
+
* @param value The number value to save.
|
|
36911
37400
|
*
|
|
36912
37401
|
* @deprecated
|
|
36913
37402
|
*/
|
|
@@ -36922,12 +37411,19 @@ interface Player extends Instance {
|
|
|
36922
37411
|
*
|
|
36923
37412
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#SaveString)
|
|
36924
37413
|
* @param this An object that represents a presently connected client to the experience.
|
|
36925
|
-
* @param key
|
|
36926
|
-
* @param value
|
|
37414
|
+
* @param key The string key to associate with the saved string value.
|
|
37415
|
+
* @param value The string value to save.
|
|
36927
37416
|
*
|
|
36928
37417
|
* @deprecated
|
|
36929
37418
|
*/
|
|
36930
37419
|
SaveString(this: Player, key: string, value: string): void;
|
|
37420
|
+
/**
|
|
37421
|
+
* - **ThreadSafety**: Unsafe
|
|
37422
|
+
* - **Tags**: Yields
|
|
37423
|
+
*
|
|
37424
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#GetFriendsInUniverseAsync)
|
|
37425
|
+
*/
|
|
37426
|
+
GetFriendsInUniverseAsync(this: Player): Array<unknown>;
|
|
36931
37427
|
/**
|
|
36932
37428
|
* **Deprecated:** This method has been superseded by `GetFriendsOnlineAsync()`.
|
|
36933
37429
|
*
|
|
@@ -36957,6 +37453,8 @@ interface Player extends Instance {
|
|
|
36957
37453
|
*/
|
|
36958
37454
|
GetFriendsOnlineAsync(this: Player, maxFriends?: number): Array<unknown>;
|
|
36959
37455
|
/**
|
|
37456
|
+
* Returns the user IDs of friends who have previously joined this experience.
|
|
37457
|
+
*
|
|
36960
37458
|
* - **ThreadSafety**: Unsafe
|
|
36961
37459
|
* - **Tags**: Yields
|
|
36962
37460
|
*
|
|
@@ -37039,7 +37537,8 @@ interface Player extends Instance {
|
|
|
37039
37537
|
*
|
|
37040
37538
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#IsBestFriendsWith)
|
|
37041
37539
|
* @param this An object that represents a presently connected client to the experience.
|
|
37042
|
-
* @param userId
|
|
37540
|
+
* @param userId The `Player.UserId` of the user to check friendship with.
|
|
37541
|
+
* @returns A boolean indicating whether the player is friends with the specified user.
|
|
37043
37542
|
*
|
|
37044
37543
|
* @deprecated
|
|
37045
37544
|
*/
|
|
@@ -37174,6 +37673,7 @@ interface Player extends Instance {
|
|
|
37174
37673
|
*
|
|
37175
37674
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#WaitForDataReady)
|
|
37176
37675
|
* @param this An object that represents a presently connected client to the experience.
|
|
37676
|
+
* @returns A boolean indicating whether the player's data loaded successfully.
|
|
37177
37677
|
*
|
|
37178
37678
|
* @deprecated
|
|
37179
37679
|
*/
|
|
@@ -37228,6 +37728,111 @@ interface Player extends Instance {
|
|
|
37228
37728
|
readonly OnTeleport: RBXScriptSignal<(teleportState: Enum.TeleportState, placeId: number, spawnName: string) => void>;
|
|
37229
37729
|
readonly Name: string;
|
|
37230
37730
|
}
|
|
37731
|
+
/**
|
|
37732
|
+
* - **Tags**: NotBrowsable
|
|
37733
|
+
*
|
|
37734
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PlayerControlState)
|
|
37735
|
+
*/
|
|
37736
|
+
interface PlayerControlState extends Instance {
|
|
37737
|
+
/**
|
|
37738
|
+
* **DO NOT USE!**
|
|
37739
|
+
*
|
|
37740
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
37741
|
+
* @hidden
|
|
37742
|
+
* @deprecated
|
|
37743
|
+
*/
|
|
37744
|
+
readonly _nominal_PlayerControlState: unique symbol;
|
|
37745
|
+
/**
|
|
37746
|
+
* - **ThreadSafety**: ReadSafe
|
|
37747
|
+
*
|
|
37748
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PlayerControlState#Owner)
|
|
37749
|
+
*/
|
|
37750
|
+
Owner: Player | undefined;
|
|
37751
|
+
/**
|
|
37752
|
+
* - **ThreadSafety**: Unsafe
|
|
37753
|
+
*
|
|
37754
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PlayerControlState#AddBoolField)
|
|
37755
|
+
*/
|
|
37756
|
+
AddBoolField(this: PlayerControlState, name: string, defaultValue?: boolean): void;
|
|
37757
|
+
/**
|
|
37758
|
+
* - **ThreadSafety**: Unsafe
|
|
37759
|
+
*
|
|
37760
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PlayerControlState#AddCFrameField)
|
|
37761
|
+
*/
|
|
37762
|
+
AddCFrameField(this: PlayerControlState, name: string, defaultValue?: CFrame): void;
|
|
37763
|
+
/**
|
|
37764
|
+
* - **ThreadSafety**: Unsafe
|
|
37765
|
+
*
|
|
37766
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PlayerControlState#AddInstanceField)
|
|
37767
|
+
*/
|
|
37768
|
+
AddInstanceField(this: PlayerControlState, name: string): void;
|
|
37769
|
+
/**
|
|
37770
|
+
* - **ThreadSafety**: Unsafe
|
|
37771
|
+
*
|
|
37772
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PlayerControlState#AddIntField)
|
|
37773
|
+
*/
|
|
37774
|
+
AddIntField(this: PlayerControlState, name: string, defaultValue?: number, min?: number, max?: number): void;
|
|
37775
|
+
/**
|
|
37776
|
+
* - **ThreadSafety**: Unsafe
|
|
37777
|
+
*
|
|
37778
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PlayerControlState#AddNumberField)
|
|
37779
|
+
*/
|
|
37780
|
+
AddNumberField(this: PlayerControlState, name: string, defaultValue?: number, min?: number, max?: number): void;
|
|
37781
|
+
/**
|
|
37782
|
+
* - **ThreadSafety**: Unsafe
|
|
37783
|
+
*
|
|
37784
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PlayerControlState#AddUnitVector3Field)
|
|
37785
|
+
*/
|
|
37786
|
+
AddUnitVector3Field(this: PlayerControlState, name: string, defaultValue?: Vector3): void;
|
|
37787
|
+
/**
|
|
37788
|
+
* - **ThreadSafety**: Unsafe
|
|
37789
|
+
*
|
|
37790
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PlayerControlState#AddVector2Field)
|
|
37791
|
+
*/
|
|
37792
|
+
AddVector2Field(this: PlayerControlState, name: string, defaultValue?: Vector2, maxMagnitude?: number): void;
|
|
37793
|
+
/**
|
|
37794
|
+
* - **ThreadSafety**: Unsafe
|
|
37795
|
+
*
|
|
37796
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PlayerControlState#AddVector3Field)
|
|
37797
|
+
*/
|
|
37798
|
+
AddVector3Field(this: PlayerControlState, name: string, defaultValue?: Vector3, maxMagnitude?: number): void;
|
|
37799
|
+
/**
|
|
37800
|
+
* - **ThreadSafety**: Unsafe
|
|
37801
|
+
*
|
|
37802
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PlayerControlState#GetChangedState)
|
|
37803
|
+
*/
|
|
37804
|
+
GetChangedState(this: PlayerControlState, prev?: CastsToEnum<Enum.StateReferenceFrame>, next?: CastsToEnum<Enum.StateReferenceFrame>): object;
|
|
37805
|
+
/**
|
|
37806
|
+
* - **ThreadSafety**: Unsafe
|
|
37807
|
+
*
|
|
37808
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PlayerControlState#GetReplicationWeight)
|
|
37809
|
+
*/
|
|
37810
|
+
GetReplicationWeight(this: PlayerControlState): number;
|
|
37811
|
+
/**
|
|
37812
|
+
* - **ThreadSafety**: Unsafe
|
|
37813
|
+
*
|
|
37814
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PlayerControlState#GetState)
|
|
37815
|
+
*/
|
|
37816
|
+
GetState(this: PlayerControlState, ref?: CastsToEnum<Enum.StateReferenceFrame>): object;
|
|
37817
|
+
/**
|
|
37818
|
+
* - **ThreadSafety**: Unsafe
|
|
37819
|
+
*
|
|
37820
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PlayerControlState#SetField)
|
|
37821
|
+
*/
|
|
37822
|
+
SetField(this: PlayerControlState, name: string, value: unknown): void;
|
|
37823
|
+
/**
|
|
37824
|
+
* - **ThreadSafety**: Unsafe
|
|
37825
|
+
*
|
|
37826
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PlayerControlState#UpdateFields)
|
|
37827
|
+
*/
|
|
37828
|
+
UpdateFields(this: PlayerControlState, state: object): void;
|
|
37829
|
+
/**
|
|
37830
|
+
* - **ThreadSafety**: Unsafe
|
|
37831
|
+
*
|
|
37832
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PlayerControlState#OnStateChanged)
|
|
37833
|
+
*/
|
|
37834
|
+
readonly OnStateChanged: RBXScriptSignal<() => void>;
|
|
37835
|
+
}
|
|
37231
37836
|
/**
|
|
37232
37837
|
* - **Tags**: NotCreatable, NotReplicated
|
|
37233
37838
|
*
|
|
@@ -37545,7 +38150,7 @@ interface PlayerScripts extends Instance {
|
|
|
37545
38150
|
*
|
|
37546
38151
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PlayerScripts#RegisterComputerCameraMovementMode)
|
|
37547
38152
|
* @param this A container for client-side scripts to be run inside `Player` objects within the `Players` service.
|
|
37548
|
-
* @param cameraMovementMode
|
|
38153
|
+
* @param cameraMovementMode The `ComputerCameraMovementMode` to add to the selectable options in the settings menu.
|
|
37549
38154
|
*/
|
|
37550
38155
|
RegisterComputerCameraMovementMode(this: PlayerScripts, cameraMovementMode: CastsToEnum<Enum.ComputerCameraMovementMode>): void;
|
|
37551
38156
|
/**
|
|
@@ -37555,7 +38160,7 @@ interface PlayerScripts extends Instance {
|
|
|
37555
38160
|
*
|
|
37556
38161
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PlayerScripts#RegisterComputerMovementMode)
|
|
37557
38162
|
* @param this A container for client-side scripts to be run inside `Player` objects within the `Players` service.
|
|
37558
|
-
* @param movementMode
|
|
38163
|
+
* @param movementMode The `ComputerMovementMode` to add to the selectable options in the settings menu.
|
|
37559
38164
|
*/
|
|
37560
38165
|
RegisterComputerMovementMode(this: PlayerScripts, movementMode: CastsToEnum<Enum.ComputerMovementMode>): void;
|
|
37561
38166
|
/**
|
|
@@ -37565,7 +38170,7 @@ interface PlayerScripts extends Instance {
|
|
|
37565
38170
|
*
|
|
37566
38171
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PlayerScripts#RegisterTouchCameraMovementMode)
|
|
37567
38172
|
* @param this A container for client-side scripts to be run inside `Player` objects within the `Players` service.
|
|
37568
|
-
* @param cameraMovementMode
|
|
38173
|
+
* @param cameraMovementMode The `TouchCameraMovementMode` to add to the selectable options in the settings menu.
|
|
37569
38174
|
*/
|
|
37570
38175
|
RegisterTouchCameraMovementMode(this: PlayerScripts, cameraMovementMode: CastsToEnum<Enum.TouchCameraMovementMode>): void;
|
|
37571
38176
|
/**
|
|
@@ -37575,7 +38180,7 @@ interface PlayerScripts extends Instance {
|
|
|
37575
38180
|
*
|
|
37576
38181
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PlayerScripts#RegisterTouchMovementMode)
|
|
37577
38182
|
* @param this A container for client-side scripts to be run inside `Player` objects within the `Players` service.
|
|
37578
|
-
* @param movementMode
|
|
38183
|
+
* @param movementMode The `TouchMovementMode` to add to the selectable options in the settings menu.
|
|
37579
38184
|
*/
|
|
37580
38185
|
RegisterTouchMovementMode(this: PlayerScripts, movementMode: CastsToEnum<Enum.TouchMovementMode>): void;
|
|
37581
38186
|
}
|
|
@@ -37699,13 +38304,14 @@ interface Players extends Instance {
|
|
|
37699
38304
|
*/
|
|
37700
38305
|
RespawnTime: number;
|
|
37701
38306
|
/**
|
|
37702
|
-
* Returns the `Player` with the given `UserId` if they are in-
|
|
38307
|
+
* Returns the `Player` with the given `UserId` if they are in-experience.
|
|
37703
38308
|
*
|
|
37704
38309
|
* - **ThreadSafety**: Safe
|
|
37705
38310
|
*
|
|
37706
38311
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Players#GetPlayerByUserId)
|
|
37707
38312
|
* @param this A service that contains presently connected `Player` objects.
|
|
37708
38313
|
* @param userId The `Player.UserId` of the player being specified.
|
|
38314
|
+
* @returns The `Player` with the given `Player.UserId`, or `nil` if no connected player has that UserId.
|
|
37709
38315
|
*/
|
|
37710
38316
|
GetPlayerByUserId(this: Players, userId: number): Player | undefined;
|
|
37711
38317
|
/**
|
|
@@ -37716,6 +38322,7 @@ interface Players extends Instance {
|
|
|
37716
38322
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Players#GetPlayerFromCharacter)
|
|
37717
38323
|
* @param this A service that contains presently connected `Player` objects.
|
|
37718
38324
|
* @param character A character instance that you want to get the player from.
|
|
38325
|
+
* @returns The `Player` whose `Player.Character` matches the given model, or `nil` if one cannot be found.
|
|
37719
38326
|
*/
|
|
37720
38327
|
GetPlayerFromCharacter(this: Players, character: Instance | undefined): Player | undefined;
|
|
37721
38328
|
/**
|
|
@@ -37729,7 +38336,7 @@ interface Players extends Instance {
|
|
|
37729
38336
|
*/
|
|
37730
38337
|
GetPlayers(this: Players): Array<Player>;
|
|
37731
38338
|
/**
|
|
37732
|
-
* Bans users from your
|
|
38339
|
+
* Bans users from your experience, with options to specify duration, reason, whether the ban applies to the entire universe or just the current place, and more. This method is enabled and disabled by the `Players.BanningEnabled` property, which you can toggle in Studio.
|
|
37733
38340
|
*
|
|
37734
38341
|
* - **ThreadSafety**: Unsafe
|
|
37735
38342
|
* - **Tags**: Yields
|
|
@@ -37737,12 +38344,12 @@ interface Players extends Instance {
|
|
|
37737
38344
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Players#BanAsync)
|
|
37738
38345
|
* @param this A service that contains presently connected `Player` objects.
|
|
37739
38346
|
* @param config - `UserIds` (required; array) — Array of `UserIds` of players to be banned. Max size is `50`.
|
|
37740
|
-
* - `ApplyToUniverse` (optional; boolean) — Whether ban propagates to all places within the
|
|
38347
|
+
* - `ApplyToUniverse` (optional; boolean) — Whether ban propagates to all places within the experience universe. Default is `true`.
|
|
37741
38348
|
* - `Duration` (required; integer) — Duration of the ban, in seconds. Permanent bans should have a value of `-1`. `0` and all other negative values are invalid.
|
|
37742
|
-
* - `DisplayReason` (required; string) — The message that will be displayed to users when they attempt to and fail to join
|
|
38349
|
+
* - `DisplayReason` (required; string) — The message that will be displayed to users when they attempt to and fail to join an experience. Maximum string length is `400`.
|
|
37743
38350
|
* - `PrivateReason` (required; string) — Internal messaging that will be returned when querying the user's ban history. Maximum string length is `1000`.
|
|
37744
38351
|
* - `ExcludeAltAccounts` (optional; boolean) — When `true`, Roblox does not attempt to ban alternate accounts. Default is `false`.
|
|
37745
|
-
* - `ApplyDeviceBlock` (optional; boolean) — When `true`, Roblox will block banned users' devices from rejoining the
|
|
38352
|
+
* - `ApplyDeviceBlock` (optional; boolean) — When `true`, Roblox will block banned users' devices from rejoining the experience for 24 hours after the ban is applied. Default is `false`. The block can be overridden by unbanning a user via a call to `Players:UnbanAsync()`. Note that unbanning a user through any other method will not lift the device block.
|
|
37746
38353
|
*/
|
|
37747
38354
|
BanAsync(this: Players, config: BanAsyncConfig): void;
|
|
37748
38355
|
/**
|
|
@@ -37764,7 +38371,7 @@ interface Players extends Instance {
|
|
|
37764
38371
|
*/
|
|
37765
38372
|
CreateHumanoidModelFromDescription(this: Players, description: HumanoidDescription, rigType: CastsToEnum<Enum.HumanoidRigType>, assetTypeVerification?: CastsToEnum<Enum.AssetTypeVerification>): Model;
|
|
37766
38373
|
/**
|
|
37767
|
-
* Returns a character `Model` equipped with everything specified in the passed in `HumanoidDescription`. If `UseAvatarSettings` is set to true, Avatar Settings in the
|
|
38374
|
+
* Returns a character `Model` equipped with everything specified in the passed in `HumanoidDescription`. If `UseAvatarSettings` is set to true, Avatar Settings in the experience will be applied to the returned model.
|
|
37768
38375
|
*
|
|
37769
38376
|
* - **ThreadSafety**: Unsafe
|
|
37770
38377
|
* - **Tags**: Yields
|
|
@@ -37806,14 +38413,14 @@ interface Players extends Instance {
|
|
|
37806
38413
|
*/
|
|
37807
38414
|
CreateHumanoidModelFromUserIdAsync(this: Players, userId: User): Model;
|
|
37808
38415
|
/**
|
|
37809
|
-
* Retrieves the ban and unban history of any user within the
|
|
38416
|
+
* Retrieves the ban and unban history of any user within the experience's universe. This method is enabled and disabled by the `Players.BanningEnabled` property, which you can toggle in Studio.
|
|
37810
38417
|
*
|
|
37811
38418
|
* - **ThreadSafety**: Unsafe
|
|
37812
38419
|
* - **Tags**: Yields
|
|
37813
38420
|
*
|
|
37814
38421
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Players#GetBanHistoryAsync)
|
|
37815
38422
|
* @param this A service that contains presently connected `Player` objects.
|
|
37816
|
-
* @param userId
|
|
38423
|
+
* @param userId The `Player.UserId` of the player whose ban history to retrieve.
|
|
37817
38424
|
* @returns See `BanHistoryPages` for return reference.
|
|
37818
38425
|
*/
|
|
37819
38426
|
GetBanHistoryAsync(this: Players, userId: User): BanHistoryPages;
|
|
@@ -37828,6 +38435,7 @@ interface Players extends Instance {
|
|
|
37828
38435
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Players#GetCharacterAppearanceAsync)
|
|
37829
38436
|
* @param this A service that contains presently connected `Player` objects.
|
|
37830
38437
|
* @param userId The `Player.UserId` of the specified player.
|
|
38438
|
+
* @returns A `Model` containing the assets the player is wearing, excluding gear.
|
|
37831
38439
|
*
|
|
37832
38440
|
* @deprecated
|
|
37833
38441
|
*/
|
|
@@ -37853,6 +38461,7 @@ interface Players extends Instance {
|
|
|
37853
38461
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Players#GetFriendsAsync)
|
|
37854
38462
|
* @param this A service that contains presently connected `Player` objects.
|
|
37855
38463
|
* @param userId The user ID of the player being specified.
|
|
38464
|
+
* @returns A `FriendPages` object containing information for all of the given user's friends.
|
|
37856
38465
|
*/
|
|
37857
38466
|
GetFriendsAsync(this: Players, userId: User): FriendPages;
|
|
37858
38467
|
/**
|
|
@@ -37924,10 +38533,15 @@ interface Players extends Instance {
|
|
|
37924
38533
|
*/
|
|
37925
38534
|
GetNameFromUserIdAsync(this: Players, userId: User): string;
|
|
37926
38535
|
/**
|
|
38536
|
+
* Returns the profile configuration of a user as a dictionary.
|
|
38537
|
+
*
|
|
37927
38538
|
* - **ThreadSafety**: Unsafe
|
|
37928
38539
|
* - **Tags**: Yields
|
|
37929
38540
|
*
|
|
37930
38541
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Players#GetProfileConfigurationFromUserIdAsync)
|
|
38542
|
+
* @param this A service that contains presently connected `Player` objects.
|
|
38543
|
+
* @param userId The `Player.UserId` of the user whose profile configuration to retrieve.
|
|
38544
|
+
* @returns A dictionary containing the user's profile configuration, such as the background asset ID.
|
|
37931
38545
|
*/
|
|
37932
38546
|
GetProfileConfigurationFromUserIdAsync(this: Players, userId: User): object;
|
|
37933
38547
|
/**
|
|
@@ -37967,18 +38581,18 @@ interface Players extends Instance {
|
|
|
37967
38581
|
*
|
|
37968
38582
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Players#UnbanAsync)
|
|
37969
38583
|
* @param this A service that contains presently connected `Player` objects.
|
|
37970
|
-
* @param config | Name | Type | Description
|
|
37971
|
-
* | ----------------- | ------- |
|
|
37972
|
-
* | `UserIds` | array | UserIDs to be force allowed into the
|
|
38584
|
+
* @param config | Name | Type | Description |
|
|
38585
|
+
* | ----------------- | ------- | -------------------------------------------------------------------------- |
|
|
38586
|
+
* | `UserIds` | array | UserIDs to be force allowed into the experience(s).
|
|
37973
38587
|
*
|
|
37974
38588
|
*
|
|
37975
38589
|
*
|
|
37976
38590
|
* Max size is `50`. |
|
|
37977
|
-
* | `ApplyToUniverse` | boolean | Propagates the unban to all places within this universe.
|
|
38591
|
+
* | `ApplyToUniverse` | boolean | Propagates the unban to all places within this universe. |
|
|
37978
38592
|
*/
|
|
37979
38593
|
UnbanAsync(this: Players, config: UnbanAsyncConfig): void;
|
|
37980
38594
|
/**
|
|
37981
|
-
* Fires when a player enters the
|
|
38595
|
+
* Fires when a player enters the experience.
|
|
37982
38596
|
*
|
|
37983
38597
|
* - **ThreadSafety**: Unsafe
|
|
37984
38598
|
*
|
|
@@ -37986,7 +38600,7 @@ interface Players extends Instance {
|
|
|
37986
38600
|
*/
|
|
37987
38601
|
readonly PlayerAdded: RBXScriptSignal<(player: Player) => void>;
|
|
37988
38602
|
/**
|
|
37989
|
-
* Fires when the
|
|
38603
|
+
* Fires when the experience server recognizes that a player's membership has changed.
|
|
37990
38604
|
*
|
|
37991
38605
|
* - **ThreadSafety**: Unsafe
|
|
37992
38606
|
*
|
|
@@ -37994,7 +38608,7 @@ interface Players extends Instance {
|
|
|
37994
38608
|
*/
|
|
37995
38609
|
readonly PlayerMembershipChanged: RBXScriptSignal<(player: Player) => void>;
|
|
37996
38610
|
/**
|
|
37997
|
-
* Fires when a player is about to leave the
|
|
38611
|
+
* Fires when a player is about to leave the experience.
|
|
37998
38612
|
*
|
|
37999
38613
|
* - **ThreadSafety**: Unsafe
|
|
38000
38614
|
*
|
|
@@ -38002,7 +38616,7 @@ interface Players extends Instance {
|
|
|
38002
38616
|
*/
|
|
38003
38617
|
readonly PlayerRemoving: RBXScriptSignal<(player: Player, reason: Enum.PlayerExitReason) => void>;
|
|
38004
38618
|
/**
|
|
38005
|
-
* Fires when the
|
|
38619
|
+
* Fires when the experience server recognizes that the user's status for a certain subscription has changed.
|
|
38006
38620
|
*
|
|
38007
38621
|
* - **ThreadSafety**: Unsafe
|
|
38008
38622
|
*
|
|
@@ -38011,6 +38625,8 @@ interface Players extends Instance {
|
|
|
38011
38625
|
readonly UserSubscriptionStatusChanged: RBXScriptSignal<(user: Player, subscriptionId: string) => void>;
|
|
38012
38626
|
}
|
|
38013
38627
|
/**
|
|
38628
|
+
* Declares a plugin's capabilities (the data models it targets and the permissions it requests) through a JSON manifest.
|
|
38629
|
+
*
|
|
38014
38630
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PluginCapabilities)
|
|
38015
38631
|
*/
|
|
38016
38632
|
interface PluginCapabilities extends Instance {
|
|
@@ -38041,6 +38657,8 @@ interface PluginConnectionService extends Instance {
|
|
|
38041
38657
|
readonly _nominal_PluginConnectionService: unique symbol;
|
|
38042
38658
|
}
|
|
38043
38659
|
/**
|
|
38660
|
+
* Studio service that manages installed plugins; not intended for creator scripts or plugins.
|
|
38661
|
+
*
|
|
38044
38662
|
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
38045
38663
|
*
|
|
38046
38664
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PluginManagementService)
|
|
@@ -38056,6 +38674,8 @@ interface PluginManagementService extends Instance {
|
|
|
38056
38674
|
readonly _nominal_PluginManagementService: unique symbol;
|
|
38057
38675
|
}
|
|
38058
38676
|
/**
|
|
38677
|
+
* The singleton object returned by the global `PluginManager()` function, exposing a small set of legacy Studio plugin utilities.
|
|
38678
|
+
*
|
|
38059
38679
|
* - **Tags**: NotCreatable, NotReplicated
|
|
38060
38680
|
*
|
|
38061
38681
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PluginManagerInterface)
|
|
@@ -38534,6 +39154,8 @@ interface ProceduralBehaviorSchedulerService extends Instance {
|
|
|
38534
39154
|
readonly _nominal_ProceduralBehaviorSchedulerService: unique symbol;
|
|
38535
39155
|
}
|
|
38536
39156
|
/**
|
|
39157
|
+
* An internal engine service that generates collision geometry (physics data) for `MeshPart` and `PartOperation` instances that need new physics.
|
|
39158
|
+
*
|
|
38537
39159
|
* - **Tags**: NotCreatable, Service
|
|
38538
39160
|
*
|
|
38539
39161
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ProcessInstancePhysicsService)
|
|
@@ -38635,6 +39257,8 @@ interface ProximityPrompt extends Instance {
|
|
|
38635
39257
|
*/
|
|
38636
39258
|
MaxActivationDistance: number;
|
|
38637
39259
|
/**
|
|
39260
|
+
* The maximum distance at which a lightweight indicator for the prompt is shown, hinting at a nearby interaction before the player is close enough to trigger it.
|
|
39261
|
+
*
|
|
38638
39262
|
* - **ThreadSafety**: ReadSafe
|
|
38639
39263
|
*
|
|
38640
39264
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ProximityPrompt#MaxIndicatorDistance)
|
|
@@ -38699,12 +39323,16 @@ interface ProximityPrompt extends Instance {
|
|
|
38699
39323
|
*/
|
|
38700
39324
|
InputHoldEnd(this: ProximityPrompt): void;
|
|
38701
39325
|
/**
|
|
39326
|
+
* Fires on the client when a lightweight indicator for the prompt is no longer shown.
|
|
39327
|
+
*
|
|
38702
39328
|
* - **ThreadSafety**: Unsafe
|
|
38703
39329
|
*
|
|
38704
39330
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ProximityPrompt#IndicatorHidden)
|
|
38705
39331
|
*/
|
|
38706
39332
|
readonly IndicatorHidden: RBXScriptSignal<() => void>;
|
|
38707
39333
|
/**
|
|
39334
|
+
* Fires on the client when a lightweight indicator for the prompt becomes visible.
|
|
39335
|
+
*
|
|
38708
39336
|
* - **ThreadSafety**: Unsafe
|
|
38709
39337
|
*
|
|
38710
39338
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ProximityPrompt#IndicatorShown)
|
|
@@ -38784,6 +39412,8 @@ interface ProximityPromptService extends Instance {
|
|
|
38784
39412
|
*/
|
|
38785
39413
|
Enabled: boolean;
|
|
38786
39414
|
/**
|
|
39415
|
+
* Maximum number of prompt indicators that can be visible at once.
|
|
39416
|
+
*
|
|
38787
39417
|
* - **ThreadSafety**: ReadSafe
|
|
38788
39418
|
*
|
|
38789
39419
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ProximityPromptService#MaxIndicatorsVisible)
|
|
@@ -38798,12 +39428,16 @@ interface ProximityPromptService extends Instance {
|
|
|
38798
39428
|
*/
|
|
38799
39429
|
MaxPromptsVisible: number;
|
|
38800
39430
|
/**
|
|
39431
|
+
* Triggers client-side when a prompt's indicator becomes hidden.
|
|
39432
|
+
*
|
|
38801
39433
|
* - **ThreadSafety**: Unsafe
|
|
38802
39434
|
*
|
|
38803
39435
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ProximityPromptService#IndicatorHidden)
|
|
38804
39436
|
*/
|
|
38805
39437
|
readonly IndicatorHidden: RBXScriptSignal<(prompt: ProximityPrompt) => void>;
|
|
38806
39438
|
/**
|
|
39439
|
+
* Triggers client-side when a prompt's indicator becomes visible.
|
|
39440
|
+
*
|
|
38807
39441
|
* - **ThreadSafety**: Unsafe
|
|
38808
39442
|
*
|
|
38809
39443
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ProximityPromptService#IndicatorShown)
|
|
@@ -38859,6 +39493,8 @@ interface ProximityPromptService extends Instance {
|
|
|
38859
39493
|
readonly PromptTriggered: RBXScriptSignal<(prompt: ProximityPrompt, playerWhoTriggered: Player) => void>;
|
|
38860
39494
|
}
|
|
38861
39495
|
/**
|
|
39496
|
+
* A service that centralizes uploading assets to Roblox, including publishing cage mesh edits and creating assets or asset versions.
|
|
39497
|
+
*
|
|
38862
39498
|
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
38863
39499
|
*
|
|
38864
39500
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PublishService)
|
|
@@ -38998,6 +39634,12 @@ interface RealtimeMedia extends Instance {
|
|
|
38998
39634
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RealtimeMedia#ConnectAsync)
|
|
38999
39635
|
*/
|
|
39000
39636
|
ConnectAsync(this: RealtimeMedia, serverUrl: string, connectParams?: object): boolean;
|
|
39637
|
+
/**
|
|
39638
|
+
* - **ThreadSafety**: Unsafe
|
|
39639
|
+
*
|
|
39640
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RealtimeMedia#AudioInputRequested)
|
|
39641
|
+
*/
|
|
39642
|
+
readonly AudioInputRequested: RBXScriptSignal<() => void>;
|
|
39001
39643
|
/**
|
|
39002
39644
|
* - **ThreadSafety**: Unsafe
|
|
39003
39645
|
*
|
|
@@ -39219,6 +39861,8 @@ interface ReflectionService extends Instance {
|
|
|
39219
39861
|
GetPropertiesOfClass(this: ReflectionService, className: string, filter?: object): Array<unknown>;
|
|
39220
39862
|
}
|
|
39221
39863
|
/**
|
|
39864
|
+
* Team Create service that executes Luau commands sent from a Studio client on the collaborative editing server and relays their output back to that client.
|
|
39865
|
+
*
|
|
39222
39866
|
* - **Tags**: NotCreatable, Service
|
|
39223
39867
|
*
|
|
39224
39868
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RemoteCommandService)
|
|
@@ -39233,32 +39877,43 @@ interface RemoteCommandService extends Instance {
|
|
|
39233
39877
|
*/
|
|
39234
39878
|
readonly _nominal_RemoteCommandService: unique symbol;
|
|
39235
39879
|
/**
|
|
39880
|
+
* Returns the `Player` for the Studio collaborator who started the command that is currently executing.
|
|
39881
|
+
*
|
|
39236
39882
|
* - **ThreadSafety**: Unsafe
|
|
39237
39883
|
*
|
|
39238
39884
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RemoteCommandService#GetExecutingPlayer)
|
|
39239
|
-
* @param this
|
|
39885
|
+
* @param this Team Create service that executes Luau commands sent from a Studio client on the collaborative editing server and relays their output back to that client.
|
|
39886
|
+
* @returns The `Player` representing the collaborator who started the running command, or `nil` if no connected player matches.
|
|
39240
39887
|
*/
|
|
39241
39888
|
GetExecutingPlayer(this: RemoteCommandService): Player;
|
|
39242
39889
|
/**
|
|
39890
|
+
* Returns a signal that fires on the server each time the Studio client that started the command sends it an update.
|
|
39891
|
+
*
|
|
39243
39892
|
* - **ThreadSafety**: Unsafe
|
|
39244
39893
|
*
|
|
39245
39894
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RemoteCommandService#GetReceivedUpdateSignal)
|
|
39246
|
-
* @param this
|
|
39895
|
+
* @param this Team Create service that executes Luau commands sent from a Studio client on the collaborative editing server and relays their output back to that client.
|
|
39896
|
+
* @returns An event that fires with the values the initiating Studio client passes each time it sends an update to the running command.
|
|
39247
39897
|
*/
|
|
39248
39898
|
GetReceivedUpdateSignal(this: RemoteCommandService): RBXScriptSignal;
|
|
39249
39899
|
/**
|
|
39900
|
+
* Returns a signal that fires on the server when the command that is currently executing is being stopped.
|
|
39901
|
+
*
|
|
39250
39902
|
* - **ThreadSafety**: Unsafe
|
|
39251
39903
|
*
|
|
39252
39904
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RemoteCommandService#GetStoppingSignal)
|
|
39253
|
-
* @param this
|
|
39905
|
+
* @param this Team Create service that executes Luau commands sent from a Studio client on the collaborative editing server and relays their output back to that client.
|
|
39906
|
+
* @returns An event that fires, with no arguments, when the running command is stopped.
|
|
39254
39907
|
*/
|
|
39255
39908
|
GetStoppingSignal(this: RemoteCommandService): RBXScriptSignal;
|
|
39256
39909
|
/**
|
|
39910
|
+
* Sends a set of values from the running command back to the Studio client that started it.
|
|
39911
|
+
*
|
|
39257
39912
|
* - **ThreadSafety**: Unsafe
|
|
39258
39913
|
*
|
|
39259
39914
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RemoteCommandService#SendUpdate)
|
|
39260
|
-
* @param this
|
|
39261
|
-
* @param args
|
|
39915
|
+
* @param this Team Create service that executes Luau commands sent from a Studio client on the collaborative editing server and relays their output back to that client.
|
|
39916
|
+
* @param args The values to deliver to the initiating Studio client.
|
|
39262
39917
|
*/
|
|
39263
39918
|
SendUpdate(this: RemoteCommandService, args: unknown): void;
|
|
39264
39919
|
}
|
|
@@ -39278,6 +39933,8 @@ interface RemoteCursorService extends Instance {
|
|
|
39278
39933
|
readonly _nominal_RemoteCursorService: unique symbol;
|
|
39279
39934
|
}
|
|
39280
39935
|
/**
|
|
39936
|
+
* Studio service that runs the server side of Luau remote debugging over DAP; not created during normal script execution.
|
|
39937
|
+
*
|
|
39281
39938
|
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
39282
39939
|
*
|
|
39283
39940
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RemoteDebuggerServer)
|
|
@@ -40228,6 +40885,8 @@ interface ScriptCommitService extends Instance {
|
|
|
40228
40885
|
readonly _nominal_ScriptCommitService: unique symbol;
|
|
40229
40886
|
}
|
|
40230
40887
|
/**
|
|
40888
|
+
* A service that manages the execution of all `BaseScript` objects.
|
|
40889
|
+
*
|
|
40231
40890
|
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
40232
40891
|
*
|
|
40233
40892
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScriptContext)
|
|
@@ -40242,18 +40901,23 @@ interface ScriptContext extends Instance {
|
|
|
40242
40901
|
*/
|
|
40243
40902
|
readonly _nominal_ScriptContext: unique symbol;
|
|
40244
40903
|
/**
|
|
40904
|
+
* Marks an instance and its descendant scripts for code-coverage tracking. Requires `PluginOrOpenCloud` security.
|
|
40905
|
+
*
|
|
40245
40906
|
* - **ThreadSafety**: Unsafe
|
|
40246
40907
|
*
|
|
40247
40908
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScriptContext#EnableCoverage)
|
|
40248
|
-
* @param this
|
|
40249
|
-
* @param instance
|
|
40909
|
+
* @param this A service that manages the execution of all `BaseScript` objects.
|
|
40910
|
+
* @param instance The instance to track; coverage is recorded for this instance and every script descended from it.
|
|
40250
40911
|
*/
|
|
40251
40912
|
EnableCoverage(this: ScriptContext, instance: Instance): void;
|
|
40252
40913
|
/**
|
|
40914
|
+
* Returns code-coverage statistics for scripts marked by `EnableCoverage()`. Requires `PluginOrOpenCloud` security.
|
|
40915
|
+
*
|
|
40253
40916
|
* - **ThreadSafety**: Unsafe
|
|
40254
40917
|
*
|
|
40255
40918
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScriptContext#GetCoverageStats)
|
|
40256
|
-
* @param this
|
|
40919
|
+
* @param this A service that manages the execution of all `BaseScript` objects.
|
|
40920
|
+
* @returns An array of per-script coverage tables, each with a `Script` field and a `GetHits` function for retrieving line and function hit counts.
|
|
40257
40921
|
*/
|
|
40258
40922
|
GetCoverageStats(this: ScriptContext): Array<unknown>;
|
|
40259
40923
|
/**
|
|
@@ -40283,6 +40947,8 @@ interface ScriptDebuggerService extends Instance {
|
|
|
40283
40947
|
readonly _nominal_ScriptDebuggerService: unique symbol;
|
|
40284
40948
|
}
|
|
40285
40949
|
/**
|
|
40950
|
+
* A service that captures sampling-based profiles of Luau script execution on the server or on a client.
|
|
40951
|
+
*
|
|
40286
40952
|
* - **Tags**: NotCreatable, Service
|
|
40287
40953
|
*
|
|
40288
40954
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScriptProfilerService)
|
|
@@ -40328,6 +40994,23 @@ interface ScriptRuntime extends Instance {
|
|
|
40328
40994
|
readonly _nominal_ScriptRuntime: unique symbol;
|
|
40329
40995
|
}
|
|
40330
40996
|
/**
|
|
40997
|
+
* - **Tags**: NotCreatable, Service
|
|
40998
|
+
*
|
|
40999
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScriptScannerService)
|
|
41000
|
+
*/
|
|
41001
|
+
interface ScriptScannerService extends Instance {
|
|
41002
|
+
/**
|
|
41003
|
+
* **DO NOT USE!**
|
|
41004
|
+
*
|
|
41005
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
41006
|
+
* @hidden
|
|
41007
|
+
* @deprecated
|
|
41008
|
+
*/
|
|
41009
|
+
readonly _nominal_ScriptScannerService: unique symbol;
|
|
41010
|
+
}
|
|
41011
|
+
/**
|
|
41012
|
+
* Studio service that draws selection outline highlights for the local user's selection and for Team Create collaborators' selections.
|
|
41013
|
+
*
|
|
40331
41014
|
* - **Tags**: NotCreatable, Service
|
|
40332
41015
|
*
|
|
40333
41016
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SelectionHighlightManager)
|
|
@@ -40369,6 +41052,8 @@ interface SensorBase extends Instance {
|
|
|
40369
41052
|
/**
|
|
40370
41053
|
* **Deprecated:** This method should not be used in new work.
|
|
40371
41054
|
*
|
|
41055
|
+
* Recomputes the sensor's output properties immediately.
|
|
41056
|
+
*
|
|
40372
41057
|
* - **ThreadSafety**: Unsafe
|
|
40373
41058
|
* - **Tags**:
|
|
40374
41059
|
*
|
|
@@ -40379,6 +41064,8 @@ interface SensorBase extends Instance {
|
|
|
40379
41064
|
*/
|
|
40380
41065
|
Sense(this: SensorBase): void;
|
|
40381
41066
|
/**
|
|
41067
|
+
* Fires when one of the sensor's output properties changes value.
|
|
41068
|
+
*
|
|
40382
41069
|
* - **ThreadSafety**: Unsafe
|
|
40383
41070
|
*
|
|
40384
41071
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SensorBase#OnSensorOutputChanged)
|
|
@@ -40450,6 +41137,8 @@ interface BuoyancySensor extends SensorBase {
|
|
|
40450
41137
|
TouchingSurface: boolean;
|
|
40451
41138
|
}
|
|
40452
41139
|
/**
|
|
41140
|
+
* An abstract base class for `SensorBase` types that supply sensory data to a character controller.
|
|
41141
|
+
*
|
|
40453
41142
|
* - **Tags**: NotCreatable
|
|
40454
41143
|
*
|
|
40455
41144
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ControllerSensor)
|
|
@@ -40495,12 +41184,16 @@ interface ControllerPartSensor extends ControllerSensor {
|
|
|
40495
41184
|
*/
|
|
40496
41185
|
HitNormal: Vector3;
|
|
40497
41186
|
/**
|
|
41187
|
+
* The upper bound, in studs, of the vertical region the sensor searches for a ladder when `ControllerPartSensor.SensorMode` is set to a ladder mode.
|
|
41188
|
+
*
|
|
40498
41189
|
* - **ThreadSafety**: ReadSafe
|
|
40499
41190
|
*
|
|
40500
41191
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ControllerPartSensor#LadderSearchHeight)
|
|
40501
41192
|
*/
|
|
40502
41193
|
LadderSearchHeight: number;
|
|
40503
41194
|
/**
|
|
41195
|
+
* The downward offset, in studs, that positions the vertical region the sensor searches for a ladder when `ControllerPartSensor.SensorMode` is set to a ladder mode.
|
|
41196
|
+
*
|
|
40504
41197
|
* - **ThreadSafety**: ReadSafe
|
|
40505
41198
|
*
|
|
40506
41199
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ControllerPartSensor#LadderSearchOffset)
|
|
@@ -40515,6 +41208,8 @@ interface ControllerPartSensor extends ControllerSensor {
|
|
|
40515
41208
|
*/
|
|
40516
41209
|
SearchDistance: number;
|
|
40517
41210
|
/**
|
|
41211
|
+
* The surface `Material` of the `ControllerPartSensor.SensedPart` that the sensor is currently detecting.
|
|
41212
|
+
*
|
|
40518
41213
|
* - **ThreadSafety**: ReadSafe
|
|
40519
41214
|
*
|
|
40520
41215
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ControllerPartSensor#SensedMaterial)
|
|
@@ -40687,7 +41382,8 @@ interface ServiceProvider<S = unknown> extends Instance {
|
|
|
40687
41382
|
*
|
|
40688
41383
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ServiceProvider#FindService)
|
|
40689
41384
|
* @param this A ServiceProvider is an abstract class, which stores, and provides certain singleton classes, depending on what inherited class you are using its members with.
|
|
40690
|
-
* @param className
|
|
41385
|
+
* @param className The class name of the service to find.
|
|
41386
|
+
* @returns The service instance if it has already been created, or nil if the service does not yet exist.
|
|
40691
41387
|
*/
|
|
40692
41388
|
FindService(this: ServiceProvider<S>, className: string): S[keyof S] | undefined;
|
|
40693
41389
|
FindService(this: ServiceProvider<S>, className: string): Instance | undefined;
|
|
@@ -41161,6 +41857,7 @@ interface SharedTableRegistry extends Instance {
|
|
|
41161
41857
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SharedTableRegistry#GetSharedTable)
|
|
41162
41858
|
* @param this Provides a global registry of named `SharedTable` objects.
|
|
41163
41859
|
* @param name The name of the registered `SharedTable`.
|
|
41860
|
+
* @returns The registered `SharedTable` with the specified name, or a newly created and registered `SharedTable` if no `SharedTable` was previously registered under that name.
|
|
41164
41861
|
*/
|
|
41165
41862
|
GetSharedTable(this: SharedTableRegistry, name: string): SharedTable;
|
|
41166
41863
|
/**
|
|
@@ -42614,6 +43311,8 @@ interface SoundService extends Instance {
|
|
|
42614
43311
|
*/
|
|
42615
43312
|
get CharacterSoundsUseNewApi(): Enum.RolloutState;
|
|
42616
43313
|
/**
|
|
43314
|
+
* Controls whether sound bends around corners globally when acoustic simulation is active.
|
|
43315
|
+
*
|
|
42617
43316
|
* - **ThreadSafety**: ReadSafe
|
|
42618
43317
|
*
|
|
42619
43318
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SoundService#DiffractionEnabled)
|
|
@@ -42660,6 +43359,8 @@ interface SoundService extends Instance {
|
|
|
42660
43359
|
*/
|
|
42661
43360
|
ListenerType: Enum.ListenerType;
|
|
42662
43361
|
/**
|
|
43362
|
+
* Controls whether sound is muffled through walls globally when acoustic simulation is active.
|
|
43363
|
+
*
|
|
42663
43364
|
* - **ThreadSafety**: ReadSafe
|
|
42664
43365
|
*
|
|
42665
43366
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SoundService#OcclusionEnabled)
|
|
@@ -42674,6 +43375,8 @@ interface SoundService extends Instance {
|
|
|
42674
43375
|
*/
|
|
42675
43376
|
RespectFilteringEnabled: boolean;
|
|
42676
43377
|
/**
|
|
43378
|
+
* Controls whether sound receives environmental reverb globally when acoustic simulation is active.
|
|
43379
|
+
*
|
|
42677
43380
|
* - **ThreadSafety**: ReadSafe
|
|
42678
43381
|
*
|
|
42679
43382
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SoundService#ReverbEnabled)
|
|
@@ -42721,7 +43424,7 @@ interface SoundService extends Instance {
|
|
|
42721
43424
|
*
|
|
42722
43425
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SoundService#GetMixerTime)
|
|
42723
43426
|
* @param this A service that determines various aspects of how the audio engine works. Most of its properties affect how `Sounds` play in the experience.
|
|
42724
|
-
* @returns The number of seconds since the audio engine began mixing. This value is stable, sample-accurate, and monotonically-increasing
|
|
43427
|
+
* @returns The number of seconds since the audio engine began mixing. This value is stable, sample-accurate, and monotonically-increasing. It's intended to be used for scheduling audible changes at precise times.
|
|
42725
43428
|
*/
|
|
42726
43429
|
GetMixerTime(this: SoundService): number;
|
|
42727
43430
|
/**
|
|
@@ -43377,17 +44080,23 @@ interface Stats extends Instance {
|
|
|
43377
44080
|
*/
|
|
43378
44081
|
readonly UI3DTriangleCount: number;
|
|
43379
44082
|
/**
|
|
44083
|
+
* Internal-only. Returns the engine's current dynamic-quality level as a score normalized from `0` to `100`.
|
|
44084
|
+
*
|
|
43380
44085
|
* - **ThreadSafety**: Unsafe
|
|
43381
44086
|
*
|
|
43382
44087
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Stats#GetHarmonyQualityLevel)
|
|
43383
44088
|
* @param this Performance metrics for a game.
|
|
44089
|
+
* @returns The current dynamic-quality level, normalized from `0` (lowest quality) to `100` (highest quality).
|
|
43384
44090
|
*/
|
|
43385
44091
|
GetHarmonyQualityLevel(this: Stats): number;
|
|
43386
44092
|
/**
|
|
44093
|
+
* Internal-only. Returns an array of the names of every developer memory category the engine tracks.
|
|
44094
|
+
*
|
|
43387
44095
|
* - **ThreadSafety**: Unsafe
|
|
43388
44096
|
*
|
|
43389
44097
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Stats#GetMemoryCategoryNames)
|
|
43390
44098
|
* @param this Performance metrics for a game.
|
|
44099
|
+
* @returns An array of strings, one per tracked memory category, ordered to match the values returned by `Stats:GetMemoryUsageMbAllCategories()`.
|
|
43391
44100
|
*/
|
|
43392
44101
|
GetMemoryCategoryNames(this: Stats): Array<unknown>;
|
|
43393
44102
|
/**
|
|
@@ -43397,6 +44106,7 @@ interface Stats extends Instance {
|
|
|
43397
44106
|
*
|
|
43398
44107
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Stats#GetMemoryUsageMbAllCategories)
|
|
43399
44108
|
* @param this Performance metrics for a game.
|
|
44109
|
+
* @returns An array of numbers in which each entry is the memory, in megabytes, consumed by one memory category, ordered to match the categories returned by `Stats:GetMemoryCategoryNames()`. Returns an empty array if `MemoryTrackingEnabled` is `false`.
|
|
43400
44110
|
*/
|
|
43401
44111
|
GetMemoryUsageMbAllCategories(this: Stats): Array<unknown>;
|
|
43402
44112
|
/**
|
|
@@ -43406,7 +44116,8 @@ interface Stats extends Instance {
|
|
|
43406
44116
|
*
|
|
43407
44117
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Stats#GetMemoryUsageMbForTag)
|
|
43408
44118
|
* @param this Performance metrics for a game.
|
|
43409
|
-
* @param tag
|
|
44119
|
+
* @param tag The `DeveloperMemoryTag` memory category to measure.
|
|
44120
|
+
* @returns The memory, in megabytes, consumed by the given `DeveloperMemoryTag` category, or `0` if `MemoryTrackingEnabled` is `false`.
|
|
43410
44121
|
*/
|
|
43411
44122
|
GetMemoryUsageMbForTag(this: Stats, tag: CastsToEnum<Enum.DeveloperMemoryTag>): number;
|
|
43412
44123
|
/**
|
|
@@ -43416,9 +44127,12 @@ interface Stats extends Instance {
|
|
|
43416
44127
|
*
|
|
43417
44128
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Stats#GetTotalMemoryUsageMb)
|
|
43418
44129
|
* @param this Performance metrics for a game.
|
|
44130
|
+
* @returns The total memory, in megabytes, used by the current game session, as reported by the operating system.
|
|
43419
44131
|
*/
|
|
43420
44132
|
GetTotalMemoryUsageMb(this: Stats): number;
|
|
43421
44133
|
/**
|
|
44134
|
+
* Internal-only. Restores the performance-control system's memory budget to the values in effect before `Stats:SetHarmonyMemoryTarget()` was called.
|
|
44135
|
+
*
|
|
43422
44136
|
* - **ThreadSafety**: Unsafe
|
|
43423
44137
|
*
|
|
43424
44138
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Stats#ResetHarmonyMemoryTarget)
|
|
@@ -43426,11 +44140,13 @@ interface Stats extends Instance {
|
|
|
43426
44140
|
*/
|
|
43427
44141
|
ResetHarmonyMemoryTarget(this: Stats): void;
|
|
43428
44142
|
/**
|
|
44143
|
+
* Internal-only. Overrides the performance-control system's memory budget with a target value, in megabytes, for testing.
|
|
44144
|
+
*
|
|
43429
44145
|
* - **ThreadSafety**: Unsafe
|
|
43430
44146
|
*
|
|
43431
44147
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Stats#SetHarmonyMemoryTarget)
|
|
43432
44148
|
* @param this Performance metrics for a game.
|
|
43433
|
-
* @param targetMB
|
|
44149
|
+
* @param targetMB The memory budget to impose on the performance-control system, in megabytes.
|
|
43434
44150
|
*/
|
|
43435
44151
|
SetHarmonyMemoryTarget(this: Stats, targetMB: number): void;
|
|
43436
44152
|
}
|
|
@@ -43903,6 +44619,8 @@ interface StyleRule extends StyleBase {
|
|
|
43903
44619
|
*/
|
|
43904
44620
|
SetProperties(this: StyleRule, styleProperties: object): void;
|
|
43905
44621
|
/**
|
|
44622
|
+
* Sets or updates a single property of the `StyleRule`.
|
|
44623
|
+
*
|
|
43906
44624
|
* - **ThreadSafety**: Unsafe
|
|
43907
44625
|
*
|
|
43908
44626
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StyleRule#SetProperty)
|
|
@@ -44132,6 +44850,8 @@ interface SurfaceAppearance extends Instance {
|
|
|
44132
44850
|
*/
|
|
44133
44851
|
Color: Color3;
|
|
44134
44852
|
/**
|
|
44853
|
+
* `Content` object that determines the color and opacity of the surface.
|
|
44854
|
+
*
|
|
44135
44855
|
* - **ThreadSafety**: ReadSafe
|
|
44136
44856
|
* - **Tags**: Hidden
|
|
44137
44857
|
*
|
|
@@ -44163,6 +44883,8 @@ interface SurfaceAppearance extends Instance {
|
|
|
44163
44883
|
*/
|
|
44164
44884
|
EmissiveTint: Color3;
|
|
44165
44885
|
/**
|
|
44886
|
+
* `Content` object that determines which parts of the surface are metal or non-metal.
|
|
44887
|
+
*
|
|
44166
44888
|
* - **ThreadSafety**: ReadSafe
|
|
44167
44889
|
* - **Tags**: Hidden
|
|
44168
44890
|
*
|
|
@@ -44170,6 +44892,8 @@ interface SurfaceAppearance extends Instance {
|
|
|
44170
44892
|
*/
|
|
44171
44893
|
get MetalnessMapContent(): Content;
|
|
44172
44894
|
/**
|
|
44895
|
+
* `Content` object that modifies the lighting of the surface by adding bumps, dents, cracks, and curves.
|
|
44896
|
+
*
|
|
44173
44897
|
* - **ThreadSafety**: ReadSafe
|
|
44174
44898
|
* - **Tags**: Hidden
|
|
44175
44899
|
*
|
|
@@ -44177,12 +44901,16 @@ interface SurfaceAppearance extends Instance {
|
|
|
44177
44901
|
*/
|
|
44178
44902
|
get NormalMapContent(): Content;
|
|
44179
44903
|
/**
|
|
44904
|
+
* Selects the texture resampling mode used for the surface's texture maps.
|
|
44905
|
+
*
|
|
44180
44906
|
* - **ThreadSafety**: ReadSafe
|
|
44181
44907
|
*
|
|
44182
44908
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SurfaceAppearance#ResampleMode)
|
|
44183
44909
|
*/
|
|
44184
44910
|
ResampleMode: Enum.ResamplerMode;
|
|
44185
44911
|
/**
|
|
44912
|
+
* `Content` object that determines the apparent roughness across the surface.
|
|
44913
|
+
*
|
|
44186
44914
|
* - **ThreadSafety**: ReadSafe
|
|
44187
44915
|
* - **Tags**: Hidden
|
|
44188
44916
|
*
|
|
@@ -44469,6 +45197,7 @@ interface TeleportOptions extends Instance {
|
|
|
44469
45197
|
*
|
|
44470
45198
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TeleportOptions#GetTeleportData)
|
|
44471
45199
|
* @param this Optional input arguments to the `TeleportService:TeleportAsync()` function.
|
|
45200
|
+
* @returns The teleport data previously stored by `TeleportOptions:SetTeleportData()`, or nil if no data was set.
|
|
44472
45201
|
*/
|
|
44473
45202
|
GetTeleportData(this: TeleportOptions): unknown;
|
|
44474
45203
|
/**
|
|
@@ -44580,6 +45309,7 @@ interface TeleportService extends Instance {
|
|
|
44580
45309
|
* Teleports a `Player` to the server instance associated with the given *placeId* and *instanceId*.
|
|
44581
45310
|
*
|
|
44582
45311
|
* - **ThreadSafety**: Unsafe
|
|
45312
|
+
* - **Tags**:
|
|
44583
45313
|
*
|
|
44584
45314
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TeleportService#TeleportToPlaceInstance)
|
|
44585
45315
|
* @param this Enables transporting `Players` between places and servers. For more information on how to teleport players between servers, see [Teleport between places](../../../projects/teleport.md).
|
|
@@ -44589,12 +45319,15 @@ interface TeleportService extends Instance {
|
|
|
44589
45319
|
* @param spawnName Optional name of the `SpawnLocation` to spawn at.
|
|
44590
45320
|
* @param teleportData Optional data to be passed to the destination place. Can be retrieved using `TeleportService:GetLocalPlayerTeleportData()`.
|
|
44591
45321
|
* @param customLoadingScreen Optional custom loading screen to be placed in the `CoreGui` at the destination place. Can be retrieved using `TeleportService:GetArrivingTeleportGui()`.
|
|
45322
|
+
*
|
|
45323
|
+
* @deprecated TeleportAsync
|
|
44592
45324
|
*/
|
|
44593
45325
|
TeleportToPlaceInstance(this: TeleportService, placeId: number, instanceId: string, player?: Player, spawnName?: string, teleportData?: TeleportData, customLoadingScreen?: ScreenGui): void;
|
|
44594
45326
|
/**
|
|
44595
45327
|
* Teleport a group of `Players` to a reserved server created using `TeleportService:ReserveServerAsync()`.
|
|
44596
45328
|
*
|
|
44597
45329
|
* - **ThreadSafety**: Unsafe
|
|
45330
|
+
* - **Tags**:
|
|
44598
45331
|
*
|
|
44599
45332
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TeleportService#TeleportToPrivateServer)
|
|
44600
45333
|
* @param this Enables transporting `Players` between places and servers. For more information on how to teleport players between servers, see [Teleport between places](../../../projects/teleport.md).
|
|
@@ -44604,12 +45337,15 @@ interface TeleportService extends Instance {
|
|
|
44604
45337
|
* @param spawnName Optional name of the `SpawnLocation` to spawn at.
|
|
44605
45338
|
* @param teleportData Optional data to be passed to the destination place. Can be retrieved using `TeleportService:GetLocalPlayerTeleportData()`.
|
|
44606
45339
|
* @param customLoadingScreen Optional custom loading screen to be placed in the `CoreGui` at the destination place. Can be retrieved using `TeleportService:GetArrivingTeleportGui()`.
|
|
45340
|
+
*
|
|
45341
|
+
* @deprecated TeleportAsync
|
|
44607
45342
|
*/
|
|
44608
45343
|
TeleportToPrivateServer(this: TeleportService, placeId: number, reservedServerAccessCode: string, players: Array<Player>, spawnName?: string, teleportData?: TeleportData, customLoadingScreen?: ScreenGui): void;
|
|
44609
45344
|
/**
|
|
44610
45345
|
* A variant of `TeleportService:Teleport()` that causes the `Player` to spawn at a `SpawnLocation` of the given name at the destination place.
|
|
44611
45346
|
*
|
|
44612
45347
|
* - **ThreadSafety**: Unsafe
|
|
45348
|
+
* - **Tags**:
|
|
44613
45349
|
*
|
|
44614
45350
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TeleportService#TeleportToSpawnByName)
|
|
44615
45351
|
* @param this Enables transporting `Players` between places and servers. For more information on how to teleport players between servers, see [Teleport between places](../../../projects/teleport.md).
|
|
@@ -44618,6 +45354,8 @@ interface TeleportService extends Instance {
|
|
|
44618
45354
|
* @param player The `Player` to teleport, if this function is being called from the client this defaults to the `Players.LocalPlayer`.
|
|
44619
45355
|
* @param teleportData Optional data to be passed to the destination place. Can be retrieved using `TeleportService:GetLocalPlayerTeleportData()`.
|
|
44620
45356
|
* @param customLoadingScreen Optional custom loading screen to be placed in the `CoreGui` at the destination place. Can be retrieved using `TeleportService:GetArrivingTeleportGui()`.
|
|
45357
|
+
*
|
|
45358
|
+
* @deprecated TeleportAsync
|
|
44621
45359
|
*/
|
|
44622
45360
|
TeleportToSpawnByName(this: TeleportService, placeId: number, spawnName: string, player?: Player, teleportData?: TeleportData, customLoadingScreen?: ScreenGui): void;
|
|
44623
45361
|
/**
|
|
@@ -44708,6 +45446,8 @@ interface TeleportService extends Instance {
|
|
|
44708
45446
|
* @param teleportData Optional data to be passed to the destination place. Can be retrieved using `TeleportService:GetLocalPlayerTeleportData()`.
|
|
44709
45447
|
* @param customLoadingScreen Optional custom loading screen to be placed in the `CoreGui` at the destination place. Can be retrieved using `TeleportService:GetArrivingTeleportGui()`.
|
|
44710
45448
|
* @returns The `DataModel.JobId` of the server instance the `Players` were teleported to.
|
|
45449
|
+
*
|
|
45450
|
+
* @deprecated TeleportAsync
|
|
44711
45451
|
*/
|
|
44712
45452
|
TeleportPartyAsync(this: TeleportService, placeId: number, players: Array<Player>, teleportData?: TeleportData, customLoadingScreen?: ScreenGui): string;
|
|
44713
45453
|
/**
|
|
@@ -45033,10 +45773,10 @@ interface TestService extends Instance {
|
|
|
45033
45773
|
*
|
|
45034
45774
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TestService#Check)
|
|
45035
45775
|
* @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.
|
|
45036
|
-
* @param condition
|
|
45037
|
-
* @param description
|
|
45038
|
-
* @param source
|
|
45039
|
-
* @param line
|
|
45776
|
+
* @param condition The boolean expression to evaluate as the test assertion.
|
|
45777
|
+
* @param description A label that identifies this check in the test output.
|
|
45778
|
+
* @param source The script instance that invoked the check, used for output attribution. Defaults to `nil`.
|
|
45779
|
+
* @param line The line number in the source script where the check was called. Defaults to `0`.
|
|
45040
45780
|
*/
|
|
45041
45781
|
Check(this: TestService, condition: boolean, description: string, source?: Instance, line?: number): void;
|
|
45042
45782
|
/**
|
|
@@ -45046,9 +45786,9 @@ interface TestService extends Instance {
|
|
|
45046
45786
|
*
|
|
45047
45787
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TestService#Checkpoint)
|
|
45048
45788
|
* @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.
|
|
45049
|
-
* @param text
|
|
45050
|
-
* @param source
|
|
45051
|
-
* @param line
|
|
45789
|
+
* @param text The message to print alongside the checkpoint label.
|
|
45790
|
+
* @param source The script instance that invoked the checkpoint, used for output attribution. Defaults to `nil`.
|
|
45791
|
+
* @param line The line number in the source script where the checkpoint was called. Defaults to `0`.
|
|
45052
45792
|
*/
|
|
45053
45793
|
Checkpoint(this: TestService, text: string, source?: Instance, line?: number): void;
|
|
45054
45794
|
/**
|
|
@@ -45067,9 +45807,9 @@ interface TestService extends Instance {
|
|
|
45067
45807
|
*
|
|
45068
45808
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TestService#Error)
|
|
45069
45809
|
* @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.
|
|
45070
|
-
* @param description
|
|
45071
|
-
* @param source
|
|
45072
|
-
* @param line
|
|
45810
|
+
* @param description The error message text to display.
|
|
45811
|
+
* @param source The script instance that raised the error, used for output attribution. Defaults to `nil`.
|
|
45812
|
+
* @param line The line number in the source script where the error was raised. Defaults to `0`.
|
|
45073
45813
|
*/
|
|
45074
45814
|
Error(this: TestService, description: string, source?: Instance, line?: number): void;
|
|
45075
45815
|
/**
|
|
@@ -45079,9 +45819,9 @@ interface TestService extends Instance {
|
|
|
45079
45819
|
*
|
|
45080
45820
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TestService#Fail)
|
|
45081
45821
|
* @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.
|
|
45082
|
-
* @param description
|
|
45083
|
-
* @param source
|
|
45084
|
-
* @param line
|
|
45822
|
+
* @param description The failure message text to display.
|
|
45823
|
+
* @param source The script instance where the failure occurred, used for output attribution. Defaults to `nil`.
|
|
45824
|
+
* @param line The line number in the source script where the failure was triggered. Defaults to `0`.
|
|
45085
45825
|
*/
|
|
45086
45826
|
Fail(this: TestService, description: string, source?: Instance, line?: number): void;
|
|
45087
45827
|
/**
|
|
@@ -45103,17 +45843,20 @@ interface TestService extends Instance {
|
|
|
45103
45843
|
*
|
|
45104
45844
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TestService#Message)
|
|
45105
45845
|
* @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.
|
|
45106
|
-
* @param text
|
|
45107
|
-
* @param source
|
|
45108
|
-
* @param line
|
|
45846
|
+
* @param text The message to print to the output.
|
|
45847
|
+
* @param source The script instance that sent the message, used for output attribution. Defaults to `nil`.
|
|
45848
|
+
* @param line The line number in the source script where the message was sent. Defaults to `0`.
|
|
45109
45849
|
*/
|
|
45110
45850
|
Message(this: TestService, text: string, source?: Instance, line?: number): void;
|
|
45111
45851
|
/**
|
|
45852
|
+
* Registers a test case with the service and returns the resulting `TestCase`.
|
|
45853
|
+
*
|
|
45112
45854
|
* - **ThreadSafety**: Unsafe
|
|
45113
45855
|
*
|
|
45114
45856
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TestService#RegisterTest)
|
|
45115
45857
|
* @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.
|
|
45116
|
-
* @param testOptions
|
|
45858
|
+
* @param testOptions A dictionary describing the test, requiring the string fields `SuiteName` and `TestCaseName` and optionally a numeric `Timeout` field.
|
|
45859
|
+
* @returns The registered `TestCase`, or no value when registration isn't supported in the current context.
|
|
45117
45860
|
*/
|
|
45118
45861
|
RegisterTest(this: TestService, testOptions: object): TestCase;
|
|
45119
45862
|
/**
|
|
@@ -45129,10 +45872,10 @@ interface TestService extends Instance {
|
|
|
45129
45872
|
*
|
|
45130
45873
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TestService#Require)
|
|
45131
45874
|
* @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.
|
|
45132
|
-
* @param condition
|
|
45133
|
-
* @param description
|
|
45134
|
-
* @param source
|
|
45135
|
-
* @param line
|
|
45875
|
+
* @param condition The boolean expression to evaluate as a required assertion.
|
|
45876
|
+
* @param description A label that identifies this requirement in the test output.
|
|
45877
|
+
* @param source The script instance that invoked the requirement, used for output attribution. Defaults to `nil`.
|
|
45878
|
+
* @param line The line number in the source script where the requirement was called. Defaults to `0`.
|
|
45136
45879
|
*/
|
|
45137
45880
|
Require(this: TestService, condition: boolean, description: string, source?: Instance, line?: number): void;
|
|
45138
45881
|
/**
|
|
@@ -45142,10 +45885,13 @@ interface TestService extends Instance {
|
|
|
45142
45885
|
*/
|
|
45143
45886
|
ResetTestControl(this: TestService, providerName: string, controlName: string): void;
|
|
45144
45887
|
/**
|
|
45888
|
+
* Returns a dictionary of per-scope physics simulation timings for performance testing.
|
|
45889
|
+
*
|
|
45145
45890
|
* - **ThreadSafety**: Unsafe
|
|
45146
45891
|
*
|
|
45147
45892
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TestService#ScopeTime)
|
|
45148
45893
|
* @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.
|
|
45894
|
+
* @returns A dictionary mapping physics simulation scopes to their measured step times.
|
|
45149
45895
|
*/
|
|
45150
45896
|
ScopeTime(this: TestService): object;
|
|
45151
45897
|
/**
|
|
@@ -45167,12 +45913,14 @@ interface TestService extends Instance {
|
|
|
45167
45913
|
*/
|
|
45168
45914
|
StopTestSession(this: TestService): void;
|
|
45169
45915
|
/**
|
|
45916
|
+
* Captures a named screenshot snapshot during a test run.
|
|
45917
|
+
*
|
|
45170
45918
|
* - **ThreadSafety**: Unsafe
|
|
45171
45919
|
*
|
|
45172
45920
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TestService#TakeSnapshot)
|
|
45173
45921
|
* @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.
|
|
45174
|
-
* @param snapshotname
|
|
45175
|
-
* @param source
|
|
45922
|
+
* @param snapshotname The name to associate with the captured snapshot.
|
|
45923
|
+
* @param source An optional script instance whose `Suite` and `TestName` attributes name the snapshot; defaults to `nil`.
|
|
45176
45924
|
*/
|
|
45177
45925
|
TakeSnapshot(this: TestService, snapshotname: string, source?: Instance): void;
|
|
45178
45926
|
/**
|
|
@@ -45182,10 +45930,10 @@ interface TestService extends Instance {
|
|
|
45182
45930
|
*
|
|
45183
45931
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TestService#Warn)
|
|
45184
45932
|
* @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.
|
|
45185
|
-
* @param condition
|
|
45186
|
-
* @param description
|
|
45187
|
-
* @param source
|
|
45188
|
-
* @param line
|
|
45933
|
+
* @param condition The boolean expression to evaluate as the warning assertion.
|
|
45934
|
+
* @param description A label that identifies this warning check in the test output.
|
|
45935
|
+
* @param source The script instance that invoked the warning, used for output attribution. Defaults to `nil`.
|
|
45936
|
+
* @param line The line number in the source script where the warning was called. Defaults to `0`.
|
|
45189
45937
|
*/
|
|
45190
45938
|
Warn(this: TestService, condition: boolean, description: string, source?: Instance, line?: number): void;
|
|
45191
45939
|
/**
|
|
@@ -45195,11 +45943,14 @@ interface TestService extends Instance {
|
|
|
45195
45943
|
*/
|
|
45196
45944
|
getTestSessionProviderStats(this: TestService, providerName: string): object;
|
|
45197
45945
|
/**
|
|
45946
|
+
* Returns whether the named feature identified by `name` is currently enabled.
|
|
45947
|
+
*
|
|
45198
45948
|
* - **ThreadSafety**: Unsafe
|
|
45199
45949
|
*
|
|
45200
45950
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TestService#isFeatureEnabled)
|
|
45201
45951
|
* @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.
|
|
45202
|
-
* @param name
|
|
45952
|
+
* @param name The name of the feature to query.
|
|
45953
|
+
* @returns `true` if the named feature resolves to `true`, `false` otherwise.
|
|
45203
45954
|
*/
|
|
45204
45955
|
isFeatureEnabled(this: TestService, name: string): boolean;
|
|
45205
45956
|
/**
|
|
@@ -46423,6 +47174,8 @@ interface TextChatService extends Instance {
|
|
|
46423
47174
|
OnIncomingMessage: (message: TextChatMessage) => TextChatMessageProperties | undefined;
|
|
46424
47175
|
}
|
|
46425
47176
|
/**
|
|
47177
|
+
* Represents the result of a call to `TextService:FilterStringAsync()`, used to distribute a filtered string accordingly.
|
|
47178
|
+
*
|
|
46426
47179
|
* - **Tags**: NotCreatable, NotReplicated
|
|
46427
47180
|
*
|
|
46428
47181
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TextFilterResult)
|
|
@@ -46445,7 +47198,7 @@ interface TextFilterResult extends Instance {
|
|
|
46445
47198
|
* - **Tags**: Yields
|
|
46446
47199
|
*
|
|
46447
47200
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TextFilterResult#GetChatForUserAsync)
|
|
46448
|
-
* @param this
|
|
47201
|
+
* @param this Represents the result of a call to `TextService:FilterStringAsync()`, used to distribute a filtered string accordingly.
|
|
46449
47202
|
* @param toUserId `Player.UserId` of the user being chatted.
|
|
46450
47203
|
* @returns Filtered text string.
|
|
46451
47204
|
*
|
|
@@ -46459,7 +47212,7 @@ interface TextFilterResult extends Instance {
|
|
|
46459
47212
|
* - **Tags**: Yields
|
|
46460
47213
|
*
|
|
46461
47214
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TextFilterResult#GetNonChatStringForBroadcastAsync)
|
|
46462
|
-
* @param this
|
|
47215
|
+
* @param this Represents the result of a call to `TextService:FilterStringAsync()`, used to distribute a filtered string accordingly.
|
|
46463
47216
|
* @returns Filtered text string.
|
|
46464
47217
|
*/
|
|
46465
47218
|
GetNonChatStringForBroadcastAsync(this: TextFilterResult): string;
|
|
@@ -46470,13 +47223,15 @@ interface TextFilterResult extends Instance {
|
|
|
46470
47223
|
* - **Tags**: Yields
|
|
46471
47224
|
*
|
|
46472
47225
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TextFilterResult#GetNonChatStringForUserAsync)
|
|
46473
|
-
* @param this
|
|
47226
|
+
* @param this Represents the result of a call to `TextService:FilterStringAsync()`, used to distribute a filtered string accordingly.
|
|
46474
47227
|
* @param toUserId `Player.UserId` of the user intended to see/receive the text.
|
|
46475
47228
|
* @returns Filtered text string.
|
|
46476
47229
|
*/
|
|
46477
47230
|
GetNonChatStringForUserAsync(this: TextFilterResult, toUserId: number): string;
|
|
46478
47231
|
}
|
|
46479
47232
|
/**
|
|
47233
|
+
* Holds the filtered source text and its filtered translations produced by `TextService:FilterAndTranslateStringAsync()`.
|
|
47234
|
+
*
|
|
46480
47235
|
* - **Tags**: NotCreatable, NotReplicated
|
|
46481
47236
|
*
|
|
46482
47237
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TextFilterTranslatedResult)
|
|
@@ -46491,6 +47246,8 @@ interface TextFilterTranslatedResult extends Instance {
|
|
|
46491
47246
|
*/
|
|
46492
47247
|
readonly _nominal_TextFilterTranslatedResult: unique symbol;
|
|
46493
47248
|
/**
|
|
47249
|
+
* The language of the original text that was filtered.
|
|
47250
|
+
*
|
|
46494
47251
|
* - **ThreadSafety**: ReadSafe
|
|
46495
47252
|
* - **Tags**: NotReplicated
|
|
46496
47253
|
*
|
|
@@ -46498,6 +47255,8 @@ interface TextFilterTranslatedResult extends Instance {
|
|
|
46498
47255
|
*/
|
|
46499
47256
|
readonly SourceLanguage: string;
|
|
46500
47257
|
/**
|
|
47258
|
+
* The filtered form of the original, untranslated text.
|
|
47259
|
+
*
|
|
46501
47260
|
* - **ThreadSafety**: ReadSafe
|
|
46502
47261
|
* - **Tags**: NotReplicated
|
|
46503
47262
|
*
|
|
@@ -46505,18 +47264,24 @@ interface TextFilterTranslatedResult extends Instance {
|
|
|
46505
47264
|
*/
|
|
46506
47265
|
readonly SourceText: TextFilterResult | undefined;
|
|
46507
47266
|
/**
|
|
47267
|
+
* Returns the filtered translation of the source text for the given locale.
|
|
47268
|
+
*
|
|
46508
47269
|
* - **ThreadSafety**: Unsafe
|
|
46509
47270
|
*
|
|
46510
47271
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TextFilterTranslatedResult#GetTranslationForLocale)
|
|
46511
|
-
* @param this
|
|
46512
|
-
* @param locale
|
|
47272
|
+
* @param this Holds the filtered source text and its filtered translations produced by `TextService:FilterAndTranslateStringAsync()`.
|
|
47273
|
+
* @param locale The locale identifier of the translation to retrieve.
|
|
47274
|
+
* @returns The filtered `TextFilterResult` for the requested locale, or `nil` if the result contains no translation for it.
|
|
46513
47275
|
*/
|
|
46514
47276
|
GetTranslationForLocale(this: TextFilterTranslatedResult, locale: string): TextFilterResult;
|
|
46515
47277
|
/**
|
|
47278
|
+
* Returns all filtered translations of the source text, keyed by language.
|
|
47279
|
+
*
|
|
46516
47280
|
* - **ThreadSafety**: Unsafe
|
|
46517
47281
|
*
|
|
46518
47282
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TextFilterTranslatedResult#GetTranslations)
|
|
46519
|
-
* @param this
|
|
47283
|
+
* @param this Holds the filtered source text and its filtered translations produced by `TextService:FilterAndTranslateStringAsync()`.
|
|
47284
|
+
* @returns A dictionary mapping each translation's language string to its filtered `TextFilterResult`.
|
|
46520
47285
|
*/
|
|
46521
47286
|
GetTranslations(this: TextFilterTranslatedResult): object;
|
|
46522
47287
|
}
|
|
@@ -46634,6 +47399,7 @@ interface TextService extends Instance {
|
|
|
46634
47399
|
* @param stringToFilter The text to be filtered.
|
|
46635
47400
|
* @param fromUserId The `Player.UserId` of the player filtering the text.
|
|
46636
47401
|
* @param textContext The context that the filtered message will be used in. This parameter does not impact the filtered result of the query and is only used to improve Roblox's text filtering.
|
|
47402
|
+
* @returns A `TextFilterResult` that wraps the filtered text and exposes methods for retrieving it in the form appropriate for each audience.
|
|
46637
47403
|
*/
|
|
46638
47404
|
FilterStringAsync(this: TextService, stringToFilter: string, fromUserId: number, textContext?: CastsToEnum<Enum.TextFilterContext>): TextFilterResult;
|
|
46639
47405
|
/**
|
|
@@ -46668,8 +47434,9 @@ interface TextService extends Instance {
|
|
|
46668
47434
|
*
|
|
46669
47435
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TextService#GetTextSizeOffsetAsync)
|
|
46670
47436
|
* @param this Service internally responsible for handling the display of text.
|
|
46671
|
-
* @param fontSize
|
|
46672
|
-
* @param font
|
|
47437
|
+
* @param fontSize The font size, in offsets. This parameter currently does not affect the returned offset.
|
|
47438
|
+
* @param font The font. This parameter currently does not affect the returned offset.
|
|
47439
|
+
* @returns The offset, in pixels, to add to the height of a `TextLabel` or `TextButton` to up-scale it for the player's current `PreferredTextSize` setting.
|
|
46673
47440
|
*/
|
|
46674
47441
|
GetTextSizeOffsetAsync(this: TextService, fontSize: number, font: Font): number;
|
|
46675
47442
|
}
|
|
@@ -47091,6 +47858,7 @@ interface Translator extends Instance {
|
|
|
47091
47858
|
* @param this The role of a Translator is to manufacture/return strings localized for the viewing player.
|
|
47092
47859
|
* @param key The **Key** value to look up and translate.
|
|
47093
47860
|
* @param args To be provided if the **Source** text and translations contain format strings. Will be a Luau table of values **or** key-value pairs, depending on whether the format strings are numbered or named.
|
|
47861
|
+
* @returns The localized text string associated with the given **key**, with any format parameters filled in from **args**.
|
|
47094
47862
|
*/
|
|
47095
47863
|
FormatByKey(this: Translator, key: string, args: unknown): string;
|
|
47096
47864
|
/**
|
|
@@ -47241,6 +48009,7 @@ interface TweenService extends Instance {
|
|
|
47241
48009
|
* @param instance The `Instance` whose properties are to be tweened.
|
|
47242
48010
|
* @param tweenInfo The `TweenInfo` to be used.
|
|
47243
48011
|
* @param propertyTable A dictionary of properties, and their target values, to be tweened.
|
|
48012
|
+
* @returns The newly created `Tween` configured to interpolate the given properties toward their target values. Call `TweenBase:Play()` on the returned object to start the tween.
|
|
47244
48013
|
*/
|
|
47245
48014
|
Create<T extends Instance>(this: TweenService, instance: T, tweenInfo: TweenInfo, propertyTable: Partial<ExtractMembers<T, Tweenable>>): Tween;
|
|
47246
48015
|
/**
|
|
@@ -48109,6 +48878,8 @@ interface UIListLayout extends UIGridStyleLayout {
|
|
|
48109
48878
|
Wraps: boolean;
|
|
48110
48879
|
}
|
|
48111
48880
|
/**
|
|
48881
|
+
* Positions sibling UI elements as full-size pages in a single row or column that users can scroll or animate through one page at a time.
|
|
48882
|
+
*
|
|
48112
48883
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UIPageLayout)
|
|
48113
48884
|
*/
|
|
48114
48885
|
interface UIPageLayout extends UIGridStyleLayout {
|
|
@@ -48207,18 +48978,18 @@ interface UIPageLayout extends UIGridStyleLayout {
|
|
|
48207
48978
|
* - **ThreadSafety**: Unsafe
|
|
48208
48979
|
*
|
|
48209
48980
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UIPageLayout#JumpTo)
|
|
48210
|
-
* @param this
|
|
48211
|
-
* @param page
|
|
48981
|
+
* @param this Positions sibling UI elements as full-size pages in a single row or column that users can scroll or animate through one page at a time.
|
|
48982
|
+
* @param page The `GuiObject` sibling to navigate to.
|
|
48212
48983
|
*/
|
|
48213
48984
|
JumpTo(this: UIPageLayout, page: GuiObject): void;
|
|
48214
48985
|
/**
|
|
48215
|
-
* If the index is `>= 0` and less than the size of the layout, this method acts like `UIPageLayout:JumpTo()`.
|
|
48986
|
+
* If the index is `>= 0` and less than the size of the layout, this method acts like `UIPageLayout:JumpTo()`. Out-of-bounds indices are wrapped modulo the page count to determine the target page.
|
|
48216
48987
|
*
|
|
48217
48988
|
* - **ThreadSafety**: Unsafe
|
|
48218
48989
|
*
|
|
48219
48990
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UIPageLayout#JumpToIndex)
|
|
48220
|
-
* @param this
|
|
48221
|
-
* @param index
|
|
48991
|
+
* @param this Positions sibling UI elements as full-size pages in a single row or column that users can scroll or animate through one page at a time.
|
|
48992
|
+
* @param index The zero-based position of the target page in layout order.
|
|
48222
48993
|
*/
|
|
48223
48994
|
JumpToIndex(this: UIPageLayout, index: number): void;
|
|
48224
48995
|
/**
|
|
@@ -48227,7 +48998,7 @@ interface UIPageLayout extends UIGridStyleLayout {
|
|
|
48227
48998
|
* - **ThreadSafety**: Unsafe
|
|
48228
48999
|
*
|
|
48229
49000
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UIPageLayout#Next)
|
|
48230
|
-
* @param this
|
|
49001
|
+
* @param this Positions sibling UI elements as full-size pages in a single row or column that users can scroll or animate through one page at a time.
|
|
48231
49002
|
*/
|
|
48232
49003
|
Next(this: UIPageLayout): void;
|
|
48233
49004
|
/**
|
|
@@ -48236,7 +49007,7 @@ interface UIPageLayout extends UIGridStyleLayout {
|
|
|
48236
49007
|
* - **ThreadSafety**: Unsafe
|
|
48237
49008
|
*
|
|
48238
49009
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UIPageLayout#Previous)
|
|
48239
|
-
* @param this
|
|
49010
|
+
* @param this Positions sibling UI elements as full-size pages in a single row or column that users can scroll or animate through one page at a time.
|
|
48240
49011
|
*/
|
|
48241
49012
|
Previous(this: UIPageLayout): void;
|
|
48242
49013
|
/**
|
|
@@ -48581,6 +49352,8 @@ interface UIDragDetectorService extends Instance {
|
|
|
48581
49352
|
readonly _nominal_UIDragDetectorService: unique symbol;
|
|
48582
49353
|
}
|
|
48583
49354
|
/**
|
|
49355
|
+
* Team Create service that maps `UniqueId` to and from RFC-4122 strings; not for experience scripts.
|
|
49356
|
+
*
|
|
48584
49357
|
* - **Tags**: NotCreatable, Service
|
|
48585
49358
|
*
|
|
48586
49359
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UniqueIdLookupService)
|
|
@@ -48595,11 +49368,14 @@ interface UniqueIdLookupService extends Instance {
|
|
|
48595
49368
|
*/
|
|
48596
49369
|
readonly _nominal_UniqueIdLookupService: unique symbol;
|
|
48597
49370
|
/**
|
|
49371
|
+
* Returns the RFC-4122 string form of the instance's `UniqueId`, creating one if the instance does not already have it.
|
|
49372
|
+
*
|
|
48598
49373
|
* - **ThreadSafety**: Unsafe
|
|
48599
49374
|
*
|
|
48600
49375
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UniqueIdLookupService#GetOrCreateUniqueIdRemoteCommand)
|
|
48601
|
-
* @param this
|
|
48602
|
-
* @param instance
|
|
49376
|
+
* @param this Team Create service that maps `UniqueId` to and from RFC-4122 strings; not for experience scripts.
|
|
49377
|
+
* @param instance The instance whose `UniqueId` to read or create.
|
|
49378
|
+
* @returns The instance's `UniqueId` as an RFC-4122 string.
|
|
48603
49379
|
*/
|
|
48604
49380
|
GetOrCreateUniqueIdRemoteCommand(this: UniqueIdLookupService, instance: Instance): string;
|
|
48605
49381
|
}
|
|
@@ -49042,6 +49818,7 @@ interface UserInputService extends Instance {
|
|
|
49042
49818
|
*
|
|
49043
49819
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UserInputService#GetDeviceAcceleration)
|
|
49044
49820
|
* @param this `UserInputService` is primarily used to detect the input types available on a user's device, as well as detect input events.
|
|
49821
|
+
* @returns An `InputObject` describing the device's current acceleration, with `Position` representing the acceleration force on each local device axis.
|
|
49045
49822
|
*/
|
|
49046
49823
|
GetDeviceAcceleration(this: UserInputService): InputObject;
|
|
49047
49824
|
/**
|
|
@@ -49051,6 +49828,7 @@ interface UserInputService extends Instance {
|
|
|
49051
49828
|
*
|
|
49052
49829
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UserInputService#GetDeviceGravity)
|
|
49053
49830
|
* @param this `UserInputService` is primarily used to detect the input types available on a user's device, as well as detect input events.
|
|
49831
|
+
* @returns An `InputObject` describing the device's current gravity vector, with `Position` representing the force of gravity on each local device axis.
|
|
49054
49832
|
*/
|
|
49055
49833
|
GetDeviceGravity(this: UserInputService): InputObject;
|
|
49056
49834
|
/**
|
|
@@ -49073,6 +49851,7 @@ interface UserInputService extends Instance {
|
|
|
49073
49851
|
*
|
|
49074
49852
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UserInputService#GetFocusedTextBox)
|
|
49075
49853
|
* @param this `UserInputService` is primarily used to detect the input types available on a user's device, as well as detect input events.
|
|
49854
|
+
* @returns The currently focused `TextBox`, or `nil` if no `TextBox` is focused.
|
|
49076
49855
|
*/
|
|
49077
49856
|
GetFocusedTextBox(this: UserInputService): TextBox | undefined;
|
|
49078
49857
|
/**
|
|
@@ -49568,6 +50347,8 @@ interface VRService extends Instance {
|
|
|
49568
50347
|
*/
|
|
49569
50348
|
AvatarGestures: boolean;
|
|
49570
50349
|
/**
|
|
50350
|
+
* Controls whether and how the player's VR hand controllers are rendered in the experience.
|
|
50351
|
+
*
|
|
49571
50352
|
* - **ThreadSafety**: ReadSafe
|
|
49572
50353
|
*
|
|
49573
50354
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VRService#ControllerModels)
|
|
@@ -49591,12 +50372,16 @@ interface VRService extends Instance {
|
|
|
49591
50372
|
*/
|
|
49592
50373
|
GuiInputUserCFrame: Enum.UserCFrame;
|
|
49593
50374
|
/**
|
|
50375
|
+
* Controls whether and how the VR laser pointer used to interact with the user interface is displayed.
|
|
50376
|
+
*
|
|
49594
50377
|
* - **ThreadSafety**: ReadSafe
|
|
49595
50378
|
*
|
|
49596
50379
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VRService#LaserPointer)
|
|
49597
50380
|
*/
|
|
49598
50381
|
LaserPointer: Enum.VRLaserPointerMode;
|
|
49599
50382
|
/**
|
|
50383
|
+
* Indicates whether the third-person follow camera is enabled for the VR user.
|
|
50384
|
+
*
|
|
49600
50385
|
* - **ThreadSafety**: ReadSafe
|
|
49601
50386
|
* - **Tags**: NotReplicated
|
|
49602
50387
|
*
|
|
@@ -49631,6 +50416,7 @@ interface VRService extends Instance {
|
|
|
49631
50416
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VRService#GetUserCFrame)
|
|
49632
50417
|
* @param this Service responsible for handling interactions between Roblox and Virtual Reality (VR).
|
|
49633
50418
|
* @param type The specified `UserCFrame`.
|
|
50419
|
+
* @returns A `CFrame` describing the position and orientation of the specified VR device as an offset from a point in real-world space.
|
|
49634
50420
|
*/
|
|
49635
50421
|
GetUserCFrame(this: VRService, type: CastsToEnum<Enum.UserCFrame>): CFrame;
|
|
49636
50422
|
/**
|
|
@@ -50355,6 +51141,8 @@ interface Vector3Curve extends Instance {
|
|
|
50355
51141
|
Z(this: Vector3Curve): FloatCurve;
|
|
50356
51142
|
}
|
|
50357
51143
|
/**
|
|
51144
|
+
* Service that manages camera capture for features such as avatar facial-animation tracking. Requires `RobloxScript` security; not callable from experience scripts.
|
|
51145
|
+
*
|
|
50358
51146
|
* - **Tags**: NotCreatable, Service
|
|
50359
51147
|
*
|
|
50360
51148
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VideoCaptureService)
|
|
@@ -50457,6 +51245,8 @@ interface VideoPlayer extends Instance {
|
|
|
50457
51245
|
*/
|
|
50458
51246
|
Looping: boolean;
|
|
50459
51247
|
/**
|
|
51248
|
+
* Caps the resolution of decoded video frames for this `VideoPlayer`.
|
|
51249
|
+
*
|
|
50460
51250
|
* - **ThreadSafety**: ReadSafe
|
|
50461
51251
|
* - **Tags**: Hidden
|
|
50462
51252
|
*
|
|
@@ -50579,6 +51369,7 @@ interface VideoPlayer extends Instance {
|
|
|
50579
51369
|
*
|
|
50580
51370
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VideoPlayer#LoadAsync)
|
|
50581
51371
|
* @param this Used to play video assets.
|
|
51372
|
+
* @returns An `AssetFetchStatus` describing the outcome of the load — `AssetFetchStatus.Success` once the `VideoContent` has loaded, or a failure status such as `AssetFetchStatus.Failure` or `AssetFetchStatus.TimedOut` if it could not be fetched.
|
|
50582
51373
|
*/
|
|
50583
51374
|
LoadAsync(this: VideoPlayer): Enum.AssetFetchStatus;
|
|
50584
51375
|
/**
|
|
@@ -50598,6 +51389,8 @@ interface VideoPlayer extends Instance {
|
|
|
50598
51389
|
*/
|
|
50599
51390
|
readonly DidLoop: RBXScriptSignal<() => void>;
|
|
50600
51391
|
/**
|
|
51392
|
+
* Fires when the `VideoPlayer` fails to load or play its `VideoContent`.
|
|
51393
|
+
*
|
|
50601
51394
|
* - **ThreadSafety**: Unsafe
|
|
50602
51395
|
*
|
|
50603
51396
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VideoPlayer#PlayFailed)
|
|
@@ -51643,6 +52436,8 @@ interface WebStreamClient extends RBXObject {
|
|
|
51643
52436
|
*/
|
|
51644
52437
|
Send(this: WebStreamClient, data: string): void;
|
|
51645
52438
|
/**
|
|
52439
|
+
* Fires when the streaming connection is closed, either by the server or by a call to `WebStreamClient:Close()`.
|
|
52440
|
+
*
|
|
51646
52441
|
* - **ThreadSafety**: Unsafe
|
|
51647
52442
|
*
|
|
51648
52443
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/WebStreamClient#Closed)
|