@rbxts/types 1.0.928 → 1.0.930
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.
|
@@ -2522,6 +2522,8 @@ interface Instance extends RBXObject {
|
|
|
2522
2522
|
*/
|
|
2523
2523
|
IsPropertyModified(this: Instance, property: string): boolean;
|
|
2524
2524
|
/**
|
|
2525
|
+
* Returns an array containing all descendants of the instance that match the `selector` string.
|
|
2526
|
+
*
|
|
2525
2527
|
* - **ThreadSafety**: Unsafe
|
|
2526
2528
|
* - **Tags**: CustomLuaState
|
|
2527
2529
|
*
|
|
@@ -2707,8 +2709,11 @@ interface AccessoryDescription extends Instance {
|
|
|
2707
2709
|
* The layered clothing puffiness, if the `Accessory` is layered.
|
|
2708
2710
|
*
|
|
2709
2711
|
* - **ThreadSafety**: ReadSafe
|
|
2712
|
+
* - **Tags**:
|
|
2710
2713
|
*
|
|
2711
2714
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AccessoryDescription#Puffiness)
|
|
2715
|
+
*
|
|
2716
|
+
* @deprecated
|
|
2712
2717
|
*/
|
|
2713
2718
|
Puffiness: number;
|
|
2714
2719
|
/**
|
|
@@ -5726,6 +5731,40 @@ interface AudioEmitter extends Instance {
|
|
|
5726
5731
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioEmitter#AudioInteractionGroup)
|
|
5727
5732
|
*/
|
|
5728
5733
|
AudioInteractionGroup: string;
|
|
5734
|
+
/**
|
|
5735
|
+
* - **ThreadSafety**: ReadSafe
|
|
5736
|
+
*
|
|
5737
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioEmitter#DiffractionEnabled)
|
|
5738
|
+
*/
|
|
5739
|
+
DiffractionEnabled: Enum.SimulationMode;
|
|
5740
|
+
/**
|
|
5741
|
+
* - **ThreadSafety**: ReadSafe
|
|
5742
|
+
*
|
|
5743
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioEmitter#OcclusionEnabled)
|
|
5744
|
+
*/
|
|
5745
|
+
OcclusionEnabled: Enum.SimulationMode;
|
|
5746
|
+
/**
|
|
5747
|
+
* The `Instance` whose position and orientation is used as the emitter's position if `PositionType` is set to `EmitterPositionType.Instance`.
|
|
5748
|
+
*
|
|
5749
|
+
* - **ThreadSafety**: ReadSafe
|
|
5750
|
+
*
|
|
5751
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioEmitter#PositionInstance)
|
|
5752
|
+
*/
|
|
5753
|
+
PositionInstance: Instance | undefined;
|
|
5754
|
+
/**
|
|
5755
|
+
* Determines how the `AudioEmitter` determines its 3D location.
|
|
5756
|
+
*
|
|
5757
|
+
* - **ThreadSafety**: ReadSafe
|
|
5758
|
+
*
|
|
5759
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioEmitter#PositionType)
|
|
5760
|
+
*/
|
|
5761
|
+
PositionType: Enum.EmitterPositionType;
|
|
5762
|
+
/**
|
|
5763
|
+
* - **ThreadSafety**: ReadSafe
|
|
5764
|
+
*
|
|
5765
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioEmitter#ReverbEnabled)
|
|
5766
|
+
*/
|
|
5767
|
+
ReverbEnabled: Enum.SimulationMode;
|
|
5729
5768
|
/**
|
|
5730
5769
|
* **Deprecated:**
|
|
5731
5770
|
*
|
|
@@ -6405,6 +6444,40 @@ interface AudioListener extends Instance {
|
|
|
6405
6444
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioListener#AudioInteractionGroup)
|
|
6406
6445
|
*/
|
|
6407
6446
|
AudioInteractionGroup: string;
|
|
6447
|
+
/**
|
|
6448
|
+
* - **ThreadSafety**: ReadSafe
|
|
6449
|
+
*
|
|
6450
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioListener#DiffractionEnabled)
|
|
6451
|
+
*/
|
|
6452
|
+
DiffractionEnabled: Enum.SimulationMode;
|
|
6453
|
+
/**
|
|
6454
|
+
* - **ThreadSafety**: ReadSafe
|
|
6455
|
+
*
|
|
6456
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioListener#OcclusionEnabled)
|
|
6457
|
+
*/
|
|
6458
|
+
OcclusionEnabled: Enum.SimulationMode;
|
|
6459
|
+
/**
|
|
6460
|
+
* The `Instance` whose position and orientation is used as the listener's position if `PositionType` is set to `ListenerPositionType.Instance`.
|
|
6461
|
+
*
|
|
6462
|
+
* - **ThreadSafety**: ReadSafe
|
|
6463
|
+
*
|
|
6464
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioListener#PositionInstance)
|
|
6465
|
+
*/
|
|
6466
|
+
PositionInstance: Instance | undefined;
|
|
6467
|
+
/**
|
|
6468
|
+
* Determines how the `AudioListener` determines its 3D location.
|
|
6469
|
+
*
|
|
6470
|
+
* - **ThreadSafety**: ReadSafe
|
|
6471
|
+
*
|
|
6472
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioListener#PositionType)
|
|
6473
|
+
*/
|
|
6474
|
+
PositionType: Enum.ListenerPositionType;
|
|
6475
|
+
/**
|
|
6476
|
+
* - **ThreadSafety**: ReadSafe
|
|
6477
|
+
*
|
|
6478
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioListener#ReverbEnabled)
|
|
6479
|
+
*/
|
|
6480
|
+
ReverbEnabled: Enum.SimulationMode;
|
|
6408
6481
|
/**
|
|
6409
6482
|
* **Deprecated:**
|
|
6410
6483
|
*
|
|
@@ -9732,8 +9805,11 @@ interface WrapLayer extends BaseWrap {
|
|
|
9732
9805
|
* Controls how much underlying clothing items inflate the current clothing item.
|
|
9733
9806
|
*
|
|
9734
9807
|
* - **ThreadSafety**: ReadSafe
|
|
9808
|
+
* - **Tags**:
|
|
9735
9809
|
*
|
|
9736
9810
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/WrapLayer#Puffiness)
|
|
9811
|
+
*
|
|
9812
|
+
* @deprecated
|
|
9737
9813
|
*/
|
|
9738
9814
|
Puffiness: number;
|
|
9739
9815
|
/**
|
|
@@ -9771,8 +9847,11 @@ interface WrapLayer extends BaseWrap {
|
|
|
9771
9847
|
* Allows slight shrinking/expanding of the resulting render mesh, without affecting any other layers.
|
|
9772
9848
|
*
|
|
9773
9849
|
* - **ThreadSafety**: ReadSafe
|
|
9850
|
+
* - **Tags**:
|
|
9774
9851
|
*
|
|
9775
9852
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/WrapLayer#ShrinkFactor)
|
|
9853
|
+
*
|
|
9854
|
+
* @deprecated
|
|
9776
9855
|
*/
|
|
9777
9856
|
get ShrinkFactor(): number;
|
|
9778
9857
|
}
|
|
@@ -9794,8 +9873,11 @@ interface WrapTarget extends BaseWrap {
|
|
|
9794
9873
|
* Defines how much the body mesh can be compressed by clothing.
|
|
9795
9874
|
*
|
|
9796
9875
|
* - **ThreadSafety**: ReadSafe
|
|
9876
|
+
* - **Tags**:
|
|
9797
9877
|
*
|
|
9798
9878
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/WrapTarget#Stiffness)
|
|
9879
|
+
*
|
|
9880
|
+
* @deprecated
|
|
9799
9881
|
*/
|
|
9800
9882
|
get Stiffness(): number;
|
|
9801
9883
|
}
|
|
@@ -12640,12 +12722,16 @@ interface AnimationConstraint extends Constraint {
|
|
|
12640
12722
|
*/
|
|
12641
12723
|
readonly _nominal_AnimationConstraint: unique symbol;
|
|
12642
12724
|
/**
|
|
12725
|
+
* Damping ratio for the rotational part of the constraint. Higher values reduce oscillation around the target orientation.
|
|
12726
|
+
*
|
|
12643
12727
|
* - **ThreadSafety**: ReadSafe
|
|
12644
12728
|
*
|
|
12645
12729
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AnimationConstraint#AngularDamping)
|
|
12646
12730
|
*/
|
|
12647
12731
|
AngularDamping: number;
|
|
12648
12732
|
/**
|
|
12733
|
+
* Controls how rigidly the constraint enforces the rotational part of its target `Transform`. Higher values track the target orientation more stiffly.
|
|
12734
|
+
*
|
|
12649
12735
|
* - **ThreadSafety**: ReadSafe
|
|
12650
12736
|
*
|
|
12651
12737
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AnimationConstraint#AngularStrength)
|
|
@@ -12678,12 +12764,16 @@ interface AnimationConstraint extends Constraint {
|
|
|
12678
12764
|
*/
|
|
12679
12765
|
IsKinematic: boolean;
|
|
12680
12766
|
/**
|
|
12767
|
+
* Damping ratio for the translational part of the constraint. Higher values reduce oscillation around the target position.
|
|
12768
|
+
*
|
|
12681
12769
|
* - **ThreadSafety**: ReadSafe
|
|
12682
12770
|
*
|
|
12683
12771
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AnimationConstraint#LinearDamping)
|
|
12684
12772
|
*/
|
|
12685
12773
|
LinearDamping: number;
|
|
12686
12774
|
/**
|
|
12775
|
+
* Controls how rigidly the constraint enforces the translational part of its target `Transform`. Higher values track the target position more stiffly.
|
|
12776
|
+
*
|
|
12687
12777
|
* - **ThreadSafety**: ReadSafe
|
|
12688
12778
|
*
|
|
12689
12779
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AnimationConstraint#LinearStrength)
|
|
@@ -16963,6 +17053,8 @@ interface Decal extends FaceInstance {
|
|
|
16963
17053
|
*/
|
|
16964
17054
|
get NormalMapContent(): Content;
|
|
16965
17055
|
/**
|
|
17056
|
+
* Rotates the decal texture.
|
|
17057
|
+
*
|
|
16966
17058
|
* - **ThreadSafety**: ReadSafe
|
|
16967
17059
|
*
|
|
16968
17060
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Decal#Rotation)
|
|
@@ -25693,10 +25785,13 @@ interface InputAction extends Instance {
|
|
|
25693
25785
|
* Updates the `InputAction` to the given state and fires the appropriate signals.
|
|
25694
25786
|
*
|
|
25695
25787
|
* - **ThreadSafety**: Unsafe
|
|
25788
|
+
* - **Tags**:
|
|
25696
25789
|
*
|
|
25697
25790
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputAction#Fire)
|
|
25698
25791
|
* @param this Defines a gameplay action mechanic. These actions are then mapped to hardware inputs using `InputBinding`.
|
|
25699
25792
|
* @param state
|
|
25793
|
+
*
|
|
25794
|
+
* @deprecated
|
|
25700
25795
|
*/
|
|
25701
25796
|
Fire(this: InputAction, state: unknown): void;
|
|
25702
25797
|
/**
|
|
@@ -25858,6 +25953,12 @@ interface InputBinding extends Instance {
|
|
|
25858
25953
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputBinding#SecondaryModifier)
|
|
25859
25954
|
*/
|
|
25860
25955
|
SecondaryModifier: Enum.KeyCode;
|
|
25956
|
+
/**
|
|
25957
|
+
* - **ThreadSafety**: ReadSafe
|
|
25958
|
+
*
|
|
25959
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputBinding#Type)
|
|
25960
|
+
*/
|
|
25961
|
+
Type: Enum.InputBindingType;
|
|
25861
25962
|
/**
|
|
25862
25963
|
* Connects a `GuiButton` to a boolean action.
|
|
25863
25964
|
*
|
|
@@ -25898,6 +25999,16 @@ interface InputBinding extends Instance {
|
|
|
25898
25999
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputBinding#Vector3Scale)
|
|
25899
26000
|
*/
|
|
25900
26001
|
Vector3Scale: Vector3;
|
|
26002
|
+
/**
|
|
26003
|
+
* Programmatically updates the parent `InputAction` state through this binding.
|
|
26004
|
+
*
|
|
26005
|
+
* - **ThreadSafety**: Unsafe
|
|
26006
|
+
*
|
|
26007
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputBinding#Fire)
|
|
26008
|
+
* @param this Defines which hardware binding should trigger the parent `InputAction`.
|
|
26009
|
+
* @param state The state value to apply; must match the parent action's `Type`.
|
|
26010
|
+
*/
|
|
26011
|
+
Fire(this: InputBinding, state: unknown): void;
|
|
25901
26012
|
}
|
|
25902
26013
|
/**
|
|
25903
26014
|
* Collection of actions which holds related actions and defines how they interact with other contexts/actions.
|
|
@@ -27019,6 +27130,8 @@ interface LanguageService extends Instance {
|
|
|
27019
27130
|
* - **Tags**: Yields
|
|
27020
27131
|
*
|
|
27021
27132
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/LanguageService#GetCapabilitiesUsedInPackageAsync)
|
|
27133
|
+
* @param this
|
|
27134
|
+
* @param instances
|
|
27022
27135
|
*/
|
|
27023
27136
|
GetCapabilitiesUsedInPackageAsync(this: LanguageService, instances: Array<Instance>): object;
|
|
27024
27137
|
}
|
|
@@ -27472,6 +27585,8 @@ interface LiveSyncService extends Instance {
|
|
|
27472
27585
|
* - **ThreadSafety**: Unsafe
|
|
27473
27586
|
*
|
|
27474
27587
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/LiveSyncService#GetSyncState)
|
|
27588
|
+
* @param this
|
|
27589
|
+
* @param instance
|
|
27475
27590
|
*/
|
|
27476
27591
|
GetSyncState(this: LiveSyncService, instance: Instance): unknown;
|
|
27477
27592
|
/**
|
|
@@ -35452,6 +35567,13 @@ interface Player extends Instance {
|
|
|
35452
35567
|
* @returns The distance in studs between the player and the location.
|
|
35453
35568
|
*/
|
|
35454
35569
|
DistanceFromCharacter(this: Player, point: Vector3): number;
|
|
35570
|
+
/**
|
|
35571
|
+
* - **ThreadSafety**: Safe
|
|
35572
|
+
* - **Tags**: CustomLuaState
|
|
35573
|
+
*
|
|
35574
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#GetCameraState)
|
|
35575
|
+
*/
|
|
35576
|
+
GetCameraState(this: Player): object;
|
|
35455
35577
|
/**
|
|
35456
35578
|
* - **ThreadSafety**: Unsafe
|
|
35457
35579
|
*
|
|
@@ -35737,8 +35859,6 @@ interface Player extends Instance {
|
|
|
35737
35859
|
*/
|
|
35738
35860
|
GetRankInGroup(this: Player, groupId: number): number;
|
|
35739
35861
|
/**
|
|
35740
|
-
* **Deprecated:** This method only returns a single role rank and may produce arbitrary results when a user holds multiple roles. Use `GroupService:GetRolesInGroupAsync()` instead, which returns all roles.
|
|
35741
|
-
*
|
|
35742
35862
|
* Returns the player's rank in the group as an integer.
|
|
35743
35863
|
*
|
|
35744
35864
|
* - **ThreadSafety**: Unsafe
|
|
@@ -35769,8 +35889,6 @@ interface Player extends Instance {
|
|
|
35769
35889
|
*/
|
|
35770
35890
|
GetRoleInGroup(this: Player, groupId: number): string;
|
|
35771
35891
|
/**
|
|
35772
|
-
* **Deprecated:** This method only returns a single role name and may produce arbitrary results when a user holds multiple roles. Use `GroupService:GetRolesInGroupAsync()` instead, which returns all roles.
|
|
35773
|
-
*
|
|
35774
35892
|
* Returns the player's role in the group as a string, or `Guest` if the player isn't part of the group.
|
|
35775
35893
|
*
|
|
35776
35894
|
* - **ThreadSafety**: Unsafe
|
|
@@ -36497,7 +36615,7 @@ interface Players extends Instance {
|
|
|
36497
36615
|
* - `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`.
|
|
36498
36616
|
* - `PrivateReason` (required; string) — Internal messaging that will be returned when querying the user's ban history. Maximum string length is `1000`.
|
|
36499
36617
|
* - `ExcludeAltAccounts` (optional; boolean) — When `true`, Roblox does not attempt to ban alternate accounts. Default is `false`.
|
|
36500
|
-
* - `ApplyDeviceBlock` (optional; boolean) — When `true`, Roblox will block banned users' devices from rejoining the experience for 24 hours after the ban is applied. Default is `false`.
|
|
36618
|
+
* - `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.
|
|
36501
36619
|
*/
|
|
36502
36620
|
BanAsync(this: Players, config: BanAsyncConfig): void;
|
|
36503
36621
|
/**
|
|
@@ -38955,6 +39073,8 @@ interface ScriptContext extends Instance {
|
|
|
38955
39073
|
readonly Error: RBXScriptSignal<(message: string, stackTrace: string, script?: LuaSourceContainer) => void>;
|
|
38956
39074
|
}
|
|
38957
39075
|
/**
|
|
39076
|
+
* Provides programmatic breakpoint management, execution control, and runtime inspection of Luau scripts during a playtest.
|
|
39077
|
+
*
|
|
38958
39078
|
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
38959
39079
|
*
|
|
38960
39080
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScriptDebuggerService)
|
|
@@ -39703,6 +39823,8 @@ interface DataModel extends ServiceProvider<Services> {
|
|
|
39703
39823
|
*/
|
|
39704
39824
|
readonly ServerLifecycleChanged: RBXScriptSignal<(serverLifecycleChangedEvent: object) => void>;
|
|
39705
39825
|
/**
|
|
39826
|
+
* Fires on the server when the server has been scheduled to restart. Provides the scheduled restart time, source, and custom attributes.
|
|
39827
|
+
*
|
|
39706
39828
|
* - **ThreadSafety**: Unsafe
|
|
39707
39829
|
*
|
|
39708
39830
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DataModel#ServerRestartScheduled)
|
|
@@ -41298,6 +41420,12 @@ interface SoundService extends Instance {
|
|
|
41298
41420
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SoundService#CharacterSoundsUseNewApi)
|
|
41299
41421
|
*/
|
|
41300
41422
|
get CharacterSoundsUseNewApi(): Enum.RolloutState;
|
|
41423
|
+
/**
|
|
41424
|
+
* - **ThreadSafety**: ReadSafe
|
|
41425
|
+
*
|
|
41426
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SoundService#DiffractionEnabled)
|
|
41427
|
+
*/
|
|
41428
|
+
DiffractionEnabled: boolean;
|
|
41301
41429
|
/**
|
|
41302
41430
|
* The number of studs to be considered a meter by `SoundService` when simulating the Doppler effect for `Sounds`.
|
|
41303
41431
|
*
|
|
@@ -41315,23 +41443,35 @@ interface SoundService extends Instance {
|
|
|
41315
41443
|
*/
|
|
41316
41444
|
DopplerScale: number;
|
|
41317
41445
|
/**
|
|
41446
|
+
* The `CFrame` that is used as the listener's position if `ListenerType` is set to `ListenerType.CFrame`.
|
|
41447
|
+
*
|
|
41318
41448
|
* - **ThreadSafety**: ReadSafe
|
|
41319
41449
|
*
|
|
41320
41450
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SoundService#ListenerCFrame)
|
|
41321
41451
|
*/
|
|
41322
41452
|
ListenerCFrame: CFrame;
|
|
41323
41453
|
/**
|
|
41454
|
+
* The `Instance` whose translation or coordinate frame is used as the listener's position if `ListenerType` is set to `ListenerType.ObjectPosition` or `ListenerType.ObjectCFrame`.
|
|
41455
|
+
*
|
|
41324
41456
|
* - **ThreadSafety**: ReadSafe
|
|
41325
41457
|
*
|
|
41326
41458
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SoundService#ListenerObject)
|
|
41327
41459
|
*/
|
|
41328
41460
|
ListenerObject: Instance | undefined;
|
|
41329
41461
|
/**
|
|
41462
|
+
* The current listener type used by 3D `Sounds` to determine where they will be heard from.
|
|
41463
|
+
*
|
|
41330
41464
|
* - **ThreadSafety**: ReadSafe
|
|
41331
41465
|
*
|
|
41332
41466
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SoundService#ListenerType)
|
|
41333
41467
|
*/
|
|
41334
41468
|
ListenerType: Enum.ListenerType;
|
|
41469
|
+
/**
|
|
41470
|
+
* - **ThreadSafety**: ReadSafe
|
|
41471
|
+
*
|
|
41472
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SoundService#OcclusionEnabled)
|
|
41473
|
+
*/
|
|
41474
|
+
OcclusionEnabled: boolean;
|
|
41335
41475
|
/**
|
|
41336
41476
|
* Sets whether `Sound` playback from a client will replicate to the server.
|
|
41337
41477
|
*
|
|
@@ -41340,6 +41480,12 @@ interface SoundService extends Instance {
|
|
|
41340
41480
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SoundService#RespectFilteringEnabled)
|
|
41341
41481
|
*/
|
|
41342
41482
|
RespectFilteringEnabled: boolean;
|
|
41483
|
+
/**
|
|
41484
|
+
* - **ThreadSafety**: ReadSafe
|
|
41485
|
+
*
|
|
41486
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SoundService#ReverbEnabled)
|
|
41487
|
+
*/
|
|
41488
|
+
ReverbEnabled: boolean;
|
|
41343
41489
|
/**
|
|
41344
41490
|
* Determines how fast the volume of a `Sound` attenuates beyond its `Sound.RollOffMinDistance`.
|
|
41345
41491
|
*
|
|
@@ -46966,8 +47112,6 @@ interface UIScale extends UIComponent {
|
|
|
46966
47112
|
/**
|
|
46967
47113
|
* Renders a shadow below the parent UI instance.
|
|
46968
47114
|
*
|
|
46969
|
-
* - **Tags**: NotBrowsable
|
|
46970
|
-
*
|
|
46971
47115
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UIShadow)
|
|
46972
47116
|
*/
|
|
46973
47117
|
interface UIShadow extends UIComponent {
|
|
@@ -47742,8 +47886,9 @@ interface UserInputService extends Instance {
|
|
|
47742
47886
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UserInputService#GetStringForKeyCode)
|
|
47743
47887
|
* @param this `UserInputService` is primarily used to detect the input types available on a user's device, as well as detect input events.
|
|
47744
47888
|
* @param keyCode
|
|
47889
|
+
* @param format
|
|
47745
47890
|
*/
|
|
47746
|
-
GetStringForKeyCode(this: UserInputService, keyCode: CastsToEnum<Enum.KeyCode>): string;
|
|
47891
|
+
GetStringForKeyCode(this: UserInputService, keyCode: CastsToEnum<Enum.KeyCode>, format?: CastsToEnum<Enum.KeyCodeStringFormat>): string;
|
|
47747
47892
|
/**
|
|
47748
47893
|
* Returns an array of `KeyCodes` that the gamepad associated with the given `UserInputType` supports.
|
|
47749
47894
|
*
|
|
@@ -49509,12 +49654,15 @@ interface WebSocketClient extends Instance {
|
|
|
49509
49654
|
* - **ThreadSafety**: Unsafe
|
|
49510
49655
|
*
|
|
49511
49656
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/WebSocketClient#Close)
|
|
49657
|
+
* @param this
|
|
49512
49658
|
*/
|
|
49513
49659
|
Close(this: WebSocketClient): void;
|
|
49514
49660
|
/**
|
|
49515
49661
|
* - **ThreadSafety**: Unsafe
|
|
49516
49662
|
*
|
|
49517
49663
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/WebSocketClient#Send)
|
|
49664
|
+
* @param this
|
|
49665
|
+
* @param data
|
|
49518
49666
|
*/
|
|
49519
49667
|
Send(this: WebSocketClient, data: string): void;
|
|
49520
49668
|
/**
|
|
@@ -49554,6 +49702,8 @@ interface WebSocketService extends Instance {
|
|
|
49554
49702
|
* - **ThreadSafety**: Unsafe
|
|
49555
49703
|
*
|
|
49556
49704
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/WebSocketService#CreateClient)
|
|
49705
|
+
* @param this
|
|
49706
|
+
* @param uri
|
|
49557
49707
|
*/
|
|
49558
49708
|
CreateClient(this: WebSocketService, uri: string): WebSocketClient;
|
|
49559
49709
|
}
|
|
@@ -2707,8 +2707,11 @@ interface WrapLayer extends BaseWrap {
|
|
|
2707
2707
|
* Allows slight shrinking/expanding of the resulting render mesh, without affecting any other layers.
|
|
2708
2708
|
*
|
|
2709
2709
|
* - **ThreadSafety**: ReadSafe
|
|
2710
|
+
* - **Tags**:
|
|
2710
2711
|
*
|
|
2711
2712
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/WrapLayer#ShrinkFactor)
|
|
2713
|
+
*
|
|
2714
|
+
* @deprecated
|
|
2712
2715
|
*/
|
|
2713
2716
|
set ShrinkFactor(value: number);
|
|
2714
2717
|
}
|
|
@@ -2730,8 +2733,11 @@ interface WrapTarget extends BaseWrap {
|
|
|
2730
2733
|
* Defines how much the body mesh can be compressed by clothing.
|
|
2731
2734
|
*
|
|
2732
2735
|
* - **ThreadSafety**: ReadSafe
|
|
2736
|
+
* - **Tags**:
|
|
2733
2737
|
*
|
|
2734
2738
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/WrapTarget#Stiffness)
|
|
2739
|
+
*
|
|
2740
|
+
* @deprecated
|
|
2735
2741
|
*/
|
|
2736
2742
|
set Stiffness(value: number);
|
|
2737
2743
|
}
|
|
@@ -12532,6 +12538,8 @@ interface ScriptDebugger extends Instance {
|
|
|
12532
12538
|
readonly _nominal_ScriptDebugger: unique symbol;
|
|
12533
12539
|
}
|
|
12534
12540
|
/**
|
|
12541
|
+
* Provides programmatic breakpoint management, execution control, and runtime inspection of Luau scripts during a playtest.
|
|
12542
|
+
*
|
|
12535
12543
|
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
12536
12544
|
*
|
|
12537
12545
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScriptDebuggerService)
|
|
@@ -12546,75 +12554,154 @@ interface ScriptDebuggerService extends Instance {
|
|
|
12546
12554
|
*/
|
|
12547
12555
|
readonly _nominal_ScriptDebuggerService: unique symbol;
|
|
12548
12556
|
/**
|
|
12557
|
+
* Adds a breakpoint to a script. If a breakpoint already exists on the same script and line, its data is replaced.
|
|
12558
|
+
*
|
|
12549
12559
|
* - **ThreadSafety**: Unsafe
|
|
12550
12560
|
*
|
|
12551
12561
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScriptDebuggerService#AddBreakpoint)
|
|
12562
|
+
* @param this Provides programmatic breakpoint management, execution control, and runtime inspection of Luau scripts during a playtest.
|
|
12563
|
+
* @param scriptInstance The `LuaSourceContainer` to place the breakpoint on.
|
|
12564
|
+
* @param breakpoint Dictionary describing the breakpoint configuration through the following key-value pairs: - `Line` — Required 1-based line number.
|
|
12565
|
+
* - `Enabled` — Optional boolean whether the breakpoint is active. Default is `true`.
|
|
12566
|
+
* - `Condition` — Optional string indicating the Luau expression which must be truthy to pause, for example `"health < 10"`.
|
|
12567
|
+
* - `LogMessage` — Optional string message logged when the breakpoint is hit. This string is parsed as a comma-separated list of Luau expressions, evaluated in the breakpoint's scope, and concatenated `print()`‑style with spaces between segments. String literals are quoted; bare identifiers reference live values. For example, `"'count is', count"` produces output like `count is 7`.
|
|
12568
|
+
* - `ContinueExecution` — If `true`, the `DataModel` does not pause when the breakpoint is hit. Default is `false`.
|
|
12569
|
+
*
|
|
12570
|
+
*
|
|
12571
|
+
* @returns Dictionary indicating whether the breakpoint was placed successfully and on which line. Includes the following key-value pairs: - `Verified` — Boolean value indicating whether the breakpoint was placed successfully.
|
|
12572
|
+
* - `Line` — The line number the breakpoint was placed on.
|
|
12573
|
+
* - `Message` — Optional explanation if `Verified` is `false`.
|
|
12552
12574
|
*/
|
|
12553
12575
|
AddBreakpoint(this: ScriptDebuggerService, scriptInstance: LuaSourceContainer, breakpoint: object): object;
|
|
12554
12576
|
/**
|
|
12577
|
+
* Removes all breakpoints across all scripts.
|
|
12578
|
+
*
|
|
12555
12579
|
* - **ThreadSafety**: Unsafe
|
|
12556
12580
|
*
|
|
12557
12581
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScriptDebuggerService#ClearBreakpoints)
|
|
12582
|
+
* @param this Provides programmatic breakpoint management, execution control, and runtime inspection of Luau scripts during a playtest.
|
|
12558
12583
|
*/
|
|
12559
12584
|
ClearBreakpoints(this: ScriptDebuggerService): void;
|
|
12560
12585
|
/**
|
|
12586
|
+
* Evaluates a Luau expression in a stack frame's context.
|
|
12587
|
+
*
|
|
12561
12588
|
* - **ThreadSafety**: Unsafe
|
|
12562
12589
|
*
|
|
12563
12590
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScriptDebuggerService#Evaluate)
|
|
12591
|
+
* @param this Provides programmatic breakpoint management, execution control, and runtime inspection of Luau scripts during a playtest.
|
|
12592
|
+
* @param expression The Luau expression to evaluate.
|
|
12593
|
+
* @param frameId Optional frame identifier. If omitted, evaluates globally.
|
|
12594
|
+
* @returns Dictionary with the following key-value pairs: - `Result` — String representation of the evaluated result.
|
|
12595
|
+
* - `Type` — String indicating the Luau type of the result (`"number"`, `"string"`, `"table"`, `"Instance"`, etc.).
|
|
12596
|
+
* - `VariablesReference` — If greater than `0`, drill into with `GetVariables()`.
|
|
12564
12597
|
*/
|
|
12565
12598
|
Evaluate(this: ScriptDebuggerService, expression: string, frameId?: number): object;
|
|
12566
12599
|
/**
|
|
12600
|
+
* Returns the root variables (locals, upvalues, globals) for a stack frame.
|
|
12601
|
+
*
|
|
12567
12602
|
* - **ThreadSafety**: Unsafe
|
|
12568
12603
|
*
|
|
12569
12604
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScriptDebuggerService#GetRootVariables)
|
|
12605
|
+
* @param this Provides programmatic breakpoint management, execution control, and runtime inspection of Luau scripts during a playtest.
|
|
12606
|
+
* @param frameId The frame identifier from a debug stack frame `Id` field (see `GetStackTrace()`).
|
|
12607
|
+
* @returns An array of script variable dictionaries, each containing the following key-value pairs: - `Name` — String value indicating the variable name or table key.
|
|
12608
|
+
* - `Value` — String representation of the value.
|
|
12609
|
+
* - `Type` — String indicating the Luau type (`"number"`, `"string"`, `"table"`, `"Instance"`, etc.).
|
|
12610
|
+
* - `Scope` — `ScriptVariableScope` value (children inherit parent's scope).
|
|
12611
|
+
* - `VariablesReference` — If greater than `0`, call `GetVariables()` with this to get children.
|
|
12570
12612
|
*/
|
|
12571
12613
|
GetRootVariables(this: ScriptDebuggerService, frameId: number): Array<unknown>;
|
|
12572
12614
|
/**
|
|
12615
|
+
* Returns the call stack for a paused thread.
|
|
12616
|
+
*
|
|
12573
12617
|
* - **ThreadSafety**: Unsafe
|
|
12574
12618
|
*
|
|
12575
12619
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScriptDebuggerService#GetStackTrace)
|
|
12620
|
+
* @param this Provides programmatic breakpoint management, execution control, and runtime inspection of Luau scripts during a playtest.
|
|
12621
|
+
* @param threadId The thread identifier from a script debug thread `Id` field (see `GetThreads()`).
|
|
12622
|
+
* @param startFrame Optional 1-based frame index for paginated retrieval.
|
|
12623
|
+
* @returns Dictionary containing the frames ordered innermost (current) to outermost. Contains the following key-value pairs: - `Frames` — Array of debug stack frame dictionaries. Each dictionary item contains the following key-value pairs:
|
|
12624
|
+
* - `Id` — Numerical frame identifier; use with `GetRootVariables()` and `Evaluate()`.
|
|
12625
|
+
* - `Name` — Human-readable name of the function at this frame.
|
|
12626
|
+
* - `ScriptPath` — Full instance path of the script, for example `"ServerScriptService.MainScript"`.
|
|
12627
|
+
* - `Line` — 1-based line number where execution is paused at this frame.
|
|
12628
|
+
* - `TotalFrames` — Total frame count, provided when paginating.
|
|
12576
12629
|
*/
|
|
12577
12630
|
GetStackTrace(this: ScriptDebuggerService, threadId: number, startFrame?: number): object;
|
|
12578
12631
|
/**
|
|
12632
|
+
* Returns all paused Luau threads.
|
|
12633
|
+
*
|
|
12579
12634
|
* - **ThreadSafety**: Unsafe
|
|
12580
12635
|
*
|
|
12581
12636
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScriptDebuggerService#GetThreads)
|
|
12637
|
+
* @param this Provides programmatic breakpoint management, execution control, and runtime inspection of Luau scripts during a playtest.
|
|
12638
|
+
* @returns An array of script debug thread dictionaries, each containing the following key-value pairs: - `Id` — Numerical thread identifier; use with `GetStackTrace()` and stepping.
|
|
12639
|
+
* - `Name` — Human-readable name of the script.
|
|
12582
12640
|
*/
|
|
12583
12641
|
GetThreads(this: ScriptDebuggerService): Array<unknown>;
|
|
12584
12642
|
/**
|
|
12643
|
+
* Drills into structured variables (tables, `Instances`).
|
|
12644
|
+
*
|
|
12585
12645
|
* - **ThreadSafety**: Unsafe
|
|
12586
12646
|
*
|
|
12587
12647
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScriptDebuggerService#GetVariables)
|
|
12648
|
+
* @param this Provides programmatic breakpoint management, execution control, and runtime inspection of Luau scripts during a playtest.
|
|
12649
|
+
* @param variablesReference A reference from a previous script variable's `VariablesReference` field (see `GetRootVariables()`).
|
|
12650
|
+
* @returns An array of script variable dictionaries representing the children in the same format as variable dictionaries from `GetRootVariables()`. Returns empty if the `DataModel` is not stopped at a breakpoint or exception, or when stopped via `Pause()`.
|
|
12588
12651
|
*/
|
|
12589
12652
|
GetVariables(this: ScriptDebuggerService, variablesReference: number): Array<unknown>;
|
|
12590
12653
|
/**
|
|
12654
|
+
* Requests the debugger to pause at the next safe point.
|
|
12655
|
+
*
|
|
12591
12656
|
* - **ThreadSafety**: Unsafe
|
|
12592
12657
|
*
|
|
12593
12658
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScriptDebuggerService#Pause)
|
|
12659
|
+
* @param this Provides programmatic breakpoint management, execution control, and runtime inspection of Luau scripts during a playtest.
|
|
12594
12660
|
*/
|
|
12595
12661
|
Pause(this: ScriptDebuggerService): void;
|
|
12596
12662
|
/**
|
|
12663
|
+
* Removes the breakpoint on the given script and line.
|
|
12664
|
+
*
|
|
12597
12665
|
* - **ThreadSafety**: Unsafe
|
|
12598
12666
|
*
|
|
12599
12667
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScriptDebuggerService#RemoveBreakpoint)
|
|
12668
|
+
* @param this Provides programmatic breakpoint management, execution control, and runtime inspection of Luau scripts during a playtest.
|
|
12669
|
+
* @param scriptInstance The `LuaSourceContainer` containing the breakpoint.
|
|
12670
|
+
* @param line The 1-based line number of the breakpoint to remove.
|
|
12671
|
+
* @returns `true` if a breakpoint was removed, `false` if no breakpoint existed on the line.
|
|
12600
12672
|
*/
|
|
12601
12673
|
RemoveBreakpoint(this: ScriptDebuggerService, scriptInstance: LuaSourceContainer, line: number): boolean;
|
|
12602
12674
|
/**
|
|
12675
|
+
* Controls when the debugger pauses on exceptions.
|
|
12676
|
+
*
|
|
12603
12677
|
* - **ThreadSafety**: Unsafe
|
|
12604
12678
|
*
|
|
12605
12679
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScriptDebuggerService#SetExceptionBreakMode)
|
|
12680
|
+
* @param this Provides programmatic breakpoint management, execution control, and runtime inspection of Luau scripts during a playtest.
|
|
12681
|
+
* @param breakMode The `DebugBreakModeType` to set.
|
|
12606
12682
|
*/
|
|
12607
12683
|
SetExceptionBreakMode(this: ScriptDebuggerService, breakMode: CastsToEnum<Enum.DebugBreakModeType>): void;
|
|
12608
12684
|
/**
|
|
12685
|
+
* Fires when a previously paused thread resumes execution.
|
|
12686
|
+
*
|
|
12609
12687
|
* - **ThreadSafety**: Unsafe
|
|
12610
12688
|
*
|
|
12611
12689
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScriptDebuggerService#Resumed)
|
|
12612
12690
|
*/
|
|
12613
12691
|
readonly Resumed: RBXScriptSignal<(threadIds: Array<unknown>) => void>;
|
|
12614
12692
|
/**
|
|
12693
|
+
* The primary callback for reacting to debugger pauses. Returns a resume action.
|
|
12694
|
+
*
|
|
12615
12695
|
* - **ThreadSafety**: Unsafe
|
|
12616
12696
|
*
|
|
12617
12697
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScriptDebuggerService#OnStopped)
|
|
12698
|
+
* @param stopped Dictionary describing why the debugger paused. The following key-value pairs are valid: - `Reason` — `ScriptStoppedReason` why the debugger paused.
|
|
12699
|
+
* - `ThreadIds` — Array of thread identifiers that stopped.
|
|
12700
|
+
* - `ExceptionText` — Error message present when `Reason` is `ScriptStoppedReason.Exception`.
|
|
12701
|
+
*
|
|
12702
|
+
*
|
|
12703
|
+
* @returns Dictionary specifying how to resume execution. Contains the following key-value pairs: - `steppedType` — `DebuggerResumeType` describing how to resume.
|
|
12704
|
+
* - `threadId` — Number indicating which thread to step. Required for step actions.
|
|
12618
12705
|
*/
|
|
12619
12706
|
OnStopped: ((stopped: object) => object) | undefined;
|
|
12620
12707
|
}
|
|
@@ -17085,8 +17172,6 @@ interface UIScale extends UIComponent {
|
|
|
17085
17172
|
/**
|
|
17086
17173
|
* Renders a shadow below the parent UI instance.
|
|
17087
17174
|
*
|
|
17088
|
-
* - **Tags**: NotBrowsable
|
|
17089
|
-
*
|
|
17090
17175
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UIShadow)
|
|
17091
17176
|
*/
|
|
17092
17177
|
interface UIShadow extends UIComponent {
|
|
@@ -3601,11 +3601,20 @@ declare namespace Enum {
|
|
|
3601
3601
|
EnumType: typeof globalThis.Enum.AssetType;
|
|
3602
3602
|
}
|
|
3603
3603
|
export const AvatarBackground: AvatarBackground;
|
|
3604
|
+
/**
|
|
3605
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AssetType#TextDocument)
|
|
3606
|
+
*/
|
|
3607
|
+
export interface TextDocument extends globalThis.EnumItem {
|
|
3608
|
+
Name: "TextDocument";
|
|
3609
|
+
Value: 93;
|
|
3610
|
+
EnumType: typeof globalThis.Enum.AssetType;
|
|
3611
|
+
}
|
|
3612
|
+
export const TextDocument: TextDocument;
|
|
3604
3613
|
export function GetEnumItems(this: globalThis.Enum): Array<globalThis.Enum.AssetType>;
|
|
3605
3614
|
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.AssetType | undefined;
|
|
3606
3615
|
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.AssetType | undefined;
|
|
3607
3616
|
}
|
|
3608
|
-
export type AssetType = AssetType.Image | AssetType.TShirt | AssetType.Audio | AssetType.Mesh | AssetType.Lua | AssetType.Hat | AssetType.Place | AssetType.Model | AssetType.Shirt | AssetType.Pants | AssetType.Decal | AssetType.Head | AssetType.Face | AssetType.Gear | AssetType.Badge | AssetType.Animation | AssetType.Torso | AssetType.RightArm | AssetType.LeftArm | AssetType.LeftLeg | AssetType.RightLeg | AssetType.Package | AssetType.GamePass | AssetType.Plugin | AssetType.MeshPart | AssetType.HairAccessory | AssetType.FaceAccessory | AssetType.NeckAccessory | AssetType.ShoulderAccessory | AssetType.FrontAccessory | AssetType.BackAccessory | AssetType.WaistAccessory | AssetType.ClimbAnimation | AssetType.DeathAnimation | AssetType.FallAnimation | AssetType.IdleAnimation | AssetType.JumpAnimation | AssetType.RunAnimation | AssetType.SwimAnimation | AssetType.WalkAnimation | AssetType.PoseAnimation | AssetType.EarAccessory | AssetType.EyeAccessory | AssetType.EmoteAnimation | AssetType.Video | AssetType.TShirtAccessory | AssetType.ShirtAccessory | AssetType.PantsAccessory | AssetType.JacketAccessory | AssetType.SweaterAccessory | AssetType.ShortsAccessory | AssetType.LeftShoeAccessory | AssetType.RightShoeAccessory | AssetType.DressSkirtAccessory | AssetType.FontFamily | AssetType.EyebrowAccessory | AssetType.EyelashAccessory | AssetType.MoodAnimation | AssetType.DynamicHead | AssetType.FaceMakeup | AssetType.LipMakeup | AssetType.EyeMakeup | AssetType.VoxelFragment | AssetType.AvatarBackground;
|
|
3617
|
+
export type AssetType = AssetType.Image | AssetType.TShirt | AssetType.Audio | AssetType.Mesh | AssetType.Lua | AssetType.Hat | AssetType.Place | AssetType.Model | AssetType.Shirt | AssetType.Pants | AssetType.Decal | AssetType.Head | AssetType.Face | AssetType.Gear | AssetType.Badge | AssetType.Animation | AssetType.Torso | AssetType.RightArm | AssetType.LeftArm | AssetType.LeftLeg | AssetType.RightLeg | AssetType.Package | AssetType.GamePass | AssetType.Plugin | AssetType.MeshPart | AssetType.HairAccessory | AssetType.FaceAccessory | AssetType.NeckAccessory | AssetType.ShoulderAccessory | AssetType.FrontAccessory | AssetType.BackAccessory | AssetType.WaistAccessory | AssetType.ClimbAnimation | AssetType.DeathAnimation | AssetType.FallAnimation | AssetType.IdleAnimation | AssetType.JumpAnimation | AssetType.RunAnimation | AssetType.SwimAnimation | AssetType.WalkAnimation | AssetType.PoseAnimation | AssetType.EarAccessory | AssetType.EyeAccessory | AssetType.EmoteAnimation | AssetType.Video | AssetType.TShirtAccessory | AssetType.ShirtAccessory | AssetType.PantsAccessory | AssetType.JacketAccessory | AssetType.SweaterAccessory | AssetType.ShortsAccessory | AssetType.LeftShoeAccessory | AssetType.RightShoeAccessory | AssetType.DressSkirtAccessory | AssetType.FontFamily | AssetType.EyebrowAccessory | AssetType.EyelashAccessory | AssetType.MoodAnimation | AssetType.DynamicHead | AssetType.FaceMakeup | AssetType.LipMakeup | AssetType.EyeMakeup | AssetType.VoxelFragment | AssetType.AvatarBackground | AssetType.TextDocument;
|
|
3609
3618
|
/**
|
|
3610
3619
|
* Determines the asset type verification mode.
|
|
3611
3620
|
*
|
|
@@ -6680,11 +6689,38 @@ declare namespace Enum {
|
|
|
6680
6689
|
EnumType: typeof globalThis.Enum.CanCollaborateError;
|
|
6681
6690
|
}
|
|
6682
6691
|
export const OutsideAgeBucketTcPc: OutsideAgeBucketTcPc;
|
|
6692
|
+
/**
|
|
6693
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CanCollaborateError#OtherCollaboratorSettingsPreventTrust)
|
|
6694
|
+
*/
|
|
6695
|
+
export interface OtherCollaboratorSettingsPreventTrust extends globalThis.EnumItem {
|
|
6696
|
+
Name: "OtherCollaboratorSettingsPreventTrust";
|
|
6697
|
+
Value: 10;
|
|
6698
|
+
EnumType: typeof globalThis.Enum.CanCollaborateError;
|
|
6699
|
+
}
|
|
6700
|
+
export const OtherCollaboratorSettingsPreventTrust: OtherCollaboratorSettingsPreventTrust;
|
|
6701
|
+
/**
|
|
6702
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CanCollaborateError#AgeVerificationCountryBlocked)
|
|
6703
|
+
*/
|
|
6704
|
+
export interface AgeVerificationCountryBlocked extends globalThis.EnumItem {
|
|
6705
|
+
Name: "AgeVerificationCountryBlocked";
|
|
6706
|
+
Value: 11;
|
|
6707
|
+
EnumType: typeof globalThis.Enum.CanCollaborateError;
|
|
6708
|
+
}
|
|
6709
|
+
export const AgeVerificationCountryBlocked: AgeVerificationCountryBlocked;
|
|
6710
|
+
/**
|
|
6711
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CanCollaborateError#OtherUserCannotCollaborate)
|
|
6712
|
+
*/
|
|
6713
|
+
export interface OtherUserCannotCollaborate extends globalThis.EnumItem {
|
|
6714
|
+
Name: "OtherUserCannotCollaborate";
|
|
6715
|
+
Value: 12;
|
|
6716
|
+
EnumType: typeof globalThis.Enum.CanCollaborateError;
|
|
6717
|
+
}
|
|
6718
|
+
export const OtherUserCannotCollaborate: OtherUserCannotCollaborate;
|
|
6683
6719
|
export function GetEnumItems(this: globalThis.Enum): Array<globalThis.Enum.CanCollaborateError>;
|
|
6684
6720
|
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.CanCollaborateError | undefined;
|
|
6685
6721
|
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.CanCollaborateError | undefined;
|
|
6686
6722
|
}
|
|
6687
|
-
export type CanCollaborateError = CanCollaborateError.Invalid | CanCollaborateError.None | CanCollaborateError.NotAgeVerified | CanCollaborateError.OutsideAgeBucket | CanCollaborateError.TooManyCollaborators | CanCollaborateError.PCBlock | CanCollaborateError.NotFound | CanCollaborateError.OutsideOwnerAgeBucket | CanCollaborateError.NotAuthorized | CanCollaborateError.OutsideAgeBucketTcPc;
|
|
6723
|
+
export type CanCollaborateError = CanCollaborateError.Invalid | CanCollaborateError.None | CanCollaborateError.NotAgeVerified | CanCollaborateError.OutsideAgeBucket | CanCollaborateError.TooManyCollaborators | CanCollaborateError.PCBlock | CanCollaborateError.NotFound | CanCollaborateError.OutsideOwnerAgeBucket | CanCollaborateError.NotAuthorized | CanCollaborateError.OutsideAgeBucketTcPc | CanCollaborateError.OtherCollaboratorSettingsPreventTrust | CanCollaborateError.AgeVerificationCountryBlocked | CanCollaborateError.OtherUserCannotCollaborate;
|
|
6688
6724
|
/**
|
|
6689
6725
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CaptureGalleryPermission)
|
|
6690
6726
|
*/
|
|
@@ -10402,10 +10438,14 @@ declare namespace Enum {
|
|
|
10402
10438
|
}
|
|
10403
10439
|
export type DataStoreRequestType = DataStoreRequestType.GetAsync | DataStoreRequestType.SetIncrementAsync | DataStoreRequestType.UpdateAsync | DataStoreRequestType.GetSortedAsync | DataStoreRequestType.SetIncrementSortedAsync | DataStoreRequestType.OnUpdate | DataStoreRequestType.ListAsync | DataStoreRequestType.GetVersionAsync | DataStoreRequestType.RemoveVersionAsync | DataStoreRequestType.StandardRead | DataStoreRequestType.StandardWrite | DataStoreRequestType.StandardList | DataStoreRequestType.StandardRemove | DataStoreRequestType.OrderedRead | DataStoreRequestType.OrderedWrite | DataStoreRequestType.OrderedList | DataStoreRequestType.OrderedRemove;
|
|
10404
10440
|
/**
|
|
10441
|
+
* Controls when the debugger pauses on exceptions.
|
|
10442
|
+
*
|
|
10405
10443
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DebugBreakModeType)
|
|
10406
10444
|
*/
|
|
10407
10445
|
export namespace DebugBreakModeType {
|
|
10408
10446
|
/**
|
|
10447
|
+
* Never break on exceptions.
|
|
10448
|
+
*
|
|
10409
10449
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DebugBreakModeType#Never)
|
|
10410
10450
|
*/
|
|
10411
10451
|
export interface Never extends globalThis.EnumItem {
|
|
@@ -10415,6 +10455,8 @@ declare namespace Enum {
|
|
|
10415
10455
|
}
|
|
10416
10456
|
export const Never: Never;
|
|
10417
10457
|
/**
|
|
10458
|
+
* Break on all exceptions.
|
|
10459
|
+
*
|
|
10418
10460
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DebugBreakModeType#Always)
|
|
10419
10461
|
*/
|
|
10420
10462
|
export interface Always extends globalThis.EnumItem {
|
|
@@ -10424,6 +10466,8 @@ declare namespace Enum {
|
|
|
10424
10466
|
}
|
|
10425
10467
|
export const Always: Always;
|
|
10426
10468
|
/**
|
|
10469
|
+
* Break only on unhandled exceptions.
|
|
10470
|
+
*
|
|
10427
10471
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DebugBreakModeType#Unhandled)
|
|
10428
10472
|
*/
|
|
10429
10473
|
export interface Unhandled extends globalThis.EnumItem {
|
|
@@ -10683,10 +10727,14 @@ declare namespace Enum {
|
|
|
10683
10727
|
}
|
|
10684
10728
|
export type DebuggerPauseReason = DebuggerPauseReason.Unknown | DebuggerPauseReason.Requested | DebuggerPauseReason.Breakpoint | DebuggerPauseReason.Exception | DebuggerPauseReason.SingleStep | DebuggerPauseReason.Entrypoint;
|
|
10685
10729
|
/**
|
|
10730
|
+
* Specifies how the debugger should resume execution after a pause.
|
|
10731
|
+
*
|
|
10686
10732
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DebuggerResumeType)
|
|
10687
10733
|
*/
|
|
10688
10734
|
export namespace DebuggerResumeType {
|
|
10689
10735
|
/**
|
|
10736
|
+
* Step into the next function call on the specified thread.
|
|
10737
|
+
*
|
|
10690
10738
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DebuggerResumeType#StepInto)
|
|
10691
10739
|
*/
|
|
10692
10740
|
export interface StepInto extends globalThis.EnumItem {
|
|
@@ -10696,6 +10744,8 @@ declare namespace Enum {
|
|
|
10696
10744
|
}
|
|
10697
10745
|
export const StepInto: StepInto;
|
|
10698
10746
|
/**
|
|
10747
|
+
* Step out of the current function on the specified thread.
|
|
10748
|
+
*
|
|
10699
10749
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DebuggerResumeType#StepOut)
|
|
10700
10750
|
*/
|
|
10701
10751
|
export interface StepOut extends globalThis.EnumItem {
|
|
@@ -10705,6 +10755,8 @@ declare namespace Enum {
|
|
|
10705
10755
|
}
|
|
10706
10756
|
export const StepOut: StepOut;
|
|
10707
10757
|
/**
|
|
10758
|
+
* Step over the current line on the specified thread.
|
|
10759
|
+
*
|
|
10708
10760
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DebuggerResumeType#StepOver)
|
|
10709
10761
|
*/
|
|
10710
10762
|
export interface StepOver extends globalThis.EnumItem {
|
|
@@ -10714,6 +10766,8 @@ declare namespace Enum {
|
|
|
10714
10766
|
}
|
|
10715
10767
|
export const StepOver: StepOver;
|
|
10716
10768
|
/**
|
|
10769
|
+
* Resume execution normally without stepping.
|
|
10770
|
+
*
|
|
10717
10771
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DebuggerResumeType#Resume)
|
|
10718
10772
|
*/
|
|
10719
10773
|
export interface Resume extends globalThis.EnumItem {
|
|
@@ -12557,6 +12611,39 @@ declare namespace Enum {
|
|
|
12557
12611
|
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.ElasticBehavior | undefined;
|
|
12558
12612
|
}
|
|
12559
12613
|
export type ElasticBehavior = ElasticBehavior.WhenScrollable | ElasticBehavior.Always | ElasticBehavior.Never;
|
|
12614
|
+
/**
|
|
12615
|
+
* Defines where and how an `AudioEmitter` is positioned when sending out spatial audio.
|
|
12616
|
+
*
|
|
12617
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/EmitterPositionType)
|
|
12618
|
+
*/
|
|
12619
|
+
export namespace EmitterPositionType {
|
|
12620
|
+
/**
|
|
12621
|
+
* Uses the parent `Instance` of the `AudioEmitter`.
|
|
12622
|
+
*
|
|
12623
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/EmitterPositionType#Parent)
|
|
12624
|
+
*/
|
|
12625
|
+
export interface Parent extends globalThis.EnumItem {
|
|
12626
|
+
Name: "Parent";
|
|
12627
|
+
Value: 0;
|
|
12628
|
+
EnumType: typeof globalThis.Enum.EmitterPositionType;
|
|
12629
|
+
}
|
|
12630
|
+
export const Parent: Parent;
|
|
12631
|
+
/**
|
|
12632
|
+
* Uses a specified `Instance`.
|
|
12633
|
+
*
|
|
12634
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/EmitterPositionType#Instance)
|
|
12635
|
+
*/
|
|
12636
|
+
export interface Instance extends globalThis.EnumItem {
|
|
12637
|
+
Name: "Instance";
|
|
12638
|
+
Value: 1;
|
|
12639
|
+
EnumType: typeof globalThis.Enum.EmitterPositionType;
|
|
12640
|
+
}
|
|
12641
|
+
export const Instance: Instance;
|
|
12642
|
+
export function GetEnumItems(this: globalThis.Enum): Array<globalThis.Enum.EmitterPositionType>;
|
|
12643
|
+
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.EmitterPositionType | undefined;
|
|
12644
|
+
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.EmitterPositionType | undefined;
|
|
12645
|
+
}
|
|
12646
|
+
export type EmitterPositionType = EmitterPositionType.Parent | EmitterPositionType.Instance;
|
|
12560
12647
|
/**
|
|
12561
12648
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/EngagementLevel)
|
|
12562
12649
|
*/
|
|
@@ -17834,6 +17921,39 @@ declare namespace Enum {
|
|
|
17834
17921
|
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.InputActionType | undefined;
|
|
17835
17922
|
}
|
|
17836
17923
|
export type InputActionType = InputActionType.Bool | InputActionType.Direction1D | InputActionType.Direction2D | InputActionType.Direction3D | InputActionType.ViewportPosition;
|
|
17924
|
+
/**
|
|
17925
|
+
* This enum is used by `InputBinding.BindingType` to determine whether the binding responds to hardware input or is driven programmatically.
|
|
17926
|
+
*
|
|
17927
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/InputBindingType)
|
|
17928
|
+
*/
|
|
17929
|
+
export namespace InputBindingType {
|
|
17930
|
+
/**
|
|
17931
|
+
* The `InputBinding` responds to physical input devices (keyboard, mouse, gamepad, touch) based on its `KeyCode` or composite direction properties. This is the default.
|
|
17932
|
+
*
|
|
17933
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/InputBindingType#Automatic)
|
|
17934
|
+
*/
|
|
17935
|
+
export interface Automatic extends globalThis.EnumItem {
|
|
17936
|
+
Name: "Automatic";
|
|
17937
|
+
Value: 0;
|
|
17938
|
+
EnumType: typeof globalThis.Enum.InputBindingType;
|
|
17939
|
+
}
|
|
17940
|
+
export const Automatic: Automatic;
|
|
17941
|
+
/**
|
|
17942
|
+
* The `InputBinding` ignores hardware input and instead receives state updates exclusively through the `InputBinding:Fire()` method.
|
|
17943
|
+
*
|
|
17944
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/InputBindingType#Scriptable)
|
|
17945
|
+
*/
|
|
17946
|
+
export interface Scriptable extends globalThis.EnumItem {
|
|
17947
|
+
Name: "Scriptable";
|
|
17948
|
+
Value: 1;
|
|
17949
|
+
EnumType: typeof globalThis.Enum.InputBindingType;
|
|
17950
|
+
}
|
|
17951
|
+
export const Scriptable: Scriptable;
|
|
17952
|
+
export function GetEnumItems(this: globalThis.Enum): Array<globalThis.Enum.InputBindingType>;
|
|
17953
|
+
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.InputBindingType | undefined;
|
|
17954
|
+
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.InputBindingType | undefined;
|
|
17955
|
+
}
|
|
17956
|
+
export type InputBindingType = InputBindingType.Automatic | InputBindingType.Scriptable;
|
|
17837
17957
|
/**
|
|
17838
17958
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/InputSink)
|
|
17839
17959
|
*/
|
|
@@ -21363,6 +21483,33 @@ declare namespace Enum {
|
|
|
21363
21483
|
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.KeyCode | undefined;
|
|
21364
21484
|
}
|
|
21365
21485
|
export type KeyCode = KeyCode.Unknown | KeyCode.Backspace | KeyCode.Tab | KeyCode.Clear | KeyCode.Return | KeyCode.Pause | KeyCode.Escape | KeyCode.Space | KeyCode.QuotedDouble | KeyCode.Hash | KeyCode.Dollar | KeyCode.Percent | KeyCode.Ampersand | KeyCode.Quote | KeyCode.LeftParenthesis | KeyCode.RightParenthesis | KeyCode.Asterisk | KeyCode.Plus | KeyCode.Comma | KeyCode.Minus | KeyCode.Period | KeyCode.Slash | KeyCode.Zero | KeyCode.One | KeyCode.Two | KeyCode.Three | KeyCode.Four | KeyCode.Five | KeyCode.Six | KeyCode.Seven | KeyCode.Eight | KeyCode.Nine | KeyCode.Colon | KeyCode.Semicolon | KeyCode.LessThan | KeyCode.Equals | KeyCode.GreaterThan | KeyCode.Question | KeyCode.At | KeyCode.LeftBracket | KeyCode.BackSlash | KeyCode.RightBracket | KeyCode.Caret | KeyCode.Underscore | KeyCode.Backquote | KeyCode.A | KeyCode.B | KeyCode.C | KeyCode.D | KeyCode.E | KeyCode.F | KeyCode.G | KeyCode.H | KeyCode.I | KeyCode.J | KeyCode.K | KeyCode.L | KeyCode.M | KeyCode.N | KeyCode.O | KeyCode.P | KeyCode.Q | KeyCode.R | KeyCode.S | KeyCode.T | KeyCode.U | KeyCode.V | KeyCode.W | KeyCode.X | KeyCode.Y | KeyCode.Z | KeyCode.LeftCurly | KeyCode.Pipe | KeyCode.RightCurly | KeyCode.Tilde | KeyCode.Delete | KeyCode.World0 | KeyCode.World1 | KeyCode.World2 | KeyCode.World3 | KeyCode.World4 | KeyCode.World5 | KeyCode.World6 | KeyCode.World7 | KeyCode.World8 | KeyCode.World9 | KeyCode.World10 | KeyCode.World11 | KeyCode.World12 | KeyCode.World13 | KeyCode.World14 | KeyCode.World15 | KeyCode.World16 | KeyCode.World17 | KeyCode.World18 | KeyCode.World19 | KeyCode.World20 | KeyCode.World21 | KeyCode.World22 | KeyCode.World23 | KeyCode.World24 | KeyCode.World25 | KeyCode.World26 | KeyCode.World27 | KeyCode.World28 | KeyCode.World29 | KeyCode.World30 | KeyCode.World31 | KeyCode.World32 | KeyCode.World33 | KeyCode.World34 | KeyCode.World35 | KeyCode.World36 | KeyCode.World37 | KeyCode.World38 | KeyCode.World39 | KeyCode.World40 | KeyCode.World41 | KeyCode.World42 | KeyCode.World43 | KeyCode.World44 | KeyCode.World45 | KeyCode.World46 | KeyCode.World47 | KeyCode.World48 | KeyCode.World49 | KeyCode.World50 | KeyCode.World51 | KeyCode.World52 | KeyCode.World53 | KeyCode.World54 | KeyCode.World55 | KeyCode.World56 | KeyCode.World57 | KeyCode.World58 | KeyCode.World59 | KeyCode.World60 | KeyCode.World61 | KeyCode.World62 | KeyCode.World63 | KeyCode.World64 | KeyCode.World65 | KeyCode.World66 | KeyCode.World67 | KeyCode.World68 | KeyCode.World69 | KeyCode.World70 | KeyCode.World71 | KeyCode.World72 | KeyCode.World73 | KeyCode.World74 | KeyCode.World75 | KeyCode.World76 | KeyCode.World77 | KeyCode.World78 | KeyCode.World79 | KeyCode.World80 | KeyCode.World81 | KeyCode.World82 | KeyCode.World83 | KeyCode.World84 | KeyCode.World85 | KeyCode.World86 | KeyCode.World87 | KeyCode.World88 | KeyCode.World89 | KeyCode.World90 | KeyCode.World91 | KeyCode.World92 | KeyCode.World93 | KeyCode.World94 | KeyCode.World95 | KeyCode.KeypadZero | KeyCode.KeypadOne | KeyCode.KeypadTwo | KeyCode.KeypadThree | KeyCode.KeypadFour | KeyCode.KeypadFive | KeyCode.KeypadSix | KeyCode.KeypadSeven | KeyCode.KeypadEight | KeyCode.KeypadNine | KeyCode.KeypadPeriod | KeyCode.KeypadDivide | KeyCode.KeypadMultiply | KeyCode.KeypadMinus | KeyCode.KeypadPlus | KeyCode.KeypadEnter | KeyCode.KeypadEquals | KeyCode.Up | KeyCode.Down | KeyCode.Right | KeyCode.Left | KeyCode.Insert | KeyCode.Home | KeyCode.End | KeyCode.PageUp | KeyCode.PageDown | KeyCode.F1 | KeyCode.F2 | KeyCode.F3 | KeyCode.F4 | KeyCode.F5 | KeyCode.F6 | KeyCode.F7 | KeyCode.F8 | KeyCode.F9 | KeyCode.F10 | KeyCode.F11 | KeyCode.F12 | KeyCode.F13 | KeyCode.F14 | KeyCode.F15 | KeyCode.NumLock | KeyCode.CapsLock | KeyCode.ScrollLock | KeyCode.RightShift | KeyCode.LeftShift | KeyCode.RightControl | KeyCode.LeftControl | KeyCode.RightAlt | KeyCode.LeftAlt | KeyCode.RightMeta | KeyCode.LeftMeta | KeyCode.LeftSuper | KeyCode.RightSuper | KeyCode.Mode | KeyCode.Compose | KeyCode.Help | KeyCode.Print | KeyCode.SysReq | KeyCode.Break | KeyCode.Menu | KeyCode.Power | KeyCode.Euro | KeyCode.Undo | KeyCode.ButtonX | KeyCode.ButtonY | KeyCode.ButtonA | KeyCode.ButtonB | KeyCode.ButtonR1 | KeyCode.ButtonL1 | KeyCode.ButtonR2 | KeyCode.ButtonL2 | KeyCode.ButtonR3 | KeyCode.ButtonL3 | KeyCode.ButtonStart | KeyCode.ButtonSelect | KeyCode.DPadLeft | KeyCode.DPadRight | KeyCode.DPadUp | KeyCode.DPadDown | KeyCode.Thumbstick1 | KeyCode.Thumbstick2 | KeyCode.Thumbstick1Up | KeyCode.Thumbstick1Down | KeyCode.Thumbstick1Left | KeyCode.Thumbstick1Right | KeyCode.Thumbstick2Up | KeyCode.Thumbstick2Down | KeyCode.Thumbstick2Left | KeyCode.Thumbstick2Right | KeyCode.MouseLeftButton | KeyCode.MouseRightButton | KeyCode.MouseMiddleButton | KeyCode.MouseBackButton | KeyCode.MouseNoButton | KeyCode.MouseX | KeyCode.MouseY | KeyCode.MousePosition | KeyCode.TouchPosition | KeyCode.MouseWheel | KeyCode.TrackpadPan | KeyCode.TrackpadPinch | KeyCode.MouseDelta | KeyCode.TouchDelta | KeyCode.TouchPinch;
|
|
21486
|
+
/**
|
|
21487
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/KeyCodeStringFormat)
|
|
21488
|
+
*/
|
|
21489
|
+
export namespace KeyCodeStringFormat {
|
|
21490
|
+
/**
|
|
21491
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/KeyCodeStringFormat#Default)
|
|
21492
|
+
*/
|
|
21493
|
+
export interface Default extends globalThis.EnumItem {
|
|
21494
|
+
Name: "Default";
|
|
21495
|
+
Value: 0;
|
|
21496
|
+
EnumType: typeof globalThis.Enum.KeyCodeStringFormat;
|
|
21497
|
+
}
|
|
21498
|
+
export const Default: Default;
|
|
21499
|
+
/**
|
|
21500
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/KeyCodeStringFormat#Abbreviated)
|
|
21501
|
+
*/
|
|
21502
|
+
export interface Abbreviated extends globalThis.EnumItem {
|
|
21503
|
+
Name: "Abbreviated";
|
|
21504
|
+
Value: 1;
|
|
21505
|
+
EnumType: typeof globalThis.Enum.KeyCodeStringFormat;
|
|
21506
|
+
}
|
|
21507
|
+
export const Abbreviated: Abbreviated;
|
|
21508
|
+
export function GetEnumItems(this: globalThis.Enum): Array<globalThis.Enum.KeyCodeStringFormat>;
|
|
21509
|
+
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.KeyCodeStringFormat | undefined;
|
|
21510
|
+
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.KeyCodeStringFormat | undefined;
|
|
21511
|
+
}
|
|
21512
|
+
export type KeyCodeStringFormat = KeyCodeStringFormat.Default | KeyCodeStringFormat.Abbreviated;
|
|
21366
21513
|
/**
|
|
21367
21514
|
* Describes the interpolation method between two keys.
|
|
21368
21515
|
*
|
|
@@ -21945,6 +22092,39 @@ declare namespace Enum {
|
|
|
21945
22092
|
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.ListenerLocation | undefined;
|
|
21946
22093
|
}
|
|
21947
22094
|
export type ListenerLocation = ListenerLocation.Default | ListenerLocation.None | ListenerLocation.Character | ListenerLocation.Camera;
|
|
22095
|
+
/**
|
|
22096
|
+
* Defines where and how an `AudioListener` is positioned when receiving spatial audio.
|
|
22097
|
+
*
|
|
22098
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ListenerPositionType)
|
|
22099
|
+
*/
|
|
22100
|
+
export namespace ListenerPositionType {
|
|
22101
|
+
/**
|
|
22102
|
+
* Uses the parent `Instance` of the `AudioEmitter`.
|
|
22103
|
+
*
|
|
22104
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ListenerPositionType#Parent)
|
|
22105
|
+
*/
|
|
22106
|
+
export interface Parent extends globalThis.EnumItem {
|
|
22107
|
+
Name: "Parent";
|
|
22108
|
+
Value: 0;
|
|
22109
|
+
EnumType: typeof globalThis.Enum.ListenerPositionType;
|
|
22110
|
+
}
|
|
22111
|
+
export const Parent: Parent;
|
|
22112
|
+
/**
|
|
22113
|
+
* Uses a specified `Instance`.
|
|
22114
|
+
*
|
|
22115
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ListenerPositionType#Instance)
|
|
22116
|
+
*/
|
|
22117
|
+
export interface Instance extends globalThis.EnumItem {
|
|
22118
|
+
Name: "Instance";
|
|
22119
|
+
Value: 1;
|
|
22120
|
+
EnumType: typeof globalThis.Enum.ListenerPositionType;
|
|
22121
|
+
}
|
|
22122
|
+
export const Instance: Instance;
|
|
22123
|
+
export function GetEnumItems(this: globalThis.Enum): Array<globalThis.Enum.ListenerPositionType>;
|
|
22124
|
+
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.ListenerPositionType | undefined;
|
|
22125
|
+
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.ListenerPositionType | undefined;
|
|
22126
|
+
}
|
|
22127
|
+
export type ListenerPositionType = ListenerPositionType.Parent | ListenerPositionType.Instance;
|
|
21948
22128
|
/**
|
|
21949
22129
|
* Defines where and how the listener is positioned when picking up spatial audio.
|
|
21950
22130
|
*
|
|
@@ -30758,10 +30938,14 @@ declare namespace Enum {
|
|
|
30758
30938
|
}
|
|
30759
30939
|
export type ScreenshotCaptureResult = ScreenshotCaptureResult.Success | ScreenshotCaptureResult.OtherError | ScreenshotCaptureResult.NoDeviceSupport | ScreenshotCaptureResult.NoSpaceOnDevice;
|
|
30760
30940
|
/**
|
|
30941
|
+
* Describes why the debugger paused execution.
|
|
30942
|
+
*
|
|
30761
30943
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ScriptStoppedReason)
|
|
30762
30944
|
*/
|
|
30763
30945
|
export namespace ScriptStoppedReason {
|
|
30764
30946
|
/**
|
|
30947
|
+
* Execution stopped because a user-defined breakpoint was hit.
|
|
30948
|
+
*
|
|
30765
30949
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ScriptStoppedReason#Breakpoint)
|
|
30766
30950
|
*/
|
|
30767
30951
|
export interface Breakpoint extends globalThis.EnumItem {
|
|
@@ -30771,6 +30955,8 @@ declare namespace Enum {
|
|
|
30771
30955
|
}
|
|
30772
30956
|
export const Breakpoint: Breakpoint;
|
|
30773
30957
|
/**
|
|
30958
|
+
* Execution stopped because an exception was thrown (governed by the current `DebugBreakModeType`).
|
|
30959
|
+
*
|
|
30774
30960
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ScriptStoppedReason#Exception)
|
|
30775
30961
|
*/
|
|
30776
30962
|
export interface Exception extends globalThis.EnumItem {
|
|
@@ -30780,6 +30966,8 @@ declare namespace Enum {
|
|
|
30780
30966
|
}
|
|
30781
30967
|
export const Exception: Exception;
|
|
30782
30968
|
/**
|
|
30969
|
+
* Execution stopped because `ScriptDebuggerService:Pause()` was called.
|
|
30970
|
+
*
|
|
30783
30971
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ScriptStoppedReason#Pause)
|
|
30784
30972
|
*/
|
|
30785
30973
|
export interface Pause extends globalThis.EnumItem {
|
|
@@ -30789,6 +30977,8 @@ declare namespace Enum {
|
|
|
30789
30977
|
}
|
|
30790
30978
|
export const Pause: Pause;
|
|
30791
30979
|
/**
|
|
30980
|
+
* Execution stopped after completing a step operation.
|
|
30981
|
+
*
|
|
30792
30982
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ScriptStoppedReason#Step)
|
|
30793
30983
|
*/
|
|
30794
30984
|
export interface Step extends globalThis.EnumItem {
|
|
@@ -30798,6 +30988,8 @@ declare namespace Enum {
|
|
|
30798
30988
|
}
|
|
30799
30989
|
export const Step: Step;
|
|
30800
30990
|
/**
|
|
30991
|
+
* Execution stopped at a script's entry point.
|
|
30992
|
+
*
|
|
30801
30993
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ScriptStoppedReason#Entry)
|
|
30802
30994
|
*/
|
|
30803
30995
|
export interface Entry extends globalThis.EnumItem {
|
|
@@ -30812,10 +31004,14 @@ declare namespace Enum {
|
|
|
30812
31004
|
}
|
|
30813
31005
|
export type ScriptStoppedReason = ScriptStoppedReason.Breakpoint | ScriptStoppedReason.Exception | ScriptStoppedReason.Pause | ScriptStoppedReason.Step | ScriptStoppedReason.Entry;
|
|
30814
31006
|
/**
|
|
31007
|
+
* Indicates the scope category of a variable returned by the debugger.
|
|
31008
|
+
*
|
|
30815
31009
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ScriptVariableScope)
|
|
30816
31010
|
*/
|
|
30817
31011
|
export namespace ScriptVariableScope {
|
|
30818
31012
|
/**
|
|
31013
|
+
* A local variable declared in the current function scope.
|
|
31014
|
+
*
|
|
30819
31015
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ScriptVariableScope#Local)
|
|
30820
31016
|
*/
|
|
30821
31017
|
export interface Local extends globalThis.EnumItem {
|
|
@@ -30825,6 +31021,8 @@ declare namespace Enum {
|
|
|
30825
31021
|
}
|
|
30826
31022
|
export const Local: Local;
|
|
30827
31023
|
/**
|
|
31024
|
+
* A variable captured from an enclosing function scope.
|
|
31025
|
+
*
|
|
30828
31026
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ScriptVariableScope#Upvalue)
|
|
30829
31027
|
*/
|
|
30830
31028
|
export interface Upvalue extends globalThis.EnumItem {
|
|
@@ -30834,6 +31032,8 @@ declare namespace Enum {
|
|
|
30834
31032
|
}
|
|
30835
31033
|
export const Upvalue: Upvalue;
|
|
30836
31034
|
/**
|
|
31035
|
+
* A global variable.
|
|
31036
|
+
*
|
|
30837
31037
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ScriptVariableScope#Global)
|
|
30838
31038
|
*/
|
|
30839
31039
|
export interface Global extends globalThis.EnumItem {
|
|
@@ -31877,6 +32077,42 @@ declare namespace Enum {
|
|
|
31877
32077
|
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.SignalBehavior | undefined;
|
|
31878
32078
|
}
|
|
31879
32079
|
export type SignalBehavior = SignalBehavior.Default | SignalBehavior.Immediate | SignalBehavior.Deferred | SignalBehavior.AncestryDeferred;
|
|
32080
|
+
/**
|
|
32081
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/SimulationMode)
|
|
32082
|
+
*/
|
|
32083
|
+
export namespace SimulationMode {
|
|
32084
|
+
/**
|
|
32085
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/SimulationMode#Default)
|
|
32086
|
+
*/
|
|
32087
|
+
export interface Default extends globalThis.EnumItem {
|
|
32088
|
+
Name: "Default";
|
|
32089
|
+
Value: 0;
|
|
32090
|
+
EnumType: typeof globalThis.Enum.SimulationMode;
|
|
32091
|
+
}
|
|
32092
|
+
export const Default: Default;
|
|
32093
|
+
/**
|
|
32094
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/SimulationMode#Enabled)
|
|
32095
|
+
*/
|
|
32096
|
+
export interface Enabled extends globalThis.EnumItem {
|
|
32097
|
+
Name: "Enabled";
|
|
32098
|
+
Value: 1;
|
|
32099
|
+
EnumType: typeof globalThis.Enum.SimulationMode;
|
|
32100
|
+
}
|
|
32101
|
+
export const Enabled: Enabled;
|
|
32102
|
+
/**
|
|
32103
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/SimulationMode#Disabled)
|
|
32104
|
+
*/
|
|
32105
|
+
export interface Disabled extends globalThis.EnumItem {
|
|
32106
|
+
Name: "Disabled";
|
|
32107
|
+
Value: 2;
|
|
32108
|
+
EnumType: typeof globalThis.Enum.SimulationMode;
|
|
32109
|
+
}
|
|
32110
|
+
export const Disabled: Disabled;
|
|
32111
|
+
export function GetEnumItems(this: globalThis.Enum): Array<globalThis.Enum.SimulationMode>;
|
|
32112
|
+
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.SimulationMode | undefined;
|
|
32113
|
+
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.SimulationMode | undefined;
|
|
32114
|
+
}
|
|
32115
|
+
export type SimulationMode = SimulationMode.Default | SimulationMode.Enabled | SimulationMode.Disabled;
|
|
31880
32116
|
/**
|
|
31881
32117
|
* Used to constrain the scale of a GUI object.
|
|
31882
32118
|
*
|
|
@@ -32716,6 +32952,33 @@ declare namespace Enum {
|
|
|
32716
32952
|
EnumType: typeof globalThis.Enum.StudioAction;
|
|
32717
32953
|
}
|
|
32718
32954
|
export const DeleteSelected: DeleteSelected;
|
|
32955
|
+
/**
|
|
32956
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/StudioAction#DuplicateSelection)
|
|
32957
|
+
*/
|
|
32958
|
+
export interface DuplicateSelection extends globalThis.EnumItem {
|
|
32959
|
+
Name: "DuplicateSelection";
|
|
32960
|
+
Value: 4;
|
|
32961
|
+
EnumType: typeof globalThis.Enum.StudioAction;
|
|
32962
|
+
}
|
|
32963
|
+
export const DuplicateSelection: DuplicateSelection;
|
|
32964
|
+
/**
|
|
32965
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/StudioAction#ClearSelection)
|
|
32966
|
+
*/
|
|
32967
|
+
export interface ClearSelection extends globalThis.EnumItem {
|
|
32968
|
+
Name: "ClearSelection";
|
|
32969
|
+
Value: 5;
|
|
32970
|
+
EnumType: typeof globalThis.Enum.StudioAction;
|
|
32971
|
+
}
|
|
32972
|
+
export const ClearSelection: ClearSelection;
|
|
32973
|
+
/**
|
|
32974
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/StudioAction#ZoomExtents)
|
|
32975
|
+
*/
|
|
32976
|
+
export interface ZoomExtents extends globalThis.EnumItem {
|
|
32977
|
+
Name: "ZoomExtents";
|
|
32978
|
+
Value: 6;
|
|
32979
|
+
EnumType: typeof globalThis.Enum.StudioAction;
|
|
32980
|
+
}
|
|
32981
|
+
export const ZoomExtents: ZoomExtents;
|
|
32719
32982
|
/**
|
|
32720
32983
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/StudioAction#Copy)
|
|
32721
32984
|
*/
|
|
@@ -32747,7 +33010,7 @@ declare namespace Enum {
|
|
|
32747
33010
|
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.StudioAction | undefined;
|
|
32748
33011
|
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.StudioAction | undefined;
|
|
32749
33012
|
}
|
|
32750
|
-
export type StudioAction = StudioAction.Undo | StudioAction.Redo | StudioAction.SelectAll | StudioAction.DeleteSelected | StudioAction.Copy | StudioAction.Cut | StudioAction.Paste;
|
|
33013
|
+
export type StudioAction = StudioAction.Undo | StudioAction.Redo | StudioAction.SelectAll | StudioAction.DeleteSelected | StudioAction.DuplicateSelection | StudioAction.ClearSelection | StudioAction.ZoomExtents | StudioAction.Copy | StudioAction.Cut | StudioAction.Paste;
|
|
32751
33014
|
/**
|
|
32752
33015
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/StudioCaptureBufferStatus)
|
|
32753
33016
|
*/
|
|
@@ -40129,11 +40392,20 @@ declare namespace Enum {
|
|
|
40129
40392
|
EnumType: typeof globalThis.Enum.VoiceRccReconnectReason;
|
|
40130
40393
|
}
|
|
40131
40394
|
export const FAEUpdate: FAEUpdate;
|
|
40395
|
+
/**
|
|
40396
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/VoiceRccReconnectReason#BlockListChanged)
|
|
40397
|
+
*/
|
|
40398
|
+
export interface BlockListChanged extends globalThis.EnumItem {
|
|
40399
|
+
Name: "BlockListChanged";
|
|
40400
|
+
Value: 4;
|
|
40401
|
+
EnumType: typeof globalThis.Enum.VoiceRccReconnectReason;
|
|
40402
|
+
}
|
|
40403
|
+
export const BlockListChanged: BlockListChanged;
|
|
40132
40404
|
export function GetEnumItems(this: globalThis.Enum): Array<globalThis.Enum.VoiceRccReconnectReason>;
|
|
40133
40405
|
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.VoiceRccReconnectReason | undefined;
|
|
40134
40406
|
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.VoiceRccReconnectReason | undefined;
|
|
40135
40407
|
}
|
|
40136
|
-
export type VoiceRccReconnectReason = VoiceRccReconnectReason.Unknown | VoiceRccReconnectReason.Migration | VoiceRccReconnectReason.CloseRoom | VoiceRccReconnectReason.FAEUpdate;
|
|
40408
|
+
export type VoiceRccReconnectReason = VoiceRccReconnectReason.Unknown | VoiceRccReconnectReason.Migration | VoiceRccReconnectReason.CloseRoom | VoiceRccReconnectReason.FAEUpdate | VoiceRccReconnectReason.BlockListChanged;
|
|
40137
40409
|
/**
|
|
40138
40410
|
* Controls how the engine renders volumetric audio effects.
|
|
40139
40411
|
*
|
package/include/roblox.d.ts
CHANGED