@rbxts/types 1.0.876 → 1.0.877
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.
|
@@ -32,6 +32,7 @@ interface Services {
|
|
|
32
32
|
BulkImportService: BulkImportService;
|
|
33
33
|
CalloutService: CalloutService;
|
|
34
34
|
CaptureService: CaptureService;
|
|
35
|
+
ChangeHistoryStreamingService: ChangeHistoryStreamingService;
|
|
35
36
|
Chat: Chat;
|
|
36
37
|
ChatbotUIService: ChatbotUIService;
|
|
37
38
|
CloudCRUDService: CloudCRUDService;
|
|
@@ -1130,6 +1131,12 @@ interface EditableMesh extends RBXObject {
|
|
|
1130
1131
|
* @returns Stable color ID of the new color.
|
|
1131
1132
|
*/
|
|
1132
1133
|
AddColor(this: EditableMesh, color: Color3, alpha: number): number;
|
|
1134
|
+
/**
|
|
1135
|
+
* - **ThreadSafety**: Unsafe
|
|
1136
|
+
*
|
|
1137
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#AddFace)
|
|
1138
|
+
*/
|
|
1139
|
+
AddFace(this: EditableMesh, vertexIds: Array<unknown>): number;
|
|
1133
1140
|
/**
|
|
1134
1141
|
* Adds a new normal to the geometry and returns a stable normal ID.
|
|
1135
1142
|
*
|
|
@@ -3387,14 +3394,14 @@ interface AnimationTrack extends Instance {
|
|
|
3387
3394
|
*/
|
|
3388
3395
|
AdjustWeight(this: AnimationTrack, weight?: number, fadeTime?: number): void;
|
|
3389
3396
|
/**
|
|
3390
|
-
* Returns an `
|
|
3397
|
+
* Returns an `RBXScriptSignal` (event) that fires when a specified `KeyframeMarker` has been hit in an `animation`.
|
|
3391
3398
|
*
|
|
3392
3399
|
* - **ThreadSafety**: Unsafe
|
|
3393
3400
|
*
|
|
3394
3401
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AnimationTrack#GetMarkerReachedSignal)
|
|
3395
3402
|
* @param this Controls the playback of an animation on an `Animator`.
|
|
3396
3403
|
* @param name The name of the `KeyframeMarker` the signal is being created for. Not to be confused with the name of the `Keyframe`.
|
|
3397
|
-
* @returns The signal created and fired when the animation reaches the created `KeyframeMarker`.
|
|
3404
|
+
* @returns The signal created and fired when the animation reaches the created `KeyframeMarker`.
|
|
3398
3405
|
*/
|
|
3399
3406
|
GetMarkerReachedSignal(this: AnimationTrack, name: string): RBXScriptSignal<(param?: string) => void>;
|
|
3400
3407
|
/**
|
|
@@ -3789,6 +3796,12 @@ interface AssetService extends Instance {
|
|
|
3789
3796
|
* @deprecated
|
|
3790
3797
|
*/
|
|
3791
3798
|
readonly _nominal_AssetService: unique symbol;
|
|
3799
|
+
/**
|
|
3800
|
+
* - **ThreadSafety**: ReadSafe
|
|
3801
|
+
*
|
|
3802
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AssetService#AllowInsertFreeAssets)
|
|
3803
|
+
*/
|
|
3804
|
+
AllowInsertFreeAssets: boolean;
|
|
3792
3805
|
/**
|
|
3793
3806
|
* Creates a new `EditableImage`.
|
|
3794
3807
|
*
|
|
@@ -3931,12 +3944,20 @@ interface AssetService extends Instance {
|
|
|
3931
3944
|
*/
|
|
3932
3945
|
CreatePlaceInPlayerInventoryAsync(this: AssetService, player: Player, placeName: string, templatePlaceID: number, description: string): number;
|
|
3933
3946
|
/**
|
|
3947
|
+
* Creates a new `SurfaceAppearance` object using the provided content maps.
|
|
3948
|
+
*
|
|
3934
3949
|
* - **ThreadSafety**: Unsafe
|
|
3935
3950
|
* - **Tags**: Yields
|
|
3936
3951
|
*
|
|
3937
3952
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AssetService#CreateSurfaceAppearanceAsync)
|
|
3938
3953
|
* @param this A non-replicated service that handles asset-related queries to the Roblox web API.
|
|
3939
|
-
* @param content
|
|
3954
|
+
* @param content Dictionary containing the following key-value pairs: - `ColorMap` — A `Content` object that contains the color map. Default is `nil`.
|
|
3955
|
+
* - `MetalnessMap` — A `Content` object that contains the metalness map. If more than one channel is present, only the red channel is used. Default is `nil`.
|
|
3956
|
+
* - `NormalMap` — A `Content` object that contains the normal map. Default is `nil`.
|
|
3957
|
+
* - `RoughnessMap` — A `Content` object that contains the roughness map. If more than one channel is present, only the red channel is used. Default is `nil`.
|
|
3958
|
+
*
|
|
3959
|
+
*
|
|
3960
|
+
* @returns A new `SurfaceAppearance` instance with the given maps from the `content` parameter.
|
|
3940
3961
|
*/
|
|
3941
3962
|
CreateSurfaceAppearanceAsync(this: AssetService, content: object): SurfaceAppearance;
|
|
3942
3963
|
/**
|
|
@@ -4016,6 +4037,13 @@ interface AssetService extends Instance {
|
|
|
4016
4037
|
Name: string;
|
|
4017
4038
|
PlaceId: number;
|
|
4018
4039
|
}>;
|
|
4040
|
+
/**
|
|
4041
|
+
* - **ThreadSafety**: Unsafe
|
|
4042
|
+
* - **Tags**: Yields
|
|
4043
|
+
*
|
|
4044
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AssetService#LoadAssetAsync)
|
|
4045
|
+
*/
|
|
4046
|
+
LoadAssetAsync(this: AssetService, assetId: number): Instance | undefined;
|
|
4019
4047
|
/**
|
|
4020
4048
|
* Allows in-experience asset creation for users by prompting a publish dialog.
|
|
4021
4049
|
*
|
|
@@ -4049,7 +4077,7 @@ interface AssetService extends Instance {
|
|
|
4049
4077
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AssetService#SavePlaceAsync)
|
|
4050
4078
|
* @param this A non-replicated service that handles asset-related queries to the Roblox web API.
|
|
4051
4079
|
*/
|
|
4052
|
-
SavePlaceAsync(this: AssetService): void;
|
|
4080
|
+
SavePlaceAsync(this: AssetService, requestParameters?: object): void;
|
|
4053
4081
|
/**
|
|
4054
4082
|
* Finds audio assets matching a variety of search criteria.
|
|
4055
4083
|
*
|
|
@@ -5902,6 +5930,12 @@ interface AudioPlayer extends Instance {
|
|
|
5902
5930
|
* @deprecated Asset
|
|
5903
5931
|
*/
|
|
5904
5932
|
AssetId: string;
|
|
5933
|
+
/**
|
|
5934
|
+
* - **ThreadSafety**: ReadSafe
|
|
5935
|
+
*
|
|
5936
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioPlayer#AudioContent)
|
|
5937
|
+
*/
|
|
5938
|
+
AudioContent: Content;
|
|
5905
5939
|
/**
|
|
5906
5940
|
* Controls whether `Asset` loads automatically once assigned.
|
|
5907
5941
|
*
|
|
@@ -9653,6 +9687,21 @@ interface CaptureService extends Instance {
|
|
|
9653
9687
|
*/
|
|
9654
9688
|
readonly UserCaptureSaved: RBXScriptSignal<(captureContentId: ContentId) => void>;
|
|
9655
9689
|
}
|
|
9690
|
+
/**
|
|
9691
|
+
* - **Tags**: NotCreatable, Service
|
|
9692
|
+
*
|
|
9693
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ChangeHistoryStreamingService)
|
|
9694
|
+
*/
|
|
9695
|
+
interface ChangeHistoryStreamingService extends Instance {
|
|
9696
|
+
/**
|
|
9697
|
+
* **DO NOT USE!**
|
|
9698
|
+
*
|
|
9699
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
9700
|
+
* @hidden
|
|
9701
|
+
* @deprecated
|
|
9702
|
+
*/
|
|
9703
|
+
readonly _nominal_ChangeHistoryStreamingService: unique symbol;
|
|
9704
|
+
}
|
|
9656
9705
|
/**
|
|
9657
9706
|
* The base class for objects that change the character's appearance, such as the `BodyColors`, `CharacterMesh`, `ShirtGraphic`, `Pants` and `Shirt` objects.
|
|
9658
9707
|
*
|
|
@@ -17085,6 +17134,12 @@ interface GuiButton extends GuiObject {
|
|
|
17085
17134
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GuiButton#MouseButton2Up)
|
|
17086
17135
|
*/
|
|
17087
17136
|
readonly MouseButton2Up: RBXScriptSignal<(x: number, y: number) => void>;
|
|
17137
|
+
/**
|
|
17138
|
+
* - **ThreadSafety**: Unsafe
|
|
17139
|
+
*
|
|
17140
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GuiButton#SecondaryActivated)
|
|
17141
|
+
*/
|
|
17142
|
+
readonly SecondaryActivated: RBXScriptSignal<(inputObject: InputObject) => void>;
|
|
17088
17143
|
}
|
|
17089
17144
|
/**
|
|
17090
17145
|
* A 2D user interface element that displays an interactive image.
|
|
@@ -18541,7 +18596,7 @@ interface VideoFrame extends GuiObject {
|
|
|
18541
18596
|
*/
|
|
18542
18597
|
Volume: number;
|
|
18543
18598
|
/**
|
|
18544
|
-
* Sets `VideoFrame.Playing` to false
|
|
18599
|
+
* Sets `VideoFrame.Playing` to `false`, pausing playback if the `VideoFrame.Video` is playing.
|
|
18545
18600
|
*
|
|
18546
18601
|
* - **ThreadSafety**: Unsafe
|
|
18547
18602
|
*
|
|
@@ -18550,7 +18605,7 @@ interface VideoFrame extends GuiObject {
|
|
|
18550
18605
|
*/
|
|
18551
18606
|
Pause(this: VideoFrame): void;
|
|
18552
18607
|
/**
|
|
18553
|
-
* Sets `VideoFrame.Playing` to true
|
|
18608
|
+
* Sets `VideoFrame.Playing` to `true`, playing the `VideoFrame.Video` from the current `VideoFrame.TimePosition`.
|
|
18554
18609
|
*
|
|
18555
18610
|
* - **ThreadSafety**: Unsafe
|
|
18556
18611
|
*
|
|
@@ -23754,6 +23809,12 @@ interface InputBinding extends Instance {
|
|
|
23754
23809
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputBinding#ReleasedThreshold)
|
|
23755
23810
|
*/
|
|
23756
23811
|
ReleasedThreshold: number;
|
|
23812
|
+
/**
|
|
23813
|
+
* - **ThreadSafety**: ReadSafe
|
|
23814
|
+
*
|
|
23815
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputBinding#ResponseCurve)
|
|
23816
|
+
*/
|
|
23817
|
+
ResponseCurve: number;
|
|
23757
23818
|
/**
|
|
23758
23819
|
* Specifies an alternate `KeyCode` for dispatching directionally "right" inputs to the parent `InputAction`.
|
|
23759
23820
|
*
|
|
@@ -36929,6 +36990,12 @@ interface Sound extends Instance {
|
|
|
36929
36990
|
* @deprecated
|
|
36930
36991
|
*/
|
|
36931
36992
|
readonly _nominal_Sound: unique symbol;
|
|
36993
|
+
/**
|
|
36994
|
+
* - **ThreadSafety**: ReadSafe
|
|
36995
|
+
*
|
|
36996
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Sound#AudioContent)
|
|
36997
|
+
*/
|
|
36998
|
+
AudioContent: Content;
|
|
36932
36999
|
/**
|
|
36933
37000
|
* **Deprecated:** This property has deprecated in favor of `Sound.RollOffMinDistance` and `Sound.RollOffMaxDistance` which should be used instead in new work.
|
|
36934
37001
|
*
|
|
@@ -38261,6 +38328,13 @@ interface Stats extends Instance {
|
|
|
38261
38328
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Stats#InstanceCount)
|
|
38262
38329
|
*/
|
|
38263
38330
|
readonly InstanceCount: number;
|
|
38331
|
+
/**
|
|
38332
|
+
* - **ThreadSafety**: ReadSafe
|
|
38333
|
+
* - **Tags**: NotReplicated
|
|
38334
|
+
*
|
|
38335
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Stats#MemoryTrackingEnabled)
|
|
38336
|
+
*/
|
|
38337
|
+
readonly MemoryTrackingEnabled: boolean;
|
|
38264
38338
|
/**
|
|
38265
38339
|
* A measurement of how many physically simulated components are currently moving in the game world.
|
|
38266
38340
|
*
|
|
@@ -44713,6 +44787,12 @@ interface VideoPlayer extends Instance {
|
|
|
44713
44787
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VideoPlayer#TimePosition)
|
|
44714
44788
|
*/
|
|
44715
44789
|
TimePosition: number;
|
|
44790
|
+
/**
|
|
44791
|
+
* - **ThreadSafety**: ReadSafe
|
|
44792
|
+
*
|
|
44793
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VideoPlayer#VideoContent)
|
|
44794
|
+
*/
|
|
44795
|
+
VideoContent: Content;
|
|
44716
44796
|
/**
|
|
44717
44797
|
* - **ThreadSafety**: ReadSafe
|
|
44718
44798
|
*
|
|
@@ -33,6 +33,7 @@ interface Services {
|
|
|
33
33
|
CalloutService: CalloutService;
|
|
34
34
|
CaptureService: CaptureService;
|
|
35
35
|
ChangeHistoryService: ChangeHistoryService;
|
|
36
|
+
ChangeHistoryStreamingService: ChangeHistoryStreamingService;
|
|
36
37
|
Chat: Chat;
|
|
37
38
|
ChatbotUIService: ChatbotUIService;
|
|
38
39
|
CloudCRUDService: CloudCRUDService;
|
|
@@ -2974,6 +2975,21 @@ interface ChangeHistoryService extends Instance {
|
|
|
2974
2975
|
*/
|
|
2975
2976
|
readonly OnUndo: RBXScriptSignal<(waypoint: string) => void>;
|
|
2976
2977
|
}
|
|
2978
|
+
/**
|
|
2979
|
+
* - **Tags**: NotCreatable, Service
|
|
2980
|
+
*
|
|
2981
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ChangeHistoryStreamingService)
|
|
2982
|
+
*/
|
|
2983
|
+
interface ChangeHistoryStreamingService extends Instance {
|
|
2984
|
+
/**
|
|
2985
|
+
* **DO NOT USE!**
|
|
2986
|
+
*
|
|
2987
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
2988
|
+
* @hidden
|
|
2989
|
+
* @deprecated
|
|
2990
|
+
*/
|
|
2991
|
+
readonly _nominal_ChangeHistoryStreamingService: unique symbol;
|
|
2992
|
+
}
|
|
2977
2993
|
/**
|
|
2978
2994
|
* The base class for objects that change the character's appearance, such as the `BodyColors`, `CharacterMesh`, `ShirtGraphic`, `Pants` and `Shirt` objects.
|
|
2979
2995
|
*
|
|
@@ -579,7 +579,7 @@ declare namespace Enum {
|
|
|
579
579
|
*/
|
|
580
580
|
export namespace AdEventType {
|
|
581
581
|
/**
|
|
582
|
-
* The event is fired when a click-to-play video
|
|
582
|
+
* The event is fired when a click-to-play video ad is being served. This can be used to communicate and promote the reward to users through the UI or signage.
|
|
583
583
|
*
|
|
584
584
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AdEventType#RewardedAdLoaded)
|
|
585
585
|
*/
|
|
@@ -590,7 +590,7 @@ declare namespace Enum {
|
|
|
590
590
|
}
|
|
591
591
|
export const RewardedAdLoaded: RewardedAdLoaded;
|
|
592
592
|
/**
|
|
593
|
-
* The event is fired when a user has watched the click-to-play video for a certain time. This can be used to grant the player a reward such as an in-game item or in-game currency. The RewardedAdGrant enum will only be triggered once per ad rotation.
|
|
593
|
+
* The event is fired when a user has watched the click-to-play video ad for a certain time. This can be used to grant the player a reward such as an in-game item or in-game currency. The `RewardedAdGrant` enum will only be triggered once per ad rotation.
|
|
594
594
|
*
|
|
595
595
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AdEventType#RewardedAdGrant)
|
|
596
596
|
*/
|
|
@@ -601,7 +601,7 @@ declare namespace Enum {
|
|
|
601
601
|
}
|
|
602
602
|
export const RewardedAdGrant: RewardedAdGrant;
|
|
603
603
|
/**
|
|
604
|
-
* The event is fired when a click-to-play video
|
|
604
|
+
* The event is fired when a click-to-play video ad is rotated out. This can be used to remove any UI or signage that is promoting the reward.
|
|
605
605
|
*
|
|
606
606
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AdEventType#RewardedAdUnloaded)
|
|
607
607
|
*/
|