@rbxts/types 1.0.944 → 1.0.946
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 +170 -12
- package/include/generated/PluginSecurity.d.ts +52 -1
- package/include/generated/enums.d.ts +201 -13
- package/package.json +1 -1
|
@@ -515,6 +515,8 @@ interface CreatableInstances {
|
|
|
515
515
|
SpotLight: SpotLight;
|
|
516
516
|
SpringConstraint: SpringConstraint;
|
|
517
517
|
StarterGear: StarterGear;
|
|
518
|
+
StateMachineDefinition: StateMachineDefinition;
|
|
519
|
+
StateMachineTransitionDefinition: StateMachineTransitionDefinition;
|
|
518
520
|
StringValue: StringValue;
|
|
519
521
|
StudioAttachment: StudioAttachment;
|
|
520
522
|
StudioCallout: StudioCallout;
|
|
@@ -1430,9 +1432,12 @@ interface EditableMesh extends RBXObject {
|
|
|
1430
1432
|
*/
|
|
1431
1433
|
BatchSetVertexFaceAttributes(this: EditableMesh, vertexIds: Array<unknown>, faceIds: Array<unknown>, attrIds: Array<unknown>): void;
|
|
1432
1434
|
/**
|
|
1435
|
+
* Clears all of an EditableMesh's geometry.
|
|
1436
|
+
*
|
|
1433
1437
|
* - **ThreadSafety**: Unsafe
|
|
1434
1438
|
*
|
|
1435
1439
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#Clear)
|
|
1440
|
+
* @param this Object which allows for the runtime creation and manipulation of meshes.
|
|
1436
1441
|
*/
|
|
1437
1442
|
Clear(this: EditableMesh): void;
|
|
1438
1443
|
/**
|
|
@@ -3059,6 +3064,8 @@ interface ActivityHistoryEventService extends Instance {
|
|
|
3059
3064
|
readonly _nominal_ActivityHistoryEventService: unique symbol;
|
|
3060
3065
|
}
|
|
3061
3066
|
/**
|
|
3067
|
+
* A portal that teleports players to a sponsored experience as part of immersive ads.
|
|
3068
|
+
*
|
|
3062
3069
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AdPortal)
|
|
3063
3070
|
*/
|
|
3064
3071
|
interface AdPortal extends Instance {
|
|
@@ -3071,6 +3078,8 @@ interface AdPortal extends Instance {
|
|
|
3071
3078
|
*/
|
|
3072
3079
|
readonly _nominal_AdPortal: unique symbol;
|
|
3073
3080
|
/**
|
|
3081
|
+
* Indicates whether the portal is currently active and able to teleport players.
|
|
3082
|
+
*
|
|
3074
3083
|
* - **ThreadSafety**: ReadSafe
|
|
3075
3084
|
* - **Tags**: NotReplicated
|
|
3076
3085
|
*
|
|
@@ -3102,6 +3111,7 @@ interface AdService extends Instance {
|
|
|
3102
3111
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AdService#CreateAdRewardFromDevProductId)
|
|
3103
3112
|
* @param this The service responsible for in-experience advertising.
|
|
3104
3113
|
* @param devProductId The ID of the developer product you want to grant as a reward.
|
|
3114
|
+
* @returns An `AdReward` configured as a developer-product reward for the specified product.
|
|
3105
3115
|
*/
|
|
3106
3116
|
CreateAdRewardFromDevProductId(this: AdService, devProductId: number): AdReward;
|
|
3107
3117
|
/**
|
|
@@ -3115,6 +3125,12 @@ interface AdService extends Instance {
|
|
|
3115
3125
|
* @param adIntegrationPlacementId The ID of the placement that this disclosure is attached to.
|
|
3116
3126
|
*/
|
|
3117
3127
|
RegisterDisclosureButton(this: AdService, disclosureButton: GuiButton, adIntegrationPlacementId: string): void;
|
|
3128
|
+
/**
|
|
3129
|
+
* - **ThreadSafety**: Unsafe
|
|
3130
|
+
*
|
|
3131
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AdService#RegisterImpressionSource)
|
|
3132
|
+
*/
|
|
3133
|
+
RegisterImpressionSource(this: AdService, instance: Instance, adIntegrationPlacementId: string): void;
|
|
3118
3134
|
/**
|
|
3119
3135
|
* **Deprecated:** `ShowVideoAd` has been decommissioned and is no longer operational.
|
|
3120
3136
|
*
|
|
@@ -3130,11 +3146,13 @@ interface AdService extends Instance {
|
|
|
3130
3146
|
*/
|
|
3131
3147
|
ShowVideoAd(this: AdService): void;
|
|
3132
3148
|
/**
|
|
3149
|
+
* Stops tracking an instance that was previously registered with `RegisterAdOpportunityAsync`.
|
|
3150
|
+
*
|
|
3133
3151
|
* - **ThreadSafety**: Unsafe
|
|
3134
3152
|
*
|
|
3135
3153
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AdService#UnregisterAdOpportunity)
|
|
3136
3154
|
* @param this The service responsible for in-experience advertising.
|
|
3137
|
-
* @param instance
|
|
3155
|
+
* @param instance The instance to stop tracking. This should be an instance that you previously passed to `RegisterAdOpportunityAsync`.
|
|
3138
3156
|
*/
|
|
3139
3157
|
UnregisterAdOpportunity(this: AdService, instance: Instance): void;
|
|
3140
3158
|
/**
|
|
@@ -3170,15 +3188,12 @@ interface AdService extends Instance {
|
|
|
3170
3188
|
*
|
|
3171
3189
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AdService#RegisterAdOpportunityAsync)
|
|
3172
3190
|
* @param this The service responsible for in-experience advertising.
|
|
3173
|
-
* @param instance
|
|
3191
|
+
* @param instance The `GuiButton` to track as a rewarded video ad opportunity. Must be a descendant of a `ScreenGui`.
|
|
3174
3192
|
* @param placementId The ID of the placement of the rewarded video ad inside the experience. Allows for reporting on the performance of individual ad placements.
|
|
3175
3193
|
*/
|
|
3176
3194
|
RegisterAdOpportunityAsync(this: AdService, instance: Instance, placementId?: number): void;
|
|
3177
3195
|
/**
|
|
3178
3196
|
* Plays the video ad to the current user inside the experience.
|
|
3179
|
-
* ```
|
|
3180
|
-
* **Warning**: Rewarded Video ads must be user opt-in and clearly disclosed. For details, review our [eligibility requirements](../../../production/promotion/rewarded-video-ads.md#eligibility-requirements) and [advertising standards](https://en.help.roblox.com/hc/en-us/articles/13722260778260-Advertising-Standards).
|
|
3181
|
-
* ```
|
|
3182
3197
|
*
|
|
3183
3198
|
* - **ThreadSafety**: Unsafe
|
|
3184
3199
|
* - **Tags**: Yields
|
|
@@ -3806,30 +3821,48 @@ interface AnimationNodeDefinition extends Instance {
|
|
|
3806
3821
|
*/
|
|
3807
3822
|
NodeType: Enum.AnimationNodeType;
|
|
3808
3823
|
/**
|
|
3824
|
+
* Appends a named input pin to the end of the ordered input pin list.
|
|
3825
|
+
*
|
|
3809
3826
|
* - **ThreadSafety**: Unsafe
|
|
3810
3827
|
*
|
|
3811
3828
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AnimationNodeDefinition#AddInputPin)
|
|
3829
|
+
* @param this
|
|
3830
|
+
* @param pin Name of the input pin to append. Should match the `Name` of the corresponding `ObjectValue` wiring child.
|
|
3812
3831
|
*/
|
|
3813
3832
|
AddInputPin(this: AnimationNodeDefinition, pin: string): void;
|
|
3814
3833
|
/**
|
|
3834
|
+
* Returns the current ordered list of input pin names.
|
|
3835
|
+
*
|
|
3815
3836
|
* - **ThreadSafety**: Unsafe
|
|
3816
3837
|
*
|
|
3817
3838
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AnimationNodeDefinition#GetOrderedInputPinNames)
|
|
3839
|
+
* @param this
|
|
3840
|
+
* @returns The ordered list of input pin names.
|
|
3818
3841
|
*/
|
|
3819
3842
|
GetOrderedInputPinNames(this: AnimationNodeDefinition): Array<unknown>;
|
|
3820
3843
|
/**
|
|
3844
|
+
* Removes the first input pin matching the given name from the ordered pin list.
|
|
3845
|
+
*
|
|
3821
3846
|
* - **ThreadSafety**: Unsafe
|
|
3822
3847
|
*
|
|
3823
3848
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AnimationNodeDefinition#RemoveInputPin)
|
|
3849
|
+
* @param this
|
|
3850
|
+
* @param pin Name of the input pin to remove. Only the first pin matching this name is removed.
|
|
3824
3851
|
*/
|
|
3825
3852
|
RemoveInputPin(this: AnimationNodeDefinition, pin: string): void;
|
|
3826
3853
|
/**
|
|
3854
|
+
* Bulk-replaces the entire ordered input pin list.
|
|
3855
|
+
*
|
|
3827
3856
|
* - **ThreadSafety**: Unsafe
|
|
3828
3857
|
*
|
|
3829
3858
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AnimationNodeDefinition#SetOrderedInputPinNames)
|
|
3859
|
+
* @param this
|
|
3860
|
+
* @param pins The new ordered list of input pin names, replacing the existing list.
|
|
3830
3861
|
*/
|
|
3831
3862
|
SetOrderedInputPinNames(this: AnimationNodeDefinition, pins: Array<unknown>): void;
|
|
3832
3863
|
/**
|
|
3864
|
+
* Fires whenever the ordered input pin list is modified.
|
|
3865
|
+
*
|
|
3833
3866
|
* - **ThreadSafety**: Unsafe
|
|
3834
3867
|
*
|
|
3835
3868
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AnimationNodeDefinition#InputPinsChanged)
|
|
@@ -4614,6 +4647,13 @@ interface AssetService extends Instance {
|
|
|
4614
4647
|
* @returns A tuple containing an `CreateContentResult` indicating the success or failure of the request, and the resulting `DataModel`-scoped `Opaque` `Content`.
|
|
4615
4648
|
*/
|
|
4616
4649
|
CreateDataModelContentAsync(this: AssetService, content: Content, options?: object): unknown;
|
|
4650
|
+
/**
|
|
4651
|
+
* - **ThreadSafety**: Unsafe
|
|
4652
|
+
* - **Tags**: Yields
|
|
4653
|
+
*
|
|
4654
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AssetService#CreateDecalAsync)
|
|
4655
|
+
*/
|
|
4656
|
+
CreateDecalAsync(this: AssetService, content: object): Decal;
|
|
4617
4657
|
/**
|
|
4618
4658
|
* Creates a new `EditableImage` object populated with the given image.
|
|
4619
4659
|
*
|
|
@@ -4706,6 +4746,13 @@ interface AssetService extends Instance {
|
|
|
4706
4746
|
* @returns A new `SurfaceAppearance` instance with the given maps from the `content` parameter.
|
|
4707
4747
|
*/
|
|
4708
4748
|
CreateSurfaceAppearanceAsync(this: AssetService, content: object): SurfaceAppearance;
|
|
4749
|
+
/**
|
|
4750
|
+
* - **ThreadSafety**: Unsafe
|
|
4751
|
+
* - **Tags**: Yields
|
|
4752
|
+
*
|
|
4753
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AssetService#CreateTextureAsync)
|
|
4754
|
+
*/
|
|
4755
|
+
CreateTextureAsync(this: AssetService, content: object): Texture;
|
|
4709
4756
|
/**
|
|
4710
4757
|
* **Deprecated:** Use `GetAssetIdsForPackageAsync()` instead.
|
|
4711
4758
|
*
|
|
@@ -9293,10 +9340,16 @@ interface BadgeService extends Instance {
|
|
|
9293
9340
|
*/
|
|
9294
9341
|
GetBadgeInfoAsync(this: BadgeService, badgeId: number): BadgeInfo;
|
|
9295
9342
|
/**
|
|
9343
|
+
* Checks a list of badge IDs against a `User` and returns, for each badge the player owns, its ID and the date it was awarded.
|
|
9344
|
+
*
|
|
9296
9345
|
* - **ThreadSafety**: Unsafe
|
|
9297
9346
|
* - **Tags**: Yields
|
|
9298
9347
|
*
|
|
9299
9348
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/BadgeService#GetUserBadgesAsync)
|
|
9349
|
+
* @param this Provides information on badges and awards them.
|
|
9350
|
+
* @param userId The `User` of the player to check for ownership of the specified badges.
|
|
9351
|
+
* @param badgeIds The list of IDs of the badges to check ownership of. Maximum length of 100.
|
|
9352
|
+
* @returns A list of dictionaries, one for each badge the given user owns out of the provided badge IDs. Each dictionary contains a `BadgeId` and an `AwardedDate`. Empty if none of the provided badges are owned by the given user. Not guaranteed to be in the same order as the input list. Some badge IDs may be omitted if the user with the target `User` has not recently been in the server and the badge IDs are not associated with the requesting experience.
|
|
9300
9353
|
*/
|
|
9301
9354
|
GetUserBadgesAsync(this: BadgeService, userId: User, badgeIds: Array<unknown>): Array<unknown>;
|
|
9302
9355
|
/**
|
|
@@ -12925,17 +12978,19 @@ interface CommerceService extends Instance {
|
|
|
12925
12978
|
*
|
|
12926
12979
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CommerceService#PromptCommerceProductPurchase)
|
|
12927
12980
|
* @param this Supports real-world purchases that you can bundle with digital benefits.
|
|
12928
|
-
* @param user
|
|
12929
|
-
* @param commerceProductId
|
|
12981
|
+
* @param user The `Player` to prompt with the purchase flow. When called from a `LocalScript`, this must be the local player.
|
|
12982
|
+
* @param commerceProductId The identifier of the commerce product to purchase, either the numeric ID or the full `COM-`-prefixed form.
|
|
12930
12983
|
*/
|
|
12931
12984
|
PromptCommerceProductPurchase(this: CommerceService, user: Player, commerceProductId: string): void;
|
|
12932
12985
|
/**
|
|
12986
|
+
* Legacy endpoint that opens an in-experience browser to a real-world commerce URL for the specified player; superseded by `CommerceService:PromptCommerceProductPurchase()`.
|
|
12987
|
+
*
|
|
12933
12988
|
* - **ThreadSafety**: Unsafe
|
|
12934
12989
|
*
|
|
12935
12990
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CommerceService#PromptRealWorldCommerceBrowser)
|
|
12936
12991
|
* @param this Supports real-world purchases that you can bundle with digital benefits.
|
|
12937
|
-
* @param player
|
|
12938
|
-
* @param url
|
|
12992
|
+
* @param player The `Player` for whom the browser opens. When called from a `LocalScript`, this must be the local player.
|
|
12993
|
+
* @param url The real-world commerce URL to open. The URL must be on the commerce allowlist, or the request is ignored.
|
|
12939
12994
|
*/
|
|
12940
12995
|
PromptRealWorldCommerceBrowser(this: CommerceService, player: Player, url: string): void;
|
|
12941
12996
|
/**
|
|
@@ -12946,15 +13001,19 @@ interface CommerceService extends Instance {
|
|
|
12946
13001
|
*
|
|
12947
13002
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CommerceService#GetCommerceProductInfoAsync)
|
|
12948
13003
|
* @param this Supports real-world purchases that you can bundle with digital benefits.
|
|
12949
|
-
* @param commerceProductId
|
|
13004
|
+
* @param commerceProductId The identifier of the commerce product to look up, either the numeric ID or the full `COM-`-prefixed form.
|
|
13005
|
+
* @returns A dictionary of information about the commerce product, including whether it `IsForSale`, an `Item` sub-table of display details (`Name`, `Description`, `IconImageAssetId`, `DisplayPrice`, and `IsPurchasable`), and the `Benefits` granted by purchasing it.
|
|
12950
13006
|
*/
|
|
12951
13007
|
GetCommerceProductInfoAsync(this: CommerceService, commerceProductId: string): object;
|
|
12952
13008
|
/**
|
|
13009
|
+
* Legacy endpoint that returns whether the current user is eligible for real-world commerce; superseded by `PolicyService`.
|
|
13010
|
+
*
|
|
12953
13011
|
* - **ThreadSafety**: Unsafe
|
|
12954
13012
|
* - **Tags**: Yields
|
|
12955
13013
|
*
|
|
12956
13014
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CommerceService#UserEligibleForRealWorldCommerceAsync)
|
|
12957
13015
|
* @param this Supports real-world purchases that you can bundle with digital benefits.
|
|
13016
|
+
* @returns `true` if the current user is eligible for real-world commerce.
|
|
12958
13017
|
*/
|
|
12959
13018
|
UserEligibleForRealWorldCommerceAsync(this: CommerceService): boolean;
|
|
12960
13019
|
/**
|
|
@@ -17945,6 +18004,24 @@ interface Decal extends FaceInstance {
|
|
|
17945
18004
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Decal#ColorMapContent)
|
|
17946
18005
|
*/
|
|
17947
18006
|
ColorMapContent: Content;
|
|
18007
|
+
/**
|
|
18008
|
+
* - **ThreadSafety**: ReadSafe
|
|
18009
|
+
*
|
|
18010
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Decal#EmissiveMaskContent)
|
|
18011
|
+
*/
|
|
18012
|
+
get EmissiveMaskContent(): Content;
|
|
18013
|
+
/**
|
|
18014
|
+
* - **ThreadSafety**: ReadSafe
|
|
18015
|
+
*
|
|
18016
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Decal#EmissiveStrength)
|
|
18017
|
+
*/
|
|
18018
|
+
EmissiveStrength: number;
|
|
18019
|
+
/**
|
|
18020
|
+
* - **ThreadSafety**: ReadSafe
|
|
18021
|
+
*
|
|
18022
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Decal#EmissiveTint)
|
|
18023
|
+
*/
|
|
18024
|
+
EmissiveTint: Color3;
|
|
17948
18025
|
/**
|
|
17949
18026
|
* Acts as a multiplier for the decal's `Transparency` property. The effects are only visible to the local player.
|
|
17950
18027
|
*
|
|
@@ -22274,6 +22351,8 @@ interface SurfaceGuiBase extends LayerCollector {
|
|
|
22274
22351
|
Face: Enum.NormalId;
|
|
22275
22352
|
}
|
|
22276
22353
|
/**
|
|
22354
|
+
* A surface-based GUI that displays immersive ads on a face of a `Part` in the 3D world.
|
|
22355
|
+
*
|
|
22277
22356
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AdGui)
|
|
22278
22357
|
*/
|
|
22279
22358
|
interface AdGui extends SurfaceGuiBase {
|
|
@@ -22286,6 +22365,8 @@ interface AdGui extends SurfaceGuiBase {
|
|
|
22286
22365
|
*/
|
|
22287
22366
|
readonly _nominal_AdGui: unique symbol;
|
|
22288
22367
|
/**
|
|
22368
|
+
* Determines the shape of the ad displayed by the `AdGui`.
|
|
22369
|
+
*
|
|
22289
22370
|
* - **ThreadSafety**: ReadSafe
|
|
22290
22371
|
*
|
|
22291
22372
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AdGui#AdShape)
|
|
@@ -22300,18 +22381,24 @@ interface AdGui extends SurfaceGuiBase {
|
|
|
22300
22381
|
*/
|
|
22301
22382
|
EnableVideoAds: boolean;
|
|
22302
22383
|
/**
|
|
22384
|
+
* The image the `AdGui` displays when no ad is available to serve.
|
|
22385
|
+
*
|
|
22303
22386
|
* - **ThreadSafety**: ReadSafe
|
|
22304
22387
|
*
|
|
22305
22388
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AdGui#FallbackImage)
|
|
22306
22389
|
*/
|
|
22307
22390
|
FallbackImage: ContentId;
|
|
22308
22391
|
/**
|
|
22392
|
+
* The `Content` equivalent of `AdGui.FallbackImage` that supports asset URIs and `EditableImage` objects.
|
|
22393
|
+
*
|
|
22309
22394
|
* - **ThreadSafety**: ReadSafe
|
|
22310
22395
|
*
|
|
22311
22396
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AdGui#FallbackImageContent)
|
|
22312
22397
|
*/
|
|
22313
22398
|
FallbackImageContent: Content;
|
|
22314
22399
|
/**
|
|
22400
|
+
* Indicates whether the `AdGui` is currently displaying a served ad.
|
|
22401
|
+
*
|
|
22315
22402
|
* - **ThreadSafety**: ReadSafe
|
|
22316
22403
|
* - **Tags**: NotReplicated
|
|
22317
22404
|
*
|
|
@@ -33426,7 +33513,7 @@ interface Terrain extends BasePart {
|
|
|
33426
33513
|
/**
|
|
33427
33514
|
* Abstract intermediate class that manages physical geometry properties for PartOperations and MeshParts.
|
|
33428
33515
|
*
|
|
33429
|
-
* - **Tags**: NotCreatable
|
|
33516
|
+
* - **Tags**: NotCreatable, NotBrowsable
|
|
33430
33517
|
*
|
|
33431
33518
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TriangleMeshPart)
|
|
33432
33519
|
*/
|
|
@@ -33448,6 +33535,13 @@ interface TriangleMeshPart extends BasePart {
|
|
|
33448
33535
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TriangleMeshPart#CollisionFidelity)
|
|
33449
33536
|
*/
|
|
33450
33537
|
get CollisionFidelity(): Enum.CollisionFidelity;
|
|
33538
|
+
/**
|
|
33539
|
+
* - **ThreadSafety**: ReadSafe
|
|
33540
|
+
* - **Tags**: NotReplicated
|
|
33541
|
+
*
|
|
33542
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TriangleMeshPart#CollisionPrecision)
|
|
33543
|
+
*/
|
|
33544
|
+
get CollisionPrecision(): number;
|
|
33451
33545
|
/**
|
|
33452
33546
|
* Determines the geometric representation used to compute aerodynamic forces and torques.
|
|
33453
33547
|
*
|
|
@@ -41711,6 +41805,12 @@ interface DataModel extends ServiceProvider<Services> {
|
|
|
41711
41805
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DataModel#ServerLifecycleChanged)
|
|
41712
41806
|
*/
|
|
41713
41807
|
readonly ServerLifecycleChanged: RBXScriptSignal<(serverLifecycleChangedEvent: object) => void>;
|
|
41808
|
+
/**
|
|
41809
|
+
* - **ThreadSafety**: Unsafe
|
|
41810
|
+
*
|
|
41811
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DataModel#ServerLowMemoryWarning)
|
|
41812
|
+
*/
|
|
41813
|
+
readonly ServerLowMemoryWarning: RBXScriptSignal<() => void>;
|
|
41714
41814
|
/**
|
|
41715
41815
|
* Fires on the server when the server has been scheduled to restart. Provides the scheduled restart time, source, and custom attributes.
|
|
41716
41816
|
*
|
|
@@ -43839,6 +43939,36 @@ interface StartupMessageService extends Instance {
|
|
|
43839
43939
|
*/
|
|
43840
43940
|
readonly _nominal_StartupMessageService: unique symbol;
|
|
43841
43941
|
}
|
|
43942
|
+
/**
|
|
43943
|
+
* - **Tags**: NotReplicated
|
|
43944
|
+
*
|
|
43945
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StateMachineDefinition)
|
|
43946
|
+
*/
|
|
43947
|
+
interface StateMachineDefinition extends Instance {
|
|
43948
|
+
/**
|
|
43949
|
+
* **DO NOT USE!**
|
|
43950
|
+
*
|
|
43951
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
43952
|
+
* @hidden
|
|
43953
|
+
* @deprecated
|
|
43954
|
+
*/
|
|
43955
|
+
readonly _nominal_StateMachineDefinition: unique symbol;
|
|
43956
|
+
}
|
|
43957
|
+
/**
|
|
43958
|
+
* - **Tags**: NotReplicated
|
|
43959
|
+
*
|
|
43960
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StateMachineTransitionDefinition)
|
|
43961
|
+
*/
|
|
43962
|
+
interface StateMachineTransitionDefinition extends Instance {
|
|
43963
|
+
/**
|
|
43964
|
+
* **DO NOT USE!**
|
|
43965
|
+
*
|
|
43966
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
43967
|
+
* @hidden
|
|
43968
|
+
* @deprecated
|
|
43969
|
+
*/
|
|
43970
|
+
readonly _nominal_StateMachineTransitionDefinition: unique symbol;
|
|
43971
|
+
}
|
|
43842
43972
|
/**
|
|
43843
43973
|
* Performance metrics for a game.
|
|
43844
43974
|
*
|
|
@@ -45306,6 +45436,8 @@ interface TeleportService extends Instance {
|
|
|
45306
45436
|
*/
|
|
45307
45437
|
Teleport(this: TeleportService, placeId: number, player?: Player, teleportData?: TeleportData, customLoadingScreen?: ScreenGui): void;
|
|
45308
45438
|
/**
|
|
45439
|
+
* **Deprecated:** Use `TeleportAsync()` instead. For a migration guide, see [Teleport between places](../../../projects/teleport.md#migrate-to-secure-teleports).
|
|
45440
|
+
*
|
|
45309
45441
|
* Teleports a `Player` to the server instance associated with the given *placeId* and *instanceId*.
|
|
45310
45442
|
*
|
|
45311
45443
|
* - **ThreadSafety**: Unsafe
|
|
@@ -45324,6 +45456,8 @@ interface TeleportService extends Instance {
|
|
|
45324
45456
|
*/
|
|
45325
45457
|
TeleportToPlaceInstance(this: TeleportService, placeId: number, instanceId: string, player?: Player, spawnName?: string, teleportData?: TeleportData, customLoadingScreen?: ScreenGui): void;
|
|
45326
45458
|
/**
|
|
45459
|
+
* **Deprecated:** Use `TeleportAsync()` instead. For a migration guide, see [Teleport between places](../../../projects/teleport.md#migrate-to-secure-teleports).
|
|
45460
|
+
*
|
|
45327
45461
|
* Teleport a group of `Players` to a reserved server created using `TeleportService:ReserveServerAsync()`.
|
|
45328
45462
|
*
|
|
45329
45463
|
* - **ThreadSafety**: Unsafe
|
|
@@ -45342,6 +45476,8 @@ interface TeleportService extends Instance {
|
|
|
45342
45476
|
*/
|
|
45343
45477
|
TeleportToPrivateServer(this: TeleportService, placeId: number, reservedServerAccessCode: string, players: Array<Player>, spawnName?: string, teleportData?: TeleportData, customLoadingScreen?: ScreenGui): void;
|
|
45344
45478
|
/**
|
|
45479
|
+
* **Deprecated:** Use `TeleportAsync()` instead. For a migration guide, see [Teleport between places](../../../projects/teleport.md#migrate-to-secure-teleports).
|
|
45480
|
+
*
|
|
45345
45481
|
* A variant of `TeleportService:Teleport()` that causes the `Player` to spawn at a `SpawnLocation` of the given name at the destination place.
|
|
45346
45482
|
*
|
|
45347
45483
|
* - **ThreadSafety**: Unsafe
|
|
@@ -45434,6 +45570,8 @@ interface TeleportService extends Instance {
|
|
|
45434
45570
|
*/
|
|
45435
45571
|
TeleportAsync(this: TeleportService, placeId: number, players: ReadonlyArray<Player>, options?: TeleportOptions): TeleportAsyncResult;
|
|
45436
45572
|
/**
|
|
45573
|
+
* **Deprecated:** Use `TeleportAsync()` instead. For a migration guide, see [Teleport between places](../../../projects/teleport.md#migrate-to-secure-teleports).
|
|
45574
|
+
*
|
|
45437
45575
|
* Teleports a group of `Players` to the same server of the place with the given `PlaceId`, returning the `JobId` of the server instance they were teleported to.
|
|
45438
45576
|
*
|
|
45439
45577
|
* - **ThreadSafety**: Unsafe
|
|
@@ -45900,6 +46038,24 @@ interface TestService extends Instance {
|
|
|
45900
46038
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TestService#SetTestControl)
|
|
45901
46039
|
*/
|
|
45902
46040
|
SetTestControl(this: TestService, providerName: string, controlName: string, value: unknown): void;
|
|
46041
|
+
/**
|
|
46042
|
+
* - **ThreadSafety**: Unsafe
|
|
46043
|
+
*
|
|
46044
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TestService#SignalProfilingCapture)
|
|
46045
|
+
*/
|
|
46046
|
+
SignalProfilingCapture(this: TestService, target?: string, options?: object): void;
|
|
46047
|
+
/**
|
|
46048
|
+
* - **ThreadSafety**: Unsafe
|
|
46049
|
+
*
|
|
46050
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TestService#SignalProfilingStart)
|
|
46051
|
+
*/
|
|
46052
|
+
SignalProfilingStart(this: TestService, target?: string, options?: object): void;
|
|
46053
|
+
/**
|
|
46054
|
+
* - **ThreadSafety**: Unsafe
|
|
46055
|
+
*
|
|
46056
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TestService#SignalProfilingStop)
|
|
46057
|
+
*/
|
|
46058
|
+
SignalProfilingStop(this: TestService, target?: string): void;
|
|
45903
46059
|
/**
|
|
45904
46060
|
* - **ThreadSafety**: Unsafe
|
|
45905
46061
|
*
|
|
@@ -45973,7 +46129,7 @@ interface TestService extends Instance {
|
|
|
45973
46129
|
*
|
|
45974
46130
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TestService#RequestValidationAsync)
|
|
45975
46131
|
*/
|
|
45976
|
-
RequestValidationAsync(this: TestService,
|
|
46132
|
+
RequestValidationAsync(this: TestService, module: string, artifactName: string, options: unknown): unknown;
|
|
45977
46133
|
/**
|
|
45978
46134
|
* - **ThreadSafety**: Unsafe
|
|
45979
46135
|
* - **Tags**: Yields
|
|
@@ -51453,6 +51609,8 @@ interface VideoService extends Instance {
|
|
|
51453
51609
|
CreateVideoSamplerAsync(this: VideoService, content: Content, options?: object): VideoSampler;
|
|
51454
51610
|
}
|
|
51455
51611
|
/**
|
|
51612
|
+
* Service that schedules and runs viewability checks for immersive ad instances in a place.
|
|
51613
|
+
*
|
|
51456
51614
|
* - **Tags**: NotCreatable, Service
|
|
51457
51615
|
*
|
|
51458
51616
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VisibilityCheckDispatcher)
|
|
@@ -539,6 +539,8 @@ interface CreatableInstances {
|
|
|
539
539
|
SpotLight: SpotLight;
|
|
540
540
|
SpringConstraint: SpringConstraint;
|
|
541
541
|
StarterGear: StarterGear;
|
|
542
|
+
StateMachineDefinition: StateMachineDefinition;
|
|
543
|
+
StateMachineTransitionDefinition: StateMachineTransitionDefinition;
|
|
542
544
|
StringValue: StringValue;
|
|
543
545
|
StudioAttachment: StudioAttachment;
|
|
544
546
|
StudioCallout: StudioCallout;
|
|
@@ -1163,6 +1165,8 @@ interface ActivityHistoryEventService extends Instance {
|
|
|
1163
1165
|
readonly _nominal_ActivityHistoryEventService: unique symbol;
|
|
1164
1166
|
}
|
|
1165
1167
|
/**
|
|
1168
|
+
* A portal that teleports players to a sponsored experience as part of immersive ads.
|
|
1169
|
+
*
|
|
1166
1170
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AdPortal)
|
|
1167
1171
|
*/
|
|
1168
1172
|
interface AdPortal extends Instance {
|
|
@@ -5807,6 +5811,12 @@ interface Decal extends FaceInstance {
|
|
|
5807
5811
|
* @deprecated
|
|
5808
5812
|
*/
|
|
5809
5813
|
readonly _nominal_Decal: unique symbol;
|
|
5814
|
+
/**
|
|
5815
|
+
* - **ThreadSafety**: ReadSafe
|
|
5816
|
+
*
|
|
5817
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Decal#EmissiveMaskContent)
|
|
5818
|
+
*/
|
|
5819
|
+
set EmissiveMaskContent(value: Content);
|
|
5810
5820
|
/**
|
|
5811
5821
|
* - **ThreadSafety**: ReadSafe
|
|
5812
5822
|
* - **Tags**: Hidden
|
|
@@ -6862,6 +6872,8 @@ interface SurfaceGuiBase extends LayerCollector {
|
|
|
6862
6872
|
readonly _nominal_SurfaceGuiBase: unique symbol;
|
|
6863
6873
|
}
|
|
6864
6874
|
/**
|
|
6875
|
+
* A surface-based GUI that displays immersive ads on a face of a `Part` in the 3D world.
|
|
6876
|
+
*
|
|
6865
6877
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AdGui)
|
|
6866
6878
|
*/
|
|
6867
6879
|
interface AdGui extends SurfaceGuiBase {
|
|
@@ -9688,7 +9700,7 @@ interface Terrain extends BasePart {
|
|
|
9688
9700
|
/**
|
|
9689
9701
|
* Abstract intermediate class that manages physical geometry properties for PartOperations and MeshParts.
|
|
9690
9702
|
*
|
|
9691
|
-
* - **Tags**: NotCreatable
|
|
9703
|
+
* - **Tags**: NotCreatable, NotBrowsable
|
|
9692
9704
|
*
|
|
9693
9705
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TriangleMeshPart)
|
|
9694
9706
|
*/
|
|
@@ -9710,6 +9722,13 @@ interface TriangleMeshPart extends BasePart {
|
|
|
9710
9722
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TriangleMeshPart#CollisionFidelity)
|
|
9711
9723
|
*/
|
|
9712
9724
|
set CollisionFidelity(value: Enum.CollisionFidelity);
|
|
9725
|
+
/**
|
|
9726
|
+
* - **ThreadSafety**: ReadSafe
|
|
9727
|
+
* - **Tags**: NotReplicated
|
|
9728
|
+
*
|
|
9729
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TriangleMeshPart#CollisionPrecision)
|
|
9730
|
+
*/
|
|
9731
|
+
set CollisionPrecision(value: number);
|
|
9713
9732
|
/**
|
|
9714
9733
|
* Determines the geometric representation used to compute aerodynamic forces and torques.
|
|
9715
9734
|
*
|
|
@@ -14710,6 +14729,36 @@ interface StartupMessageService extends Instance {
|
|
|
14710
14729
|
*/
|
|
14711
14730
|
readonly _nominal_StartupMessageService: unique symbol;
|
|
14712
14731
|
}
|
|
14732
|
+
/**
|
|
14733
|
+
* - **Tags**: NotReplicated
|
|
14734
|
+
*
|
|
14735
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StateMachineDefinition)
|
|
14736
|
+
*/
|
|
14737
|
+
interface StateMachineDefinition extends Instance {
|
|
14738
|
+
/**
|
|
14739
|
+
* **DO NOT USE!**
|
|
14740
|
+
*
|
|
14741
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
14742
|
+
* @hidden
|
|
14743
|
+
* @deprecated
|
|
14744
|
+
*/
|
|
14745
|
+
readonly _nominal_StateMachineDefinition: unique symbol;
|
|
14746
|
+
}
|
|
14747
|
+
/**
|
|
14748
|
+
* - **Tags**: NotReplicated
|
|
14749
|
+
*
|
|
14750
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StateMachineTransitionDefinition)
|
|
14751
|
+
*/
|
|
14752
|
+
interface StateMachineTransitionDefinition extends Instance {
|
|
14753
|
+
/**
|
|
14754
|
+
* **DO NOT USE!**
|
|
14755
|
+
*
|
|
14756
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
14757
|
+
* @hidden
|
|
14758
|
+
* @deprecated
|
|
14759
|
+
*/
|
|
14760
|
+
readonly _nominal_StateMachineTransitionDefinition: unique symbol;
|
|
14761
|
+
}
|
|
14713
14762
|
/**
|
|
14714
14763
|
* Performance metrics for a game.
|
|
14715
14764
|
*
|
|
@@ -18393,6 +18442,8 @@ interface VideoService extends Instance {
|
|
|
18393
18442
|
readonly _nominal_VideoService: unique symbol;
|
|
18394
18443
|
}
|
|
18395
18444
|
/**
|
|
18445
|
+
* Service that schedules and runs viewability checks for immersive ad instances in a place.
|
|
18446
|
+
*
|
|
18396
18447
|
* - **Tags**: NotCreatable, Service
|
|
18397
18448
|
*
|
|
18398
18449
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VisibilityCheckDispatcher)
|
|
@@ -588,6 +588,8 @@ declare namespace Enum {
|
|
|
588
588
|
}
|
|
589
589
|
export type ActuatorType = ActuatorType.None | ActuatorType.Motor | ActuatorType.Servo;
|
|
590
590
|
/**
|
|
591
|
+
* Indicates whether an ad is available or the reason it cannot be shown.
|
|
592
|
+
*
|
|
591
593
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AdAvailabilityResult)
|
|
592
594
|
*/
|
|
593
595
|
export namespace AdAvailabilityResult {
|
|
@@ -749,11 +751,13 @@ declare namespace Enum {
|
|
|
749
751
|
}
|
|
750
752
|
export type AdEventType = AdEventType.VideoLoaded | AdEventType.VideoRemoved | AdEventType.UserCompletedVideo | AdEventType.RewardedAdLoaded | AdEventType.RewardedAdGrant | AdEventType.RewardedAdUnloaded;
|
|
751
753
|
/**
|
|
754
|
+
* Specifies the format of an ad used with `AdService` methods.
|
|
755
|
+
*
|
|
752
756
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AdFormat)
|
|
753
757
|
*/
|
|
754
758
|
export namespace AdFormat {
|
|
755
759
|
/**
|
|
756
|
-
*
|
|
760
|
+
* A full-screen video ad that plays to completion and rewards the viewer, used as the `adFormat` argument for `AdService` methods.
|
|
757
761
|
*
|
|
758
762
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AdFormat#RewardedVideo)
|
|
759
763
|
*/
|
|
@@ -791,10 +795,14 @@ declare namespace Enum {
|
|
|
791
795
|
}
|
|
792
796
|
export type AdShape = AdShape.HorizontalRectangle;
|
|
793
797
|
/**
|
|
798
|
+
* Describes the method by which a player teleports during an immersive ad portal flow.
|
|
799
|
+
*
|
|
794
800
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AdTeleportMethod)
|
|
795
801
|
*/
|
|
796
802
|
export namespace AdTeleportMethod {
|
|
797
803
|
/**
|
|
804
|
+
* Default uninitialized sentinel value indicating that no teleport method has been determined yet.
|
|
805
|
+
*
|
|
798
806
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AdTeleportMethod#Undefined)
|
|
799
807
|
*/
|
|
800
808
|
export interface Undefined extends globalThis.EnumItem {
|
|
@@ -804,6 +812,8 @@ declare namespace Enum {
|
|
|
804
812
|
}
|
|
805
813
|
export const Undefined: Undefined;
|
|
806
814
|
/**
|
|
815
|
+
* The player teleported forward to the advertiser's destination experience by walking into an `AdPortal`.
|
|
816
|
+
*
|
|
807
817
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AdTeleportMethod#PortalForward)
|
|
808
818
|
*/
|
|
809
819
|
export interface PortalForward extends globalThis.EnumItem {
|
|
@@ -813,6 +823,8 @@ declare namespace Enum {
|
|
|
813
823
|
}
|
|
814
824
|
export const PortalForward: PortalForward;
|
|
815
825
|
/**
|
|
826
|
+
* The player initiated a return teleport to the publisher's experience by pressing the back button in the in-game menu.
|
|
827
|
+
*
|
|
816
828
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AdTeleportMethod#InGameMenuBackButton)
|
|
817
829
|
*/
|
|
818
830
|
export interface InGameMenuBackButton extends globalThis.EnumItem {
|
|
@@ -822,6 +834,8 @@ declare namespace Enum {
|
|
|
822
834
|
}
|
|
823
835
|
export const InGameMenuBackButton: InGameMenuBackButton;
|
|
824
836
|
/**
|
|
837
|
+
* The player initiated a return teleport to the publisher's experience by pressing a back button rendered in the ad destination's UI overlay.
|
|
838
|
+
*
|
|
825
839
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AdTeleportMethod#UIBackButton)
|
|
826
840
|
*/
|
|
827
841
|
export interface UIBackButton extends globalThis.EnumItem {
|
|
@@ -836,10 +850,14 @@ declare namespace Enum {
|
|
|
836
850
|
}
|
|
837
851
|
export type AdTeleportMethod = AdTeleportMethod.Undefined | AdTeleportMethod.PortalForward | AdTeleportMethod.InGameMenuBackButton | AdTeleportMethod.UIBackButton;
|
|
838
852
|
/**
|
|
853
|
+
* Describes the type of user-interaction or system event that occurred on the immersive ad UI overlay of an `AdGui`.
|
|
854
|
+
*
|
|
839
855
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AdUIEventType)
|
|
840
856
|
*/
|
|
841
857
|
export namespace AdUIEventType {
|
|
842
858
|
/**
|
|
859
|
+
* The player clicked the "Sponsored" label on the ad overlay, which opens the ad disclosure prompt showing advertiser and payer information.
|
|
860
|
+
*
|
|
843
861
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AdUIEventType#AdLabelClicked)
|
|
844
862
|
*/
|
|
845
863
|
export interface AdLabelClicked extends globalThis.EnumItem {
|
|
@@ -849,6 +867,8 @@ declare namespace Enum {
|
|
|
849
867
|
}
|
|
850
868
|
export const AdLabelClicked: AdLabelClicked;
|
|
851
869
|
/**
|
|
870
|
+
* The player clicked the volume toggle button on the ad overlay, which mutes or unmutes the video ad audio.
|
|
871
|
+
*
|
|
852
872
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AdUIEventType#VolumeButtonClicked)
|
|
853
873
|
*/
|
|
854
874
|
export interface VolumeButtonClicked extends globalThis.EnumItem {
|
|
@@ -858,6 +878,8 @@ declare namespace Enum {
|
|
|
858
878
|
}
|
|
859
879
|
export const VolumeButtonClicked: VolumeButtonClicked;
|
|
860
880
|
/**
|
|
881
|
+
* The player clicked the fullscreen toggle button, which smoothly zooms the camera to a centered view of the ad surface and enables audio.
|
|
882
|
+
*
|
|
861
883
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AdUIEventType#FullscreenButtonClicked)
|
|
862
884
|
*/
|
|
863
885
|
export interface FullscreenButtonClicked extends globalThis.EnumItem {
|
|
@@ -867,6 +889,8 @@ declare namespace Enum {
|
|
|
867
889
|
}
|
|
868
890
|
export const FullscreenButtonClicked: FullscreenButtonClicked;
|
|
869
891
|
/**
|
|
892
|
+
* The player clicked the play button on the ad overlay. If the ad is already in fullscreen, playback resumes; otherwise it enters fullscreen mode which also starts (or resumes) the video.
|
|
893
|
+
*
|
|
870
894
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AdUIEventType#PlayButtonClicked)
|
|
871
895
|
*/
|
|
872
896
|
export interface PlayButtonClicked extends globalThis.EnumItem {
|
|
@@ -876,6 +900,8 @@ declare namespace Enum {
|
|
|
876
900
|
}
|
|
877
901
|
export const PlayButtonClicked: PlayButtonClicked;
|
|
878
902
|
/**
|
|
903
|
+
* The player clicked the pause button while a video ad is playing in fullscreen mode, which pauses video playback.
|
|
904
|
+
*
|
|
879
905
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AdUIEventType#PauseButtonClicked)
|
|
880
906
|
*/
|
|
881
907
|
export interface PauseButtonClicked extends globalThis.EnumItem {
|
|
@@ -885,6 +911,8 @@ declare namespace Enum {
|
|
|
885
911
|
}
|
|
886
912
|
export const PauseButtonClicked: PauseButtonClicked;
|
|
887
913
|
/**
|
|
914
|
+
* The player clicked the close button on the fullscreen video ad view, which exits fullscreen mode and returns to the normal camera position.
|
|
915
|
+
*
|
|
888
916
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AdUIEventType#CloseButtonClicked)
|
|
889
917
|
*/
|
|
890
918
|
export interface CloseButtonClicked extends globalThis.EnumItem {
|
|
@@ -894,6 +922,8 @@ declare namespace Enum {
|
|
|
894
922
|
}
|
|
895
923
|
export const CloseButtonClicked: CloseButtonClicked;
|
|
896
924
|
/**
|
|
925
|
+
* The player clicked the "Why this ad?" link, which displays the EUDSA (European Digital Services Act) disclosure prompt showing the advertiser and payer names for the current ad creative.
|
|
926
|
+
*
|
|
897
927
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AdUIEventType#WhyThisAdClicked)
|
|
898
928
|
*/
|
|
899
929
|
export interface WhyThisAdClicked extends globalThis.EnumItem {
|
|
@@ -903,6 +933,8 @@ declare namespace Enum {
|
|
|
903
933
|
}
|
|
904
934
|
export const WhyThisAdClicked: WhyThisAdClicked;
|
|
905
935
|
/**
|
|
936
|
+
* A system-initiated play/resume event that clears the force-pause state set by `PauseEventTriggered` and resumes video playback if the stream is open.
|
|
937
|
+
*
|
|
906
938
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AdUIEventType#PlayEventTriggered)
|
|
907
939
|
*/
|
|
908
940
|
export interface PlayEventTriggered extends globalThis.EnumItem {
|
|
@@ -912,6 +944,8 @@ declare namespace Enum {
|
|
|
912
944
|
}
|
|
913
945
|
export const PlayEventTriggered: PlayEventTriggered;
|
|
914
946
|
/**
|
|
947
|
+
* A system-initiated pause event, used when the engine needs to force-pause the video (for example, when a dropdown menu opens over the ad). Prevents viewability-based auto-play from resuming playback until a corresponding `PlayEventTriggered` clears that pause.
|
|
948
|
+
*
|
|
915
949
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AdUIEventType#PauseEventTriggered)
|
|
916
950
|
*/
|
|
917
951
|
export interface PauseEventTriggered extends globalThis.EnumItem {
|
|
@@ -926,10 +960,14 @@ declare namespace Enum {
|
|
|
926
960
|
}
|
|
927
961
|
export type AdUIEventType = AdUIEventType.AdLabelClicked | AdUIEventType.VolumeButtonClicked | AdUIEventType.FullscreenButtonClicked | AdUIEventType.PlayButtonClicked | AdUIEventType.PauseButtonClicked | AdUIEventType.CloseButtonClicked | AdUIEventType.WhyThisAdClicked | AdUIEventType.PlayEventTriggered | AdUIEventType.PauseEventTriggered;
|
|
928
962
|
/**
|
|
963
|
+
* Describes the type of ad creative currently rendered by an `AdGui`.
|
|
964
|
+
*
|
|
929
965
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AdUIType)
|
|
930
966
|
*/
|
|
931
967
|
export namespace AdUIType {
|
|
932
968
|
/**
|
|
969
|
+
* The `AdGui` has no ad creative loaded and is not rendering ad content.
|
|
970
|
+
*
|
|
933
971
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AdUIType#None)
|
|
934
972
|
*/
|
|
935
973
|
export interface None extends globalThis.EnumItem {
|
|
@@ -939,6 +977,8 @@ declare namespace Enum {
|
|
|
939
977
|
}
|
|
940
978
|
export const None: None;
|
|
941
979
|
/**
|
|
980
|
+
* The `AdGui` is rendering a static image ad creative.
|
|
981
|
+
*
|
|
942
982
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AdUIType#Image)
|
|
943
983
|
*/
|
|
944
984
|
export interface Image extends globalThis.EnumItem {
|
|
@@ -948,6 +988,8 @@ declare namespace Enum {
|
|
|
948
988
|
}
|
|
949
989
|
export const Image: Image;
|
|
950
990
|
/**
|
|
991
|
+
* The `AdGui` is rendering a video ad creative.
|
|
992
|
+
*
|
|
951
993
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AdUIType#Video)
|
|
952
994
|
*/
|
|
953
995
|
export interface Video extends globalThis.EnumItem {
|
|
@@ -1904,6 +1946,33 @@ declare namespace Enum {
|
|
|
1904
1946
|
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.AnimationNodeTransitionType | undefined;
|
|
1905
1947
|
}
|
|
1906
1948
|
export type AnimationNodeTransitionType = AnimationNodeTransitionType.CrossFade | AnimationNodeTransitionType.InertialBlend | AnimationNodeTransitionType.DeadBlend;
|
|
1949
|
+
/**
|
|
1950
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnimationNodeTransitionWhen)
|
|
1951
|
+
*/
|
|
1952
|
+
export namespace AnimationNodeTransitionWhen {
|
|
1953
|
+
/**
|
|
1954
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnimationNodeTransitionWhen#Finished)
|
|
1955
|
+
*/
|
|
1956
|
+
export interface Finished extends globalThis.EnumItem {
|
|
1957
|
+
Name: "Finished";
|
|
1958
|
+
Value: 0;
|
|
1959
|
+
EnumType: typeof globalThis.Enum.AnimationNodeTransitionWhen;
|
|
1960
|
+
}
|
|
1961
|
+
export const Finished: Finished;
|
|
1962
|
+
/**
|
|
1963
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnimationNodeTransitionWhen#BeforeFinished)
|
|
1964
|
+
*/
|
|
1965
|
+
export interface BeforeFinished extends globalThis.EnumItem {
|
|
1966
|
+
Name: "BeforeFinished";
|
|
1967
|
+
Value: 1;
|
|
1968
|
+
EnumType: typeof globalThis.Enum.AnimationNodeTransitionWhen;
|
|
1969
|
+
}
|
|
1970
|
+
export const BeforeFinished: BeforeFinished;
|
|
1971
|
+
export function GetEnumItems(this: globalThis.Enum): Array<globalThis.Enum.AnimationNodeTransitionWhen>;
|
|
1972
|
+
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.AnimationNodeTransitionWhen | undefined;
|
|
1973
|
+
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.AnimationNodeTransitionWhen | undefined;
|
|
1974
|
+
}
|
|
1975
|
+
export type AnimationNodeTransitionWhen = AnimationNodeTransitionWhen.Finished | AnimationNodeTransitionWhen.BeforeFinished;
|
|
1907
1976
|
/**
|
|
1908
1977
|
* Specifies the type of an animation graph node, determining how it processes or combines animation data.
|
|
1909
1978
|
*
|
|
@@ -8236,21 +8305,19 @@ declare namespace Enum {
|
|
|
8236
8305
|
}
|
|
8237
8306
|
export const PreciseConvexDecomposition: PreciseConvexDecomposition;
|
|
8238
8307
|
/**
|
|
8239
|
-
*
|
|
8240
|
-
*
|
|
8241
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CollisionFidelity#Scalable)
|
|
8308
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/CollisionFidelity#Tunable)
|
|
8242
8309
|
*/
|
|
8243
|
-
export interface
|
|
8244
|
-
Name: "
|
|
8310
|
+
export interface Tunable extends globalThis.EnumItem {
|
|
8311
|
+
Name: "Tunable";
|
|
8245
8312
|
Value: 4;
|
|
8246
8313
|
EnumType: typeof globalThis.Enum.CollisionFidelity;
|
|
8247
8314
|
}
|
|
8248
|
-
export const
|
|
8315
|
+
export const Tunable: Tunable;
|
|
8249
8316
|
export function GetEnumItems(this: globalThis.Enum): Array<globalThis.Enum.CollisionFidelity>;
|
|
8250
8317
|
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.CollisionFidelity | undefined;
|
|
8251
8318
|
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.CollisionFidelity | undefined;
|
|
8252
8319
|
}
|
|
8253
|
-
export type CollisionFidelity = CollisionFidelity.Default | CollisionFidelity.Hull | CollisionFidelity.Box | CollisionFidelity.PreciseConvexDecomposition | CollisionFidelity.
|
|
8320
|
+
export type CollisionFidelity = CollisionFidelity.Default | CollisionFidelity.Hull | CollisionFidelity.Box | CollisionFidelity.PreciseConvexDecomposition | CollisionFidelity.Tunable;
|
|
8254
8321
|
/**
|
|
8255
8322
|
* Specifies the minimum security permission level required to invoke a Studio command.
|
|
8256
8323
|
*
|
|
@@ -16599,11 +16666,20 @@ declare namespace Enum {
|
|
|
16599
16666
|
EnumType: typeof globalThis.Enum.GenerateMomentTextResult;
|
|
16600
16667
|
}
|
|
16601
16668
|
export const Failed: Failed;
|
|
16669
|
+
/**
|
|
16670
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/GenerateMomentTextResult#Filtered)
|
|
16671
|
+
*/
|
|
16672
|
+
export interface Filtered extends globalThis.EnumItem {
|
|
16673
|
+
Name: "Filtered";
|
|
16674
|
+
Value: 3;
|
|
16675
|
+
EnumType: typeof globalThis.Enum.GenerateMomentTextResult;
|
|
16676
|
+
}
|
|
16677
|
+
export const Filtered: Filtered;
|
|
16602
16678
|
export function GetEnumItems(this: globalThis.Enum): Array<globalThis.Enum.GenerateMomentTextResult>;
|
|
16603
16679
|
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.GenerateMomentTextResult | undefined;
|
|
16604
16680
|
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.GenerateMomentTextResult | undefined;
|
|
16605
16681
|
}
|
|
16606
|
-
export type GenerateMomentTextResult = GenerateMomentTextResult.Success | GenerateMomentTextResult.Pending | GenerateMomentTextResult.Failed;
|
|
16682
|
+
export type GenerateMomentTextResult = GenerateMomentTextResult.Success | GenerateMomentTextResult.Pending | GenerateMomentTextResult.Failed | GenerateMomentTextResult.Filtered;
|
|
16607
16683
|
/**
|
|
16608
16684
|
* **Deprecated:**
|
|
16609
16685
|
*
|
|
@@ -32982,10 +33058,14 @@ declare namespace Enum {
|
|
|
32982
33058
|
}
|
|
32983
33059
|
export type ScrollingDirection = ScrollingDirection.X | ScrollingDirection.Y | ScrollingDirection.XY;
|
|
32984
33060
|
/**
|
|
33061
|
+
* Identifies a specific permission capability that a sandboxed script container may grant or restrict.
|
|
33062
|
+
*
|
|
32985
33063
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/SecurityCapability)
|
|
32986
33064
|
*/
|
|
32987
33065
|
export namespace SecurityCapability {
|
|
32988
33066
|
/**
|
|
33067
|
+
* Indicates that a script container is permitted to execute scripts on the client (`LocalScript`).
|
|
33068
|
+
*
|
|
32989
33069
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/SecurityCapability#RunClientScript)
|
|
32990
33070
|
*/
|
|
32991
33071
|
export interface RunClientScript extends globalThis.EnumItem {
|
|
@@ -32995,6 +33075,8 @@ declare namespace Enum {
|
|
|
32995
33075
|
}
|
|
32996
33076
|
export const RunClientScript: RunClientScript;
|
|
32997
33077
|
/**
|
|
33078
|
+
* Indicates that a script container is permitted to execute scripts on the server (`Script`).
|
|
33079
|
+
*
|
|
32998
33080
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/SecurityCapability#RunServerScript)
|
|
32999
33081
|
*/
|
|
33000
33082
|
export interface RunServerScript extends globalThis.EnumItem {
|
|
@@ -33004,6 +33086,8 @@ declare namespace Enum {
|
|
|
33004
33086
|
}
|
|
33005
33087
|
export const RunServerScript: RunServerScript;
|
|
33006
33088
|
/**
|
|
33089
|
+
* Grants a script read-write access to instances that live outside its sandboxed container.
|
|
33090
|
+
*
|
|
33007
33091
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/SecurityCapability#AccessOutsideWrite)
|
|
33008
33092
|
*/
|
|
33009
33093
|
export interface AccessOutsideWrite extends globalThis.EnumItem {
|
|
@@ -33013,7 +33097,9 @@ declare namespace Enum {
|
|
|
33013
33097
|
}
|
|
33014
33098
|
export const AccessOutsideWrite: AccessOutsideWrite;
|
|
33015
33099
|
/**
|
|
33016
|
-
* **Deprecated:**
|
|
33100
|
+
* **Deprecated:** Use `SecurityCapability.LoadUnownedAsset` instead.
|
|
33101
|
+
*
|
|
33102
|
+
* Deprecated. Use `SecurityCapability.LoadUnownedAsset` instead.
|
|
33017
33103
|
*
|
|
33018
33104
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/SecurityCapability#AssetRequire)
|
|
33019
33105
|
*/
|
|
@@ -33024,6 +33110,8 @@ declare namespace Enum {
|
|
|
33024
33110
|
}
|
|
33025
33111
|
export const AssetRequire: AssetRequire;
|
|
33026
33112
|
/**
|
|
33113
|
+
* Allows a script to use the `loadstring()` Luau built-in to compile and execute a string as code.
|
|
33114
|
+
*
|
|
33027
33115
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/SecurityCapability#LoadString)
|
|
33028
33116
|
*/
|
|
33029
33117
|
export interface LoadString extends globalThis.EnumItem {
|
|
@@ -33033,6 +33121,8 @@ declare namespace Enum {
|
|
|
33033
33121
|
}
|
|
33034
33122
|
export const LoadString: LoadString;
|
|
33035
33123
|
/**
|
|
33124
|
+
* Allows a script to access the `shared` and `_G` shared global variable tables.
|
|
33125
|
+
*
|
|
33036
33126
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/SecurityCapability#ScriptGlobals)
|
|
33037
33127
|
*/
|
|
33038
33128
|
export interface ScriptGlobals extends globalThis.EnumItem {
|
|
@@ -33042,6 +33132,8 @@ declare namespace Enum {
|
|
|
33042
33132
|
}
|
|
33043
33133
|
export const ScriptGlobals: ScriptGlobals;
|
|
33044
33134
|
/**
|
|
33135
|
+
* Allows a script to create new `Instance` objects using `new()`.
|
|
33136
|
+
*
|
|
33045
33137
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/SecurityCapability#CreateInstances)
|
|
33046
33138
|
*/
|
|
33047
33139
|
export interface CreateInstances extends globalThis.EnumItem {
|
|
@@ -33051,6 +33143,8 @@ declare namespace Enum {
|
|
|
33051
33143
|
}
|
|
33052
33144
|
export const CreateInstances: CreateInstances;
|
|
33053
33145
|
/**
|
|
33146
|
+
* Guards access to a broad set of general-purpose engine APIs that do not belong to a more specific capability category.
|
|
33147
|
+
*
|
|
33054
33148
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/SecurityCapability#Basic)
|
|
33055
33149
|
*/
|
|
33056
33150
|
export interface Basic extends globalThis.EnumItem {
|
|
@@ -33060,6 +33154,8 @@ declare namespace Enum {
|
|
|
33060
33154
|
}
|
|
33061
33155
|
export const Basic: Basic;
|
|
33062
33156
|
/**
|
|
33157
|
+
* Guards access to audio engine APIs such as `Sound`, `AudioPlayer`, and related classes.
|
|
33158
|
+
*
|
|
33063
33159
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/SecurityCapability#Audio)
|
|
33064
33160
|
*/
|
|
33065
33161
|
export interface Audio extends globalThis.EnumItem {
|
|
@@ -33069,6 +33165,8 @@ declare namespace Enum {
|
|
|
33069
33165
|
}
|
|
33070
33166
|
export const Audio: Audio;
|
|
33071
33167
|
/**
|
|
33168
|
+
* Guards access to data store APIs such as `DataStoreService` and its associated objects.
|
|
33169
|
+
*
|
|
33072
33170
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/SecurityCapability#DataStore)
|
|
33073
33171
|
*/
|
|
33074
33172
|
export interface DataStore extends globalThis.EnumItem {
|
|
@@ -33078,6 +33176,8 @@ declare namespace Enum {
|
|
|
33078
33176
|
}
|
|
33079
33177
|
export const DataStore: DataStore;
|
|
33080
33178
|
/**
|
|
33179
|
+
* Guards access to low-level networking APIs such as `HttpService`.
|
|
33180
|
+
*
|
|
33081
33181
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/SecurityCapability#Network)
|
|
33082
33182
|
*/
|
|
33083
33183
|
export interface Network extends globalThis.EnumItem {
|
|
@@ -33087,6 +33187,8 @@ declare namespace Enum {
|
|
|
33087
33187
|
}
|
|
33088
33188
|
export const Network: Network;
|
|
33089
33189
|
/**
|
|
33190
|
+
* Guards access to physics engine APIs such as `Constraint` classes and `BasePart` physics properties.
|
|
33191
|
+
*
|
|
33090
33192
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/SecurityCapability#Physics)
|
|
33091
33193
|
*/
|
|
33092
33194
|
export interface Physics extends globalThis.EnumItem {
|
|
@@ -33096,6 +33198,8 @@ declare namespace Enum {
|
|
|
33096
33198
|
}
|
|
33097
33199
|
export const Physics: Physics;
|
|
33098
33200
|
/**
|
|
33201
|
+
* Guards access to UI engine APIs such as `ScreenGui`, `Frame`, and other `GuiObject` classes.
|
|
33202
|
+
*
|
|
33099
33203
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/SecurityCapability#UI)
|
|
33100
33204
|
*/
|
|
33101
33205
|
export interface UI extends globalThis.EnumItem {
|
|
@@ -33105,6 +33209,8 @@ declare namespace Enum {
|
|
|
33105
33209
|
}
|
|
33106
33210
|
export const UI: UI;
|
|
33107
33211
|
/**
|
|
33212
|
+
* Guards access to Constructive Solid Geometry (CSG) APIs such as `UnionOperation` and `NegateOperation`.
|
|
33213
|
+
*
|
|
33108
33214
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/SecurityCapability#CSG)
|
|
33109
33215
|
*/
|
|
33110
33216
|
export interface CSG extends globalThis.EnumItem {
|
|
@@ -33114,6 +33220,8 @@ declare namespace Enum {
|
|
|
33114
33220
|
}
|
|
33115
33221
|
export const CSG: CSG;
|
|
33116
33222
|
/**
|
|
33223
|
+
* Guards access to chat engine APIs such as `TextChatService` and related chat classes.
|
|
33224
|
+
*
|
|
33117
33225
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/SecurityCapability#Chat)
|
|
33118
33226
|
*/
|
|
33119
33227
|
export interface Chat extends globalThis.EnumItem {
|
|
@@ -33123,6 +33231,8 @@ declare namespace Enum {
|
|
|
33123
33231
|
}
|
|
33124
33232
|
export const Chat: Chat;
|
|
33125
33233
|
/**
|
|
33234
|
+
* Guards access to animation engine APIs such as `AnimationController` and related classes.
|
|
33235
|
+
*
|
|
33126
33236
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/SecurityCapability#Animation)
|
|
33127
33237
|
*/
|
|
33128
33238
|
export interface Animation extends globalThis.EnumItem {
|
|
@@ -33132,7 +33242,9 @@ declare namespace Enum {
|
|
|
33132
33242
|
}
|
|
33133
33243
|
export const Animation: Animation;
|
|
33134
33244
|
/**
|
|
33135
|
-
* **Deprecated:**
|
|
33245
|
+
* **Deprecated:** Use `SecurityCapability.AvatarAppearance` instead.
|
|
33246
|
+
*
|
|
33247
|
+
* Deprecated. Use `SecurityCapability.AvatarAppearance` instead.
|
|
33136
33248
|
*
|
|
33137
33249
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/SecurityCapability#Avatar)
|
|
33138
33250
|
*/
|
|
@@ -33143,6 +33255,8 @@ declare namespace Enum {
|
|
|
33143
33255
|
}
|
|
33144
33256
|
export const Avatar: Avatar;
|
|
33145
33257
|
/**
|
|
33258
|
+
* Guards access to user input APIs such as `UserInputService` and `ContextActionService`.
|
|
33259
|
+
*
|
|
33146
33260
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/SecurityCapability#Input)
|
|
33147
33261
|
*/
|
|
33148
33262
|
export interface Input extends globalThis.EnumItem {
|
|
@@ -33152,6 +33266,8 @@ declare namespace Enum {
|
|
|
33152
33266
|
}
|
|
33153
33267
|
export const Input: Input;
|
|
33154
33268
|
/**
|
|
33269
|
+
* Guards access to environment and world-setting APIs such as `Lighting` and `Atmosphere`.
|
|
33270
|
+
*
|
|
33155
33271
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/SecurityCapability#Environment)
|
|
33156
33272
|
*/
|
|
33157
33273
|
export interface Environment extends globalThis.EnumItem {
|
|
@@ -33161,6 +33277,8 @@ declare namespace Enum {
|
|
|
33161
33277
|
}
|
|
33162
33278
|
export const Environment: Environment;
|
|
33163
33279
|
/**
|
|
33280
|
+
* Guards access to remote event and function APIs such as `RemoteEvent` and `RemoteFunction`.
|
|
33281
|
+
*
|
|
33164
33282
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/SecurityCapability#RemoteEvent)
|
|
33165
33283
|
*/
|
|
33166
33284
|
export interface RemoteEvent extends globalThis.EnumItem {
|
|
@@ -33170,6 +33288,8 @@ declare namespace Enum {
|
|
|
33170
33288
|
}
|
|
33171
33289
|
export const RemoteEvent: RemoteEvent;
|
|
33172
33290
|
/**
|
|
33291
|
+
* Guards access to the legacy `Sound` and pre-`VoiceChatService.UseAudioApi` sound stack APIs.
|
|
33292
|
+
*
|
|
33173
33293
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/SecurityCapability#LegacySound)
|
|
33174
33294
|
*/
|
|
33175
33295
|
export interface LegacySound extends globalThis.EnumItem {
|
|
@@ -33179,6 +33299,8 @@ declare namespace Enum {
|
|
|
33179
33299
|
}
|
|
33180
33300
|
export const LegacySound: LegacySound;
|
|
33181
33301
|
/**
|
|
33302
|
+
* Guards access to `Players` service APIs that query or manage connected players.
|
|
33303
|
+
*
|
|
33182
33304
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/SecurityCapability#Players)
|
|
33183
33305
|
*/
|
|
33184
33306
|
export interface Players extends globalThis.EnumItem {
|
|
@@ -33188,6 +33310,8 @@ declare namespace Enum {
|
|
|
33188
33310
|
}
|
|
33189
33311
|
export const Players: Players;
|
|
33190
33312
|
/**
|
|
33313
|
+
* Guards access to the `Capabilities` and `Sandboxed` properties that configure script sandboxing.
|
|
33314
|
+
*
|
|
33191
33315
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/SecurityCapability#CapabilityControl)
|
|
33192
33316
|
*/
|
|
33193
33317
|
export interface CapabilityControl extends globalThis.EnumItem {
|
|
@@ -33197,6 +33321,8 @@ declare namespace Enum {
|
|
|
33197
33321
|
}
|
|
33198
33322
|
export const CapabilityControl: CapabilityControl;
|
|
33199
33323
|
/**
|
|
33324
|
+
* Mirrors the legacy `Plugin` permission level, granting access to Studio plugin APIs.
|
|
33325
|
+
*
|
|
33200
33326
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/SecurityCapability#Plugin)
|
|
33201
33327
|
*/
|
|
33202
33328
|
export interface Plugin extends globalThis.EnumItem {
|
|
@@ -33206,6 +33332,8 @@ declare namespace Enum {
|
|
|
33206
33332
|
}
|
|
33207
33333
|
export const Plugin: Plugin;
|
|
33208
33334
|
/**
|
|
33335
|
+
* Mirrors the legacy `LocalUser` permission level, granting access to IDE-only and Studio-level APIs.
|
|
33336
|
+
*
|
|
33209
33337
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/SecurityCapability#LocalUser)
|
|
33210
33338
|
*/
|
|
33211
33339
|
export interface LocalUser extends globalThis.EnumItem {
|
|
@@ -33215,6 +33343,8 @@ declare namespace Enum {
|
|
|
33215
33343
|
}
|
|
33216
33344
|
export const LocalUser: LocalUser;
|
|
33217
33345
|
/**
|
|
33346
|
+
* Mirrors the legacy `WritePlayer` permission level, granting the ability to modify player identity properties such as name and `UserId`.
|
|
33347
|
+
*
|
|
33218
33348
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/SecurityCapability#WritePlayer)
|
|
33219
33349
|
*/
|
|
33220
33350
|
export interface WritePlayer extends globalThis.EnumItem {
|
|
@@ -33224,6 +33354,8 @@ declare namespace Enum {
|
|
|
33224
33354
|
}
|
|
33225
33355
|
export const WritePlayer: WritePlayer;
|
|
33226
33356
|
/**
|
|
33357
|
+
* Mirrors the legacy `RobloxScript` permission level, granting access to `CoreScript` APIs.
|
|
33358
|
+
*
|
|
33227
33359
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/SecurityCapability#RobloxScript)
|
|
33228
33360
|
*/
|
|
33229
33361
|
export interface RobloxScript extends globalThis.EnumItem {
|
|
@@ -33233,6 +33365,8 @@ declare namespace Enum {
|
|
|
33233
33365
|
}
|
|
33234
33366
|
export const RobloxScript: RobloxScript;
|
|
33235
33367
|
/**
|
|
33368
|
+
* Mirrors the legacy `RobloxEngine` permission level, granting access to internal engine-level APIs.
|
|
33369
|
+
*
|
|
33236
33370
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/SecurityCapability#RobloxEngine)
|
|
33237
33371
|
*/
|
|
33238
33372
|
export interface RobloxEngine extends globalThis.EnumItem {
|
|
@@ -33242,6 +33376,8 @@ declare namespace Enum {
|
|
|
33242
33376
|
}
|
|
33243
33377
|
export const RobloxEngine: RobloxEngine;
|
|
33244
33378
|
/**
|
|
33379
|
+
* The default capability assigned to API members that have not been explicitly assigned to any other capability category.
|
|
33380
|
+
*
|
|
33245
33381
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/SecurityCapability#Unassigned)
|
|
33246
33382
|
*/
|
|
33247
33383
|
export interface Unassigned extends globalThis.EnumItem {
|
|
@@ -33251,6 +33387,8 @@ declare namespace Enum {
|
|
|
33251
33387
|
}
|
|
33252
33388
|
export const Unassigned: Unassigned;
|
|
33253
33389
|
/**
|
|
33390
|
+
* Restricts access to non-sensitive APIs that are intentionally kept internal.
|
|
33391
|
+
*
|
|
33254
33392
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/SecurityCapability#InternalTest)
|
|
33255
33393
|
*/
|
|
33256
33394
|
export interface InternalTest extends globalThis.EnumItem {
|
|
@@ -33260,6 +33398,8 @@ declare namespace Enum {
|
|
|
33260
33398
|
}
|
|
33261
33399
|
export const InternalTest: InternalTest;
|
|
33262
33400
|
/**
|
|
33401
|
+
* Restricts access to APIs callable only from Studio plugin or Open Cloud Luau execution sessions.
|
|
33402
|
+
*
|
|
33263
33403
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/SecurityCapability#PluginOrOpenCloud)
|
|
33264
33404
|
*/
|
|
33265
33405
|
export interface PluginOrOpenCloud extends globalThis.EnumItem {
|
|
@@ -33269,6 +33409,8 @@ declare namespace Enum {
|
|
|
33269
33409
|
}
|
|
33270
33410
|
export const PluginOrOpenCloud: PluginOrOpenCloud;
|
|
33271
33411
|
/**
|
|
33412
|
+
* Restricts access to APIs that may only be called from Studio Assistant execution contexts.
|
|
33413
|
+
*
|
|
33272
33414
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/SecurityCapability#Assistant)
|
|
33273
33415
|
*/
|
|
33274
33416
|
export interface Assistant extends globalThis.EnumItem {
|
|
@@ -33278,6 +33420,8 @@ declare namespace Enum {
|
|
|
33278
33420
|
}
|
|
33279
33421
|
export const Assistant: Assistant;
|
|
33280
33422
|
/**
|
|
33423
|
+
* Restricts access to APIs that are executable only from Studio's `RemoteCommandService` in Team Create sessions.
|
|
33424
|
+
*
|
|
33281
33425
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/SecurityCapability#RemoteCommand)
|
|
33282
33426
|
*/
|
|
33283
33427
|
export interface RemoteCommand extends globalThis.EnumItem {
|
|
@@ -33287,6 +33431,8 @@ declare namespace Enum {
|
|
|
33287
33431
|
}
|
|
33288
33432
|
export const RemoteCommand: RemoteCommand;
|
|
33289
33433
|
/**
|
|
33434
|
+
* Guards access to APIs that read or query asset metadata from the Roblox catalog.
|
|
33435
|
+
*
|
|
33290
33436
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/SecurityCapability#AssetRead)
|
|
33291
33437
|
*/
|
|
33292
33438
|
export interface AssetRead extends globalThis.EnumItem {
|
|
@@ -33296,6 +33442,8 @@ declare namespace Enum {
|
|
|
33296
33442
|
}
|
|
33297
33443
|
export const AssetRead: AssetRead;
|
|
33298
33444
|
/**
|
|
33445
|
+
* Guards access to asset management APIs such as `ContentProvider:PreloadAsync()` and encryption-key registration.
|
|
33446
|
+
*
|
|
33299
33447
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/SecurityCapability#AssetManagement)
|
|
33300
33448
|
*/
|
|
33301
33449
|
export interface AssetManagement extends globalThis.EnumItem {
|
|
@@ -33305,6 +33453,8 @@ declare namespace Enum {
|
|
|
33305
33453
|
}
|
|
33306
33454
|
export const AssetManagement: AssetManagement;
|
|
33307
33455
|
/**
|
|
33456
|
+
* Guards access to procedural and AI-driven content generation APIs such as `EditableMesh` and `AvatarCreationService`.
|
|
33457
|
+
*
|
|
33308
33458
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/SecurityCapability#DynamicGeneration)
|
|
33309
33459
|
*/
|
|
33310
33460
|
export interface DynamicGeneration extends globalThis.EnumItem {
|
|
@@ -33314,6 +33464,8 @@ declare namespace Enum {
|
|
|
33314
33464
|
}
|
|
33315
33465
|
export const DynamicGeneration: DynamicGeneration;
|
|
33316
33466
|
/**
|
|
33467
|
+
* Guards access to platform-level avatar editing APIs provided by `AvatarEditorService`.
|
|
33468
|
+
*
|
|
33317
33469
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/SecurityCapability#PlatformAvatarEditing)
|
|
33318
33470
|
*/
|
|
33319
33471
|
export interface PlatformAvatarEditing extends globalThis.EnumItem {
|
|
@@ -33323,6 +33475,8 @@ declare namespace Enum {
|
|
|
33323
33475
|
}
|
|
33324
33476
|
export const PlatformAvatarEditing: PlatformAvatarEditing;
|
|
33325
33477
|
/**
|
|
33478
|
+
* Guards access to APIs that create or update published Roblox assets.
|
|
33479
|
+
*
|
|
33326
33480
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/SecurityCapability#AssetCreateUpdate)
|
|
33327
33481
|
*/
|
|
33328
33482
|
export interface AssetCreateUpdate extends globalThis.EnumItem {
|
|
@@ -33332,6 +33486,8 @@ declare namespace Enum {
|
|
|
33332
33486
|
}
|
|
33333
33487
|
export const AssetCreateUpdate: AssetCreateUpdate;
|
|
33334
33488
|
/**
|
|
33489
|
+
* Guards access to `CaptureService` APIs that take screenshots and record video.
|
|
33490
|
+
*
|
|
33335
33491
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/SecurityCapability#Capture)
|
|
33336
33492
|
*/
|
|
33337
33493
|
export interface Capture extends globalThis.EnumItem {
|
|
@@ -33341,6 +33497,8 @@ declare namespace Enum {
|
|
|
33341
33497
|
}
|
|
33342
33498
|
export const Capture: Capture;
|
|
33343
33499
|
/**
|
|
33500
|
+
* Guards access to sensitive user input APIs such as those that can read raw keyboard or mouse data beyond normal game input.
|
|
33501
|
+
*
|
|
33344
33502
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/SecurityCapability#SensitiveInput)
|
|
33345
33503
|
*/
|
|
33346
33504
|
export interface SensitiveInput extends globalThis.EnumItem {
|
|
@@ -33350,6 +33508,8 @@ declare namespace Enum {
|
|
|
33350
33508
|
}
|
|
33351
33509
|
export const SensitiveInput: SensitiveInput;
|
|
33352
33510
|
/**
|
|
33511
|
+
* Guards access to in-experience purchase and monetization APIs such as `MarketplaceService`.
|
|
33512
|
+
*
|
|
33353
33513
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/SecurityCapability#Monetization)
|
|
33354
33514
|
*/
|
|
33355
33515
|
export interface Monetization extends globalThis.EnumItem {
|
|
@@ -33359,6 +33519,8 @@ declare namespace Enum {
|
|
|
33359
33519
|
}
|
|
33360
33520
|
export const Monetization: Monetization;
|
|
33361
33521
|
/**
|
|
33522
|
+
* Allows a script to load assets that are owned by the experience's creator using `InsertService` or `require()`.
|
|
33523
|
+
*
|
|
33362
33524
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/SecurityCapability#LoadOwnedAsset)
|
|
33363
33525
|
*/
|
|
33364
33526
|
export interface LoadOwnedAsset extends globalThis.EnumItem {
|
|
@@ -33368,6 +33530,8 @@ declare namespace Enum {
|
|
|
33368
33530
|
}
|
|
33369
33531
|
export const LoadOwnedAsset: LoadOwnedAsset;
|
|
33370
33532
|
/**
|
|
33533
|
+
* Guards access to social APIs such as `SocialService`, `FriendPages`, and `ExperienceInviteOptions`.
|
|
33534
|
+
*
|
|
33371
33535
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/SecurityCapability#Social)
|
|
33372
33536
|
*/
|
|
33373
33537
|
export interface Social extends globalThis.EnumItem {
|
|
@@ -33377,6 +33541,8 @@ declare namespace Enum {
|
|
|
33377
33541
|
}
|
|
33378
33542
|
export const Social: Social;
|
|
33379
33543
|
/**
|
|
33544
|
+
* Guards access to server-to-server messaging APIs such as `MessagingService`.
|
|
33545
|
+
*
|
|
33380
33546
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/SecurityCapability#ServerCommunication)
|
|
33381
33547
|
*/
|
|
33382
33548
|
export interface ServerCommunication extends globalThis.EnumItem {
|
|
@@ -33386,6 +33552,8 @@ declare namespace Enum {
|
|
|
33386
33552
|
}
|
|
33387
33553
|
export const ServerCommunication: ServerCommunication;
|
|
33388
33554
|
/**
|
|
33555
|
+
* Guards access to `LogService` and logging-related APIs.
|
|
33556
|
+
*
|
|
33389
33557
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/SecurityCapability#Logging)
|
|
33390
33558
|
*/
|
|
33391
33559
|
export interface Logging extends globalThis.EnumItem {
|
|
@@ -33395,6 +33563,8 @@ declare namespace Enum {
|
|
|
33395
33563
|
}
|
|
33396
33564
|
export const Logging: Logging;
|
|
33397
33565
|
/**
|
|
33566
|
+
* Guards access to APIs that initiate external (non-Roblox) purchase prompts.
|
|
33567
|
+
*
|
|
33398
33568
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/SecurityCapability#PromptExternalPurchase)
|
|
33399
33569
|
*/
|
|
33400
33570
|
export interface PromptExternalPurchase extends globalThis.EnumItem {
|
|
@@ -33404,6 +33574,8 @@ declare namespace Enum {
|
|
|
33404
33574
|
}
|
|
33405
33575
|
export const PromptExternalPurchase: PromptExternalPurchase;
|
|
33406
33576
|
/**
|
|
33577
|
+
* Guards access to group-related APIs such as `GroupService`.
|
|
33578
|
+
*
|
|
33407
33579
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/SecurityCapability#Groups)
|
|
33408
33580
|
*/
|
|
33409
33581
|
export interface Groups extends globalThis.EnumItem {
|
|
@@ -33413,6 +33585,8 @@ declare namespace Enum {
|
|
|
33413
33585
|
}
|
|
33414
33586
|
export const Groups: Groups;
|
|
33415
33587
|
/**
|
|
33588
|
+
* Guards access to teleportation APIs such as `TeleportService`, `TeleportOptions`, and `TeleportAsyncResult`.
|
|
33589
|
+
*
|
|
33416
33590
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/SecurityCapability#Teleport)
|
|
33417
33591
|
*/
|
|
33418
33592
|
export interface Teleport extends globalThis.EnumItem {
|
|
@@ -33422,6 +33596,8 @@ declare namespace Enum {
|
|
|
33422
33596
|
}
|
|
33423
33597
|
export const Teleport: Teleport;
|
|
33424
33598
|
/**
|
|
33599
|
+
* Guards access to moderation and player-consequence APIs such as `Players:BanAsync()` and `ModerationService`.
|
|
33600
|
+
*
|
|
33425
33601
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/SecurityCapability#Consequences)
|
|
33426
33602
|
*/
|
|
33427
33603
|
export interface Consequences extends globalThis.EnumItem {
|
|
@@ -33431,6 +33607,8 @@ declare namespace Enum {
|
|
|
33431
33607
|
}
|
|
33432
33608
|
export const Consequences: Consequences;
|
|
33433
33609
|
/**
|
|
33610
|
+
* Guards access to `MaterialService`, `MaterialVariant`, and custom material APIs.
|
|
33611
|
+
*
|
|
33434
33612
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/SecurityCapability#Material)
|
|
33435
33613
|
*/
|
|
33436
33614
|
export interface Material extends globalThis.EnumItem {
|
|
@@ -33440,6 +33618,8 @@ declare namespace Enum {
|
|
|
33440
33618
|
}
|
|
33441
33619
|
export const Material: Material;
|
|
33442
33620
|
/**
|
|
33621
|
+
* Guards access to APIs that control avatar locomotion and behavior at runtime.
|
|
33622
|
+
*
|
|
33443
33623
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/SecurityCapability#AvatarBehavior)
|
|
33444
33624
|
*/
|
|
33445
33625
|
export interface AvatarBehavior extends globalThis.EnumItem {
|
|
@@ -33449,6 +33629,8 @@ declare namespace Enum {
|
|
|
33449
33629
|
}
|
|
33450
33630
|
export const AvatarBehavior: AvatarBehavior;
|
|
33451
33631
|
/**
|
|
33632
|
+
* Guards access to APIs that read or modify avatar appearance, such as `HumanoidDescription`.
|
|
33633
|
+
*
|
|
33452
33634
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/SecurityCapability#AvatarAppearance)
|
|
33453
33635
|
*/
|
|
33454
33636
|
export interface AvatarAppearance extends globalThis.EnumItem {
|
|
@@ -33458,6 +33640,8 @@ declare namespace Enum {
|
|
|
33458
33640
|
}
|
|
33459
33641
|
export const AvatarAppearance: AvatarAppearance;
|
|
33460
33642
|
/**
|
|
33643
|
+
* Allows a script to `require()` asset IDs or call `InsertService:LoadAsset()` for assets not owned by the creator.
|
|
33644
|
+
*
|
|
33461
33645
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/SecurityCapability#LoadUnownedAsset)
|
|
33462
33646
|
*/
|
|
33463
33647
|
export interface LoadUnownedAsset extends globalThis.EnumItem {
|
|
@@ -33838,6 +34022,8 @@ declare namespace Enum {
|
|
|
33838
34022
|
}
|
|
33839
34023
|
export type Severity = Severity.Error | Severity.Warning | Severity.Information | Severity.Hint;
|
|
33840
34024
|
/**
|
|
34025
|
+
* Result codes returned by `AdService:ShowRewardedVideoAdAsync()` indicating whether a rewarded video ad completed successfully or why it did not.
|
|
34026
|
+
*
|
|
33841
34027
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ShowAdResult)
|
|
33842
34028
|
*/
|
|
33843
34029
|
export namespace ShowAdResult {
|
|
@@ -33897,6 +34083,8 @@ declare namespace Enum {
|
|
|
33897
34083
|
}
|
|
33898
34084
|
export const ShowInterrupted: ShowInterrupted;
|
|
33899
34085
|
/**
|
|
34086
|
+
* The device does not have sufficient video memory available to display the ad.
|
|
34087
|
+
*
|
|
33900
34088
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ShowAdResult#InsufficientMemory)
|
|
33901
34089
|
*/
|
|
33902
34090
|
export interface InsufficientMemory extends globalThis.EnumItem {
|
|
@@ -34166,7 +34354,7 @@ declare namespace Enum {
|
|
|
34166
34354
|
}
|
|
34167
34355
|
export const NoHash: NoHash;
|
|
34168
34356
|
/**
|
|
34169
|
-
* The model
|
|
34357
|
+
* The model has not been uploaded to the content-delivery network. Shown as orange in the debug tint overlay.
|
|
34170
34358
|
*
|
|
34171
34359
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/SlimTranscoderStatus#NotUploaded)
|
|
34172
34360
|
*/
|
|
@@ -34177,7 +34365,7 @@ declare namespace Enum {
|
|
|
34177
34365
|
}
|
|
34178
34366
|
export const NotUploaded: NotUploaded;
|
|
34179
34367
|
/**
|
|
34180
|
-
* The
|
|
34368
|
+
* The model has been uploaded to the content-delivery network but has not yet been transcoded into SLIM assets. Shown as yellow in the debug tint overlay.
|
|
34181
34369
|
*
|
|
34182
34370
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/SlimTranscoderStatus#Uploaded)
|
|
34183
34371
|
*/
|