@rbxts/types 1.0.945 → 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 +176 -18
- package/include/generated/PluginSecurity.d.ts +69 -18
- 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
|
*
|
|
@@ -41569,21 +41663,21 @@ interface DataModel extends ServiceProvider<Services> {
|
|
|
41569
41663
|
*/
|
|
41570
41664
|
readonly VIPServerOwnerId: number;
|
|
41571
41665
|
/**
|
|
41572
|
-
* A reference to the `Workspace` service.
|
|
41573
|
-
*
|
|
41574
41666
|
* - **ThreadSafety**: ReadSafe
|
|
41575
41667
|
* - **Tags**: NotReplicated
|
|
41576
41668
|
*
|
|
41577
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DataModel#
|
|
41669
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DataModel#RunService)
|
|
41578
41670
|
*/
|
|
41579
|
-
readonly
|
|
41671
|
+
readonly RunService: RunService | undefined;
|
|
41580
41672
|
/**
|
|
41673
|
+
* A reference to the `Workspace` service.
|
|
41674
|
+
*
|
|
41581
41675
|
* - **ThreadSafety**: ReadSafe
|
|
41582
41676
|
* - **Tags**: NotReplicated
|
|
41583
41677
|
*
|
|
41584
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DataModel#
|
|
41678
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DataModel#Workspace)
|
|
41585
41679
|
*/
|
|
41586
|
-
readonly
|
|
41680
|
+
readonly Workspace: Workspace;
|
|
41587
41681
|
/**
|
|
41588
41682
|
* Binds a function to be called before the server shuts down.
|
|
41589
41683
|
*
|
|
@@ -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
|
*
|
|
@@ -13964,46 +13983,46 @@ interface DataModel extends ServiceProvider<Services> {
|
|
|
13964
13983
|
*/
|
|
13965
13984
|
readonly _nominal_DataModel: unique symbol;
|
|
13966
13985
|
/**
|
|
13967
|
-
*
|
|
13986
|
+
* Sets the `DataModel.PlaceId` of the current game instance.
|
|
13968
13987
|
*
|
|
13969
13988
|
* - **ThreadSafety**: Unsafe
|
|
13970
13989
|
*
|
|
13971
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DataModel#
|
|
13990
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DataModel#SetPlaceId)
|
|
13972
13991
|
* @param this The root of Roblox's parent-child hierarchy. Its direct children are services, such as `Workspace` and `Lighting`, that act as the fundamental components of a Roblox game.
|
|
13973
|
-
* @
|
|
13992
|
+
* @param placeId The ID to set the `DataModel.PlaceId` to.
|
|
13974
13993
|
*/
|
|
13975
|
-
|
|
13994
|
+
SetPlaceId(this: DataModel, placeId: number): void;
|
|
13976
13995
|
/**
|
|
13977
|
-
*
|
|
13996
|
+
* Sets the `DataModel.GameId` of the current game instance to the given `universeId`.
|
|
13978
13997
|
*
|
|
13979
13998
|
* - **ThreadSafety**: Unsafe
|
|
13980
13999
|
*
|
|
13981
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DataModel#
|
|
14000
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DataModel#SetUniverseId)
|
|
13982
14001
|
* @param this The root of Roblox's parent-child hierarchy. Its direct children are services, such as `Workspace` and `Lighting`, that act as the fundamental components of a Roblox game.
|
|
13983
|
-
* @param
|
|
13984
|
-
* @returns An array of `Instances` associated with the content URL.
|
|
14002
|
+
* @param universeId The ID to set the `DataModel.GameId` to.
|
|
13985
14003
|
*/
|
|
13986
|
-
|
|
14004
|
+
SetUniverseId(this: DataModel, universeId: number): void;
|
|
13987
14005
|
/**
|
|
13988
|
-
*
|
|
14006
|
+
* Returns a table containing basic information about the jobs performed by the task scheduler.
|
|
13989
14007
|
*
|
|
13990
14008
|
* - **ThreadSafety**: Unsafe
|
|
13991
14009
|
*
|
|
13992
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DataModel#
|
|
14010
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DataModel#GetJobsInfo)
|
|
13993
14011
|
* @param this The root of Roblox's parent-child hierarchy. Its direct children are services, such as `Workspace` and `Lighting`, that act as the fundamental components of a Roblox game.
|
|
13994
|
-
* @
|
|
14012
|
+
* @returns A table containing information about the jobs performed by the task scheduler, see above for the format.
|
|
13995
14013
|
*/
|
|
13996
|
-
|
|
14014
|
+
GetJobsInfo(this: DataModel): Array<unknown>;
|
|
13997
14015
|
/**
|
|
13998
|
-
*
|
|
14016
|
+
* Returns an array of `Instances` associated with the given content URL.
|
|
13999
14017
|
*
|
|
14000
14018
|
* - **ThreadSafety**: Unsafe
|
|
14001
14019
|
*
|
|
14002
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DataModel#
|
|
14020
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DataModel#GetObjects)
|
|
14003
14021
|
* @param this The root of Roblox's parent-child hierarchy. Its direct children are services, such as `Workspace` and `Lighting`, that act as the fundamental components of a Roblox game.
|
|
14004
|
-
* @param
|
|
14022
|
+
* @param url The given content URL.
|
|
14023
|
+
* @returns An array of `Instances` associated with the content URL.
|
|
14005
14024
|
*/
|
|
14006
|
-
|
|
14025
|
+
GetObjects(this: DataModel, url: ContentId): Array<Instance>;
|
|
14007
14026
|
}
|
|
14008
14027
|
/**
|
|
14009
14028
|
* The abstract class for settings database classes.
|
|
@@ -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)
|