@rbxts/types 1.0.919 → 1.0.920
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 +185 -19
- package/include/generated/PluginSecurity.d.ts +101 -2
- package/include/generated/enums.d.ts +256 -3
- package/package.json +1 -1
|
@@ -179,6 +179,7 @@ interface Services {
|
|
|
179
179
|
ScriptCloneWatcherHelper: ScriptCloneWatcherHelper;
|
|
180
180
|
ScriptCommitService: ScriptCommitService;
|
|
181
181
|
ScriptContext: ScriptContext;
|
|
182
|
+
ScriptDebuggerService: ScriptDebuggerService;
|
|
182
183
|
ScriptProfilerService: ScriptProfilerService;
|
|
183
184
|
ScriptRegistrationService: ScriptRegistrationService;
|
|
184
185
|
SelectionHighlightManager: SelectionHighlightManager;
|
|
@@ -3972,7 +3973,7 @@ interface Animator extends Instance {
|
|
|
3972
3973
|
*/
|
|
3973
3974
|
readonly RootMotionWeight: number;
|
|
3974
3975
|
/**
|
|
3975
|
-
* Computes relative velocities between parts and
|
|
3976
|
+
* Computes relative velocities between parts and applies them to `Motor6D.Part1`.
|
|
3976
3977
|
*
|
|
3977
3978
|
* - **ThreadSafety**: Unsafe
|
|
3978
3979
|
*
|
|
@@ -3982,7 +3983,7 @@ interface Animator extends Instance {
|
|
|
3982
3983
|
*/
|
|
3983
3984
|
ApplyJointVelocities(this: Animator, motors: Array<Motor6D>): void;
|
|
3984
3985
|
/**
|
|
3985
|
-
* Returns the list of currently
|
|
3986
|
+
* Returns the list of currently active `AnimationTracks`.
|
|
3986
3987
|
*
|
|
3987
3988
|
* - **ThreadSafety**: Unsafe
|
|
3988
3989
|
*
|
|
@@ -3991,9 +3992,14 @@ interface Animator extends Instance {
|
|
|
3991
3992
|
*/
|
|
3992
3993
|
GetPlayingAnimationTracks(this: Animator): Array<AnimationTrack>;
|
|
3993
3994
|
/**
|
|
3995
|
+
* Returns an existing `AnimationTrack` on this `Animator` that was loaded from an `Animation` with the given animation ID. Unlike `LoadAnimation()`, this method does not create a new `AnimationTrack` instance.
|
|
3996
|
+
*
|
|
3994
3997
|
* - **ThreadSafety**: Unsafe
|
|
3995
3998
|
*
|
|
3996
3999
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Animator#GetTrackByAnimationId)
|
|
4000
|
+
* @param this Responsible for the playback and replication of `Animations`.
|
|
4001
|
+
* @param animationId The asset ID of the `Animation` whose loaded track should be retrieved.
|
|
4002
|
+
* @returns The first `AnimationTrack` on this `Animator` that was loaded from the given animation ID, or `nil` if none has been loaded.
|
|
3997
4003
|
*/
|
|
3998
4004
|
GetTrackByAnimationId(this: Animator, animationId: ContentId): AnimationTrack;
|
|
3999
4005
|
/**
|
|
@@ -4015,7 +4021,7 @@ interface Animator extends Instance {
|
|
|
4015
4021
|
*/
|
|
4016
4022
|
RegisterEvaluationParallelCallback(this: Animator, callback: Callback): void;
|
|
4017
4023
|
/**
|
|
4018
|
-
* Fires when the Animator starts playing an AnimationTrack
|
|
4024
|
+
* Fires when the `Animator` starts playing an `AnimationTrack`.
|
|
4019
4025
|
*
|
|
4020
4026
|
* - **ThreadSafety**: Unsafe
|
|
4021
4027
|
*
|
|
@@ -8060,7 +8066,7 @@ interface AvatarCreationService extends Instance {
|
|
|
8060
8066
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AvatarCreationService#PromptSelectAvatarGenerationImageAsync)
|
|
8061
8067
|
* @param this A service to support developer avatar creators.
|
|
8062
8068
|
* @param player The `Player` to prompt for taking a selfie.
|
|
8063
|
-
* @returns A string FileId of the selfie.
|
|
8069
|
+
* @returns A string FileId of the selfie on success, or an error string describing the reason for failure.
|
|
8064
8070
|
*/
|
|
8065
8071
|
PromptSelectAvatarGenerationImageAsync(this: AvatarCreationService, player: Player): string;
|
|
8066
8072
|
/**
|
|
@@ -10936,6 +10942,8 @@ interface CaptureService extends Instance {
|
|
|
10936
10942
|
* - **Tags**: Yields
|
|
10937
10943
|
*
|
|
10938
10944
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CaptureService#CheckUploadCaptureStatusAsync)
|
|
10945
|
+
* @param this A service which provides control over screenshot and video capture features.
|
|
10946
|
+
* @param token
|
|
10939
10947
|
*/
|
|
10940
10948
|
CheckUploadCaptureStatusAsync(this: CaptureService, token: string): unknown;
|
|
10941
10949
|
/**
|
|
@@ -10978,6 +10986,8 @@ interface CaptureService extends Instance {
|
|
|
10978
10986
|
* - **Tags**: Yields
|
|
10979
10987
|
*
|
|
10980
10988
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CaptureService#StartUploadCaptureAsync)
|
|
10989
|
+
* @param this A service which provides control over screenshot and video capture features.
|
|
10990
|
+
* @param capture
|
|
10981
10991
|
*/
|
|
10982
10992
|
StartUploadCaptureAsync(this: CaptureService, capture: Capture): unknown;
|
|
10983
10993
|
/**
|
|
@@ -17746,6 +17756,20 @@ interface GenerationService extends Instance {
|
|
|
17746
17756
|
* @deprecated
|
|
17747
17757
|
*/
|
|
17748
17758
|
readonly _nominal_GenerationService: unique symbol;
|
|
17759
|
+
/**
|
|
17760
|
+
* - **ThreadSafety**: Unsafe
|
|
17761
|
+
* - **Tags**: Yields
|
|
17762
|
+
*
|
|
17763
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GenerationService#ConnectAsync)
|
|
17764
|
+
*/
|
|
17765
|
+
ConnectAsync(this: GenerationService, sessionId: string, sdp: string, type: string, relay: string): unknown;
|
|
17766
|
+
/**
|
|
17767
|
+
* - **ThreadSafety**: Unsafe
|
|
17768
|
+
* - **Tags**: Yields
|
|
17769
|
+
*
|
|
17770
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GenerationService#DisconnectAsync)
|
|
17771
|
+
*/
|
|
17772
|
+
DisconnectAsync(this: GenerationService, sessionId: string): boolean;
|
|
17749
17773
|
/**
|
|
17750
17774
|
* Starts the generation of a new 3D mesh from a text prompt and returns unique IDs used to track and retrieve the result.
|
|
17751
17775
|
*
|
|
@@ -17781,6 +17805,20 @@ interface GenerationService extends Instance {
|
|
|
17781
17805
|
* - A table containing a UUID and other metadata about the generation.
|
|
17782
17806
|
*/
|
|
17783
17807
|
GenerateModelAsync(this: GenerationService, inputs: object, schema: object, options?: object): unknown;
|
|
17808
|
+
/**
|
|
17809
|
+
* - **ThreadSafety**: Unsafe
|
|
17810
|
+
* - **Tags**: Yields
|
|
17811
|
+
*
|
|
17812
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GenerationService#GetVideoGenSessionAsync)
|
|
17813
|
+
*/
|
|
17814
|
+
GetVideoGenSessionAsync(this: GenerationService): unknown;
|
|
17815
|
+
/**
|
|
17816
|
+
* - **ThreadSafety**: Unsafe
|
|
17817
|
+
* - **Tags**: Yields
|
|
17818
|
+
*
|
|
17819
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GenerationService#GetVideoGenTriggersAsync)
|
|
17820
|
+
*/
|
|
17821
|
+
GetVideoGenTriggersAsync(this: GenerationService, sessionId: string, lookbackSeconds: number): object;
|
|
17784
17822
|
/**
|
|
17785
17823
|
* Retrieves and loads a mesh generated by `GenerationService:GenerateMeshAsync()` using the provided `generationId`.
|
|
17786
17824
|
*
|
|
@@ -17793,6 +17831,27 @@ interface GenerationService extends Instance {
|
|
|
17793
17831
|
* @returns The generated asset, returned as a `Model` with a single `MeshPart` containing an `EditableMesh`.
|
|
17794
17832
|
*/
|
|
17795
17833
|
LoadGeneratedMeshAsync(this: GenerationService, generationId: string): MeshPart;
|
|
17834
|
+
/**
|
|
17835
|
+
* - **ThreadSafety**: Unsafe
|
|
17836
|
+
* - **Tags**: Yields
|
|
17837
|
+
*
|
|
17838
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GenerationService#StartVideoGenSessionAsync)
|
|
17839
|
+
*/
|
|
17840
|
+
StartVideoGenSessionAsync(this: GenerationService, sessionId: string, prompt: string, imageData: string, imageS3Reference: string, triggers: object): boolean;
|
|
17841
|
+
/**
|
|
17842
|
+
* - **ThreadSafety**: Unsafe
|
|
17843
|
+
* - **Tags**: Yields
|
|
17844
|
+
*
|
|
17845
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GenerationService#UpdateVideoGenSessionPromptAsync)
|
|
17846
|
+
*/
|
|
17847
|
+
UpdateVideoGenSessionPromptAsync(this: GenerationService, sessionId: string, prompt: string, imageData: string, imageS3Reference: string, mode: string): boolean;
|
|
17848
|
+
/**
|
|
17849
|
+
* - **ThreadSafety**: Unsafe
|
|
17850
|
+
* - **Tags**: Yields
|
|
17851
|
+
*
|
|
17852
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GenerationService#UpdateVideoGenSessionTriggersAsync)
|
|
17853
|
+
*/
|
|
17854
|
+
UpdateVideoGenSessionTriggersAsync(this: GenerationService, sessionId: string, triggers: object): boolean;
|
|
17796
17855
|
}
|
|
17797
17856
|
/**
|
|
17798
17857
|
* - **Tags**: NotCreatable, Service
|
|
@@ -20599,6 +20658,12 @@ interface VideoFrame extends GuiObject {
|
|
|
20599
20658
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VideoFrame#Looped)
|
|
20600
20659
|
*/
|
|
20601
20660
|
Looped: boolean;
|
|
20661
|
+
/**
|
|
20662
|
+
* - **ThreadSafety**: ReadSafe
|
|
20663
|
+
*
|
|
20664
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VideoFrame#MaximumResolution)
|
|
20665
|
+
*/
|
|
20666
|
+
MaximumResolution: Enum.VideoSampleSize;
|
|
20602
20667
|
/**
|
|
20603
20668
|
* Indicates whether the `VideoFrame.Video` is currently playing. It can be set to start or pause playback.
|
|
20604
20669
|
*
|
|
@@ -23679,9 +23744,12 @@ interface Humanoid extends Instance {
|
|
|
23679
23744
|
*/
|
|
23680
23745
|
GetPlayingAnimationTracks(this: Humanoid): Array<AnimationTrack>;
|
|
23681
23746
|
/**
|
|
23747
|
+
* Returns the humanoid's actual physical velocity relative to the surface it is standing on as a `Vector3` in world-space orientation.
|
|
23748
|
+
*
|
|
23682
23749
|
* - **ThreadSafety**: Unsafe
|
|
23683
23750
|
*
|
|
23684
23751
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Humanoid#GetRelativeVelocityAtFloor)
|
|
23752
|
+
* @param this A special object that gives models the functionality of a character.
|
|
23685
23753
|
*/
|
|
23686
23754
|
GetRelativeVelocityAtFloor(this: Humanoid): Vector3;
|
|
23687
23755
|
/**
|
|
@@ -28418,15 +28486,24 @@ interface MarketplaceService extends Instance {
|
|
|
28418
28486
|
*/
|
|
28419
28487
|
readonly _nominal_MarketplaceService: unique symbol;
|
|
28420
28488
|
/**
|
|
28489
|
+
* Registers a callback to process receipts of a specific type.
|
|
28490
|
+
*
|
|
28421
28491
|
* - **ThreadSafety**: Unsafe
|
|
28422
28492
|
*
|
|
28423
28493
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MarketplaceService#BindReceiptHandler)
|
|
28494
|
+
* @param this The service responsible for in-experience transactions.
|
|
28495
|
+
* @param transactionType The `ReceiptType` indicating which kind of receipt to handle.
|
|
28496
|
+
* @param handler A callback function that receives a receipt info dictionary and must return an `ReceiptDecision` value.
|
|
28497
|
+
* @param filter An optional array of product IDs. When provided, the handler only fires for receipts matching those product IDs. Not supported for `RobuxTransferSender` or `RobuxTransferReceiver` receipt types.
|
|
28498
|
+
* @returns A `RBXScriptConnection` that can be disconnected to unregister the handler.
|
|
28424
28499
|
*/
|
|
28425
28500
|
BindReceiptHandler(this: MarketplaceService, transactionType: CastsToEnum<Enum.ReceiptType>, handler: Callback, filter?: Array<unknown>): RBXScriptConnection;
|
|
28426
28501
|
/**
|
|
28427
28502
|
* - **ThreadSafety**: Unsafe
|
|
28428
28503
|
*
|
|
28429
28504
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MarketplaceService#OpenShop)
|
|
28505
|
+
* @param this The service responsible for in-experience transactions.
|
|
28506
|
+
* @param player
|
|
28430
28507
|
*/
|
|
28431
28508
|
OpenShop(this: MarketplaceService, player: Player): void;
|
|
28432
28509
|
/**
|
|
@@ -28726,10 +28803,17 @@ interface MarketplaceService extends Instance {
|
|
|
28726
28803
|
*/
|
|
28727
28804
|
PlayerOwnsBundleAsync(this: MarketplaceService, player: Player, bundleId: number): boolean;
|
|
28728
28805
|
/**
|
|
28806
|
+
* Initiates a Robux transfer from the sender to another user.
|
|
28807
|
+
*
|
|
28729
28808
|
* - **ThreadSafety**: Unsafe
|
|
28730
28809
|
* - **Tags**: Yields
|
|
28731
28810
|
*
|
|
28732
28811
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MarketplaceService#PromptRobuxTransferAsync)
|
|
28812
|
+
* @param this The service responsible for in-experience transactions.
|
|
28813
|
+
* @param sender The `Player` initiating the transfer. Must be a valid player currently in the server.
|
|
28814
|
+
* @param receiverUserId The `UserId` of the user who will receive the Robux.
|
|
28815
|
+
* @param amount The amount of Robux to transfer. Must be a positive integer.
|
|
28816
|
+
* @returns A string `transferRequestId` that uniquely identifies this transfer request. Use this ID to correlate with receipts delivered through `BindReceiptHandler`.
|
|
28733
28817
|
*/
|
|
28734
28818
|
PromptRobuxTransferAsync(this: MarketplaceService, sender: Player, receiverUserId: number, amount: number): string;
|
|
28735
28819
|
/**
|
|
@@ -34586,7 +34670,7 @@ interface Path extends Instance {
|
|
|
34586
34670
|
*/
|
|
34587
34671
|
readonly _nominal_Path: unique symbol;
|
|
34588
34672
|
/**
|
|
34589
|
-
* The
|
|
34673
|
+
* The `PathStatus` of the generated `Path`.
|
|
34590
34674
|
*
|
|
34591
34675
|
* - **ThreadSafety**: ReadSafe
|
|
34592
34676
|
* - **Tags**: NotReplicated
|
|
@@ -34595,7 +34679,7 @@ interface Path extends Instance {
|
|
|
34595
34679
|
*/
|
|
34596
34680
|
readonly Status: Enum.PathStatus;
|
|
34597
34681
|
/**
|
|
34598
|
-
* **Deprecated:** This item has been superseded by `
|
|
34682
|
+
* **Deprecated:** This item has been superseded by `GetWaypoints()` which should be used in all new work instead.
|
|
34599
34683
|
*
|
|
34600
34684
|
* Returns a table of `Path` instances.
|
|
34601
34685
|
*
|
|
@@ -34697,7 +34781,7 @@ interface PathfindingLink extends Instance {
|
|
|
34697
34781
|
*/
|
|
34698
34782
|
IsBidirectional: boolean;
|
|
34699
34783
|
/**
|
|
34700
|
-
* A classifying string to add additional information about the link.
|
|
34784
|
+
* A classifying string to add additional information about the link.
|
|
34701
34785
|
*
|
|
34702
34786
|
* - **ThreadSafety**: ReadSafe
|
|
34703
34787
|
*
|
|
@@ -34706,7 +34790,7 @@ interface PathfindingLink extends Instance {
|
|
|
34706
34790
|
Label: string;
|
|
34707
34791
|
}
|
|
34708
34792
|
/**
|
|
34709
|
-
* Modifiers used to represent space that has a higher or lower cost to be traversed when creating paths using
|
|
34793
|
+
* Modifiers used to represent space that has a higher or lower cost to be traversed when creating paths using `PathfindingService`.
|
|
34710
34794
|
*
|
|
34711
34795
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PathfindingModifier)
|
|
34712
34796
|
*/
|
|
@@ -34720,7 +34804,7 @@ interface PathfindingModifier extends Instance {
|
|
|
34720
34804
|
*/
|
|
34721
34805
|
readonly _nominal_PathfindingModifier: unique symbol;
|
|
34722
34806
|
/**
|
|
34723
|
-
* The name of the navigation area inside or on top of the
|
|
34807
|
+
* The name of the navigation area inside or on top of the parts enclosed by the modifier.
|
|
34724
34808
|
*
|
|
34725
34809
|
* - **ThreadSafety**: ReadSafe
|
|
34726
34810
|
*
|
|
@@ -34770,7 +34854,7 @@ interface PathfindingService extends Instance {
|
|
|
34770
34854
|
*
|
|
34771
34855
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PathfindingService#CreatePath)
|
|
34772
34856
|
* @param this Used to find logical paths between two points.
|
|
34773
|
-
* @param agentParameters
|
|
34857
|
+
* @param agentParameters Lua table which lets you fine-tune the path based on various agent parameters.
|
|
34774
34858
|
* @returns A `Path` object.
|
|
34775
34859
|
*/
|
|
34776
34860
|
CreatePath(this: PathfindingService, agentParameters?: AgentParameters): Path;
|
|
@@ -35489,6 +35573,12 @@ interface Player extends Instance {
|
|
|
35489
35573
|
* @param part The `BasePart` to use as a new replication focus.
|
|
35490
35574
|
*/
|
|
35491
35575
|
AddReplicationFocus(this: Player, part: BasePart): void;
|
|
35576
|
+
/**
|
|
35577
|
+
* - **ThreadSafety**: Unsafe
|
|
35578
|
+
*
|
|
35579
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#ClearCachedAvatarAppearance)
|
|
35580
|
+
*/
|
|
35581
|
+
ClearCachedAvatarAppearance(this: Player): void;
|
|
35492
35582
|
/**
|
|
35493
35583
|
* Removes all accessories and other character appearance objects from a player's `Character`.
|
|
35494
35584
|
*
|
|
@@ -36543,7 +36633,7 @@ interface Players extends Instance {
|
|
|
36543
36633
|
*/
|
|
36544
36634
|
BanAsync(this: Players, config: BanAsyncConfig): void;
|
|
36545
36635
|
/**
|
|
36546
|
-
* **Deprecated:** This method has been superseded by `
|
|
36636
|
+
* **Deprecated:** This method has been superseded by `CreateHumanoidModelFromDescriptionAsync()`.
|
|
36547
36637
|
*
|
|
36548
36638
|
* Returns a character `Model` equipped with everything specified in the passed in `HumanoidDescription`.
|
|
36549
36639
|
*
|
|
@@ -37827,6 +37917,12 @@ interface RecommendationService extends Instance {
|
|
|
37827
37917
|
* - **ThreadSafety**: Unsafe
|
|
37828
37918
|
*
|
|
37829
37919
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RecommendationService#LogPreferenceEvent)
|
|
37920
|
+
* @param this A service that provides an interface for you to manage and display personalized content recommendations.
|
|
37921
|
+
* @param preferenceType
|
|
37922
|
+
* @param targetType
|
|
37923
|
+
* @param targetId
|
|
37924
|
+
* @param tracingId
|
|
37925
|
+
* @param itemId
|
|
37830
37926
|
*/
|
|
37831
37927
|
LogPreferenceEvent(this: RecommendationService, preferenceType: CastsToEnum<Enum.RecommendationPreferenceType>, targetType: CastsToEnum<Enum.RecommendationPreferenceTargetType>, targetId: string, tracingId?: string, itemId?: string): void;
|
|
37832
37928
|
/**
|
|
@@ -38685,6 +38781,8 @@ interface SceneAnalysisService extends Instance {
|
|
|
38685
38781
|
* - **Tags**: Yields
|
|
38686
38782
|
*
|
|
38687
38783
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SceneAnalysisService#GetAnimationMemoryAsync)
|
|
38784
|
+
* @param this
|
|
38785
|
+
* @returns A dictionary tree of loaded animation clip memory, deduplicated by clip.
|
|
38688
38786
|
*/
|
|
38689
38787
|
GetAnimationMemoryAsync(this: SceneAnalysisService): object;
|
|
38690
38788
|
/**
|
|
@@ -38692,6 +38790,8 @@ interface SceneAnalysisService extends Instance {
|
|
|
38692
38790
|
* - **Tags**: Yields
|
|
38693
38791
|
*
|
|
38694
38792
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SceneAnalysisService#GetAudioMemoryAsync)
|
|
38793
|
+
* @param this
|
|
38794
|
+
* @returns A dictionary tree of loaded audio asset memory, deduplicated by asset ID.
|
|
38695
38795
|
*/
|
|
38696
38796
|
GetAudioMemoryAsync(this: SceneAnalysisService): object;
|
|
38697
38797
|
/**
|
|
@@ -38699,6 +38799,8 @@ interface SceneAnalysisService extends Instance {
|
|
|
38699
38799
|
* - **Tags**: Yields
|
|
38700
38800
|
*
|
|
38701
38801
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SceneAnalysisService#GetInstanceCompositionAsync)
|
|
38802
|
+
* @param this
|
|
38803
|
+
* @returns A dictionary tree of instance counts grouped by category and class name.
|
|
38702
38804
|
*/
|
|
38703
38805
|
GetInstanceCompositionAsync(this: SceneAnalysisService): object;
|
|
38704
38806
|
/**
|
|
@@ -38706,6 +38808,8 @@ interface SceneAnalysisService extends Instance {
|
|
|
38706
38808
|
* - **Tags**: Yields
|
|
38707
38809
|
*
|
|
38708
38810
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SceneAnalysisService#GetScriptMemoryAsync)
|
|
38811
|
+
* @param this
|
|
38812
|
+
* @returns A dictionary tree of per-script Luau VM heap memory grouped by service and script type.
|
|
38709
38813
|
*/
|
|
38710
38814
|
GetScriptMemoryAsync(this: SceneAnalysisService): object;
|
|
38711
38815
|
/**
|
|
@@ -38713,6 +38817,8 @@ interface SceneAnalysisService extends Instance {
|
|
|
38713
38817
|
* - **Tags**: Yields
|
|
38714
38818
|
*
|
|
38715
38819
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SceneAnalysisService#GetTriangleCompositionAsync)
|
|
38820
|
+
* @param this
|
|
38821
|
+
* @returns A dictionary tree of triangle and draw call counts broken down by render pass type.
|
|
38716
38822
|
*/
|
|
38717
38823
|
GetTriangleCompositionAsync(this: SceneAnalysisService): object;
|
|
38718
38824
|
/**
|
|
@@ -38720,6 +38826,8 @@ interface SceneAnalysisService extends Instance {
|
|
|
38720
38826
|
* - **Tags**: Yields
|
|
38721
38827
|
*
|
|
38722
38828
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SceneAnalysisService#GetUnparentedInstancesAsync)
|
|
38829
|
+
* @param this
|
|
38830
|
+
* @returns A dictionary tree of unparented instances grouped by the host script holding the reference.
|
|
38723
38831
|
*/
|
|
38724
38832
|
GetUnparentedInstancesAsync(this: SceneAnalysisService): object;
|
|
38725
38833
|
}
|
|
@@ -38974,12 +39082,15 @@ interface ScriptContext extends Instance {
|
|
|
38974
39082
|
* - **ThreadSafety**: Unsafe
|
|
38975
39083
|
*
|
|
38976
39084
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScriptContext#EnableCoverage)
|
|
39085
|
+
* @param this
|
|
39086
|
+
* @param instance
|
|
38977
39087
|
*/
|
|
38978
39088
|
EnableCoverage(this: ScriptContext, instance: Instance): void;
|
|
38979
39089
|
/**
|
|
38980
39090
|
* - **ThreadSafety**: Unsafe
|
|
38981
39091
|
*
|
|
38982
39092
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScriptContext#GetCoverageStats)
|
|
39093
|
+
* @param this
|
|
38983
39094
|
*/
|
|
38984
39095
|
GetCoverageStats(this: ScriptContext): Array<unknown>;
|
|
38985
39096
|
/**
|
|
@@ -38991,6 +39102,21 @@ interface ScriptContext extends Instance {
|
|
|
38991
39102
|
*/
|
|
38992
39103
|
readonly Error: RBXScriptSignal<(message: string, stackTrace: string, script?: LuaSourceContainer) => void>;
|
|
38993
39104
|
}
|
|
39105
|
+
/**
|
|
39106
|
+
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
39107
|
+
*
|
|
39108
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScriptDebuggerService)
|
|
39109
|
+
*/
|
|
39110
|
+
interface ScriptDebuggerService extends Instance {
|
|
39111
|
+
/**
|
|
39112
|
+
* **DO NOT USE!**
|
|
39113
|
+
*
|
|
39114
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
39115
|
+
* @hidden
|
|
39116
|
+
* @deprecated
|
|
39117
|
+
*/
|
|
39118
|
+
readonly _nominal_ScriptDebuggerService: unique symbol;
|
|
39119
|
+
}
|
|
38994
39120
|
/**
|
|
38995
39121
|
* - **Tags**: NotCreatable, Service
|
|
38996
39122
|
*
|
|
@@ -41377,6 +41503,12 @@ interface SoundService extends Instance {
|
|
|
41377
41503
|
* @param sound The `Sound` to be played.
|
|
41378
41504
|
*/
|
|
41379
41505
|
PlayLocalSound(this: SoundService, sound: Sound): void;
|
|
41506
|
+
/**
|
|
41507
|
+
* - **ThreadSafety**: Unsafe
|
|
41508
|
+
*
|
|
41509
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SoundService#SetInputDevice)
|
|
41510
|
+
*/
|
|
41511
|
+
SetInputDevice(this: SoundService, nameOrInstance: unknown, guidOrPin: string): void;
|
|
41380
41512
|
/**
|
|
41381
41513
|
* Sets the listener used by `Sounds`.
|
|
41382
41514
|
*
|
|
@@ -43721,6 +43853,8 @@ interface TestService extends Instance {
|
|
|
43721
43853
|
* - **ThreadSafety**: Unsafe
|
|
43722
43854
|
*
|
|
43723
43855
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TestService#RegisterTest)
|
|
43856
|
+
* @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.
|
|
43857
|
+
* @param testOptions
|
|
43724
43858
|
*/
|
|
43725
43859
|
RegisterTest(this: TestService, testOptions: object): TestCase;
|
|
43726
43860
|
/**
|
|
@@ -43791,6 +43925,13 @@ interface TestService extends Instance {
|
|
|
43791
43925
|
* @param name
|
|
43792
43926
|
*/
|
|
43793
43927
|
isFeatureEnabled(this: TestService, name: string): boolean;
|
|
43928
|
+
/**
|
|
43929
|
+
* - **ThreadSafety**: Unsafe
|
|
43930
|
+
* - **Tags**: Yields
|
|
43931
|
+
*
|
|
43932
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TestService#CaptureScreenshotAsync)
|
|
43933
|
+
*/
|
|
43934
|
+
CaptureScreenshotAsync(this: TestService, artifactName?: string, options?: object): unknown;
|
|
43794
43935
|
/**
|
|
43795
43936
|
* - **ThreadSafety**: Unsafe
|
|
43796
43937
|
* - **Tags**: Yields
|
|
@@ -46011,41 +46152,46 @@ interface UICorner extends UIComponent {
|
|
|
46011
46152
|
*/
|
|
46012
46153
|
readonly _nominal_UICorner: unique symbol;
|
|
46013
46154
|
/**
|
|
46155
|
+
* Determines the radius of the bottom-left corner.
|
|
46156
|
+
*
|
|
46014
46157
|
* - **ThreadSafety**: ReadSafe
|
|
46015
|
-
* - **Tags**: Hidden, NotReplicated
|
|
46016
46158
|
*
|
|
46017
46159
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UICorner#BottomLeftRadius)
|
|
46018
46160
|
*/
|
|
46019
|
-
|
|
46161
|
+
BottomLeftRadius: UDim;
|
|
46020
46162
|
/**
|
|
46163
|
+
* Determines the radius of the bottom-right corner.
|
|
46164
|
+
*
|
|
46021
46165
|
* - **ThreadSafety**: ReadSafe
|
|
46022
|
-
* - **Tags**: Hidden, NotReplicated
|
|
46023
46166
|
*
|
|
46024
46167
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UICorner#BottomRightRadius)
|
|
46025
46168
|
*/
|
|
46026
|
-
|
|
46169
|
+
BottomRightRadius: UDim;
|
|
46027
46170
|
/**
|
|
46028
46171
|
* Sets all four corner radii at once and reads from `TopLeftRadius`.
|
|
46029
46172
|
*
|
|
46030
46173
|
* - **ThreadSafety**: ReadSafe
|
|
46174
|
+
* - **Tags**: NotReplicated
|
|
46031
46175
|
*
|
|
46032
46176
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UICorner#CornerRadius)
|
|
46033
46177
|
*/
|
|
46034
46178
|
CornerRadius: UDim;
|
|
46035
46179
|
/**
|
|
46180
|
+
* Determines the radius of the top-left corner.
|
|
46181
|
+
*
|
|
46036
46182
|
* - **ThreadSafety**: ReadSafe
|
|
46037
|
-
* - **Tags**: Hidden, NotReplicated
|
|
46038
46183
|
*
|
|
46039
46184
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UICorner#TopLeftRadius)
|
|
46040
46185
|
*/
|
|
46041
|
-
|
|
46186
|
+
TopLeftRadius: UDim;
|
|
46042
46187
|
/**
|
|
46188
|
+
* Determines the radius of the top-right corner.
|
|
46189
|
+
*
|
|
46043
46190
|
* - **ThreadSafety**: ReadSafe
|
|
46044
|
-
* - **Tags**: Hidden, NotReplicated
|
|
46045
46191
|
*
|
|
46046
46192
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UICorner#TopRightRadius)
|
|
46047
46193
|
*/
|
|
46048
|
-
|
|
46194
|
+
TopRightRadius: UDim;
|
|
46049
46195
|
}
|
|
46050
46196
|
/**
|
|
46051
46197
|
* Instance which facilitates and encourages interaction with UI elements in an experience.
|
|
@@ -46909,6 +47055,8 @@ interface UIScale extends UIComponent {
|
|
|
46909
47055
|
Scale: number;
|
|
46910
47056
|
}
|
|
46911
47057
|
/**
|
|
47058
|
+
* Renders a shadow below the parent UI instance.
|
|
47059
|
+
*
|
|
46912
47060
|
* - **Tags**: NotBrowsable
|
|
46913
47061
|
*
|
|
46914
47062
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UIShadow)
|
|
@@ -46923,36 +47071,48 @@ interface UIShadow extends UIComponent {
|
|
|
46923
47071
|
*/
|
|
46924
47072
|
readonly _nominal_UIShadow: unique symbol;
|
|
46925
47073
|
/**
|
|
47074
|
+
* Determines the shadow's blurriness.
|
|
47075
|
+
*
|
|
46926
47076
|
* - **ThreadSafety**: ReadSafe
|
|
46927
47077
|
*
|
|
46928
47078
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UIShadow#BlurRadius)
|
|
46929
47079
|
*/
|
|
46930
47080
|
BlurRadius: UDim;
|
|
46931
47081
|
/**
|
|
47082
|
+
* Determines the shadow's color.
|
|
47083
|
+
*
|
|
46932
47084
|
* - **ThreadSafety**: ReadSafe
|
|
46933
47085
|
*
|
|
46934
47086
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UIShadow#Color)
|
|
46935
47087
|
*/
|
|
46936
47088
|
Color: Color3;
|
|
46937
47089
|
/**
|
|
47090
|
+
* Moves the shadow relative to the parent's position.
|
|
47091
|
+
*
|
|
46938
47092
|
* - **ThreadSafety**: ReadSafe
|
|
46939
47093
|
*
|
|
46940
47094
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UIShadow#Offset)
|
|
46941
47095
|
*/
|
|
46942
47096
|
Offset: UDim2;
|
|
46943
47097
|
/**
|
|
47098
|
+
* Expands or shrinks the shadow relative to the parent's size.
|
|
47099
|
+
*
|
|
46944
47100
|
* - **ThreadSafety**: ReadSafe
|
|
46945
47101
|
*
|
|
46946
47102
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UIShadow#Spread)
|
|
46947
47103
|
*/
|
|
46948
47104
|
Spread: UDim2;
|
|
46949
47105
|
/**
|
|
47106
|
+
* Sets the shadow's transparency.
|
|
47107
|
+
*
|
|
46950
47108
|
* - **ThreadSafety**: ReadSafe
|
|
46951
47109
|
*
|
|
46952
47110
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UIShadow#Transparency)
|
|
46953
47111
|
*/
|
|
46954
47112
|
Transparency: number;
|
|
46955
47113
|
/**
|
|
47114
|
+
* Determines the shadow's render order relative to sibling `UIShadow` instances.
|
|
47115
|
+
*
|
|
46956
47116
|
* - **ThreadSafety**: ReadSafe
|
|
46957
47117
|
*
|
|
46958
47118
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UIShadow#ZIndex)
|
|
@@ -48916,6 +49076,12 @@ interface VideoPlayer extends Instance {
|
|
|
48916
49076
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VideoPlayer#Looping)
|
|
48917
49077
|
*/
|
|
48918
49078
|
Looping: boolean;
|
|
49079
|
+
/**
|
|
49080
|
+
* - **ThreadSafety**: ReadSafe
|
|
49081
|
+
*
|
|
49082
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VideoPlayer#MaximumResolution)
|
|
49083
|
+
*/
|
|
49084
|
+
MaximumResolution: Enum.VideoSampleSize;
|
|
48919
49085
|
/**
|
|
48920
49086
|
* Controls the speed at which the video is played.
|
|
48921
49087
|
*
|
|
@@ -194,6 +194,7 @@ interface Services {
|
|
|
194
194
|
ScriptCloneWatcherHelper: ScriptCloneWatcherHelper;
|
|
195
195
|
ScriptCommitService: ScriptCommitService;
|
|
196
196
|
ScriptContext: ScriptContext;
|
|
197
|
+
ScriptDebuggerService: ScriptDebuggerService;
|
|
197
198
|
ScriptEditorService: ScriptEditorService;
|
|
198
199
|
ScriptProfilerService: ScriptProfilerService;
|
|
199
200
|
ScriptRegistrationService: ScriptRegistrationService;
|
|
@@ -1425,7 +1426,7 @@ interface Animator extends Instance {
|
|
|
1425
1426
|
*
|
|
1426
1427
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Animator#StepAnimations)
|
|
1427
1428
|
* @param this Responsible for the playback and replication of `Animations`.
|
|
1428
|
-
* @param deltaTime The amount of time in seconds animation playback is to be incremented by.
|
|
1429
|
+
* @param deltaTime The amount of time in seconds animation playback is to be incremented. by.
|
|
1429
1430
|
*/
|
|
1430
1431
|
StepAnimations(this: Animator, deltaTime: number): void;
|
|
1431
1432
|
}
|
|
@@ -10230,7 +10231,7 @@ interface PathfindingLink extends Instance {
|
|
|
10230
10231
|
readonly _nominal_PathfindingLink: unique symbol;
|
|
10231
10232
|
}
|
|
10232
10233
|
/**
|
|
10233
|
-
* Modifiers used to represent space that has a higher or lower cost to be traversed when creating paths using
|
|
10234
|
+
* Modifiers used to represent space that has a higher or lower cost to be traversed when creating paths using `PathfindingService`.
|
|
10234
10235
|
*
|
|
10235
10236
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PathfindingModifier)
|
|
10236
10237
|
*/
|
|
@@ -12441,6 +12442,93 @@ interface ScriptDebugger extends Instance {
|
|
|
12441
12442
|
*/
|
|
12442
12443
|
readonly _nominal_ScriptDebugger: unique symbol;
|
|
12443
12444
|
}
|
|
12445
|
+
/**
|
|
12446
|
+
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
12447
|
+
*
|
|
12448
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScriptDebuggerService)
|
|
12449
|
+
*/
|
|
12450
|
+
interface ScriptDebuggerService extends Instance {
|
|
12451
|
+
/**
|
|
12452
|
+
* **DO NOT USE!**
|
|
12453
|
+
*
|
|
12454
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
12455
|
+
* @hidden
|
|
12456
|
+
* @deprecated
|
|
12457
|
+
*/
|
|
12458
|
+
readonly _nominal_ScriptDebuggerService: unique symbol;
|
|
12459
|
+
/**
|
|
12460
|
+
* - **ThreadSafety**: Unsafe
|
|
12461
|
+
*
|
|
12462
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScriptDebuggerService#AddBreakpoint)
|
|
12463
|
+
*/
|
|
12464
|
+
AddBreakpoint(this: ScriptDebuggerService, scriptInstance: LuaSourceContainer, breakpoint: object): object;
|
|
12465
|
+
/**
|
|
12466
|
+
* - **ThreadSafety**: Unsafe
|
|
12467
|
+
*
|
|
12468
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScriptDebuggerService#ClearBreakpoints)
|
|
12469
|
+
*/
|
|
12470
|
+
ClearBreakpoints(this: ScriptDebuggerService): void;
|
|
12471
|
+
/**
|
|
12472
|
+
* - **ThreadSafety**: Unsafe
|
|
12473
|
+
*
|
|
12474
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScriptDebuggerService#Evaluate)
|
|
12475
|
+
*/
|
|
12476
|
+
Evaluate(this: ScriptDebuggerService, expression: string, frameId?: number): object;
|
|
12477
|
+
/**
|
|
12478
|
+
* - **ThreadSafety**: Unsafe
|
|
12479
|
+
*
|
|
12480
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScriptDebuggerService#GetRootVariables)
|
|
12481
|
+
*/
|
|
12482
|
+
GetRootVariables(this: ScriptDebuggerService, frameId: number): Array<unknown>;
|
|
12483
|
+
/**
|
|
12484
|
+
* - **ThreadSafety**: Unsafe
|
|
12485
|
+
*
|
|
12486
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScriptDebuggerService#GetStackTrace)
|
|
12487
|
+
*/
|
|
12488
|
+
GetStackTrace(this: ScriptDebuggerService, threadId: number, startFrame?: number): object;
|
|
12489
|
+
/**
|
|
12490
|
+
* - **ThreadSafety**: Unsafe
|
|
12491
|
+
*
|
|
12492
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScriptDebuggerService#GetThreads)
|
|
12493
|
+
*/
|
|
12494
|
+
GetThreads(this: ScriptDebuggerService): Array<unknown>;
|
|
12495
|
+
/**
|
|
12496
|
+
* - **ThreadSafety**: Unsafe
|
|
12497
|
+
*
|
|
12498
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScriptDebuggerService#GetVariables)
|
|
12499
|
+
*/
|
|
12500
|
+
GetVariables(this: ScriptDebuggerService, variablesReference: number): Array<unknown>;
|
|
12501
|
+
/**
|
|
12502
|
+
* - **ThreadSafety**: Unsafe
|
|
12503
|
+
*
|
|
12504
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScriptDebuggerService#Pause)
|
|
12505
|
+
*/
|
|
12506
|
+
Pause(this: ScriptDebuggerService): void;
|
|
12507
|
+
/**
|
|
12508
|
+
* - **ThreadSafety**: Unsafe
|
|
12509
|
+
*
|
|
12510
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScriptDebuggerService#RemoveBreakpoint)
|
|
12511
|
+
*/
|
|
12512
|
+
RemoveBreakpoint(this: ScriptDebuggerService, scriptInstance: LuaSourceContainer, line: number): boolean;
|
|
12513
|
+
/**
|
|
12514
|
+
* - **ThreadSafety**: Unsafe
|
|
12515
|
+
*
|
|
12516
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScriptDebuggerService#SetExceptionBreakMode)
|
|
12517
|
+
*/
|
|
12518
|
+
SetExceptionBreakMode(this: ScriptDebuggerService, breakMode: CastsToEnum<Enum.DebugBreakModeType>): void;
|
|
12519
|
+
/**
|
|
12520
|
+
* - **ThreadSafety**: Unsafe
|
|
12521
|
+
*
|
|
12522
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScriptDebuggerService#Resumed)
|
|
12523
|
+
*/
|
|
12524
|
+
readonly Resumed: RBXScriptSignal<(threadIds: Array<unknown>) => void>;
|
|
12525
|
+
/**
|
|
12526
|
+
* - **ThreadSafety**: Unsafe
|
|
12527
|
+
*
|
|
12528
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScriptDebuggerService#OnStopped)
|
|
12529
|
+
*/
|
|
12530
|
+
OnStopped: ((stopped: object) => object) | undefined;
|
|
12531
|
+
}
|
|
12444
12532
|
/**
|
|
12445
12533
|
* - **Tags**: NotCreatable, NotReplicated
|
|
12446
12534
|
*
|
|
@@ -14097,12 +14185,15 @@ interface StudioCaptureService extends Instance {
|
|
|
14097
14185
|
* - **ThreadSafety**: Unsafe
|
|
14098
14186
|
*
|
|
14099
14187
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StudioCaptureService#CanCaptureScreenshot)
|
|
14188
|
+
* @param this
|
|
14100
14189
|
*/
|
|
14101
14190
|
CanCaptureScreenshot(this: StudioCaptureService): boolean;
|
|
14102
14191
|
/**
|
|
14103
14192
|
* - **ThreadSafety**: Unsafe
|
|
14104
14193
|
*
|
|
14105
14194
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StudioCaptureService#CaptureScreenshot)
|
|
14195
|
+
* @param this
|
|
14196
|
+
* @param screenshotOptions
|
|
14106
14197
|
*/
|
|
14107
14198
|
CaptureScreenshot(this: StudioCaptureService, screenshotOptions: object): StudioScreenshotCapture;
|
|
14108
14199
|
/**
|
|
@@ -14110,6 +14201,7 @@ interface StudioCaptureService extends Instance {
|
|
|
14110
14201
|
* - **Tags**: Yields
|
|
14111
14202
|
*
|
|
14112
14203
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StudioCaptureService#RequestScreenshotPermissionAsync)
|
|
14204
|
+
* @param this
|
|
14113
14205
|
*/
|
|
14114
14206
|
RequestScreenshotPermissionAsync(this: StudioCaptureService): boolean;
|
|
14115
14207
|
}
|
|
@@ -14418,12 +14510,14 @@ interface StudioScreenshotCapture extends Instance {
|
|
|
14418
14510
|
* - **ThreadSafety**: Unsafe
|
|
14419
14511
|
*
|
|
14420
14512
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StudioScreenshotCapture#GetBuffer)
|
|
14513
|
+
* @param this
|
|
14421
14514
|
*/
|
|
14422
14515
|
GetBuffer(this: StudioScreenshotCapture): buffer;
|
|
14423
14516
|
/**
|
|
14424
14517
|
* - **ThreadSafety**: Unsafe
|
|
14425
14518
|
*
|
|
14426
14519
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StudioScreenshotCapture#GetErrors)
|
|
14520
|
+
* @param this
|
|
14427
14521
|
*/
|
|
14428
14522
|
GetErrors(this: StudioScreenshotCapture): Array<unknown>;
|
|
14429
14523
|
/**
|
|
@@ -14431,6 +14525,9 @@ interface StudioScreenshotCapture extends Instance {
|
|
|
14431
14525
|
* - **Tags**: Yields
|
|
14432
14526
|
*
|
|
14433
14527
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StudioScreenshotCapture#ScaleAsync)
|
|
14528
|
+
* @param this
|
|
14529
|
+
* @param strategy
|
|
14530
|
+
* @param newSize
|
|
14434
14531
|
*/
|
|
14435
14532
|
ScaleAsync(this: StudioScreenshotCapture, strategy: CastsToEnum<Enum.ResamplerMode>, newSize: Vector2): StudioScreenshotCapture;
|
|
14436
14533
|
}
|
|
@@ -16079,6 +16176,8 @@ interface UIScale extends UIComponent {
|
|
|
16079
16176
|
readonly _nominal_UIScale: unique symbol;
|
|
16080
16177
|
}
|
|
16081
16178
|
/**
|
|
16179
|
+
* Renders a shadow below the parent UI instance.
|
|
16180
|
+
*
|
|
16082
16181
|
* - **Tags**: NotBrowsable
|
|
16083
16182
|
*
|
|
16084
16183
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UIShadow)
|
|
@@ -2864,6 +2864,33 @@ declare namespace Enum {
|
|
|
2864
2864
|
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.AssetFetchStatus | undefined;
|
|
2865
2865
|
}
|
|
2866
2866
|
export type AssetFetchStatus = AssetFetchStatus.Success | AssetFetchStatus.Failure | AssetFetchStatus.None | AssetFetchStatus.Loading | AssetFetchStatus.TimedOut;
|
|
2867
|
+
/**
|
|
2868
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AssetRepresentation)
|
|
2869
|
+
*/
|
|
2870
|
+
export namespace AssetRepresentation {
|
|
2871
|
+
/**
|
|
2872
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AssetRepresentation#FullLength)
|
|
2873
|
+
*/
|
|
2874
|
+
export interface FullLength extends globalThis.EnumItem {
|
|
2875
|
+
Name: "FullLength";
|
|
2876
|
+
Value: 0;
|
|
2877
|
+
EnumType: typeof globalThis.Enum.AssetRepresentation;
|
|
2878
|
+
}
|
|
2879
|
+
export const FullLength: FullLength;
|
|
2880
|
+
/**
|
|
2881
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AssetRepresentation#ShortPreview)
|
|
2882
|
+
*/
|
|
2883
|
+
export interface ShortPreview extends globalThis.EnumItem {
|
|
2884
|
+
Name: "ShortPreview";
|
|
2885
|
+
Value: 1;
|
|
2886
|
+
EnumType: typeof globalThis.Enum.AssetRepresentation;
|
|
2887
|
+
}
|
|
2888
|
+
export const ShortPreview: ShortPreview;
|
|
2889
|
+
export function GetEnumItems(this: globalThis.Enum): Array<globalThis.Enum.AssetRepresentation>;
|
|
2890
|
+
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.AssetRepresentation | undefined;
|
|
2891
|
+
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.AssetRepresentation | undefined;
|
|
2892
|
+
}
|
|
2893
|
+
export type AssetRepresentation = AssetRepresentation.FullLength | AssetRepresentation.ShortPreview;
|
|
2867
2894
|
/**
|
|
2868
2895
|
* This Enum can be used to match the AssetTypeId from `MarketplaceService:GetProductInfoAsync()` to an asset type.
|
|
2869
2896
|
*
|
|
@@ -7686,11 +7713,20 @@ declare namespace Enum {
|
|
|
7686
7713
|
EnumType: typeof globalThis.Enum.CollisionFidelity;
|
|
7687
7714
|
}
|
|
7688
7715
|
export const PreciseConvexDecomposition: PreciseConvexDecomposition;
|
|
7716
|
+
/**
|
|
7717
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CollisionFidelity#Scalable)
|
|
7718
|
+
*/
|
|
7719
|
+
export interface Scalable extends globalThis.EnumItem {
|
|
7720
|
+
Name: "Scalable";
|
|
7721
|
+
Value: 4;
|
|
7722
|
+
EnumType: typeof globalThis.Enum.CollisionFidelity;
|
|
7723
|
+
}
|
|
7724
|
+
export const Scalable: Scalable;
|
|
7689
7725
|
export function GetEnumItems(this: globalThis.Enum): Array<globalThis.Enum.CollisionFidelity>;
|
|
7690
7726
|
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.CollisionFidelity | undefined;
|
|
7691
7727
|
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.CollisionFidelity | undefined;
|
|
7692
7728
|
}
|
|
7693
|
-
export type CollisionFidelity = CollisionFidelity.Default | CollisionFidelity.Hull | CollisionFidelity.Box | CollisionFidelity.PreciseConvexDecomposition;
|
|
7729
|
+
export type CollisionFidelity = CollisionFidelity.Default | CollisionFidelity.Hull | CollisionFidelity.Box | CollisionFidelity.PreciseConvexDecomposition | CollisionFidelity.Scalable;
|
|
7694
7730
|
/**
|
|
7695
7731
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CommandPermission)
|
|
7696
7732
|
*/
|
|
@@ -9210,6 +9246,15 @@ declare namespace Enum {
|
|
|
9210
9246
|
EnumType: typeof globalThis.Enum.ConnectionError;
|
|
9211
9247
|
}
|
|
9212
9248
|
export const PlacelaunchUserPrivacyUnauthorized: PlacelaunchUserPrivacyUnauthorized;
|
|
9249
|
+
/**
|
|
9250
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ConnectionError#PlacelaunchVipOwnerNotPresent)
|
|
9251
|
+
*/
|
|
9252
|
+
export interface PlacelaunchVipOwnerNotPresent extends globalThis.EnumItem {
|
|
9253
|
+
Name: "PlacelaunchVipOwnerNotPresent";
|
|
9254
|
+
Value: 541;
|
|
9255
|
+
EnumType: typeof globalThis.Enum.ConnectionError;
|
|
9256
|
+
}
|
|
9257
|
+
export const PlacelaunchVipOwnerNotPresent: PlacelaunchVipOwnerNotPresent;
|
|
9213
9258
|
/**
|
|
9214
9259
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ConnectionError#PlacelaunchAgeVerificationRequired)
|
|
9215
9260
|
*/
|
|
@@ -9349,7 +9394,7 @@ declare namespace Enum {
|
|
|
9349
9394
|
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.ConnectionError | undefined;
|
|
9350
9395
|
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.ConnectionError | undefined;
|
|
9351
9396
|
}
|
|
9352
|
-
export type ConnectionError = ConnectionError.OK | ConnectionError.Unknown | ConnectionError.ConnectErrors | ConnectionError.AlreadyConnected | ConnectionError.NoFreeIncomingConnections | ConnectionError.ConnectionBanned | ConnectionError.InvalidPassword | ConnectionError.IncompatibleProtocolVersion | ConnectionError.IPRecentlyConnected | ConnectionError.OurSystemRequiresSecurity | ConnectionError.SecurityKeyMismatch | ConnectionError.DisconnectErrors | ConnectionError.DisconnectBadhash | ConnectionError.DisconnectSecurityKeyMismatch | ConnectionError.DisconnectProtocolMismatch | ConnectionError.DisconnectReceivePacketError | ConnectionError.DisconnectReceivePacketStreamError | ConnectionError.DisconnectSendPacketError | ConnectionError.DisconnectIllegalTeleport | ConnectionError.DisconnectDuplicatePlayer | ConnectionError.DisconnectDuplicateTicket | ConnectionError.DisconnectTimeout | ConnectionError.DisconnectLuaKick | ConnectionError.DisconnectOnRemoteSysStats | ConnectionError.DisconnectHashTimeout | ConnectionError.DisconnectCloudEditKick | ConnectionError.DisconnectPlayerless | ConnectionError.DisconnectNewSecurityKeyMismatch | ConnectionError.DisconnectEvicted | ConnectionError.DisconnectDevMaintenance | ConnectionError.DisconnectRobloxMaintenance | ConnectionError.DisconnectRejoin | ConnectionError.DisconnectConnectionLost | ConnectionError.DisconnectIdle | ConnectionError.DisconnectRaknetErrors | ConnectionError.DisconnectWrongVersion | ConnectionError.DisconnectBySecurityPolicy | ConnectionError.DisconnectBlockedIP | ConnectionError.DisconnectClientFailure | ConnectionError.DisconnectClientRequest | ConnectionError.DisconnectPrivateServerKickout | ConnectionError.DisconnectModeratedGame | ConnectionError.ServerShutdown | ConnectionError.ReplicatorTimeout | ConnectionError.PlayerRemoved | ConnectionError.DisconnectOutOfMemoryKeepPlayingLeave | ConnectionError.DisconnectRomarkEndOfTest | ConnectionError.DisconnectCollaboratorPermissionRevoked | ConnectionError.DisconnectCollaboratorUnderage | ConnectionError.NetworkInternal | ConnectionError.NetworkSend | ConnectionError.NetworkTimeout | ConnectionError.NetworkMisbehavior | ConnectionError.NetworkSecurity | ConnectionError.ReplacementReady | ConnectionError.ServerEmpty | ConnectionError.PhantomFreeze | ConnectionError.AndroidAnticheatKick | ConnectionError.AndroidEmulatorKick | ConnectionError.AndroidRootedKick | ConnectionError.ScreentimeLockoutKick | ConnectionError.DisconnectionNotification | ConnectionError.DisconnectVerboselyModeratedGame | ConnectionError.DisconnectCollaboratorNotAgeVerified | ConnectionError.DisconnectCollaboratorTrustedConnectionsRequired | ConnectionError.DisconnectCollaboratorOwnerActionRequired | ConnectionError.DisconnectCollaboratorTooManyCollaborators | ConnectionError.DisconnectCollaboratorUnknownError | ConnectionError.PlacelaunchErrors | ConnectionError.PlacelaunchDisabled | ConnectionError.PlacelaunchError | ConnectionError.PlacelaunchGameEnded | ConnectionError.PlacelaunchGameFull | ConnectionError.PlacelaunchUserLeft | ConnectionError.PlacelaunchRestricted | ConnectionError.PlacelaunchUnauthorized | ConnectionError.PlacelaunchFlooded | ConnectionError.PlacelaunchHashExpired | ConnectionError.PlacelaunchHashException | ConnectionError.PlacelaunchPartyCannotFit | ConnectionError.PlacelaunchHttpError | ConnectionError.PlacelaunchUserPrivacyUnauthorized | ConnectionError.PlacelaunchAgeVerificationRequired | ConnectionError.PlacelaunchParentalApprovalRequired | ConnectionError.PlacelaunchCoreGated | ConnectionError.PlacelaunchCreatorBan | ConnectionError.PlacelaunchDeviceBlock | ConnectionError.PlacelaunchCustomMessage | ConnectionError.PlacelaunchOtherError | ConnectionError.TeleportErrors | ConnectionError.TeleportFailure | ConnectionError.TeleportGameNotFound | ConnectionError.TeleportGameEnded | ConnectionError.TeleportGameFull | ConnectionError.TeleportUnauthorized | ConnectionError.TeleportFlooded | ConnectionError.TeleportIsTeleporting;
|
|
9397
|
+
export type ConnectionError = ConnectionError.OK | ConnectionError.Unknown | ConnectionError.ConnectErrors | ConnectionError.AlreadyConnected | ConnectionError.NoFreeIncomingConnections | ConnectionError.ConnectionBanned | ConnectionError.InvalidPassword | ConnectionError.IncompatibleProtocolVersion | ConnectionError.IPRecentlyConnected | ConnectionError.OurSystemRequiresSecurity | ConnectionError.SecurityKeyMismatch | ConnectionError.DisconnectErrors | ConnectionError.DisconnectBadhash | ConnectionError.DisconnectSecurityKeyMismatch | ConnectionError.DisconnectProtocolMismatch | ConnectionError.DisconnectReceivePacketError | ConnectionError.DisconnectReceivePacketStreamError | ConnectionError.DisconnectSendPacketError | ConnectionError.DisconnectIllegalTeleport | ConnectionError.DisconnectDuplicatePlayer | ConnectionError.DisconnectDuplicateTicket | ConnectionError.DisconnectTimeout | ConnectionError.DisconnectLuaKick | ConnectionError.DisconnectOnRemoteSysStats | ConnectionError.DisconnectHashTimeout | ConnectionError.DisconnectCloudEditKick | ConnectionError.DisconnectPlayerless | ConnectionError.DisconnectNewSecurityKeyMismatch | ConnectionError.DisconnectEvicted | ConnectionError.DisconnectDevMaintenance | ConnectionError.DisconnectRobloxMaintenance | ConnectionError.DisconnectRejoin | ConnectionError.DisconnectConnectionLost | ConnectionError.DisconnectIdle | ConnectionError.DisconnectRaknetErrors | ConnectionError.DisconnectWrongVersion | ConnectionError.DisconnectBySecurityPolicy | ConnectionError.DisconnectBlockedIP | ConnectionError.DisconnectClientFailure | ConnectionError.DisconnectClientRequest | ConnectionError.DisconnectPrivateServerKickout | ConnectionError.DisconnectModeratedGame | ConnectionError.ServerShutdown | ConnectionError.ReplicatorTimeout | ConnectionError.PlayerRemoved | ConnectionError.DisconnectOutOfMemoryKeepPlayingLeave | ConnectionError.DisconnectRomarkEndOfTest | ConnectionError.DisconnectCollaboratorPermissionRevoked | ConnectionError.DisconnectCollaboratorUnderage | ConnectionError.NetworkInternal | ConnectionError.NetworkSend | ConnectionError.NetworkTimeout | ConnectionError.NetworkMisbehavior | ConnectionError.NetworkSecurity | ConnectionError.ReplacementReady | ConnectionError.ServerEmpty | ConnectionError.PhantomFreeze | ConnectionError.AndroidAnticheatKick | ConnectionError.AndroidEmulatorKick | ConnectionError.AndroidRootedKick | ConnectionError.ScreentimeLockoutKick | ConnectionError.DisconnectionNotification | ConnectionError.DisconnectVerboselyModeratedGame | ConnectionError.DisconnectCollaboratorNotAgeVerified | ConnectionError.DisconnectCollaboratorTrustedConnectionsRequired | ConnectionError.DisconnectCollaboratorOwnerActionRequired | ConnectionError.DisconnectCollaboratorTooManyCollaborators | ConnectionError.DisconnectCollaboratorUnknownError | ConnectionError.PlacelaunchErrors | ConnectionError.PlacelaunchDisabled | ConnectionError.PlacelaunchError | ConnectionError.PlacelaunchGameEnded | ConnectionError.PlacelaunchGameFull | ConnectionError.PlacelaunchUserLeft | ConnectionError.PlacelaunchRestricted | ConnectionError.PlacelaunchUnauthorized | ConnectionError.PlacelaunchFlooded | ConnectionError.PlacelaunchHashExpired | ConnectionError.PlacelaunchHashException | ConnectionError.PlacelaunchPartyCannotFit | ConnectionError.PlacelaunchHttpError | ConnectionError.PlacelaunchUserPrivacyUnauthorized | ConnectionError.PlacelaunchVipOwnerNotPresent | ConnectionError.PlacelaunchAgeVerificationRequired | ConnectionError.PlacelaunchParentalApprovalRequired | ConnectionError.PlacelaunchCoreGated | ConnectionError.PlacelaunchCreatorBan | ConnectionError.PlacelaunchDeviceBlock | ConnectionError.PlacelaunchCustomMessage | ConnectionError.PlacelaunchOtherError | ConnectionError.TeleportErrors | ConnectionError.TeleportFailure | ConnectionError.TeleportGameNotFound | ConnectionError.TeleportGameEnded | ConnectionError.TeleportGameFull | ConnectionError.TeleportUnauthorized | ConnectionError.TeleportFlooded | ConnectionError.TeleportIsTeleporting;
|
|
9353
9398
|
/**
|
|
9354
9399
|
* Used to determine the connection state of the client to the game server.
|
|
9355
9400
|
*
|
|
@@ -10203,6 +10248,42 @@ declare namespace Enum {
|
|
|
10203
10248
|
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.DataStoreRequestType | undefined;
|
|
10204
10249
|
}
|
|
10205
10250
|
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;
|
|
10251
|
+
/**
|
|
10252
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DebugBreakModeType)
|
|
10253
|
+
*/
|
|
10254
|
+
export namespace DebugBreakModeType {
|
|
10255
|
+
/**
|
|
10256
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DebugBreakModeType#Never)
|
|
10257
|
+
*/
|
|
10258
|
+
export interface Never extends globalThis.EnumItem {
|
|
10259
|
+
Name: "Never";
|
|
10260
|
+
Value: 0;
|
|
10261
|
+
EnumType: typeof globalThis.Enum.DebugBreakModeType;
|
|
10262
|
+
}
|
|
10263
|
+
export const Never: Never;
|
|
10264
|
+
/**
|
|
10265
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DebugBreakModeType#Always)
|
|
10266
|
+
*/
|
|
10267
|
+
export interface Always extends globalThis.EnumItem {
|
|
10268
|
+
Name: "Always";
|
|
10269
|
+
Value: 1;
|
|
10270
|
+
EnumType: typeof globalThis.Enum.DebugBreakModeType;
|
|
10271
|
+
}
|
|
10272
|
+
export const Always: Always;
|
|
10273
|
+
/**
|
|
10274
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DebugBreakModeType#Unhandled)
|
|
10275
|
+
*/
|
|
10276
|
+
export interface Unhandled extends globalThis.EnumItem {
|
|
10277
|
+
Name: "Unhandled";
|
|
10278
|
+
Value: 2;
|
|
10279
|
+
EnumType: typeof globalThis.Enum.DebugBreakModeType;
|
|
10280
|
+
}
|
|
10281
|
+
export const Unhandled: Unhandled;
|
|
10282
|
+
export function GetEnumItems(this: globalThis.Enum): Array<globalThis.Enum.DebugBreakModeType>;
|
|
10283
|
+
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.DebugBreakModeType | undefined;
|
|
10284
|
+
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.DebugBreakModeType | undefined;
|
|
10285
|
+
}
|
|
10286
|
+
export type DebugBreakModeType = DebugBreakModeType.Never | DebugBreakModeType.Always | DebugBreakModeType.Unhandled;
|
|
10206
10287
|
/**
|
|
10207
10288
|
* Reason for the end of the debugger session.
|
|
10208
10289
|
*
|
|
@@ -10448,6 +10529,51 @@ declare namespace Enum {
|
|
|
10448
10529
|
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.DebuggerPauseReason | undefined;
|
|
10449
10530
|
}
|
|
10450
10531
|
export type DebuggerPauseReason = DebuggerPauseReason.Unknown | DebuggerPauseReason.Requested | DebuggerPauseReason.Breakpoint | DebuggerPauseReason.Exception | DebuggerPauseReason.SingleStep | DebuggerPauseReason.Entrypoint;
|
|
10532
|
+
/**
|
|
10533
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DebuggerResumeType)
|
|
10534
|
+
*/
|
|
10535
|
+
export namespace DebuggerResumeType {
|
|
10536
|
+
/**
|
|
10537
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DebuggerResumeType#StepInto)
|
|
10538
|
+
*/
|
|
10539
|
+
export interface StepInto extends globalThis.EnumItem {
|
|
10540
|
+
Name: "StepInto";
|
|
10541
|
+
Value: 0;
|
|
10542
|
+
EnumType: typeof globalThis.Enum.DebuggerResumeType;
|
|
10543
|
+
}
|
|
10544
|
+
export const StepInto: StepInto;
|
|
10545
|
+
/**
|
|
10546
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DebuggerResumeType#StepOut)
|
|
10547
|
+
*/
|
|
10548
|
+
export interface StepOut extends globalThis.EnumItem {
|
|
10549
|
+
Name: "StepOut";
|
|
10550
|
+
Value: 1;
|
|
10551
|
+
EnumType: typeof globalThis.Enum.DebuggerResumeType;
|
|
10552
|
+
}
|
|
10553
|
+
export const StepOut: StepOut;
|
|
10554
|
+
/**
|
|
10555
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DebuggerResumeType#StepOver)
|
|
10556
|
+
*/
|
|
10557
|
+
export interface StepOver extends globalThis.EnumItem {
|
|
10558
|
+
Name: "StepOver";
|
|
10559
|
+
Value: 2;
|
|
10560
|
+
EnumType: typeof globalThis.Enum.DebuggerResumeType;
|
|
10561
|
+
}
|
|
10562
|
+
export const StepOver: StepOver;
|
|
10563
|
+
/**
|
|
10564
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DebuggerResumeType#Resume)
|
|
10565
|
+
*/
|
|
10566
|
+
export interface Resume extends globalThis.EnumItem {
|
|
10567
|
+
Name: "Resume";
|
|
10568
|
+
Value: 3;
|
|
10569
|
+
EnumType: typeof globalThis.Enum.DebuggerResumeType;
|
|
10570
|
+
}
|
|
10571
|
+
export const Resume: Resume;
|
|
10572
|
+
export function GetEnumItems(this: globalThis.Enum): Array<globalThis.Enum.DebuggerResumeType>;
|
|
10573
|
+
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.DebuggerResumeType | undefined;
|
|
10574
|
+
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.DebuggerResumeType | undefined;
|
|
10575
|
+
}
|
|
10576
|
+
export type DebuggerResumeType = DebuggerResumeType.StepInto | DebuggerResumeType.StepOut | DebuggerResumeType.StepOver | DebuggerResumeType.Resume;
|
|
10451
10577
|
/**
|
|
10452
10578
|
* Result of a debugger request.
|
|
10453
10579
|
*
|
|
@@ -12318,10 +12444,14 @@ declare namespace Enum {
|
|
|
12318
12444
|
}
|
|
12319
12445
|
export type EngineFolder = EngineFolder.Screenshots | EngineFolder.Videos | EngineFolder.Logs;
|
|
12320
12446
|
/**
|
|
12447
|
+
* Used to control the throttle rate of Roblox's physics engine.
|
|
12448
|
+
*
|
|
12321
12449
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/EnviromentalPhysicsThrottle)
|
|
12322
12450
|
*/
|
|
12323
12451
|
export namespace EnviromentalPhysicsThrottle {
|
|
12324
12452
|
/**
|
|
12453
|
+
* Automatically adjusts throttle level based on performance.
|
|
12454
|
+
*
|
|
12325
12455
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/EnviromentalPhysicsThrottle#DefaultAuto)
|
|
12326
12456
|
*/
|
|
12327
12457
|
export interface DefaultAuto extends globalThis.EnumItem {
|
|
@@ -12331,6 +12461,8 @@ declare namespace Enum {
|
|
|
12331
12461
|
}
|
|
12332
12462
|
export const DefaultAuto: DefaultAuto;
|
|
12333
12463
|
/**
|
|
12464
|
+
* No throttling; every physics step runs.
|
|
12465
|
+
*
|
|
12334
12466
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/EnviromentalPhysicsThrottle#Disabled)
|
|
12335
12467
|
*/
|
|
12336
12468
|
export interface Disabled extends globalThis.EnumItem {
|
|
@@ -12340,6 +12472,8 @@ declare namespace Enum {
|
|
|
12340
12472
|
}
|
|
12341
12473
|
export const Disabled: Disabled;
|
|
12342
12474
|
/**
|
|
12475
|
+
* Maximum throttling; physics is effectively frozen.
|
|
12476
|
+
*
|
|
12343
12477
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/EnviromentalPhysicsThrottle#Always)
|
|
12344
12478
|
*/
|
|
12345
12479
|
export interface Always extends globalThis.EnumItem {
|
|
@@ -12349,6 +12483,8 @@ declare namespace Enum {
|
|
|
12349
12483
|
}
|
|
12350
12484
|
export const Always: Always;
|
|
12351
12485
|
/**
|
|
12486
|
+
* Runs 1 out of every 2 steps (50% reduction). If `Workspace.PhysicsSteppingMethod` is set to `Adaptive`, skipping is based on groups of 4 steps instead of individual steps.
|
|
12487
|
+
*
|
|
12352
12488
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/EnviromentalPhysicsThrottle#Skip2)
|
|
12353
12489
|
*/
|
|
12354
12490
|
export interface Skip2 extends globalThis.EnumItem {
|
|
@@ -12358,6 +12494,8 @@ declare namespace Enum {
|
|
|
12358
12494
|
}
|
|
12359
12495
|
export const Skip2: Skip2;
|
|
12360
12496
|
/**
|
|
12497
|
+
* Runs 1 out of every 4 steps (75% reduction). If `Workspace.PhysicsSteppingMethod` is set to `Adaptive`, skipping is based on groups of 4 steps instead of individual steps.
|
|
12498
|
+
*
|
|
12361
12499
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/EnviromentalPhysicsThrottle#Skip4)
|
|
12362
12500
|
*/
|
|
12363
12501
|
export interface Skip4 extends globalThis.EnumItem {
|
|
@@ -12367,6 +12505,8 @@ declare namespace Enum {
|
|
|
12367
12505
|
}
|
|
12368
12506
|
export const Skip4: Skip4;
|
|
12369
12507
|
/**
|
|
12508
|
+
* Runs 1 out of every 8 steps (87.5% reduction). If `Workspace.PhysicsSteppingMethod` is set to `Adaptive`, skipping is based on groups of 4 steps instead of individual steps.
|
|
12509
|
+
*
|
|
12370
12510
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/EnviromentalPhysicsThrottle#Skip8)
|
|
12371
12511
|
*/
|
|
12372
12512
|
export interface Skip8 extends globalThis.EnumItem {
|
|
@@ -12376,6 +12516,8 @@ declare namespace Enum {
|
|
|
12376
12516
|
}
|
|
12377
12517
|
export const Skip8: Skip8;
|
|
12378
12518
|
/**
|
|
12519
|
+
* Runs 1 out of every 16 steps (93.75% reduction). If `Workspace.PhysicsSteppingMethod` is set to `Adaptive`, skipping is based on groups of 4 steps instead of individual steps.
|
|
12520
|
+
*
|
|
12379
12521
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/EnviromentalPhysicsThrottle#Skip16)
|
|
12380
12522
|
*/
|
|
12381
12523
|
export interface Skip16 extends globalThis.EnumItem {
|
|
@@ -17076,11 +17218,20 @@ declare namespace Enum {
|
|
|
17076
17218
|
EnumType: typeof globalThis.Enum.ImageCombineType;
|
|
17077
17219
|
}
|
|
17078
17220
|
export const AlphaBlend: AlphaBlend;
|
|
17221
|
+
/**
|
|
17222
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ImageCombineType#NormalMapBlend)
|
|
17223
|
+
*/
|
|
17224
|
+
export interface NormalMapBlend extends globalThis.EnumItem {
|
|
17225
|
+
Name: "NormalMapBlend";
|
|
17226
|
+
Value: 6;
|
|
17227
|
+
EnumType: typeof globalThis.Enum.ImageCombineType;
|
|
17228
|
+
}
|
|
17229
|
+
export const NormalMapBlend: NormalMapBlend;
|
|
17079
17230
|
export function GetEnumItems(this: globalThis.Enum): Array<globalThis.Enum.ImageCombineType>;
|
|
17080
17231
|
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.ImageCombineType | undefined;
|
|
17081
17232
|
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.ImageCombineType | undefined;
|
|
17082
17233
|
}
|
|
17083
|
-
export type ImageCombineType = ImageCombineType.BlendSourceOver | ImageCombineType.Overwrite | ImageCombineType.Add | ImageCombineType.Multiply | ImageCombineType.AlphaBlend;
|
|
17234
|
+
export type ImageCombineType = ImageCombineType.BlendSourceOver | ImageCombineType.Overwrite | ImageCombineType.Add | ImageCombineType.Multiply | ImageCombineType.AlphaBlend | ImageCombineType.NormalMapBlend;
|
|
17084
17235
|
/**
|
|
17085
17236
|
* The InOut Enum is used to set where the object is on the side of its parent.
|
|
17086
17237
|
*
|
|
@@ -27316,10 +27467,14 @@ declare namespace Enum {
|
|
|
27316
27467
|
}
|
|
27317
27468
|
export type ReadCapturesFromGalleryResult = ReadCapturesFromGalleryResult.Success | ReadCapturesFromGalleryResult.NeedPermission;
|
|
27318
27469
|
/**
|
|
27470
|
+
* `ReceiptDecision` works with `MarketplaceService` to indicate the acknowledgement of receipts.
|
|
27471
|
+
*
|
|
27319
27472
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ReceiptDecision)
|
|
27320
27473
|
*/
|
|
27321
27474
|
export namespace ReceiptDecision {
|
|
27322
27475
|
/**
|
|
27476
|
+
* The receipt has not been processed yet. Returning this value keeps the receipt unresolved so it will be delivered again on the next opportunity, such as when the user rejoins a server.
|
|
27477
|
+
*
|
|
27323
27478
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ReceiptDecision#NotProcessedYet)
|
|
27324
27479
|
*/
|
|
27325
27480
|
export interface NotProcessedYet extends globalThis.EnumItem {
|
|
@@ -27329,6 +27484,8 @@ declare namespace Enum {
|
|
|
27329
27484
|
}
|
|
27330
27485
|
export const NotProcessedYet: NotProcessedYet;
|
|
27331
27486
|
/**
|
|
27487
|
+
* The receipt has been processed and all benefits have been granted. The receipt is marked as complete and will not be delivered again.
|
|
27488
|
+
*
|
|
27332
27489
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ReceiptDecision#Processed)
|
|
27333
27490
|
*/
|
|
27334
27491
|
export interface Processed extends globalThis.EnumItem {
|
|
@@ -27343,6 +27500,8 @@ declare namespace Enum {
|
|
|
27343
27500
|
}
|
|
27344
27501
|
export type ReceiptDecision = ReceiptDecision.NotProcessedYet | ReceiptDecision.Processed;
|
|
27345
27502
|
/**
|
|
27503
|
+
* `ReceiptType` is used to work with server-sided receipt processing.
|
|
27504
|
+
*
|
|
27346
27505
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ReceiptType)
|
|
27347
27506
|
*/
|
|
27348
27507
|
export namespace ReceiptType {
|
|
@@ -27356,6 +27515,8 @@ declare namespace Enum {
|
|
|
27356
27515
|
}
|
|
27357
27516
|
export const DeveloperProduct: DeveloperProduct;
|
|
27358
27517
|
/**
|
|
27518
|
+
* Used for processing receipts for the user who initiated a Robux transfer. The receipt's `PlayerId` is the sender's user ID and includes a `TransferRequestId` field.
|
|
27519
|
+
*
|
|
27359
27520
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ReceiptType#RobuxTransferSender)
|
|
27360
27521
|
*/
|
|
27361
27522
|
export interface RobuxTransferSender extends globalThis.EnumItem {
|
|
@@ -27365,6 +27526,8 @@ declare namespace Enum {
|
|
|
27365
27526
|
}
|
|
27366
27527
|
export const RobuxTransferSender: RobuxTransferSender;
|
|
27367
27528
|
/**
|
|
27529
|
+
* Used for processing receipts for the user who received Robux via a transfer. The receipt's `PlayerId` is the receiver's user ID and includes a `TransferRequestId` field.
|
|
27530
|
+
*
|
|
27368
27531
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ReceiptType#RobuxTransferReceiver)
|
|
27369
27532
|
*/
|
|
27370
27533
|
export interface RobuxTransferReceiver extends globalThis.EnumItem {
|
|
@@ -30065,6 +30228,96 @@ declare namespace Enum {
|
|
|
30065
30228
|
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.ScreenshotCaptureResult | undefined;
|
|
30066
30229
|
}
|
|
30067
30230
|
export type ScreenshotCaptureResult = ScreenshotCaptureResult.Success | ScreenshotCaptureResult.OtherError | ScreenshotCaptureResult.NoDeviceSupport | ScreenshotCaptureResult.NoSpaceOnDevice;
|
|
30231
|
+
/**
|
|
30232
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ScriptStoppedReason)
|
|
30233
|
+
*/
|
|
30234
|
+
export namespace ScriptStoppedReason {
|
|
30235
|
+
/**
|
|
30236
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ScriptStoppedReason#Breakpoint)
|
|
30237
|
+
*/
|
|
30238
|
+
export interface Breakpoint extends globalThis.EnumItem {
|
|
30239
|
+
Name: "Breakpoint";
|
|
30240
|
+
Value: 0;
|
|
30241
|
+
EnumType: typeof globalThis.Enum.ScriptStoppedReason;
|
|
30242
|
+
}
|
|
30243
|
+
export const Breakpoint: Breakpoint;
|
|
30244
|
+
/**
|
|
30245
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ScriptStoppedReason#Exception)
|
|
30246
|
+
*/
|
|
30247
|
+
export interface Exception extends globalThis.EnumItem {
|
|
30248
|
+
Name: "Exception";
|
|
30249
|
+
Value: 1;
|
|
30250
|
+
EnumType: typeof globalThis.Enum.ScriptStoppedReason;
|
|
30251
|
+
}
|
|
30252
|
+
export const Exception: Exception;
|
|
30253
|
+
/**
|
|
30254
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ScriptStoppedReason#Pause)
|
|
30255
|
+
*/
|
|
30256
|
+
export interface Pause extends globalThis.EnumItem {
|
|
30257
|
+
Name: "Pause";
|
|
30258
|
+
Value: 2;
|
|
30259
|
+
EnumType: typeof globalThis.Enum.ScriptStoppedReason;
|
|
30260
|
+
}
|
|
30261
|
+
export const Pause: Pause;
|
|
30262
|
+
/**
|
|
30263
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ScriptStoppedReason#Step)
|
|
30264
|
+
*/
|
|
30265
|
+
export interface Step extends globalThis.EnumItem {
|
|
30266
|
+
Name: "Step";
|
|
30267
|
+
Value: 3;
|
|
30268
|
+
EnumType: typeof globalThis.Enum.ScriptStoppedReason;
|
|
30269
|
+
}
|
|
30270
|
+
export const Step: Step;
|
|
30271
|
+
/**
|
|
30272
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ScriptStoppedReason#Entry)
|
|
30273
|
+
*/
|
|
30274
|
+
export interface Entry extends globalThis.EnumItem {
|
|
30275
|
+
Name: "Entry";
|
|
30276
|
+
Value: 4;
|
|
30277
|
+
EnumType: typeof globalThis.Enum.ScriptStoppedReason;
|
|
30278
|
+
}
|
|
30279
|
+
export const Entry: Entry;
|
|
30280
|
+
export function GetEnumItems(this: globalThis.Enum): Array<globalThis.Enum.ScriptStoppedReason>;
|
|
30281
|
+
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.ScriptStoppedReason | undefined;
|
|
30282
|
+
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.ScriptStoppedReason | undefined;
|
|
30283
|
+
}
|
|
30284
|
+
export type ScriptStoppedReason = ScriptStoppedReason.Breakpoint | ScriptStoppedReason.Exception | ScriptStoppedReason.Pause | ScriptStoppedReason.Step | ScriptStoppedReason.Entry;
|
|
30285
|
+
/**
|
|
30286
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ScriptVariableScope)
|
|
30287
|
+
*/
|
|
30288
|
+
export namespace ScriptVariableScope {
|
|
30289
|
+
/**
|
|
30290
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ScriptVariableScope#Local)
|
|
30291
|
+
*/
|
|
30292
|
+
export interface Local extends globalThis.EnumItem {
|
|
30293
|
+
Name: "Local";
|
|
30294
|
+
Value: 0;
|
|
30295
|
+
EnumType: typeof globalThis.Enum.ScriptVariableScope;
|
|
30296
|
+
}
|
|
30297
|
+
export const Local: Local;
|
|
30298
|
+
/**
|
|
30299
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ScriptVariableScope#Upvalue)
|
|
30300
|
+
*/
|
|
30301
|
+
export interface Upvalue extends globalThis.EnumItem {
|
|
30302
|
+
Name: "Upvalue";
|
|
30303
|
+
Value: 1;
|
|
30304
|
+
EnumType: typeof globalThis.Enum.ScriptVariableScope;
|
|
30305
|
+
}
|
|
30306
|
+
export const Upvalue: Upvalue;
|
|
30307
|
+
/**
|
|
30308
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ScriptVariableScope#Global)
|
|
30309
|
+
*/
|
|
30310
|
+
export interface Global extends globalThis.EnumItem {
|
|
30311
|
+
Name: "Global";
|
|
30312
|
+
Value: 2;
|
|
30313
|
+
EnumType: typeof globalThis.Enum.ScriptVariableScope;
|
|
30314
|
+
}
|
|
30315
|
+
export const Global: Global;
|
|
30316
|
+
export function GetEnumItems(this: globalThis.Enum): Array<globalThis.Enum.ScriptVariableScope>;
|
|
30317
|
+
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.ScriptVariableScope | undefined;
|
|
30318
|
+
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.ScriptVariableScope | undefined;
|
|
30319
|
+
}
|
|
30320
|
+
export type ScriptVariableScope = ScriptVariableScope.Local | ScriptVariableScope.Upvalue | ScriptVariableScope.Global;
|
|
30068
30321
|
/**
|
|
30069
30322
|
* This enum is used with `ScrollingFrame.HorizontalScrollBarInset` and `ScrollingFrame.VerticalScrollBarInset` to indicate whether the canvas should be inset by `ScrollBarThickness` for the respective scroll bar.
|
|
30070
30323
|
*
|