@rbxts/types 1.0.919 → 1.0.921
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 +322 -127
- package/include/generated/PluginSecurity.d.ts +143 -12
- package/include/generated/enums.d.ts +460 -5
- package/package.json +1 -1
|
@@ -79,6 +79,7 @@ interface Services {
|
|
|
79
79
|
FacialAnimationStreamingServiceV2: FacialAnimationStreamingServiceV2;
|
|
80
80
|
FeatureRestrictionManager: FeatureRestrictionManager;
|
|
81
81
|
FileManagerService: FileManagerService;
|
|
82
|
+
FileSyncReplicationService: FileSyncReplicationService;
|
|
82
83
|
GamepadService: GamepadService;
|
|
83
84
|
GamePassService: GamePassService;
|
|
84
85
|
GenerationService: GenerationService;
|
|
@@ -90,6 +91,7 @@ interface Services {
|
|
|
90
91
|
HapticService: HapticService;
|
|
91
92
|
HarmonyService: HarmonyService;
|
|
92
93
|
HeapProfilerService: HeapProfilerService;
|
|
94
|
+
HeatmapQueryService: HeatmapQueryService;
|
|
93
95
|
HeatmapService: HeatmapService;
|
|
94
96
|
HeightmapImporterService: HeightmapImporterService;
|
|
95
97
|
HttpService: HttpService;
|
|
@@ -179,6 +181,7 @@ interface Services {
|
|
|
179
181
|
ScriptCloneWatcherHelper: ScriptCloneWatcherHelper;
|
|
180
182
|
ScriptCommitService: ScriptCommitService;
|
|
181
183
|
ScriptContext: ScriptContext;
|
|
184
|
+
ScriptDebuggerService: ScriptDebuggerService;
|
|
182
185
|
ScriptProfilerService: ScriptProfilerService;
|
|
183
186
|
ScriptRegistrationService: ScriptRegistrationService;
|
|
184
187
|
SelectionHighlightManager: SelectionHighlightManager;
|
|
@@ -3972,7 +3975,7 @@ interface Animator extends Instance {
|
|
|
3972
3975
|
*/
|
|
3973
3976
|
readonly RootMotionWeight: number;
|
|
3974
3977
|
/**
|
|
3975
|
-
* Computes relative velocities between parts and
|
|
3978
|
+
* Computes relative velocities between parts and applies them to `Motor6D.Part1`.
|
|
3976
3979
|
*
|
|
3977
3980
|
* - **ThreadSafety**: Unsafe
|
|
3978
3981
|
*
|
|
@@ -3982,7 +3985,7 @@ interface Animator extends Instance {
|
|
|
3982
3985
|
*/
|
|
3983
3986
|
ApplyJointVelocities(this: Animator, motors: Array<Motor6D>): void;
|
|
3984
3987
|
/**
|
|
3985
|
-
* Returns the list of currently
|
|
3988
|
+
* Returns the list of currently active `AnimationTracks`.
|
|
3986
3989
|
*
|
|
3987
3990
|
* - **ThreadSafety**: Unsafe
|
|
3988
3991
|
*
|
|
@@ -3991,9 +3994,14 @@ interface Animator extends Instance {
|
|
|
3991
3994
|
*/
|
|
3992
3995
|
GetPlayingAnimationTracks(this: Animator): Array<AnimationTrack>;
|
|
3993
3996
|
/**
|
|
3997
|
+
* 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.
|
|
3998
|
+
*
|
|
3994
3999
|
* - **ThreadSafety**: Unsafe
|
|
3995
4000
|
*
|
|
3996
4001
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Animator#GetTrackByAnimationId)
|
|
4002
|
+
* @param this Responsible for the playback and replication of `Animations`.
|
|
4003
|
+
* @param animationId The asset ID of the `Animation` whose loaded track should be retrieved.
|
|
4004
|
+
* @returns The first `AnimationTrack` on this `Animator` that was loaded from the given animation ID, or `nil` if none has been loaded.
|
|
3997
4005
|
*/
|
|
3998
4006
|
GetTrackByAnimationId(this: Animator, animationId: ContentId): AnimationTrack;
|
|
3999
4007
|
/**
|
|
@@ -4015,7 +4023,7 @@ interface Animator extends Instance {
|
|
|
4015
4023
|
*/
|
|
4016
4024
|
RegisterEvaluationParallelCallback(this: Animator, callback: Callback): void;
|
|
4017
4025
|
/**
|
|
4018
|
-
* Fires when the Animator starts playing an AnimationTrack
|
|
4026
|
+
* Fires when the `Animator` starts playing an `AnimationTrack`.
|
|
4019
4027
|
*
|
|
4020
4028
|
* - **ThreadSafety**: Unsafe
|
|
4021
4029
|
*
|
|
@@ -8060,7 +8068,7 @@ interface AvatarCreationService extends Instance {
|
|
|
8060
8068
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AvatarCreationService#PromptSelectAvatarGenerationImageAsync)
|
|
8061
8069
|
* @param this A service to support developer avatar creators.
|
|
8062
8070
|
* @param player The `Player` to prompt for taking a selfie.
|
|
8063
|
-
* @returns A string FileId of the selfie.
|
|
8071
|
+
* @returns A string FileId of the selfie on success, or an error string describing the reason for failure.
|
|
8064
8072
|
*/
|
|
8065
8073
|
PromptSelectAvatarGenerationImageAsync(this: AvatarCreationService, player: Player): string;
|
|
8066
8074
|
/**
|
|
@@ -8347,6 +8355,13 @@ interface AvatarEditorService extends Instance {
|
|
|
8347
8355
|
* @returns Returns an array of item details.
|
|
8348
8356
|
*/
|
|
8349
8357
|
GetBatchItemDetailsAsync(this: AvatarEditorService, itemIds: Array<unknown>, itemType: CastsToEnum<Enum.AvatarItemType>): Array<unknown>;
|
|
8358
|
+
/**
|
|
8359
|
+
* - **ThreadSafety**: Unsafe
|
|
8360
|
+
* - **Tags**: Yields
|
|
8361
|
+
*
|
|
8362
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AvatarEditorService#GetBundlesByAssetIdAsync)
|
|
8363
|
+
*/
|
|
8364
|
+
GetBundlesByAssetIdAsync(this: AvatarEditorService, assetId: number, limit?: number): CatalogPages;
|
|
8350
8365
|
/**
|
|
8351
8366
|
* **Deprecated:**
|
|
8352
8367
|
*
|
|
@@ -8693,7 +8708,7 @@ interface AvatarSettings extends Instance {
|
|
|
8693
8708
|
readonly _nominal_AvatarSettings: unique symbol;
|
|
8694
8709
|
}
|
|
8695
8710
|
/**
|
|
8696
|
-
* A container object that holds a player's inventory. Any `Tool` in a player's Backpack will be displayed in their inventory at the bottom of
|
|
8711
|
+
* A container object that holds a player's inventory. Any `Tool` in a player's `Backpack` will be displayed in their inventory at the bottom of the screen.
|
|
8697
8712
|
*
|
|
8698
8713
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Backpack)
|
|
8699
8714
|
*/
|
|
@@ -9454,7 +9469,7 @@ interface BasePlayerGui extends Instance {
|
|
|
9454
9469
|
GetGuiObjectsAtPosition(this: BasePlayerGui, x: number, y: number): Array<GuiObject>;
|
|
9455
9470
|
}
|
|
9456
9471
|
/**
|
|
9457
|
-
* A container
|
|
9472
|
+
* A container that holds a player's UI.
|
|
9458
9473
|
*
|
|
9459
9474
|
* - **Tags**: NotCreatable, PlayerReplicated
|
|
9460
9475
|
*
|
|
@@ -9503,7 +9518,7 @@ interface PlayerGui extends BasePlayerGui {
|
|
|
9503
9518
|
* - **Tags**:
|
|
9504
9519
|
*
|
|
9505
9520
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PlayerGui#GetTopbarTransparency)
|
|
9506
|
-
* @param this A container
|
|
9521
|
+
* @param this A container that holds a player's UI.
|
|
9507
9522
|
*
|
|
9508
9523
|
* @deprecated
|
|
9509
9524
|
*/
|
|
@@ -9517,7 +9532,7 @@ interface PlayerGui extends BasePlayerGui {
|
|
|
9517
9532
|
* - **Tags**:
|
|
9518
9533
|
*
|
|
9519
9534
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PlayerGui#SetTopbarTransparency)
|
|
9520
|
-
* @param this A container
|
|
9535
|
+
* @param this A container that holds a player's UI.
|
|
9521
9536
|
* @param transparency
|
|
9522
9537
|
*
|
|
9523
9538
|
* @deprecated
|
|
@@ -10936,6 +10951,8 @@ interface CaptureService extends Instance {
|
|
|
10936
10951
|
* - **Tags**: Yields
|
|
10937
10952
|
*
|
|
10938
10953
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CaptureService#CheckUploadCaptureStatusAsync)
|
|
10954
|
+
* @param this A service which provides control over screenshot and video capture features.
|
|
10955
|
+
* @param token
|
|
10939
10956
|
*/
|
|
10940
10957
|
CheckUploadCaptureStatusAsync(this: CaptureService, token: string): unknown;
|
|
10941
10958
|
/**
|
|
@@ -10978,6 +10995,8 @@ interface CaptureService extends Instance {
|
|
|
10978
10995
|
* - **Tags**: Yields
|
|
10979
10996
|
*
|
|
10980
10997
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CaptureService#StartUploadCaptureAsync)
|
|
10998
|
+
* @param this A service which provides control over screenshot and video capture features.
|
|
10999
|
+
* @param capture
|
|
10981
11000
|
*/
|
|
10982
11001
|
StartUploadCaptureAsync(this: CaptureService, capture: Capture): unknown;
|
|
10983
11002
|
/**
|
|
@@ -12404,7 +12423,7 @@ interface ConfigService extends Instance {
|
|
|
12404
12423
|
GetConfigForPlayerAsync(this: ConfigService, player: Player): ConfigSnapshot;
|
|
12405
12424
|
}
|
|
12406
12425
|
/**
|
|
12407
|
-
*
|
|
12426
|
+
* A container object designed to hold value objects. Makes values used in `Tools` or any model using `Scripts` more accessible.
|
|
12408
12427
|
*
|
|
12409
12428
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Configuration)
|
|
12410
12429
|
*/
|
|
@@ -16821,7 +16840,7 @@ interface ExperienceStateCaptureService extends Instance {
|
|
|
16821
16840
|
readonly _nominal_ExperienceStateCaptureService: unique symbol;
|
|
16822
16841
|
}
|
|
16823
16842
|
/**
|
|
16824
|
-
* - **Tags**: NotCreatable, Service
|
|
16843
|
+
* - **Tags**: NotCreatable, Service
|
|
16825
16844
|
*
|
|
16826
16845
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ExperienceStateRecordingService)
|
|
16827
16846
|
*/
|
|
@@ -17410,6 +17429,21 @@ interface FileManagerService extends Instance {
|
|
|
17410
17429
|
*/
|
|
17411
17430
|
readonly _nominal_FileManagerService: unique symbol;
|
|
17412
17431
|
}
|
|
17432
|
+
/**
|
|
17433
|
+
* - **Tags**: NotCreatable, Service
|
|
17434
|
+
*
|
|
17435
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/FileSyncReplicationService)
|
|
17436
|
+
*/
|
|
17437
|
+
interface FileSyncReplicationService extends Instance {
|
|
17438
|
+
/**
|
|
17439
|
+
* **DO NOT USE!**
|
|
17440
|
+
*
|
|
17441
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
17442
|
+
* @hidden
|
|
17443
|
+
* @deprecated
|
|
17444
|
+
*/
|
|
17445
|
+
readonly _nominal_FileSyncReplicationService: unique symbol;
|
|
17446
|
+
}
|
|
17413
17447
|
/**
|
|
17414
17448
|
* A preconfigured particle emitter with the visual aesthetic of fire.
|
|
17415
17449
|
*
|
|
@@ -17746,6 +17780,20 @@ interface GenerationService extends Instance {
|
|
|
17746
17780
|
* @deprecated
|
|
17747
17781
|
*/
|
|
17748
17782
|
readonly _nominal_GenerationService: unique symbol;
|
|
17783
|
+
/**
|
|
17784
|
+
* - **ThreadSafety**: Unsafe
|
|
17785
|
+
* - **Tags**: Yields
|
|
17786
|
+
*
|
|
17787
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GenerationService#ConnectAsync)
|
|
17788
|
+
*/
|
|
17789
|
+
ConnectAsync(this: GenerationService, sessionId: string, sdp: string, type: string, relay: string): unknown;
|
|
17790
|
+
/**
|
|
17791
|
+
* - **ThreadSafety**: Unsafe
|
|
17792
|
+
* - **Tags**: Yields
|
|
17793
|
+
*
|
|
17794
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GenerationService#DisconnectAsync)
|
|
17795
|
+
*/
|
|
17796
|
+
DisconnectAsync(this: GenerationService, sessionId: string): boolean;
|
|
17749
17797
|
/**
|
|
17750
17798
|
* Starts the generation of a new 3D mesh from a text prompt and returns unique IDs used to track and retrieve the result.
|
|
17751
17799
|
*
|
|
@@ -17781,6 +17829,20 @@ interface GenerationService extends Instance {
|
|
|
17781
17829
|
* - A table containing a UUID and other metadata about the generation.
|
|
17782
17830
|
*/
|
|
17783
17831
|
GenerateModelAsync(this: GenerationService, inputs: object, schema: object, options?: object): unknown;
|
|
17832
|
+
/**
|
|
17833
|
+
* - **ThreadSafety**: Unsafe
|
|
17834
|
+
* - **Tags**: Yields
|
|
17835
|
+
*
|
|
17836
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GenerationService#GetVideoGenSessionAsync)
|
|
17837
|
+
*/
|
|
17838
|
+
GetVideoGenSessionAsync(this: GenerationService): unknown;
|
|
17839
|
+
/**
|
|
17840
|
+
* - **ThreadSafety**: Unsafe
|
|
17841
|
+
* - **Tags**: Yields
|
|
17842
|
+
*
|
|
17843
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GenerationService#GetVideoGenTriggersAsync)
|
|
17844
|
+
*/
|
|
17845
|
+
GetVideoGenTriggersAsync(this: GenerationService, sessionId: string, lookbackSeconds: number): object;
|
|
17784
17846
|
/**
|
|
17785
17847
|
* Retrieves and loads a mesh generated by `GenerationService:GenerateMeshAsync()` using the provided `generationId`.
|
|
17786
17848
|
*
|
|
@@ -17793,6 +17855,27 @@ interface GenerationService extends Instance {
|
|
|
17793
17855
|
* @returns The generated asset, returned as a `Model` with a single `MeshPart` containing an `EditableMesh`.
|
|
17794
17856
|
*/
|
|
17795
17857
|
LoadGeneratedMeshAsync(this: GenerationService, generationId: string): MeshPart;
|
|
17858
|
+
/**
|
|
17859
|
+
* - **ThreadSafety**: Unsafe
|
|
17860
|
+
* - **Tags**: Yields
|
|
17861
|
+
*
|
|
17862
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GenerationService#StartVideoGenSessionAsync)
|
|
17863
|
+
*/
|
|
17864
|
+
StartVideoGenSessionAsync(this: GenerationService, sessionId: string, prompt: string, imageData: string, imageS3Reference: string, triggers: object): boolean;
|
|
17865
|
+
/**
|
|
17866
|
+
* - **ThreadSafety**: Unsafe
|
|
17867
|
+
* - **Tags**: Yields
|
|
17868
|
+
*
|
|
17869
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GenerationService#UpdateVideoGenSessionPromptAsync)
|
|
17870
|
+
*/
|
|
17871
|
+
UpdateVideoGenSessionPromptAsync(this: GenerationService, sessionId: string, prompt: string, imageData: string, imageS3Reference: string, mode: string): boolean;
|
|
17872
|
+
/**
|
|
17873
|
+
* - **ThreadSafety**: Unsafe
|
|
17874
|
+
* - **Tags**: Yields
|
|
17875
|
+
*
|
|
17876
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GenerationService#UpdateVideoGenSessionTriggersAsync)
|
|
17877
|
+
*/
|
|
17878
|
+
UpdateVideoGenSessionTriggersAsync(this: GenerationService, sessionId: string, triggers: object): boolean;
|
|
17796
17879
|
}
|
|
17797
17880
|
/**
|
|
17798
17881
|
* - **Tags**: NotCreatable, Service
|
|
@@ -20109,6 +20192,8 @@ interface ScrollingFrame extends GuiObject {
|
|
|
20109
20192
|
*/
|
|
20110
20193
|
VerticalScrollBarPosition: Enum.VerticalScrollBarPosition;
|
|
20111
20194
|
/**
|
|
20195
|
+
* Returns a `Vector2` representing the current inertial scroll velocity after the user stops their input.
|
|
20196
|
+
*
|
|
20112
20197
|
* - **ThreadSafety**: Unsafe
|
|
20113
20198
|
*
|
|
20114
20199
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScrollingFrame#GetScrollVelocity)
|
|
@@ -20116,6 +20201,8 @@ interface ScrollingFrame extends GuiObject {
|
|
|
20116
20201
|
*/
|
|
20117
20202
|
GetScrollVelocity(this: ScrollingFrame): Vector2;
|
|
20118
20203
|
/**
|
|
20204
|
+
* Resets the inertial scroll velocity of the `ScrollingFrame` to `0` on both axes.
|
|
20205
|
+
*
|
|
20119
20206
|
* - **ThreadSafety**: Unsafe
|
|
20120
20207
|
*
|
|
20121
20208
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScrollingFrame#ResetScrollVelocity)
|
|
@@ -20599,6 +20686,12 @@ interface VideoFrame extends GuiObject {
|
|
|
20599
20686
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VideoFrame#Looped)
|
|
20600
20687
|
*/
|
|
20601
20688
|
Looped: boolean;
|
|
20689
|
+
/**
|
|
20690
|
+
* - **ThreadSafety**: ReadSafe
|
|
20691
|
+
*
|
|
20692
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VideoFrame#MaximumResolution)
|
|
20693
|
+
*/
|
|
20694
|
+
MaximumResolution: Enum.VideoSampleSize;
|
|
20602
20695
|
/**
|
|
20603
20696
|
* Indicates whether the `VideoFrame.Video` is currently playing. It can be set to start or pause playback.
|
|
20604
20697
|
*
|
|
@@ -22969,6 +23062,21 @@ interface HeapProfilerService extends Instance {
|
|
|
22969
23062
|
*/
|
|
22970
23063
|
readonly _nominal_HeapProfilerService: unique symbol;
|
|
22971
23064
|
}
|
|
23065
|
+
/**
|
|
23066
|
+
* - **Tags**: NotCreatable, Service
|
|
23067
|
+
*
|
|
23068
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HeatmapQueryService)
|
|
23069
|
+
*/
|
|
23070
|
+
interface HeatmapQueryService extends Instance {
|
|
23071
|
+
/**
|
|
23072
|
+
* **DO NOT USE!**
|
|
23073
|
+
*
|
|
23074
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
23075
|
+
* @hidden
|
|
23076
|
+
* @deprecated
|
|
23077
|
+
*/
|
|
23078
|
+
readonly _nominal_HeatmapQueryService: unique symbol;
|
|
23079
|
+
}
|
|
22972
23080
|
/**
|
|
22973
23081
|
* - **Tags**: NotCreatable, Service
|
|
22974
23082
|
*
|
|
@@ -23679,9 +23787,12 @@ interface Humanoid extends Instance {
|
|
|
23679
23787
|
*/
|
|
23680
23788
|
GetPlayingAnimationTracks(this: Humanoid): Array<AnimationTrack>;
|
|
23681
23789
|
/**
|
|
23790
|
+
* Returns the humanoid's actual physical velocity relative to the surface it is standing on as a `Vector3` in world-space orientation.
|
|
23791
|
+
*
|
|
23682
23792
|
* - **ThreadSafety**: Unsafe
|
|
23683
23793
|
*
|
|
23684
23794
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Humanoid#GetRelativeVelocityAtFloor)
|
|
23795
|
+
* @param this A special object that gives models the functionality of a character.
|
|
23685
23796
|
*/
|
|
23686
23797
|
GetRelativeVelocityAtFloor(this: Humanoid): Vector3;
|
|
23687
23798
|
/**
|
|
@@ -25831,6 +25942,12 @@ interface InputBinding extends Instance {
|
|
|
25831
25942
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputBinding#UIButton)
|
|
25832
25943
|
*/
|
|
25833
25944
|
UIButton: GuiButton | undefined;
|
|
25945
|
+
/**
|
|
25946
|
+
* - **ThreadSafety**: ReadSafe
|
|
25947
|
+
*
|
|
25948
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputBinding#UIModifier)
|
|
25949
|
+
*/
|
|
25950
|
+
UIModifier: GuiButton | undefined;
|
|
25834
25951
|
/**
|
|
25835
25952
|
* Specifies an alternate `KeyCode` for dispatching directionally "up" inputs to the parent `InputAction`.
|
|
25836
25953
|
*
|
|
@@ -28418,9 +28535,16 @@ interface MarketplaceService extends Instance {
|
|
|
28418
28535
|
*/
|
|
28419
28536
|
readonly _nominal_MarketplaceService: unique symbol;
|
|
28420
28537
|
/**
|
|
28538
|
+
* Registers a callback to process receipts of a specific type.
|
|
28539
|
+
*
|
|
28421
28540
|
* - **ThreadSafety**: Unsafe
|
|
28422
28541
|
*
|
|
28423
28542
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MarketplaceService#BindReceiptHandler)
|
|
28543
|
+
* @param this The service responsible for in-experience transactions.
|
|
28544
|
+
* @param transactionType The `ReceiptType` indicating which kind of receipt to handle.
|
|
28545
|
+
* @param handler A callback function that receives a receipt info dictionary and must return an `ReceiptDecision` value.
|
|
28546
|
+
* @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.
|
|
28547
|
+
* @returns A `RBXScriptConnection` that can be disconnected to unregister the handler.
|
|
28424
28548
|
*/
|
|
28425
28549
|
BindReceiptHandler(this: MarketplaceService, transactionType: CastsToEnum<Enum.ReceiptType>, handler: Callback, filter?: Array<unknown>): RBXScriptConnection;
|
|
28426
28550
|
/**
|
|
@@ -28726,10 +28850,17 @@ interface MarketplaceService extends Instance {
|
|
|
28726
28850
|
*/
|
|
28727
28851
|
PlayerOwnsBundleAsync(this: MarketplaceService, player: Player, bundleId: number): boolean;
|
|
28728
28852
|
/**
|
|
28853
|
+
* Initiates a Robux transfer from the sender to another user.
|
|
28854
|
+
*
|
|
28729
28855
|
* - **ThreadSafety**: Unsafe
|
|
28730
28856
|
* - **Tags**: Yields
|
|
28731
28857
|
*
|
|
28732
28858
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MarketplaceService#PromptRobuxTransferAsync)
|
|
28859
|
+
* @param this The service responsible for in-experience transactions.
|
|
28860
|
+
* @param sender The `Player` initiating the transfer. Must be a valid player currently in the server.
|
|
28861
|
+
* @param receiverUserId The `UserId` of the user who will receive the Robux.
|
|
28862
|
+
* @param amount The amount of Robux to transfer. Must be a positive integer.
|
|
28863
|
+
* @returns A string `transferRequestId` that uniquely identifies this transfer request. Use this ID to correlate with receipts delivered through `BindReceiptHandler`.
|
|
28733
28864
|
*/
|
|
28734
28865
|
PromptRobuxTransferAsync(this: MarketplaceService, sender: Player, receiverUserId: number, amount: number): string;
|
|
28735
28866
|
/**
|
|
@@ -31405,7 +31536,7 @@ interface WedgePart extends FormFactorPart {
|
|
|
31405
31536
|
readonly _nominal_WedgePart: unique symbol;
|
|
31406
31537
|
}
|
|
31407
31538
|
/**
|
|
31408
|
-
* Terrain lets you to create dynamically morphable environments.
|
|
31539
|
+
* `Terrain` lets you to create dynamically morphable environments.
|
|
31409
31540
|
*
|
|
31410
31541
|
* - **Tags**: NotCreatable
|
|
31411
31542
|
*
|
|
@@ -31421,9 +31552,9 @@ interface Terrain extends BasePart {
|
|
|
31421
31552
|
*/
|
|
31422
31553
|
readonly _nominal_Terrain: unique symbol;
|
|
31423
31554
|
/**
|
|
31424
|
-
* **Deprecated:**
|
|
31555
|
+
* **Deprecated:** The legacy terrain engine has been removed, so this property will always be `true`.
|
|
31425
31556
|
*
|
|
31426
|
-
* Returns true if the
|
|
31557
|
+
* Returns `true` if the game is using the smooth terrain system.
|
|
31427
31558
|
*
|
|
31428
31559
|
* - **ThreadSafety**: ReadSafe
|
|
31429
31560
|
* - **Tags**: NotReplicated
|
|
@@ -31443,7 +31574,7 @@ interface Terrain extends BasePart {
|
|
|
31443
31574
|
*/
|
|
31444
31575
|
readonly MaxExtents: Region3int16;
|
|
31445
31576
|
/**
|
|
31446
|
-
* The tint of
|
|
31577
|
+
* The tint of `Terrain` water.
|
|
31447
31578
|
*
|
|
31448
31579
|
* - **ThreadSafety**: ReadSafe
|
|
31449
31580
|
*
|
|
@@ -31451,7 +31582,7 @@ interface Terrain extends BasePart {
|
|
|
31451
31582
|
*/
|
|
31452
31583
|
WaterColor: Color3;
|
|
31453
31584
|
/**
|
|
31454
|
-
* Controls how opaque
|
|
31585
|
+
* Controls how opaque `Terrain` water reflections are.
|
|
31455
31586
|
*
|
|
31456
31587
|
* - **ThreadSafety**: ReadSafe
|
|
31457
31588
|
*
|
|
@@ -31459,7 +31590,7 @@ interface Terrain extends BasePart {
|
|
|
31459
31590
|
*/
|
|
31460
31591
|
WaterReflectance: number;
|
|
31461
31592
|
/**
|
|
31462
|
-
* The transparency of
|
|
31593
|
+
* The transparency of `Terrain` water.
|
|
31463
31594
|
*
|
|
31464
31595
|
* - **ThreadSafety**: ReadSafe
|
|
31465
31596
|
*
|
|
@@ -31467,7 +31598,7 @@ interface Terrain extends BasePart {
|
|
|
31467
31598
|
*/
|
|
31468
31599
|
WaterTransparency: number;
|
|
31469
31600
|
/**
|
|
31470
|
-
* Sets the maximum height of
|
|
31601
|
+
* Sets the maximum height of `Terrain` water waves in studs.
|
|
31471
31602
|
*
|
|
31472
31603
|
* - **ThreadSafety**: ReadSafe
|
|
31473
31604
|
*
|
|
@@ -31475,7 +31606,7 @@ interface Terrain extends BasePart {
|
|
|
31475
31606
|
*/
|
|
31476
31607
|
WaterWaveSize: number;
|
|
31477
31608
|
/**
|
|
31478
|
-
* Sets how many times
|
|
31609
|
+
* Sets how many times `Terrain` water waves will move up and down per minute.
|
|
31479
31610
|
*
|
|
31480
31611
|
* - **ThreadSafety**: ReadSafe
|
|
31481
31612
|
*
|
|
@@ -31485,13 +31616,13 @@ interface Terrain extends BasePart {
|
|
|
31485
31616
|
/**
|
|
31486
31617
|
* **Deprecated:** This item is a deprecated function of a legacy `Terrain` engine that has been removed. Do not use it for new work.
|
|
31487
31618
|
*
|
|
31488
|
-
*
|
|
31619
|
+
* Obsolete function which no longer does anything.
|
|
31489
31620
|
*
|
|
31490
31621
|
* - **ThreadSafety**: Unsafe
|
|
31491
31622
|
* - **Tags**:
|
|
31492
31623
|
*
|
|
31493
31624
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Terrain#AutowedgeCell)
|
|
31494
|
-
* @param this Terrain lets you to create dynamically morphable environments.
|
|
31625
|
+
* @param this `Terrain` lets you to create dynamically morphable environments.
|
|
31495
31626
|
* @param x
|
|
31496
31627
|
* @param y
|
|
31497
31628
|
* @param z
|
|
@@ -31502,49 +31633,49 @@ interface Terrain extends BasePart {
|
|
|
31502
31633
|
/**
|
|
31503
31634
|
* **Deprecated:** This item is a deprecated function of a legacy `Terrain` engine that has been removed. Do not use it for new work.
|
|
31504
31635
|
*
|
|
31505
|
-
*
|
|
31636
|
+
* Obsolete function which no longer does anything.
|
|
31506
31637
|
*
|
|
31507
31638
|
* - **ThreadSafety**: Unsafe
|
|
31508
31639
|
* - **Tags**:
|
|
31509
31640
|
*
|
|
31510
31641
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Terrain#AutowedgeCells)
|
|
31511
|
-
* @param this Terrain lets you to create dynamically morphable environments.
|
|
31642
|
+
* @param this `Terrain` lets you to create dynamically morphable environments.
|
|
31512
31643
|
* @param region
|
|
31513
31644
|
*
|
|
31514
31645
|
* @deprecated
|
|
31515
31646
|
*/
|
|
31516
31647
|
AutowedgeCells(this: Terrain, region: Region3int16): void;
|
|
31517
31648
|
/**
|
|
31518
|
-
* Returns the world position of the center of the terrain cell
|
|
31649
|
+
* Returns the world position of the center of the terrain cell.
|
|
31519
31650
|
*
|
|
31520
31651
|
* - **ThreadSafety**: Unsafe
|
|
31521
31652
|
*
|
|
31522
31653
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Terrain#CellCenterToWorld)
|
|
31523
|
-
* @param this Terrain lets you to create dynamically morphable environments.
|
|
31654
|
+
* @param this `Terrain` lets you to create dynamically morphable environments.
|
|
31524
31655
|
* @param x
|
|
31525
31656
|
* @param y
|
|
31526
31657
|
* @param z
|
|
31527
31658
|
*/
|
|
31528
31659
|
CellCenterToWorld(this: Terrain, x: number, y: number, z: number): Vector3;
|
|
31529
31660
|
/**
|
|
31530
|
-
* Returns the position of the lower-left-forward corner of the grid cell
|
|
31661
|
+
* Returns the position of the lower-left-forward corner of the grid cell.
|
|
31531
31662
|
*
|
|
31532
31663
|
* - **ThreadSafety**: Unsafe
|
|
31533
31664
|
*
|
|
31534
31665
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Terrain#CellCornerToWorld)
|
|
31535
|
-
* @param this Terrain lets you to create dynamically morphable environments.
|
|
31666
|
+
* @param this `Terrain` lets you to create dynamically morphable environments.
|
|
31536
31667
|
* @param x
|
|
31537
31668
|
* @param y
|
|
31538
31669
|
* @param z
|
|
31539
31670
|
*/
|
|
31540
31671
|
CellCornerToWorld(this: Terrain, x: number, y: number, z: number): Vector3;
|
|
31541
31672
|
/**
|
|
31542
|
-
* Clears
|
|
31673
|
+
* Clears all terrain.
|
|
31543
31674
|
*
|
|
31544
31675
|
* - **ThreadSafety**: Unsafe
|
|
31545
31676
|
*
|
|
31546
31677
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Terrain#Clear)
|
|
31547
|
-
* @param this Terrain lets you to create dynamically morphable environments.
|
|
31678
|
+
* @param this `Terrain` lets you to create dynamically morphable environments.
|
|
31548
31679
|
*/
|
|
31549
31680
|
Clear(this: Terrain): void;
|
|
31550
31681
|
/**
|
|
@@ -31552,28 +31683,25 @@ interface Terrain extends BasePart {
|
|
|
31552
31683
|
* - **Tags**: CustomLuaState
|
|
31553
31684
|
*
|
|
31554
31685
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Terrain#ClearVoxelsAsync_beta)
|
|
31555
|
-
* @param this Terrain lets you to create dynamically morphable environments.
|
|
31556
|
-
* @param region
|
|
31557
|
-
* @param channelIds
|
|
31558
31686
|
*/
|
|
31559
31687
|
ClearVoxelsAsync_beta(this: Terrain, region: Region3, channelIds: Array<unknown>): void;
|
|
31560
31688
|
/**
|
|
31561
|
-
* Stores a chunk of terrain into a `TerrainRegion` object so it can be loaded back later.
|
|
31689
|
+
* Stores a chunk of terrain into a `TerrainRegion` object so it can be loaded back later.
|
|
31562
31690
|
*
|
|
31563
31691
|
* - **ThreadSafety**: Unsafe
|
|
31564
31692
|
*
|
|
31565
31693
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Terrain#CopyRegion)
|
|
31566
|
-
* @param this Terrain lets you to create dynamically morphable environments.
|
|
31694
|
+
* @param this `Terrain` lets you to create dynamically morphable environments.
|
|
31567
31695
|
* @param region
|
|
31568
31696
|
*/
|
|
31569
31697
|
CopyRegion(this: Terrain, region: Region3int16): TerrainRegion;
|
|
31570
31698
|
/**
|
|
31571
|
-
* Returns the number of non-empty cells in the
|
|
31699
|
+
* Returns the number of non-empty cells in the terrain.
|
|
31572
31700
|
*
|
|
31573
31701
|
* - **ThreadSafety**: Unsafe
|
|
31574
31702
|
*
|
|
31575
31703
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Terrain#CountCells)
|
|
31576
|
-
* @param this Terrain lets you to create dynamically morphable environments.
|
|
31704
|
+
* @param this `Terrain` lets you to create dynamically morphable environments.
|
|
31577
31705
|
*/
|
|
31578
31706
|
CountCells(this: Terrain): number;
|
|
31579
31707
|
/**
|
|
@@ -31582,7 +31710,7 @@ interface Terrain extends BasePart {
|
|
|
31582
31710
|
* - **ThreadSafety**: Unsafe
|
|
31583
31711
|
*
|
|
31584
31712
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Terrain#FillBall)
|
|
31585
|
-
* @param this Terrain lets you to create dynamically morphable environments.
|
|
31713
|
+
* @param this `Terrain` lets you to create dynamically morphable environments.
|
|
31586
31714
|
* @param center The position of the center of the terrain ball.
|
|
31587
31715
|
* @param radius The radius in studs of the terrain ball.
|
|
31588
31716
|
* @param material The `Material` of the terrain ball.
|
|
@@ -31594,9 +31722,9 @@ interface Terrain extends BasePart {
|
|
|
31594
31722
|
* - **ThreadSafety**: Unsafe
|
|
31595
31723
|
*
|
|
31596
31724
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Terrain#FillBlock)
|
|
31597
|
-
* @param this Terrain lets you to create dynamically morphable environments.
|
|
31725
|
+
* @param this `Terrain` lets you to create dynamically morphable environments.
|
|
31598
31726
|
* @param cframe The position and orientation of the terrain block.
|
|
31599
|
-
* @param size The size in studs of the square block
|
|
31727
|
+
* @param size The size in studs of the square block (both the height and width).
|
|
31600
31728
|
* @param material The `Material` of the terrain block.
|
|
31601
31729
|
*/
|
|
31602
31730
|
FillBlock(this: Terrain, cframe: CFrame, size: Vector3, material: CastsToEnum<Enum.Material>): void;
|
|
@@ -31606,7 +31734,7 @@ interface Terrain extends BasePart {
|
|
|
31606
31734
|
* - **ThreadSafety**: Unsafe
|
|
31607
31735
|
*
|
|
31608
31736
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Terrain#FillCylinder)
|
|
31609
|
-
* @param this Terrain lets you to create dynamically morphable environments.
|
|
31737
|
+
* @param this `Terrain` lets you to create dynamically morphable environments.
|
|
31610
31738
|
* @param cframe The position and orientation of the terrain cylinder.
|
|
31611
31739
|
* @param height The height in studs of the terrain cylinder.
|
|
31612
31740
|
* @param radius The radius in studs of the terrain cylinder.
|
|
@@ -31619,19 +31747,19 @@ interface Terrain extends BasePart {
|
|
|
31619
31747
|
* - **ThreadSafety**: Unsafe
|
|
31620
31748
|
*
|
|
31621
31749
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Terrain#FillRegion)
|
|
31622
|
-
* @param this Terrain lets you to create dynamically morphable environments.
|
|
31750
|
+
* @param this `Terrain` lets you to create dynamically morphable environments.
|
|
31623
31751
|
* @param region
|
|
31624
31752
|
* @param resolution
|
|
31625
31753
|
* @param material
|
|
31626
31754
|
*/
|
|
31627
31755
|
FillRegion(this: Terrain, region: Region3, resolution: number, material: CastsToEnum<Enum.Material>): void;
|
|
31628
31756
|
/**
|
|
31629
|
-
* Fills a wedge-shaped volume of
|
|
31757
|
+
* Fills a wedge-shaped volume of terrain with the given `Material`.
|
|
31630
31758
|
*
|
|
31631
31759
|
* - **ThreadSafety**: Unsafe
|
|
31632
31760
|
*
|
|
31633
31761
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Terrain#FillWedge)
|
|
31634
|
-
* @param this Terrain lets you to create dynamically morphable environments.
|
|
31762
|
+
* @param this `Terrain` lets you to create dynamically morphable environments.
|
|
31635
31763
|
* @param cframe The position and orientation of the wedge to fill.
|
|
31636
31764
|
* @param size The size of the wedge to fill.
|
|
31637
31765
|
* @param material The material with which the wedge will be filled.
|
|
@@ -31646,13 +31774,13 @@ interface Terrain extends BasePart {
|
|
|
31646
31774
|
/**
|
|
31647
31775
|
* **Deprecated:** This item is a deprecated function of a legacy `Terrain` engine that has been removed. Do not use it for new work.
|
|
31648
31776
|
*
|
|
31649
|
-
* Returns the closest
|
|
31777
|
+
* Returns the closest cell material from the legacy terrain engine that matches the smooth terrain voxel specified.
|
|
31650
31778
|
*
|
|
31651
31779
|
* - **ThreadSafety**: Unsafe
|
|
31652
31780
|
* - **Tags**:
|
|
31653
31781
|
*
|
|
31654
31782
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Terrain#GetCell)
|
|
31655
|
-
* @param this Terrain lets you to create dynamically morphable environments.
|
|
31783
|
+
* @param this `Terrain` lets you to create dynamically morphable environments.
|
|
31656
31784
|
* @param x
|
|
31657
31785
|
* @param y
|
|
31658
31786
|
* @param z
|
|
@@ -31672,7 +31800,7 @@ interface Terrain extends BasePart {
|
|
|
31672
31800
|
* - **ThreadSafety**: Safe
|
|
31673
31801
|
*
|
|
31674
31802
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Terrain#GetMaterialColor)
|
|
31675
|
-
* @param this Terrain lets you to create dynamically morphable environments.
|
|
31803
|
+
* @param this `Terrain` lets you to create dynamically morphable environments.
|
|
31676
31804
|
* @param material
|
|
31677
31805
|
*/
|
|
31678
31806
|
GetMaterialColor(this: Terrain, material: CastsToEnum<Enum.Material>): Color3;
|
|
@@ -31685,13 +31813,13 @@ interface Terrain extends BasePart {
|
|
|
31685
31813
|
/**
|
|
31686
31814
|
* **Deprecated:** This item is a deprecated function of a legacy `Terrain` engine that has been removed. Do not use it for new work.
|
|
31687
31815
|
*
|
|
31688
|
-
* Returns if the cell is a water cell.
|
|
31816
|
+
* Returns `true` if the cell is a water cell.
|
|
31689
31817
|
*
|
|
31690
31818
|
* - **ThreadSafety**: Unsafe
|
|
31691
31819
|
* - **Tags**:
|
|
31692
31820
|
*
|
|
31693
31821
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Terrain#GetWaterCell)
|
|
31694
|
-
* @param this Terrain lets you to create dynamically morphable environments.
|
|
31822
|
+
* @param this `Terrain` lets you to create dynamically morphable environments.
|
|
31695
31823
|
* @param x
|
|
31696
31824
|
* @param y
|
|
31697
31825
|
* @param z
|
|
@@ -31704,10 +31832,6 @@ interface Terrain extends BasePart {
|
|
|
31704
31832
|
* - **Tags**: CustomLuaState
|
|
31705
31833
|
*
|
|
31706
31834
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Terrain#IterateVoxelsAsync_beta)
|
|
31707
|
-
* @param this Terrain lets you to create dynamically morphable environments.
|
|
31708
|
-
* @param region
|
|
31709
|
-
* @param resolution
|
|
31710
|
-
* @param channelIds
|
|
31711
31835
|
*/
|
|
31712
31836
|
IterateVoxelsAsync_beta(this: Terrain, region: Region3, resolution: number, channelIds: Array<unknown>): TerrainIterateOperation;
|
|
31713
31837
|
/**
|
|
@@ -31715,19 +31839,15 @@ interface Terrain extends BasePart {
|
|
|
31715
31839
|
* - **Tags**: CustomLuaState
|
|
31716
31840
|
*
|
|
31717
31841
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Terrain#ModifyVoxelsAsync_beta)
|
|
31718
|
-
* @param this Terrain lets you to create dynamically morphable environments.
|
|
31719
|
-
* @param region
|
|
31720
|
-
* @param resolution
|
|
31721
|
-
* @param channelIds
|
|
31722
31842
|
*/
|
|
31723
31843
|
ModifyVoxelsAsync_beta(this: Terrain, region: Region3, resolution: number, channelIds: Array<unknown>): TerrainModifyOperation;
|
|
31724
31844
|
/**
|
|
31725
|
-
* Applies a chunk of terrain to the Terrain object.
|
|
31845
|
+
* Applies a chunk of terrain to the `Terrain` object.
|
|
31726
31846
|
*
|
|
31727
31847
|
* - **ThreadSafety**: Unsafe
|
|
31728
31848
|
*
|
|
31729
31849
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Terrain#PasteRegion)
|
|
31730
|
-
* @param this Terrain lets you to create dynamically morphable environments.
|
|
31850
|
+
* @param this `Terrain` lets you to create dynamically morphable environments.
|
|
31731
31851
|
* @param region
|
|
31732
31852
|
* @param corner
|
|
31733
31853
|
* @param pasteEmptyCells
|
|
@@ -31740,7 +31860,7 @@ interface Terrain extends BasePart {
|
|
|
31740
31860
|
* - **Tags**: CustomLuaState
|
|
31741
31861
|
*
|
|
31742
31862
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Terrain#ReadVoxelChannels)
|
|
31743
|
-
* @param this Terrain lets you to create dynamically morphable environments.
|
|
31863
|
+
* @param this `Terrain` lets you to create dynamically morphable environments.
|
|
31744
31864
|
* @param region Target region to read from. Must be aligned to the voxel grid. Will throw an error if region is too large; limit is currently 4194304 voxels³.
|
|
31745
31865
|
* @param resolution Voxel resolution. Must be 4.
|
|
31746
31866
|
* @param channelIds Array of channel IDs (strings) that need to be accessed from the voxel data. Each channel ID represents a type of data that's stored in voxel. Current supported IDs are `{"SolidMaterial", "SolidOccupancy", "LiquidOccupancy"}`.
|
|
@@ -31758,9 +31878,9 @@ interface Terrain extends BasePart {
|
|
|
31758
31878
|
* - **Tags**: CustomLuaState
|
|
31759
31879
|
*
|
|
31760
31880
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Terrain#ReadVoxels)
|
|
31761
|
-
* @param this Terrain lets you to create dynamically morphable environments.
|
|
31762
|
-
* @param region Target region to read from. Must be aligned to the voxel grid. Will throw an error if region is too large. The limit is currently 4194304 voxels
|
|
31763
|
-
* @param resolution Voxel resolution. Must be 4
|
|
31881
|
+
* @param this `Terrain` lets you to create dynamically morphable environments.
|
|
31882
|
+
* @param region Target region to read from. Must be aligned to the voxel grid. Will throw an error if region is too large. The limit is currently 4194304 voxels³.
|
|
31883
|
+
* @param resolution Voxel resolution. Must be `4`.
|
|
31764
31884
|
* @returns Returns raw voxel data as two 3D arrays. - `materials` - 3D array of `Material` from the target area. Also contains a Size field, equal to the dimensions of the nested arrays.
|
|
31765
31885
|
* - `occupancies` - 3D array of occupancy values from the target area. Also contains a Size field, equal to the dimensions of the nested arrays.
|
|
31766
31886
|
*/
|
|
@@ -31773,10 +31893,6 @@ interface Terrain extends BasePart {
|
|
|
31773
31893
|
* - **Tags**: CustomLuaState
|
|
31774
31894
|
*
|
|
31775
31895
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Terrain#ReadVoxelsAsync_beta)
|
|
31776
|
-
* @param this Terrain lets you to create dynamically morphable environments.
|
|
31777
|
-
* @param region
|
|
31778
|
-
* @param resolution
|
|
31779
|
-
* @param channelIds
|
|
31780
31896
|
*/
|
|
31781
31897
|
ReadVoxelsAsync_beta(this: Terrain, region: Region3, resolution: number, channelIds: Array<unknown>): TerrainReadOperation;
|
|
31782
31898
|
/**
|
|
@@ -31785,9 +31901,9 @@ interface Terrain extends BasePart {
|
|
|
31785
31901
|
* - **ThreadSafety**: Unsafe
|
|
31786
31902
|
*
|
|
31787
31903
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Terrain#ReplaceMaterial)
|
|
31788
|
-
* @param this Terrain lets you to create dynamically morphable environments.
|
|
31904
|
+
* @param this `Terrain` lets you to create dynamically morphable environments.
|
|
31789
31905
|
* @param region The region in which the replacement operation will occur.
|
|
31790
|
-
* @param resolution The resolution at which the replacement operation will take place; at the moment this must be exactly 4
|
|
31906
|
+
* @param resolution The resolution at which the replacement operation will take place; at the moment this must be exactly `4`.
|
|
31791
31907
|
* @param sourceMaterial The old material that shall be replaced.
|
|
31792
31908
|
* @param targetMaterial The new material.
|
|
31793
31909
|
*/
|
|
@@ -31807,7 +31923,7 @@ interface Terrain extends BasePart {
|
|
|
31807
31923
|
* - **Tags**:
|
|
31808
31924
|
*
|
|
31809
31925
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Terrain#SetCell)
|
|
31810
|
-
* @param this Terrain lets you to create dynamically morphable environments.
|
|
31926
|
+
* @param this `Terrain` lets you to create dynamically morphable environments.
|
|
31811
31927
|
* @param x
|
|
31812
31928
|
* @param y
|
|
31813
31929
|
* @param z
|
|
@@ -31827,7 +31943,7 @@ interface Terrain extends BasePart {
|
|
|
31827
31943
|
* - **Tags**:
|
|
31828
31944
|
*
|
|
31829
31945
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Terrain#SetCells)
|
|
31830
|
-
* @param this Terrain lets you to create dynamically morphable environments.
|
|
31946
|
+
* @param this `Terrain` lets you to create dynamically morphable environments.
|
|
31831
31947
|
* @param region
|
|
31832
31948
|
* @param material
|
|
31833
31949
|
* @param block
|
|
@@ -31842,7 +31958,7 @@ interface Terrain extends BasePart {
|
|
|
31842
31958
|
* - **ThreadSafety**: Unsafe
|
|
31843
31959
|
*
|
|
31844
31960
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Terrain#SetMaterialColor)
|
|
31845
|
-
* @param this Terrain lets you to create dynamically morphable environments.
|
|
31961
|
+
* @param this `Terrain` lets you to create dynamically morphable environments.
|
|
31846
31962
|
* @param material
|
|
31847
31963
|
* @param value
|
|
31848
31964
|
*/
|
|
@@ -31856,13 +31972,13 @@ interface Terrain extends BasePart {
|
|
|
31856
31972
|
/**
|
|
31857
31973
|
* **Deprecated:** This item is a deprecated function of a legacy `Terrain` engine that has been removed. Do not use it for new work.
|
|
31858
31974
|
*
|
|
31859
|
-
* Sets the specified terrain voxel's material to
|
|
31975
|
+
* Sets the specified terrain voxel's material to water and sets its occupancy to `1`.
|
|
31860
31976
|
*
|
|
31861
31977
|
* - **ThreadSafety**: Unsafe
|
|
31862
31978
|
* - **Tags**:
|
|
31863
31979
|
*
|
|
31864
31980
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Terrain#SetWaterCell)
|
|
31865
|
-
* @param this Terrain lets you to create dynamically morphable environments.
|
|
31981
|
+
* @param this `Terrain` lets you to create dynamically morphable environments.
|
|
31866
31982
|
* @param x
|
|
31867
31983
|
* @param y
|
|
31868
31984
|
* @param z
|
|
@@ -31873,22 +31989,22 @@ interface Terrain extends BasePart {
|
|
|
31873
31989
|
*/
|
|
31874
31990
|
SetWaterCell(this: Terrain, x: number, y: number, z: number, force: CastsToEnum<Enum.WaterForce>, direction: CastsToEnum<Enum.WaterDirection>): void;
|
|
31875
31991
|
/**
|
|
31876
|
-
* Returns the grid cell location that contains the point
|
|
31992
|
+
* Returns the grid cell location that contains the position point.
|
|
31877
31993
|
*
|
|
31878
31994
|
* - **ThreadSafety**: Unsafe
|
|
31879
31995
|
*
|
|
31880
31996
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Terrain#WorldToCell)
|
|
31881
|
-
* @param this Terrain lets you to create dynamically morphable environments.
|
|
31997
|
+
* @param this `Terrain` lets you to create dynamically morphable environments.
|
|
31882
31998
|
* @param position
|
|
31883
31999
|
*/
|
|
31884
32000
|
WorldToCell(this: Terrain, position: Vector3): Vector3;
|
|
31885
32001
|
/**
|
|
31886
|
-
* Returns the grid cell location that contains the point
|
|
32002
|
+
* Returns the grid cell location that contains the position point, preferring empty grid cells when position is on a grid edge.
|
|
31887
32003
|
*
|
|
31888
32004
|
* - **ThreadSafety**: Unsafe
|
|
31889
32005
|
*
|
|
31890
32006
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Terrain#WorldToCellPreferEmpty)
|
|
31891
|
-
* @param this Terrain lets you to create dynamically morphable environments.
|
|
32007
|
+
* @param this `Terrain` lets you to create dynamically morphable environments.
|
|
31892
32008
|
* @param position
|
|
31893
32009
|
*/
|
|
31894
32010
|
WorldToCellPreferEmpty(this: Terrain, position: Vector3): Vector3;
|
|
@@ -31898,7 +32014,7 @@ interface Terrain extends BasePart {
|
|
|
31898
32014
|
* - **ThreadSafety**: Unsafe
|
|
31899
32015
|
*
|
|
31900
32016
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Terrain#WorldToCellPreferSolid)
|
|
31901
|
-
* @param this Terrain lets you to create dynamically morphable environments.
|
|
32017
|
+
* @param this `Terrain` lets you to create dynamically morphable environments.
|
|
31902
32018
|
* @param position
|
|
31903
32019
|
*/
|
|
31904
32020
|
WorldToCellPreferSolid(this: Terrain, position: Vector3): Vector3;
|
|
@@ -31909,12 +32025,12 @@ interface Terrain extends BasePart {
|
|
|
31909
32025
|
* - **Tags**: CustomLuaState
|
|
31910
32026
|
*
|
|
31911
32027
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Terrain#WriteVoxelChannels)
|
|
31912
|
-
* @param this Terrain lets you to create dynamically morphable environments.
|
|
32028
|
+
* @param this `Terrain` lets you to create dynamically morphable environments.
|
|
31913
32029
|
* @param region Target region to write to. Must be aligned to the voxel grid. Will throw an error if region is too large; limit is currently 4194304 voxels³.
|
|
31914
|
-
* @param resolution Voxel resolution. Must be 4
|
|
31915
|
-
* @param channels Dictionary of voxel data similar to the return value of `ReadVoxelChannels()`. Keys represent each channel ID with their respective value as an array of 3D data. The dictionary can support single or multiple channel inputs. - `SolidMaterial` — The `Material` material of the voxel. Note that `Water` is not supported anymore; instead, a voxel that contains only water should be entered as `SolidMaterial = Enum.Material.Air, LiquidOccupancy = x`, where `x` is a number between 0 (exclusive) and 1 (inclusive).
|
|
31916
|
-
* - `SolidOccupancy` — The occupancy of the voxel's material as specified in the `SolidMaterial` channel. This should be a value between 0 (empty) and 1 (full).
|
|
31917
|
-
* - `LiquidOccupancy` — Specifies the occupancy of the `Water` material in a voxel as a value between 0 (no water) and 1 (full of water). If the `SolidOccupancy` is 1 and the `SolidMaterial` is not `Air`, this will be 0
|
|
32030
|
+
* @param resolution Voxel resolution. Must be `4`.
|
|
32031
|
+
* @param channels Dictionary of voxel data similar to the return value of `ReadVoxelChannels()`. Keys represent each channel ID with their respective value as an array of 3D data. The dictionary can support single or multiple channel inputs. - `SolidMaterial` — The `Material` material of the voxel. Note that `Water` is not supported anymore; instead, a voxel that contains only water should be entered as `SolidMaterial = Enum.Material.Air, LiquidOccupancy = x`, where `x` is a number between `0` (exclusive) and `1` (inclusive).
|
|
32032
|
+
* - `SolidOccupancy` — The occupancy of the voxel's material as specified in the `SolidMaterial` channel. This should be a value between `0` (empty) and `1` (full).
|
|
32033
|
+
* - `LiquidOccupancy` — Specifies the occupancy of the `Water` material in a voxel as a value between `0` (no water) and `1` (full of water). If the `SolidOccupancy` is 1 and the `SolidMaterial` is not `Air`, this will be `0`.
|
|
31918
32034
|
*/
|
|
31919
32035
|
WriteVoxelChannels(this: Terrain, region: Region3, resolution: number, channels: VoxelChannels): void;
|
|
31920
32036
|
/**
|
|
@@ -31924,11 +32040,11 @@ interface Terrain extends BasePart {
|
|
|
31924
32040
|
* - **Tags**: CustomLuaState
|
|
31925
32041
|
*
|
|
31926
32042
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Terrain#WriteVoxels)
|
|
31927
|
-
* @param this Terrain lets you to create dynamically morphable environments.
|
|
32043
|
+
* @param this `Terrain` lets you to create dynamically morphable environments.
|
|
31928
32044
|
* @param region Target region to write to. Must be aligned to the voxel grid. Will throw an error if region is too large.
|
|
31929
|
-
* @param resolution Voxel resolution. Must be 4
|
|
31930
|
-
* @param materials 3D array of
|
|
31931
|
-
* @param occupancy 3D array of voxel occupancies (number between 0 and 1). Dimensions must exactly match the size of the target region in voxels.
|
|
32045
|
+
* @param resolution Voxel resolution. Must be `4`.
|
|
32046
|
+
* @param materials 3D array of `Material`. Dimensions must exactly match the size of the target region in voxels.
|
|
32047
|
+
* @param occupancy 3D array of voxel occupancies (number between `0` and `1`). Dimensions must exactly match the size of the target region in voxels.
|
|
31932
32048
|
*/
|
|
31933
32049
|
WriteVoxels(this: Terrain, region: Region3, resolution: number, materials: Array<Array<Array<CastsToEnum<Enum.Material>>>>, occupancy: Array<Array<Array<number>>>): void;
|
|
31934
32050
|
/**
|
|
@@ -31936,10 +32052,6 @@ interface Terrain extends BasePart {
|
|
|
31936
32052
|
* - **Tags**: CustomLuaState
|
|
31937
32053
|
*
|
|
31938
32054
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Terrain#WriteVoxelsAsync_beta)
|
|
31939
|
-
* @param this Terrain lets you to create dynamically morphable environments.
|
|
31940
|
-
* @param region
|
|
31941
|
-
* @param resolution
|
|
31942
|
-
* @param channelIds
|
|
31943
32055
|
*/
|
|
31944
32056
|
WriteVoxelsAsync_beta(this: Terrain, region: Region3, resolution: number, channelIds: Array<unknown>): TerrainWriteOperation;
|
|
31945
32057
|
}
|
|
@@ -34586,7 +34698,7 @@ interface Path extends Instance {
|
|
|
34586
34698
|
*/
|
|
34587
34699
|
readonly _nominal_Path: unique symbol;
|
|
34588
34700
|
/**
|
|
34589
|
-
* The
|
|
34701
|
+
* The `PathStatus` of the generated `Path`.
|
|
34590
34702
|
*
|
|
34591
34703
|
* - **ThreadSafety**: ReadSafe
|
|
34592
34704
|
* - **Tags**: NotReplicated
|
|
@@ -34595,7 +34707,7 @@ interface Path extends Instance {
|
|
|
34595
34707
|
*/
|
|
34596
34708
|
readonly Status: Enum.PathStatus;
|
|
34597
34709
|
/**
|
|
34598
|
-
* **Deprecated:** This item has been superseded by `
|
|
34710
|
+
* **Deprecated:** This item has been superseded by `GetWaypoints()` which should be used in all new work instead.
|
|
34599
34711
|
*
|
|
34600
34712
|
* Returns a table of `Path` instances.
|
|
34601
34713
|
*
|
|
@@ -34697,7 +34809,7 @@ interface PathfindingLink extends Instance {
|
|
|
34697
34809
|
*/
|
|
34698
34810
|
IsBidirectional: boolean;
|
|
34699
34811
|
/**
|
|
34700
|
-
* A classifying string to add additional information about the link.
|
|
34812
|
+
* A classifying string to add additional information about the link.
|
|
34701
34813
|
*
|
|
34702
34814
|
* - **ThreadSafety**: ReadSafe
|
|
34703
34815
|
*
|
|
@@ -34706,7 +34818,7 @@ interface PathfindingLink extends Instance {
|
|
|
34706
34818
|
Label: string;
|
|
34707
34819
|
}
|
|
34708
34820
|
/**
|
|
34709
|
-
* Modifiers used to represent space that has a higher or lower cost to be traversed when creating paths using
|
|
34821
|
+
* Modifiers used to represent space that has a higher or lower cost to be traversed when creating paths using `PathfindingService`.
|
|
34710
34822
|
*
|
|
34711
34823
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PathfindingModifier)
|
|
34712
34824
|
*/
|
|
@@ -34720,7 +34832,7 @@ interface PathfindingModifier extends Instance {
|
|
|
34720
34832
|
*/
|
|
34721
34833
|
readonly _nominal_PathfindingModifier: unique symbol;
|
|
34722
34834
|
/**
|
|
34723
|
-
* The name of the navigation area inside or on top of the
|
|
34835
|
+
* The name of the navigation area inside or on top of the parts enclosed by the modifier.
|
|
34724
34836
|
*
|
|
34725
34837
|
* - **ThreadSafety**: ReadSafe
|
|
34726
34838
|
*
|
|
@@ -34770,7 +34882,7 @@ interface PathfindingService extends Instance {
|
|
|
34770
34882
|
*
|
|
34771
34883
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PathfindingService#CreatePath)
|
|
34772
34884
|
* @param this Used to find logical paths between two points.
|
|
34773
|
-
* @param agentParameters
|
|
34885
|
+
* @param agentParameters Lua table which lets you fine-tune the path based on various agent parameters.
|
|
34774
34886
|
* @returns A `Path` object.
|
|
34775
34887
|
*/
|
|
34776
34888
|
CreatePath(this: PathfindingService, agentParameters?: AgentParameters): Path;
|
|
@@ -35489,6 +35601,12 @@ interface Player extends Instance {
|
|
|
35489
35601
|
* @param part The `BasePart` to use as a new replication focus.
|
|
35490
35602
|
*/
|
|
35491
35603
|
AddReplicationFocus(this: Player, part: BasePart): void;
|
|
35604
|
+
/**
|
|
35605
|
+
* - **ThreadSafety**: Unsafe
|
|
35606
|
+
*
|
|
35607
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#ClearCachedAvatarAppearance)
|
|
35608
|
+
*/
|
|
35609
|
+
ClearCachedAvatarAppearance(this: Player): void;
|
|
35492
35610
|
/**
|
|
35493
35611
|
* Removes all accessories and other character appearance objects from a player's `Character`.
|
|
35494
35612
|
*
|
|
@@ -36285,7 +36403,7 @@ interface PlayerHydrationService extends Instance {
|
|
|
36285
36403
|
readonly _nominal_PlayerHydrationService: unique symbol;
|
|
36286
36404
|
}
|
|
36287
36405
|
/**
|
|
36288
|
-
* A container for
|
|
36406
|
+
* A container for client-side scripts to be run inside `Player` objects within the `Players` service.
|
|
36289
36407
|
*
|
|
36290
36408
|
* - **Tags**: NotCreatable, NotReplicated
|
|
36291
36409
|
*
|
|
@@ -36301,39 +36419,39 @@ interface PlayerScripts extends Instance {
|
|
|
36301
36419
|
*/
|
|
36302
36420
|
readonly _nominal_PlayerScripts: unique symbol;
|
|
36303
36421
|
/**
|
|
36304
|
-
* Unregisters all ComputerCameraMovementMode enums from the
|
|
36422
|
+
* Unregisters all `ComputerCameraMovementMode` enums from the game's settings menu.
|
|
36305
36423
|
*
|
|
36306
36424
|
* - **ThreadSafety**: Unsafe
|
|
36307
36425
|
*
|
|
36308
36426
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PlayerScripts#ClearComputerCameraMovementModes)
|
|
36309
|
-
* @param this A container for
|
|
36427
|
+
* @param this A container for client-side scripts to be run inside `Player` objects within the `Players` service.
|
|
36310
36428
|
*/
|
|
36311
36429
|
ClearComputerCameraMovementModes(this: PlayerScripts): void;
|
|
36312
36430
|
/**
|
|
36313
|
-
* Unregisters all ComputerMovementMode enums from the
|
|
36431
|
+
* Unregisters all `ComputerMovementMode` enums from the game's settings menu.
|
|
36314
36432
|
*
|
|
36315
36433
|
* - **ThreadSafety**: Unsafe
|
|
36316
36434
|
*
|
|
36317
36435
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PlayerScripts#ClearComputerMovementModes)
|
|
36318
|
-
* @param this A container for
|
|
36436
|
+
* @param this A container for client-side scripts to be run inside `Player` objects within the `Players` service.
|
|
36319
36437
|
*/
|
|
36320
36438
|
ClearComputerMovementModes(this: PlayerScripts): void;
|
|
36321
36439
|
/**
|
|
36322
|
-
* Unregisters all TouchCameraMovementMode enums from the
|
|
36440
|
+
* Unregisters all `TouchCameraMovementMode` enums from the game's settings menu.
|
|
36323
36441
|
*
|
|
36324
36442
|
* - **ThreadSafety**: Unsafe
|
|
36325
36443
|
*
|
|
36326
36444
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PlayerScripts#ClearTouchCameraMovementModes)
|
|
36327
|
-
* @param this A container for
|
|
36445
|
+
* @param this A container for client-side scripts to be run inside `Player` objects within the `Players` service.
|
|
36328
36446
|
*/
|
|
36329
36447
|
ClearTouchCameraMovementModes(this: PlayerScripts): void;
|
|
36330
36448
|
/**
|
|
36331
|
-
* Unregisters all TouchMovementMode enums from the
|
|
36449
|
+
* Unregisters all `TouchMovementMode` enums from the game's settings menu.
|
|
36332
36450
|
*
|
|
36333
36451
|
* - **ThreadSafety**: Unsafe
|
|
36334
36452
|
*
|
|
36335
36453
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PlayerScripts#ClearTouchMovementModes)
|
|
36336
|
-
* @param this A container for
|
|
36454
|
+
* @param this A container for client-side scripts to be run inside `Player` objects within the `Players` service.
|
|
36337
36455
|
*/
|
|
36338
36456
|
ClearTouchMovementModes(this: PlayerScripts): void;
|
|
36339
36457
|
/**
|
|
@@ -36342,7 +36460,7 @@ interface PlayerScripts extends Instance {
|
|
|
36342
36460
|
* - **ThreadSafety**: Unsafe
|
|
36343
36461
|
*
|
|
36344
36462
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PlayerScripts#RegisterComputerCameraMovementMode)
|
|
36345
|
-
* @param this A container for
|
|
36463
|
+
* @param this A container for client-side scripts to be run inside `Player` objects within the `Players` service.
|
|
36346
36464
|
* @param cameraMovementMode
|
|
36347
36465
|
*/
|
|
36348
36466
|
RegisterComputerCameraMovementMode(this: PlayerScripts, cameraMovementMode: CastsToEnum<Enum.ComputerCameraMovementMode>): void;
|
|
@@ -36352,7 +36470,7 @@ interface PlayerScripts extends Instance {
|
|
|
36352
36470
|
* - **ThreadSafety**: Unsafe
|
|
36353
36471
|
*
|
|
36354
36472
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PlayerScripts#RegisterComputerMovementMode)
|
|
36355
|
-
* @param this A container for
|
|
36473
|
+
* @param this A container for client-side scripts to be run inside `Player` objects within the `Players` service.
|
|
36356
36474
|
* @param movementMode
|
|
36357
36475
|
*/
|
|
36358
36476
|
RegisterComputerMovementMode(this: PlayerScripts, movementMode: CastsToEnum<Enum.ComputerMovementMode>): void;
|
|
@@ -36362,7 +36480,7 @@ interface PlayerScripts extends Instance {
|
|
|
36362
36480
|
* - **ThreadSafety**: Unsafe
|
|
36363
36481
|
*
|
|
36364
36482
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PlayerScripts#RegisterTouchCameraMovementMode)
|
|
36365
|
-
* @param this A container for
|
|
36483
|
+
* @param this A container for client-side scripts to be run inside `Player` objects within the `Players` service.
|
|
36366
36484
|
* @param cameraMovementMode
|
|
36367
36485
|
*/
|
|
36368
36486
|
RegisterTouchCameraMovementMode(this: PlayerScripts, cameraMovementMode: CastsToEnum<Enum.TouchCameraMovementMode>): void;
|
|
@@ -36372,7 +36490,7 @@ interface PlayerScripts extends Instance {
|
|
|
36372
36490
|
* - **ThreadSafety**: Unsafe
|
|
36373
36491
|
*
|
|
36374
36492
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PlayerScripts#RegisterTouchMovementMode)
|
|
36375
|
-
* @param this A container for
|
|
36493
|
+
* @param this A container for client-side scripts to be run inside `Player` objects within the `Players` service.
|
|
36376
36494
|
* @param movementMode
|
|
36377
36495
|
*/
|
|
36378
36496
|
RegisterTouchMovementMode(this: PlayerScripts, movementMode: CastsToEnum<Enum.TouchMovementMode>): void;
|
|
@@ -36543,7 +36661,7 @@ interface Players extends Instance {
|
|
|
36543
36661
|
*/
|
|
36544
36662
|
BanAsync(this: Players, config: BanAsyncConfig): void;
|
|
36545
36663
|
/**
|
|
36546
|
-
* **Deprecated:** This method has been superseded by `
|
|
36664
|
+
* **Deprecated:** This method has been superseded by `CreateHumanoidModelFromDescriptionAsync()`.
|
|
36547
36665
|
*
|
|
36548
36666
|
* Returns a character `Model` equipped with everything specified in the passed in `HumanoidDescription`.
|
|
36549
36667
|
*
|
|
@@ -37827,6 +37945,12 @@ interface RecommendationService extends Instance {
|
|
|
37827
37945
|
* - **ThreadSafety**: Unsafe
|
|
37828
37946
|
*
|
|
37829
37947
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RecommendationService#LogPreferenceEvent)
|
|
37948
|
+
* @param this A service that provides an interface for you to manage and display personalized content recommendations.
|
|
37949
|
+
* @param preferenceType
|
|
37950
|
+
* @param targetType
|
|
37951
|
+
* @param targetId
|
|
37952
|
+
* @param tracingId
|
|
37953
|
+
* @param itemId
|
|
37830
37954
|
*/
|
|
37831
37955
|
LogPreferenceEvent(this: RecommendationService, preferenceType: CastsToEnum<Enum.RecommendationPreferenceType>, targetType: CastsToEnum<Enum.RecommendationPreferenceTargetType>, targetId: string, tracingId?: string, itemId?: string): void;
|
|
37832
37956
|
/**
|
|
@@ -38685,6 +38809,8 @@ interface SceneAnalysisService extends Instance {
|
|
|
38685
38809
|
* - **Tags**: Yields
|
|
38686
38810
|
*
|
|
38687
38811
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SceneAnalysisService#GetAnimationMemoryAsync)
|
|
38812
|
+
* @param this
|
|
38813
|
+
* @returns A dictionary tree of loaded animation clip memory, deduplicated by clip.
|
|
38688
38814
|
*/
|
|
38689
38815
|
GetAnimationMemoryAsync(this: SceneAnalysisService): object;
|
|
38690
38816
|
/**
|
|
@@ -38692,6 +38818,8 @@ interface SceneAnalysisService extends Instance {
|
|
|
38692
38818
|
* - **Tags**: Yields
|
|
38693
38819
|
*
|
|
38694
38820
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SceneAnalysisService#GetAudioMemoryAsync)
|
|
38821
|
+
* @param this
|
|
38822
|
+
* @returns A dictionary tree of loaded audio asset memory, deduplicated by asset ID.
|
|
38695
38823
|
*/
|
|
38696
38824
|
GetAudioMemoryAsync(this: SceneAnalysisService): object;
|
|
38697
38825
|
/**
|
|
@@ -38699,6 +38827,8 @@ interface SceneAnalysisService extends Instance {
|
|
|
38699
38827
|
* - **Tags**: Yields
|
|
38700
38828
|
*
|
|
38701
38829
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SceneAnalysisService#GetInstanceCompositionAsync)
|
|
38830
|
+
* @param this
|
|
38831
|
+
* @returns A dictionary tree of instance counts grouped by category and class name.
|
|
38702
38832
|
*/
|
|
38703
38833
|
GetInstanceCompositionAsync(this: SceneAnalysisService): object;
|
|
38704
38834
|
/**
|
|
@@ -38706,6 +38836,8 @@ interface SceneAnalysisService extends Instance {
|
|
|
38706
38836
|
* - **Tags**: Yields
|
|
38707
38837
|
*
|
|
38708
38838
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SceneAnalysisService#GetScriptMemoryAsync)
|
|
38839
|
+
* @param this
|
|
38840
|
+
* @returns A dictionary tree of per-script Luau VM heap memory grouped by service and script type.
|
|
38709
38841
|
*/
|
|
38710
38842
|
GetScriptMemoryAsync(this: SceneAnalysisService): object;
|
|
38711
38843
|
/**
|
|
@@ -38713,6 +38845,8 @@ interface SceneAnalysisService extends Instance {
|
|
|
38713
38845
|
* - **Tags**: Yields
|
|
38714
38846
|
*
|
|
38715
38847
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SceneAnalysisService#GetTriangleCompositionAsync)
|
|
38848
|
+
* @param this
|
|
38849
|
+
* @returns A dictionary tree of triangle and draw call counts broken down by render pass type.
|
|
38716
38850
|
*/
|
|
38717
38851
|
GetTriangleCompositionAsync(this: SceneAnalysisService): object;
|
|
38718
38852
|
/**
|
|
@@ -38720,6 +38854,8 @@ interface SceneAnalysisService extends Instance {
|
|
|
38720
38854
|
* - **Tags**: Yields
|
|
38721
38855
|
*
|
|
38722
38856
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SceneAnalysisService#GetUnparentedInstancesAsync)
|
|
38857
|
+
* @param this
|
|
38858
|
+
* @returns A dictionary tree of unparented instances grouped by the host script holding the reference.
|
|
38723
38859
|
*/
|
|
38724
38860
|
GetUnparentedInstancesAsync(this: SceneAnalysisService): object;
|
|
38725
38861
|
}
|
|
@@ -38974,12 +39110,15 @@ interface ScriptContext extends Instance {
|
|
|
38974
39110
|
* - **ThreadSafety**: Unsafe
|
|
38975
39111
|
*
|
|
38976
39112
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScriptContext#EnableCoverage)
|
|
39113
|
+
* @param this
|
|
39114
|
+
* @param instance
|
|
38977
39115
|
*/
|
|
38978
39116
|
EnableCoverage(this: ScriptContext, instance: Instance): void;
|
|
38979
39117
|
/**
|
|
38980
39118
|
* - **ThreadSafety**: Unsafe
|
|
38981
39119
|
*
|
|
38982
39120
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScriptContext#GetCoverageStats)
|
|
39121
|
+
* @param this
|
|
38983
39122
|
*/
|
|
38984
39123
|
GetCoverageStats(this: ScriptContext): Array<unknown>;
|
|
38985
39124
|
/**
|
|
@@ -38991,6 +39130,21 @@ interface ScriptContext extends Instance {
|
|
|
38991
39130
|
*/
|
|
38992
39131
|
readonly Error: RBXScriptSignal<(message: string, stackTrace: string, script?: LuaSourceContainer) => void>;
|
|
38993
39132
|
}
|
|
39133
|
+
/**
|
|
39134
|
+
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
39135
|
+
*
|
|
39136
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScriptDebuggerService)
|
|
39137
|
+
*/
|
|
39138
|
+
interface ScriptDebuggerService extends Instance {
|
|
39139
|
+
/**
|
|
39140
|
+
* **DO NOT USE!**
|
|
39141
|
+
*
|
|
39142
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
39143
|
+
* @hidden
|
|
39144
|
+
* @deprecated
|
|
39145
|
+
*/
|
|
39146
|
+
readonly _nominal_ScriptDebuggerService: unique symbol;
|
|
39147
|
+
}
|
|
38994
39148
|
/**
|
|
38995
39149
|
* - **Tags**: NotCreatable, Service
|
|
38996
39150
|
*
|
|
@@ -41377,6 +41531,12 @@ interface SoundService extends Instance {
|
|
|
41377
41531
|
* @param sound The `Sound` to be played.
|
|
41378
41532
|
*/
|
|
41379
41533
|
PlayLocalSound(this: SoundService, sound: Sound): void;
|
|
41534
|
+
/**
|
|
41535
|
+
* - **ThreadSafety**: Unsafe
|
|
41536
|
+
*
|
|
41537
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SoundService#SetInputDevice)
|
|
41538
|
+
*/
|
|
41539
|
+
SetInputDevice(this: SoundService, nameOrInstance: unknown, guidOrPin: string): void;
|
|
41380
41540
|
/**
|
|
41381
41541
|
* Sets the listener used by `Sounds`.
|
|
41382
41542
|
*
|
|
@@ -41491,7 +41651,7 @@ interface StartPageService extends Instance {
|
|
|
41491
41651
|
readonly _nominal_StartPageService: unique symbol;
|
|
41492
41652
|
}
|
|
41493
41653
|
/**
|
|
41494
|
-
* If the game allows gear, StarterGear
|
|
41654
|
+
* If the game allows gear, `StarterGear` is a container automatically inserted into each `Player` object when the player joins the game. Whenever the player's character spawns, the contents of that player's `StarterGear` are copied into the player's `Backpack`.
|
|
41495
41655
|
*
|
|
41496
41656
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StarterGear)
|
|
41497
41657
|
*/
|
|
@@ -41506,7 +41666,7 @@ interface StarterGear extends Instance {
|
|
|
41506
41666
|
readonly _nominal_StarterGear: unique symbol;
|
|
41507
41667
|
}
|
|
41508
41668
|
/**
|
|
41509
|
-
* A
|
|
41669
|
+
* A container whose contents are copied into each player's `Backpack` when their player character spawns. It is generally used to hold `Tools`.
|
|
41510
41670
|
*
|
|
41511
41671
|
* - **Tags**: NotCreatable, Service
|
|
41512
41672
|
*
|
|
@@ -43721,6 +43881,8 @@ interface TestService extends Instance {
|
|
|
43721
43881
|
* - **ThreadSafety**: Unsafe
|
|
43722
43882
|
*
|
|
43723
43883
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TestService#RegisterTest)
|
|
43884
|
+
* @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.
|
|
43885
|
+
* @param testOptions
|
|
43724
43886
|
*/
|
|
43725
43887
|
RegisterTest(this: TestService, testOptions: object): TestCase;
|
|
43726
43888
|
/**
|
|
@@ -43791,6 +43953,13 @@ interface TestService extends Instance {
|
|
|
43791
43953
|
* @param name
|
|
43792
43954
|
*/
|
|
43793
43955
|
isFeatureEnabled(this: TestService, name: string): boolean;
|
|
43956
|
+
/**
|
|
43957
|
+
* - **ThreadSafety**: Unsafe
|
|
43958
|
+
* - **Tags**: Yields
|
|
43959
|
+
*
|
|
43960
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TestService#CaptureScreenshotAsync)
|
|
43961
|
+
*/
|
|
43962
|
+
CaptureScreenshotAsync(this: TestService, artifactName?: string, options?: object): unknown;
|
|
43794
43963
|
/**
|
|
43795
43964
|
* - **ThreadSafety**: Unsafe
|
|
43796
43965
|
* - **Tags**: Yields
|
|
@@ -46011,41 +46180,46 @@ interface UICorner extends UIComponent {
|
|
|
46011
46180
|
*/
|
|
46012
46181
|
readonly _nominal_UICorner: unique symbol;
|
|
46013
46182
|
/**
|
|
46183
|
+
* Determines the radius of the bottom-left corner.
|
|
46184
|
+
*
|
|
46014
46185
|
* - **ThreadSafety**: ReadSafe
|
|
46015
|
-
* - **Tags**: Hidden, NotReplicated
|
|
46016
46186
|
*
|
|
46017
46187
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UICorner#BottomLeftRadius)
|
|
46018
46188
|
*/
|
|
46019
|
-
|
|
46189
|
+
BottomLeftRadius: UDim;
|
|
46020
46190
|
/**
|
|
46191
|
+
* Determines the radius of the bottom-right corner.
|
|
46192
|
+
*
|
|
46021
46193
|
* - **ThreadSafety**: ReadSafe
|
|
46022
|
-
* - **Tags**: Hidden, NotReplicated
|
|
46023
46194
|
*
|
|
46024
46195
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UICorner#BottomRightRadius)
|
|
46025
46196
|
*/
|
|
46026
|
-
|
|
46197
|
+
BottomRightRadius: UDim;
|
|
46027
46198
|
/**
|
|
46028
46199
|
* Sets all four corner radii at once and reads from `TopLeftRadius`.
|
|
46029
46200
|
*
|
|
46030
46201
|
* - **ThreadSafety**: ReadSafe
|
|
46202
|
+
* - **Tags**: NotReplicated
|
|
46031
46203
|
*
|
|
46032
46204
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UICorner#CornerRadius)
|
|
46033
46205
|
*/
|
|
46034
46206
|
CornerRadius: UDim;
|
|
46035
46207
|
/**
|
|
46208
|
+
* Determines the radius of the top-left corner.
|
|
46209
|
+
*
|
|
46036
46210
|
* - **ThreadSafety**: ReadSafe
|
|
46037
|
-
* - **Tags**: Hidden, NotReplicated
|
|
46038
46211
|
*
|
|
46039
46212
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UICorner#TopLeftRadius)
|
|
46040
46213
|
*/
|
|
46041
|
-
|
|
46214
|
+
TopLeftRadius: UDim;
|
|
46042
46215
|
/**
|
|
46216
|
+
* Determines the radius of the top-right corner.
|
|
46217
|
+
*
|
|
46043
46218
|
* - **ThreadSafety**: ReadSafe
|
|
46044
|
-
* - **Tags**: Hidden, NotReplicated
|
|
46045
46219
|
*
|
|
46046
46220
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UICorner#TopRightRadius)
|
|
46047
46221
|
*/
|
|
46048
|
-
|
|
46222
|
+
TopRightRadius: UDim;
|
|
46049
46223
|
}
|
|
46050
46224
|
/**
|
|
46051
46225
|
* Instance which facilitates and encourages interaction with UI elements in an experience.
|
|
@@ -46909,6 +47083,8 @@ interface UIScale extends UIComponent {
|
|
|
46909
47083
|
Scale: number;
|
|
46910
47084
|
}
|
|
46911
47085
|
/**
|
|
47086
|
+
* Renders a shadow below the parent UI instance.
|
|
47087
|
+
*
|
|
46912
47088
|
* - **Tags**: NotBrowsable
|
|
46913
47089
|
*
|
|
46914
47090
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UIShadow)
|
|
@@ -46923,36 +47099,48 @@ interface UIShadow extends UIComponent {
|
|
|
46923
47099
|
*/
|
|
46924
47100
|
readonly _nominal_UIShadow: unique symbol;
|
|
46925
47101
|
/**
|
|
47102
|
+
* Determines the shadow's blurriness.
|
|
47103
|
+
*
|
|
46926
47104
|
* - **ThreadSafety**: ReadSafe
|
|
46927
47105
|
*
|
|
46928
47106
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UIShadow#BlurRadius)
|
|
46929
47107
|
*/
|
|
46930
47108
|
BlurRadius: UDim;
|
|
46931
47109
|
/**
|
|
47110
|
+
* Determines the shadow's color.
|
|
47111
|
+
*
|
|
46932
47112
|
* - **ThreadSafety**: ReadSafe
|
|
46933
47113
|
*
|
|
46934
47114
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UIShadow#Color)
|
|
46935
47115
|
*/
|
|
46936
47116
|
Color: Color3;
|
|
46937
47117
|
/**
|
|
47118
|
+
* Moves the shadow relative to the parent's position.
|
|
47119
|
+
*
|
|
46938
47120
|
* - **ThreadSafety**: ReadSafe
|
|
46939
47121
|
*
|
|
46940
47122
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UIShadow#Offset)
|
|
46941
47123
|
*/
|
|
46942
47124
|
Offset: UDim2;
|
|
46943
47125
|
/**
|
|
47126
|
+
* Expands or shrinks the shadow relative to the parent's size.
|
|
47127
|
+
*
|
|
46944
47128
|
* - **ThreadSafety**: ReadSafe
|
|
46945
47129
|
*
|
|
46946
47130
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UIShadow#Spread)
|
|
46947
47131
|
*/
|
|
46948
47132
|
Spread: UDim2;
|
|
46949
47133
|
/**
|
|
47134
|
+
* Sets the shadow's transparency.
|
|
47135
|
+
*
|
|
46950
47136
|
* - **ThreadSafety**: ReadSafe
|
|
46951
47137
|
*
|
|
46952
47138
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UIShadow#Transparency)
|
|
46953
47139
|
*/
|
|
46954
47140
|
Transparency: number;
|
|
46955
47141
|
/**
|
|
47142
|
+
* Determines the shadow's render order relative to sibling `UIShadow` instances.
|
|
47143
|
+
*
|
|
46956
47144
|
* - **ThreadSafety**: ReadSafe
|
|
46957
47145
|
*
|
|
46958
47146
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UIShadow#ZIndex)
|
|
@@ -47164,12 +47352,16 @@ interface UserGameSettings extends Instance {
|
|
|
47164
47352
|
*/
|
|
47165
47353
|
MouseSensitivity: number;
|
|
47166
47354
|
/**
|
|
47355
|
+
* Internal MicroProfiler setting specifying the frame rate used when capturing server-side RCC profiler data.
|
|
47356
|
+
*
|
|
47167
47357
|
* - **ThreadSafety**: ReadSafe
|
|
47168
47358
|
*
|
|
47169
47359
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UserGameSettings#RCCProfilerRecordFrameRate)
|
|
47170
47360
|
*/
|
|
47171
47361
|
RCCProfilerRecordFrameRate: number;
|
|
47172
47362
|
/**
|
|
47363
|
+
* Internal MicroProfiler setting specifying the duration over which server-side RCC profiler data is captured.
|
|
47364
|
+
*
|
|
47173
47365
|
* - **ThreadSafety**: ReadSafe
|
|
47174
47366
|
*
|
|
47175
47367
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UserGameSettings#RCCProfilerRecordTimeFrame)
|
|
@@ -47208,12 +47400,16 @@ interface UserGameSettings extends Instance {
|
|
|
47208
47400
|
*/
|
|
47209
47401
|
TouchMovementMode: Enum.TouchMovementMode;
|
|
47210
47402
|
/**
|
|
47403
|
+
* Indicates whether smooth rotation is used instead of snap rotation in VR.
|
|
47404
|
+
*
|
|
47211
47405
|
* - **ThreadSafety**: ReadSafe
|
|
47212
47406
|
*
|
|
47213
47407
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UserGameSettings#VRSmoothRotationEnabled)
|
|
47214
47408
|
*/
|
|
47215
47409
|
get VRSmoothRotationEnabled(): boolean;
|
|
47216
47410
|
/**
|
|
47411
|
+
* Indicates whether the VR vignette comfort effect is enabled.
|
|
47412
|
+
*
|
|
47217
47413
|
* - **ThreadSafety**: ReadSafe
|
|
47218
47414
|
*
|
|
47219
47415
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UserGameSettings#VignetteEnabled)
|
|
@@ -48916,6 +49112,12 @@ interface VideoPlayer extends Instance {
|
|
|
48916
49112
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VideoPlayer#Looping)
|
|
48917
49113
|
*/
|
|
48918
49114
|
Looping: boolean;
|
|
49115
|
+
/**
|
|
49116
|
+
* - **ThreadSafety**: ReadSafe
|
|
49117
|
+
*
|
|
49118
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VideoPlayer#MaximumResolution)
|
|
49119
|
+
*/
|
|
49120
|
+
MaximumResolution: Enum.VideoSampleSize;
|
|
48919
49121
|
/**
|
|
48920
49122
|
* Controls the speed at which the video is played.
|
|
48921
49123
|
*
|
|
@@ -49716,8 +49918,6 @@ interface TerrainIterateOperation extends RBXObject {
|
|
|
49716
49918
|
* - **ThreadSafety**: Unsafe
|
|
49717
49919
|
*
|
|
49718
49920
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TerrainIterateOperation#CommitBlock)
|
|
49719
|
-
* @param this
|
|
49720
|
-
* @param block
|
|
49721
49921
|
*/
|
|
49722
49922
|
CommitBlock(this: TerrainIterateOperation, block: object): RBXScriptSignal;
|
|
49723
49923
|
/**
|
|
@@ -49745,8 +49945,6 @@ interface TerrainModifyOperation extends RBXObject {
|
|
|
49745
49945
|
* - **ThreadSafety**: Unsafe
|
|
49746
49946
|
*
|
|
49747
49947
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TerrainModifyOperation#CommitBlock)
|
|
49748
|
-
* @param this
|
|
49749
|
-
* @param block
|
|
49750
49948
|
*/
|
|
49751
49949
|
CommitBlock(this: TerrainModifyOperation, block: object): RBXScriptSignal;
|
|
49752
49950
|
/**
|
|
@@ -49795,8 +49993,6 @@ interface TerrainWriteOperation extends RBXObject {
|
|
|
49795
49993
|
* - **ThreadSafety**: Unsafe
|
|
49796
49994
|
*
|
|
49797
49995
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TerrainWriteOperation#CommitBlock)
|
|
49798
|
-
* @param this
|
|
49799
|
-
* @param block
|
|
49800
49996
|
*/
|
|
49801
49997
|
CommitBlock(this: TerrainWriteOperation, block: object): RBXScriptSignal;
|
|
49802
49998
|
/**
|
|
@@ -49804,7 +50000,6 @@ interface TerrainWriteOperation extends RBXObject {
|
|
|
49804
50000
|
* - **Tags**: CustomLuaState
|
|
49805
50001
|
*
|
|
49806
50002
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TerrainWriteOperation#GetBlock)
|
|
49807
|
-
* @param this
|
|
49808
50003
|
*/
|
|
49809
50004
|
GetBlock(this: TerrainWriteOperation): object;
|
|
49810
50005
|
}
|