@rbxts/types 1.0.889 → 1.0.891
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.
|
@@ -6,6 +6,7 @@ interface Services {
|
|
|
6
6
|
AccountService: AccountService;
|
|
7
7
|
AchievementService: AchievementService;
|
|
8
8
|
ActivityHistoryEventService: ActivityHistoryEventService;
|
|
9
|
+
AdService: AdService;
|
|
9
10
|
AnalyticsService: AnalyticsService;
|
|
10
11
|
AnimationClipProvider: AnimationClipProvider;
|
|
11
12
|
AnimationFromVideoCreatorService: AnimationFromVideoCreatorService;
|
|
@@ -2855,6 +2856,102 @@ interface AdPortal extends Instance {
|
|
|
2855
2856
|
*/
|
|
2856
2857
|
readonly Status: Enum.AdUnitStatus;
|
|
2857
2858
|
}
|
|
2859
|
+
/**
|
|
2860
|
+
* A class that allows the display of mobile video ads.
|
|
2861
|
+
*
|
|
2862
|
+
* - **Tags**: NotCreatable, Service
|
|
2863
|
+
*
|
|
2864
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AdService)
|
|
2865
|
+
*/
|
|
2866
|
+
interface AdService extends Instance {
|
|
2867
|
+
/**
|
|
2868
|
+
* **DO NOT USE!**
|
|
2869
|
+
*
|
|
2870
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
2871
|
+
* @hidden
|
|
2872
|
+
* @deprecated
|
|
2873
|
+
*/
|
|
2874
|
+
readonly _nominal_AdService: unique symbol;
|
|
2875
|
+
/**
|
|
2876
|
+
* Creates a reward to give users who watch an entire video ad.
|
|
2877
|
+
*
|
|
2878
|
+
* - **ThreadSafety**: Unsafe
|
|
2879
|
+
*
|
|
2880
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AdService#CreateAdRewardFromDevProductId)
|
|
2881
|
+
* @param this A class that allows the display of mobile video ads.
|
|
2882
|
+
* @param devProductId The ID of the developer product you want to grant as a reward.
|
|
2883
|
+
*/
|
|
2884
|
+
CreateAdRewardFromDevProductId(this: AdService, devProductId: number): AdReward;
|
|
2885
|
+
/**
|
|
2886
|
+
* **Deprecated:** `ShowVideoAd` has been decommissioned and is no longer operational.
|
|
2887
|
+
*
|
|
2888
|
+
* Show mobile video advertisements.
|
|
2889
|
+
*
|
|
2890
|
+
* - **ThreadSafety**: Unsafe
|
|
2891
|
+
* - **Tags**:
|
|
2892
|
+
*
|
|
2893
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AdService#ShowVideoAd)
|
|
2894
|
+
* @param this A class that allows the display of mobile video ads.
|
|
2895
|
+
*
|
|
2896
|
+
* @deprecated
|
|
2897
|
+
*/
|
|
2898
|
+
ShowVideoAd(this: AdService): void;
|
|
2899
|
+
/**
|
|
2900
|
+
* - **ThreadSafety**: Unsafe
|
|
2901
|
+
*
|
|
2902
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AdService#UnregisterAdOpportunity)
|
|
2903
|
+
* @param this A class that allows the display of mobile video ads.
|
|
2904
|
+
* @param instance
|
|
2905
|
+
*/
|
|
2906
|
+
UnregisterAdOpportunity(this: AdService, instance: Instance): void;
|
|
2907
|
+
/**
|
|
2908
|
+
* Checks if a video ad is available to be played to the current user inside the experience.
|
|
2909
|
+
*
|
|
2910
|
+
* - **ThreadSafety**: Unsafe
|
|
2911
|
+
* - **Tags**: Yields
|
|
2912
|
+
*
|
|
2913
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AdService#GetAdAvailabilityNowAsync)
|
|
2914
|
+
* @param this A class that allows the display of mobile video ads.
|
|
2915
|
+
* @param adFormat The format of the requested ad. For example, `RewardedVideo`.
|
|
2916
|
+
*/
|
|
2917
|
+
GetAdAvailabilityNowAsync(this: AdService, adFormat: CastsToEnum<Enum.AdFormat>): unknown;
|
|
2918
|
+
/**
|
|
2919
|
+
* - **ThreadSafety**: Unsafe
|
|
2920
|
+
* - **Tags**: Yields
|
|
2921
|
+
*
|
|
2922
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AdService#RegisterAdOpportunityAsync)
|
|
2923
|
+
* @param this A class that allows the display of mobile video ads.
|
|
2924
|
+
* @param instance
|
|
2925
|
+
* @param placementId
|
|
2926
|
+
*/
|
|
2927
|
+
RegisterAdOpportunityAsync(this: AdService, instance: Instance, placementId?: number): void;
|
|
2928
|
+
/**
|
|
2929
|
+
* Plays the video ad to the current user inside the experience.
|
|
2930
|
+
*
|
|
2931
|
+
* - **ThreadSafety**: Unsafe
|
|
2932
|
+
* - **Tags**: Yields
|
|
2933
|
+
*
|
|
2934
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AdService#ShowRewardedVideoAdAsync)
|
|
2935
|
+
* @param this A class that allows the display of mobile video ads.
|
|
2936
|
+
* @param player The `Player` object for whom you are fetching the ad for.
|
|
2937
|
+
* @param reward The reward object for the reward you want to grant the user who watches an ad to completion.
|
|
2938
|
+
* @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.
|
|
2939
|
+
*/
|
|
2940
|
+
ShowRewardedVideoAdAsync(this: AdService, player: Player, reward: AdReward, placementId?: number): Enum.ShowAdResult;
|
|
2941
|
+
/**
|
|
2942
|
+
* **Deprecated:** `VideoAdClosed` has been decommissioned and is no longer operational.
|
|
2943
|
+
*
|
|
2944
|
+
* Fires when an `AdService` video closes.
|
|
2945
|
+
*
|
|
2946
|
+
* - **ThreadSafety**: Unsafe
|
|
2947
|
+
* - **Tags**:
|
|
2948
|
+
*
|
|
2949
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AdService#VideoAdClosed)
|
|
2950
|
+
*
|
|
2951
|
+
* @deprecated
|
|
2952
|
+
*/
|
|
2953
|
+
readonly VideoAdClosed: RBXScriptSignal<(adShown: boolean) => void>;
|
|
2954
|
+
}
|
|
2858
2955
|
/**
|
|
2859
2956
|
* Collection of methods that allows developers to track how users interact with their experiences.
|
|
2860
2957
|
*
|
|
@@ -6227,6 +6324,12 @@ interface AudioPlayer extends Instance {
|
|
|
6227
6324
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioPlayer#AutoLoad)
|
|
6228
6325
|
*/
|
|
6229
6326
|
AutoLoad: boolean;
|
|
6327
|
+
/**
|
|
6328
|
+
* - **ThreadSafety**: ReadSafe
|
|
6329
|
+
*
|
|
6330
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioPlayer#AutoPlay)
|
|
6331
|
+
*/
|
|
6332
|
+
AutoPlay: boolean;
|
|
6230
6333
|
/**
|
|
6231
6334
|
* Denotes whether this `AudioPlayer` is currently playing.
|
|
6232
6335
|
*
|
|
@@ -16434,6 +16537,13 @@ interface GenerationService extends Instance {
|
|
|
16434
16537
|
* @returns A tuple of the generation ID (a unique ID returned for each invocation of `GenerateMeshAsync()`) and context ID (not currently used).
|
|
16435
16538
|
*/
|
|
16436
16539
|
GenerateMeshAsync(this: GenerationService, inputs: object, player: Player, options: object, intermediateResultCallback?: Callback): unknown;
|
|
16540
|
+
/**
|
|
16541
|
+
* - **ThreadSafety**: Unsafe
|
|
16542
|
+
* - **Tags**: Yields
|
|
16543
|
+
*
|
|
16544
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GenerationService#GenerateModelAsync)
|
|
16545
|
+
*/
|
|
16546
|
+
GenerateModelAsync(this: GenerationService, inputs: object, schema: object, options?: object): unknown;
|
|
16437
16547
|
/**
|
|
16438
16548
|
* Retrieves and loads a mesh generated by `GenerationService:GenerateMeshAsync()` using the provided `generationId`.
|
|
16439
16549
|
*
|
|
@@ -16557,6 +16667,13 @@ interface GeometryService extends Instance {
|
|
|
16557
16667
|
* @returns One or more `PartOperations` from the geometry of the main part (`part`) minus the geometry occupied by the other parts.
|
|
16558
16668
|
*/
|
|
16559
16669
|
SubtractAsync(this: GeometryService, part: Part | PartOperation, parts: ReadonlyArray<Part | PartOperation>, options?: GeometryServiceAsyncMethodConfig): Array<PartOperation>;
|
|
16670
|
+
/**
|
|
16671
|
+
* - **ThreadSafety**: Unsafe
|
|
16672
|
+
* - **Tags**: Yields
|
|
16673
|
+
*
|
|
16674
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GeometryService#SweepPartAsync)
|
|
16675
|
+
*/
|
|
16676
|
+
SweepPartAsync(this: GeometryService, part: BasePart, cframes: Array<unknown>, options?: object): MeshPart;
|
|
16560
16677
|
/**
|
|
16561
16678
|
* Creates one or more `PartOperations` from one part plus the geometry occupied by other parts.
|
|
16562
16679
|
*
|
|
@@ -22636,7 +22753,7 @@ interface Humanoid extends Instance {
|
|
|
22636
22753
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Humanoid#ApplyDescription)
|
|
22637
22754
|
* @param this A special object that gives models the functionality of a character.
|
|
22638
22755
|
* @param humanoidDescription The `HumanoidDescription` instance which you want to set the character to match.
|
|
22639
|
-
* @param assetTypeVerification
|
|
22756
|
+
* @param assetTypeVerification The asset type verification mode.
|
|
22640
22757
|
*/
|
|
22641
22758
|
ApplyDescription(this: Humanoid, humanoidDescription: HumanoidDescription, assetTypeVerification?: CastsToEnum<Enum.AssetTypeVerification>): void;
|
|
22642
22759
|
/**
|
|
@@ -22648,7 +22765,7 @@ interface Humanoid extends Instance {
|
|
|
22648
22765
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Humanoid#ApplyDescriptionReset)
|
|
22649
22766
|
* @param this A special object that gives models the functionality of a character.
|
|
22650
22767
|
* @param humanoidDescription The `HumanoidDescription` instance which you want to set the character to match.
|
|
22651
|
-
* @param assetTypeVerification
|
|
22768
|
+
* @param assetTypeVerification The asset type verification mode.
|
|
22652
22769
|
*/
|
|
22653
22770
|
ApplyDescriptionReset(this: Humanoid, humanoidDescription: HumanoidDescription, assetTypeVerification?: CastsToEnum<Enum.AssetTypeVerification>): void;
|
|
22654
22771
|
/**
|
|
@@ -23997,14 +24114,6 @@ interface HumanoidRigDescription extends Instance {
|
|
|
23997
24114
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#WaistTposeAdjustment)
|
|
23998
24115
|
*/
|
|
23999
24116
|
WaistTposeAdjustment: CFrame;
|
|
24000
|
-
/**
|
|
24001
|
-
* - **ThreadSafety**: Safe
|
|
24002
|
-
*
|
|
24003
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#Automap)
|
|
24004
|
-
* @param this
|
|
24005
|
-
* @param character
|
|
24006
|
-
*/
|
|
24007
|
-
Automap(this: HumanoidRigDescription, character: Instance): void;
|
|
24008
24117
|
/**
|
|
24009
24118
|
* - **ThreadSafety**: Safe
|
|
24010
24119
|
*
|
|
@@ -24466,6 +24575,8 @@ interface InputBinding extends Instance {
|
|
|
24466
24575
|
*/
|
|
24467
24576
|
ReleasedThreshold: number;
|
|
24468
24577
|
/**
|
|
24578
|
+
* Numerical value to configure scaling for more precise thumbstick aiming.
|
|
24579
|
+
*
|
|
24469
24580
|
* - **ThreadSafety**: ReadSafe
|
|
24470
24581
|
*
|
|
24471
24582
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputBinding#ResponseCurve)
|
|
@@ -27059,6 +27170,13 @@ interface MarketplaceService extends Instance {
|
|
|
27059
27170
|
* @returns Indicates whether the given player's inventory contains the given bundle.
|
|
27060
27171
|
*/
|
|
27061
27172
|
PlayerOwnsBundle(this: MarketplaceService, player: Player, bundleId: number): boolean;
|
|
27173
|
+
/**
|
|
27174
|
+
* - **ThreadSafety**: Unsafe
|
|
27175
|
+
* - **Tags**: Yields
|
|
27176
|
+
*
|
|
27177
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MarketplaceService#RecommendTopProductsAsync)
|
|
27178
|
+
*/
|
|
27179
|
+
RecommendTopProductsAsync(this: MarketplaceService, infoTypes: Array<unknown>): Array<unknown>;
|
|
27062
27180
|
/**
|
|
27063
27181
|
* Returns true if the player with the given `UserId` owns the pass with the given `gamePassId`.
|
|
27064
27182
|
*
|
|
@@ -28150,6 +28268,8 @@ interface OmniRecommendationsService extends Instance {
|
|
|
28150
28268
|
readonly _nominal_OmniRecommendationsService: unique symbol;
|
|
28151
28269
|
}
|
|
28152
28270
|
/**
|
|
28271
|
+
* **Deprecated:** This class is deprecated and should not be used for new work. Use `HttpService` instead and see the [In-experience HTTP requests guide](../../../cloud-services/http-service.md).
|
|
28272
|
+
*
|
|
28153
28273
|
* - **Tags**: NotCreatable, NotReplicated
|
|
28154
28274
|
*
|
|
28155
28275
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/OpenCloudApiV1)
|
|
@@ -28166,22 +28286,26 @@ interface OpenCloudApiV1 extends Instance {
|
|
|
28166
28286
|
*/
|
|
28167
28287
|
readonly _nominal_OpenCloudApiV1: unique symbol;
|
|
28168
28288
|
/**
|
|
28289
|
+
* **Deprecated:**
|
|
28290
|
+
*
|
|
28169
28291
|
* - **ThreadSafety**: Unsafe
|
|
28170
28292
|
* - **Tags**: CustomLuaState
|
|
28171
28293
|
*
|
|
28172
28294
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/OpenCloudApiV1#CreateModel)
|
|
28173
|
-
* @param this
|
|
28295
|
+
* @param this **Deprecated:** This class is deprecated and should not be used for new work. Use `HttpService` instead and see the [In-experience HTTP requests guide](../../../cloud-services/http-service.md).
|
|
28174
28296
|
* @param name
|
|
28175
28297
|
*
|
|
28176
28298
|
* @deprecated
|
|
28177
28299
|
*/
|
|
28178
28300
|
CreateModel(this: OpenCloudApiV1, name: string): OpenCloudModel;
|
|
28179
28301
|
/**
|
|
28302
|
+
* **Deprecated:**
|
|
28303
|
+
*
|
|
28180
28304
|
* - **ThreadSafety**: Unsafe
|
|
28181
28305
|
* - **Tags**: Yields
|
|
28182
28306
|
*
|
|
28183
28307
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/OpenCloudApiV1#CreateUserNotificationAsync)
|
|
28184
|
-
* @param this
|
|
28308
|
+
* @param this **Deprecated:** This class is deprecated and should not be used for new work. Use `HttpService` instead and see the [In-experience HTTP requests guide](../../../cloud-services/http-service.md).
|
|
28185
28309
|
* @param user
|
|
28186
28310
|
* @param userNotification
|
|
28187
28311
|
*
|
|
@@ -28190,6 +28314,8 @@ interface OpenCloudApiV1 extends Instance {
|
|
|
28190
28314
|
CreateUserNotificationAsync(this: OpenCloudApiV1, user: string, userNotification: OpenCloudModel): OpenCloudModel;
|
|
28191
28315
|
}
|
|
28192
28316
|
/**
|
|
28317
|
+
* **Deprecated:** This class is deprecated and should not be used for new work. Use `HttpService` instead and see the [In-experience HTTP requests guide](../../../cloud-services/http-service.md).
|
|
28318
|
+
*
|
|
28193
28319
|
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
28194
28320
|
*
|
|
28195
28321
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/OpenCloudService)
|
|
@@ -28206,21 +28332,25 @@ interface OpenCloudService extends Instance {
|
|
|
28206
28332
|
*/
|
|
28207
28333
|
readonly _nominal_OpenCloudService: unique symbol;
|
|
28208
28334
|
/**
|
|
28335
|
+
* **Deprecated:**
|
|
28336
|
+
*
|
|
28209
28337
|
* - **ThreadSafety**: Unsafe
|
|
28210
28338
|
* - **Tags**:
|
|
28211
28339
|
*
|
|
28212
28340
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/OpenCloudService#GetApiV1)
|
|
28213
|
-
* @param this
|
|
28341
|
+
* @param this **Deprecated:** This class is deprecated and should not be used for new work. Use `HttpService` instead and see the [In-experience HTTP requests guide](../../../cloud-services/http-service.md).
|
|
28214
28342
|
*
|
|
28215
28343
|
* @deprecated
|
|
28216
28344
|
*/
|
|
28217
28345
|
GetApiV1(this: OpenCloudService): OpenCloudApiV1;
|
|
28218
28346
|
/**
|
|
28347
|
+
* **Deprecated:**
|
|
28348
|
+
*
|
|
28219
28349
|
* - **ThreadSafety**: Unsafe
|
|
28220
28350
|
* - **Tags**: Yields
|
|
28221
28351
|
*
|
|
28222
28352
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/OpenCloudService#InvokeAsync)
|
|
28223
|
-
* @param this
|
|
28353
|
+
* @param this **Deprecated:** This class is deprecated and should not be used for new work. Use `HttpService` instead and see the [In-experience HTTP requests guide](../../../cloud-services/http-service.md).
|
|
28224
28354
|
* @param version
|
|
28225
28355
|
* @param methodName
|
|
28226
28356
|
* @param arguments
|
|
@@ -31077,7 +31207,7 @@ interface Model extends PVInstance {
|
|
|
31077
31207
|
*/
|
|
31078
31208
|
GetPrimaryPartCFrame(this: Model): CFrame;
|
|
31079
31209
|
/**
|
|
31080
|
-
* Returns the canonical scale of the model, which defaults to 1 for newly created models and will change as it is scaled via `Model
|
|
31210
|
+
* Returns the canonical scale of the model, which defaults to 1 for newly created models and will change as it is scaled via `Model:ScaleTo()`.
|
|
31081
31211
|
*
|
|
31082
31212
|
* - **ThreadSafety**: Unsafe
|
|
31083
31213
|
*
|
|
@@ -34569,7 +34699,7 @@ interface Players extends Instance {
|
|
|
34569
34699
|
* @param this A service that contains presently connected `Player` objects.
|
|
34570
34700
|
* @param description Specifies the appearance of the returned character.
|
|
34571
34701
|
* @param rigType Specifies whether the returned character will be R6 or R15.
|
|
34572
|
-
* @param assetTypeVerification
|
|
34702
|
+
* @param assetTypeVerification The asset type verification mode.
|
|
34573
34703
|
* @returns A `Humanoid` character `Model`.
|
|
34574
34704
|
*/
|
|
34575
34705
|
CreateHumanoidModelFromDescription(this: Players, description: HumanoidDescription, rigType: CastsToEnum<Enum.HumanoidRigType>, assetTypeVerification?: CastsToEnum<Enum.AssetTypeVerification>): Model;
|
|
@@ -36177,6 +36307,12 @@ interface RunService extends Instance {
|
|
|
36177
36307
|
* @param function The custom function being bound.
|
|
36178
36308
|
*/
|
|
36179
36309
|
BindToRenderStep(this: RunService, name: string, priority: number, callback: (deltaTime: number) => void): void;
|
|
36310
|
+
/**
|
|
36311
|
+
* - **ThreadSafety**: Unsafe
|
|
36312
|
+
*
|
|
36313
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RunService#BindToSimulation)
|
|
36314
|
+
*/
|
|
36315
|
+
BindToSimulation(this: RunService, callback: Callback, frequency?: CastsToEnum<Enum.StepFrequency>): RBXScriptConnection;
|
|
36180
36316
|
/**
|
|
36181
36317
|
* Returns whether the current environment is running on the client.
|
|
36182
36318
|
*
|
|
@@ -36237,12 +36373,6 @@ interface RunService extends Instance {
|
|
|
36237
36373
|
* @param name The name of the function being unbound.
|
|
36238
36374
|
*/
|
|
36239
36375
|
UnbindFromRenderStep(this: RunService, name: string): void;
|
|
36240
|
-
/**
|
|
36241
|
-
* - **ThreadSafety**: Unsafe
|
|
36242
|
-
*
|
|
36243
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RunService#FixedHeartbeat)
|
|
36244
|
-
*/
|
|
36245
|
-
readonly FixedHeartbeat: RBXScriptSignal<(deltaTime: number) => void>;
|
|
36246
36376
|
/**
|
|
36247
36377
|
* Fires every frame, after the physics simulation has completed.
|
|
36248
36378
|
*
|
|
@@ -40031,6 +40161,30 @@ interface StyleQuery extends Instance {
|
|
|
40031
40161
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StyleQuery#MinSize)
|
|
40032
40162
|
*/
|
|
40033
40163
|
MinSize: Vector2;
|
|
40164
|
+
/**
|
|
40165
|
+
* - **ThreadSafety**: Unsafe
|
|
40166
|
+
*
|
|
40167
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StyleQuery#GetCondition)
|
|
40168
|
+
*/
|
|
40169
|
+
GetCondition(this: StyleQuery, name: string): unknown;
|
|
40170
|
+
/**
|
|
40171
|
+
* - **ThreadSafety**: Unsafe
|
|
40172
|
+
*
|
|
40173
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StyleQuery#GetConditions)
|
|
40174
|
+
*/
|
|
40175
|
+
GetConditions(this: StyleQuery): object;
|
|
40176
|
+
/**
|
|
40177
|
+
* - **ThreadSafety**: Unsafe
|
|
40178
|
+
*
|
|
40179
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StyleQuery#SetCondition)
|
|
40180
|
+
*/
|
|
40181
|
+
SetCondition(this: StyleQuery, name: string, value: unknown): void;
|
|
40182
|
+
/**
|
|
40183
|
+
* - **ThreadSafety**: Unsafe
|
|
40184
|
+
*
|
|
40185
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StyleQuery#SetConditions)
|
|
40186
|
+
*/
|
|
40187
|
+
SetConditions(this: StyleQuery, conditions: object): void;
|
|
40034
40188
|
}
|
|
40035
40189
|
/**
|
|
40036
40190
|
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
@@ -46184,10 +46338,18 @@ interface VideoService extends Instance {
|
|
|
46184
46338
|
*/
|
|
46185
46339
|
readonly _nominal_VideoService: unique symbol;
|
|
46186
46340
|
/**
|
|
46341
|
+
* Creates a `VideoSampler` that samples frames from the provided video content.
|
|
46342
|
+
*
|
|
46187
46343
|
* - **ThreadSafety**: Unsafe
|
|
46188
46344
|
* - **Tags**: Yields
|
|
46189
46345
|
*
|
|
46190
46346
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VideoService#CreateVideoSamplerAsync)
|
|
46347
|
+
* @param this An internal service that offers no functionality to developers.
|
|
46348
|
+
* @param content The video content to sample from.
|
|
46349
|
+
* @param options Options table for creating the `VideoSampler`: - `Size` – A `VideoSampleSize` value that determines the resolution of textures produced by the `VideoSampler`. Defaults to `VideoSampleSize.Small`. Use the smallest resolution that meets your needs to minimize memory usage and improve sampling performance.
|
|
46350
|
+
*
|
|
46351
|
+
*
|
|
46352
|
+
* @returns The created `VideoSampler`.
|
|
46191
46353
|
*/
|
|
46192
46354
|
CreateVideoSamplerAsync(this: VideoService, content: Content, options?: object): VideoSampler;
|
|
46193
46355
|
}
|
|
@@ -46829,6 +46991,8 @@ interface TerrainWriteOperation extends RBXObject {
|
|
|
46829
46991
|
GetBlock(this: TerrainWriteOperation): object;
|
|
46830
46992
|
}
|
|
46831
46993
|
/**
|
|
46994
|
+
* An object for sampling frames from video content.
|
|
46995
|
+
*
|
|
46832
46996
|
* - **Tags**: NotCreatable
|
|
46833
46997
|
*
|
|
46834
46998
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VideoSampler)
|
|
@@ -46843,6 +47007,8 @@ interface VideoSampler extends RBXObject {
|
|
|
46843
47007
|
*/
|
|
46844
47008
|
readonly _nominal_VideoSampler: unique symbol;
|
|
46845
47009
|
/**
|
|
47010
|
+
* The length of the `VideoContent` in seconds.
|
|
47011
|
+
*
|
|
46846
47012
|
* - **ThreadSafety**: ReadSafe
|
|
46847
47013
|
* - **Tags**: NotReplicated
|
|
46848
47014
|
*
|
|
@@ -46850,6 +47016,8 @@ interface VideoSampler extends RBXObject {
|
|
|
46850
47016
|
*/
|
|
46851
47017
|
readonly TimeLength: number;
|
|
46852
47018
|
/**
|
|
47019
|
+
* The asset loaded into the `VideoSampler`.
|
|
47020
|
+
*
|
|
46853
47021
|
* - **ThreadSafety**: ReadSafe
|
|
46854
47022
|
* - **Tags**: NotReplicated
|
|
46855
47023
|
*
|
|
@@ -46857,10 +47025,16 @@ interface VideoSampler extends RBXObject {
|
|
|
46857
47025
|
*/
|
|
46858
47026
|
readonly VideoContent: Content;
|
|
46859
47027
|
/**
|
|
47028
|
+
* Gets image frames at the specified timestamps.
|
|
47029
|
+
*
|
|
46860
47030
|
* - **ThreadSafety**: Unsafe
|
|
46861
47031
|
* - **Tags**: Yields
|
|
46862
47032
|
*
|
|
46863
47033
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VideoSampler#GetSamplesAtTimesAsync)
|
|
47034
|
+
* @param this An object for sampling frames from video content.
|
|
47035
|
+
* @param times An array of requested timestamps in seconds for which to retrieve image frames. Each timestamp should be a number between `0` and `TimeLength`.
|
|
47036
|
+
* @returns An array of dictionary or nil values for each requested timestamp. If a requested timestamp is out of range or the `VideoSampler` was unable to produce a sample, the corresponding entry in the returned array will be nil. Each dictionary contains the following keys: - `Time` (number): The timestamp of the returned image frame in seconds. This value may differ slightly from the requested timestamp.
|
|
47037
|
+
* - `Image` (`Content`): A `Content` with a `SourceType` of `ContentSourceType.Opaque` containing the image frame at the corresponding timestamp.
|
|
46864
47038
|
*/
|
|
46865
47039
|
GetSamplesAtTimesAsync(this: VideoSampler, times: Array<unknown>): Array<unknown>;
|
|
46866
47040
|
}
|
|
@@ -6,6 +6,7 @@ interface Services {
|
|
|
6
6
|
AccountService: AccountService;
|
|
7
7
|
AchievementService: AchievementService;
|
|
8
8
|
ActivityHistoryEventService: ActivityHistoryEventService;
|
|
9
|
+
AdService: AdService;
|
|
9
10
|
AnalyticsService: AnalyticsService;
|
|
10
11
|
AnimationClipProvider: AnimationClipProvider;
|
|
11
12
|
AnimationFromVideoCreatorService: AnimationFromVideoCreatorService;
|
|
@@ -1080,6 +1081,23 @@ interface AdPortal extends Instance {
|
|
|
1080
1081
|
*/
|
|
1081
1082
|
readonly _nominal_AdPortal: unique symbol;
|
|
1082
1083
|
}
|
|
1084
|
+
/**
|
|
1085
|
+
* A class that allows the display of mobile video ads.
|
|
1086
|
+
*
|
|
1087
|
+
* - **Tags**: NotCreatable, Service
|
|
1088
|
+
*
|
|
1089
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AdService)
|
|
1090
|
+
*/
|
|
1091
|
+
interface AdService extends Instance {
|
|
1092
|
+
/**
|
|
1093
|
+
* **DO NOT USE!**
|
|
1094
|
+
*
|
|
1095
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
1096
|
+
* @hidden
|
|
1097
|
+
* @deprecated
|
|
1098
|
+
*/
|
|
1099
|
+
readonly _nominal_AdService: unique symbol;
|
|
1100
|
+
}
|
|
1083
1101
|
/**
|
|
1084
1102
|
* Collection of methods that allows developers to track how users interact with their experiences.
|
|
1085
1103
|
*
|
|
@@ -8612,6 +8630,8 @@ interface OmniRecommendationsService extends Instance {
|
|
|
8612
8630
|
readonly _nominal_OmniRecommendationsService: unique symbol;
|
|
8613
8631
|
}
|
|
8614
8632
|
/**
|
|
8633
|
+
* **Deprecated:** This class is deprecated and should not be used for new work. Use `HttpService` instead and see the [In-experience HTTP requests guide](../../../cloud-services/http-service.md).
|
|
8634
|
+
*
|
|
8615
8635
|
* - **Tags**: NotCreatable, NotReplicated
|
|
8616
8636
|
*
|
|
8617
8637
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/OpenCloudApiV1)
|
|
@@ -8629,6 +8649,8 @@ interface OpenCloudApiV1 extends Instance {
|
|
|
8629
8649
|
readonly _nominal_OpenCloudApiV1: unique symbol;
|
|
8630
8650
|
}
|
|
8631
8651
|
/**
|
|
8652
|
+
* **Deprecated:** This class is deprecated and should not be used for new work. Use `HttpService` instead and see the [In-experience HTTP requests guide](../../../cloud-services/http-service.md).
|
|
8653
|
+
*
|
|
8632
8654
|
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
8633
8655
|
*
|
|
8634
8656
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/OpenCloudService)
|
|
@@ -15403,6 +15425,8 @@ interface TerrainWriteOperation extends RBXObject {
|
|
|
15403
15425
|
readonly _nominal_TerrainWriteOperation: unique symbol;
|
|
15404
15426
|
}
|
|
15405
15427
|
/**
|
|
15428
|
+
* An object for sampling frames from video content.
|
|
15429
|
+
*
|
|
15406
15430
|
* - **Tags**: NotCreatable
|
|
15407
15431
|
*
|
|
15408
15432
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VideoSampler)
|
|
@@ -1590,6 +1590,51 @@ declare namespace Enum {
|
|
|
1590
1590
|
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.AnimationClipFromVideoStatus | undefined;
|
|
1591
1591
|
}
|
|
1592
1592
|
export type AnimationClipFromVideoStatus = AnimationClipFromVideoStatus.Initializing | AnimationClipFromVideoStatus.Pending | AnimationClipFromVideoStatus.Processing | AnimationClipFromVideoStatus.ErrorGeneric | AnimationClipFromVideoStatus.Success | AnimationClipFromVideoStatus.ErrorVideoTooLong | AnimationClipFromVideoStatus.ErrorNoPersonDetected | AnimationClipFromVideoStatus.ErrorVideoUnstable | AnimationClipFromVideoStatus.Timeout | AnimationClipFromVideoStatus.Cancelled | AnimationClipFromVideoStatus.ErrorMultiplePeople | AnimationClipFromVideoStatus.ErrorUploadingVideo;
|
|
1593
|
+
/**
|
|
1594
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnimationNodePlayMode)
|
|
1595
|
+
*/
|
|
1596
|
+
export namespace AnimationNodePlayMode {
|
|
1597
|
+
/**
|
|
1598
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnimationNodePlayMode#Loop)
|
|
1599
|
+
*/
|
|
1600
|
+
export interface Loop extends globalThis.EnumItem {
|
|
1601
|
+
Name: "Loop";
|
|
1602
|
+
Value: 0;
|
|
1603
|
+
EnumType: typeof globalThis.Enum.AnimationNodePlayMode;
|
|
1604
|
+
}
|
|
1605
|
+
export const Loop: Loop;
|
|
1606
|
+
/**
|
|
1607
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnimationNodePlayMode#PingPong)
|
|
1608
|
+
*/
|
|
1609
|
+
export interface PingPong extends globalThis.EnumItem {
|
|
1610
|
+
Name: "PingPong";
|
|
1611
|
+
Value: 1;
|
|
1612
|
+
EnumType: typeof globalThis.Enum.AnimationNodePlayMode;
|
|
1613
|
+
}
|
|
1614
|
+
export const PingPong: PingPong;
|
|
1615
|
+
/**
|
|
1616
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnimationNodePlayMode#OnceAndHold)
|
|
1617
|
+
*/
|
|
1618
|
+
export interface OnceAndHold extends globalThis.EnumItem {
|
|
1619
|
+
Name: "OnceAndHold";
|
|
1620
|
+
Value: 2;
|
|
1621
|
+
EnumType: typeof globalThis.Enum.AnimationNodePlayMode;
|
|
1622
|
+
}
|
|
1623
|
+
export const OnceAndHold: OnceAndHold;
|
|
1624
|
+
/**
|
|
1625
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnimationNodePlayMode#OnceAndReset)
|
|
1626
|
+
*/
|
|
1627
|
+
export interface OnceAndReset extends globalThis.EnumItem {
|
|
1628
|
+
Name: "OnceAndReset";
|
|
1629
|
+
Value: 3;
|
|
1630
|
+
EnumType: typeof globalThis.Enum.AnimationNodePlayMode;
|
|
1631
|
+
}
|
|
1632
|
+
export const OnceAndReset: OnceAndReset;
|
|
1633
|
+
export function GetEnumItems(this: globalThis.Enum): Array<globalThis.Enum.AnimationNodePlayMode>;
|
|
1634
|
+
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.AnimationNodePlayMode | undefined;
|
|
1635
|
+
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.AnimationNodePlayMode | undefined;
|
|
1636
|
+
}
|
|
1637
|
+
export type AnimationNodePlayMode = AnimationNodePlayMode.Loop | AnimationNodePlayMode.PingPong | AnimationNodePlayMode.OnceAndHold | AnimationNodePlayMode.OnceAndReset;
|
|
1593
1638
|
/**
|
|
1594
1639
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AnimationNodeType)
|
|
1595
1640
|
*/
|
|
@@ -3147,6 +3192,33 @@ declare namespace Enum {
|
|
|
3147
3192
|
EnumType: typeof globalThis.Enum.AssetType;
|
|
3148
3193
|
}
|
|
3149
3194
|
export const DynamicHead: DynamicHead;
|
|
3195
|
+
/**
|
|
3196
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AssetType#FaceMakeup)
|
|
3197
|
+
*/
|
|
3198
|
+
export interface FaceMakeup extends globalThis.EnumItem {
|
|
3199
|
+
Name: "FaceMakeup";
|
|
3200
|
+
Value: 88;
|
|
3201
|
+
EnumType: typeof globalThis.Enum.AssetType;
|
|
3202
|
+
}
|
|
3203
|
+
export const FaceMakeup: FaceMakeup;
|
|
3204
|
+
/**
|
|
3205
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AssetType#LipMakeup)
|
|
3206
|
+
*/
|
|
3207
|
+
export interface LipMakeup extends globalThis.EnumItem {
|
|
3208
|
+
Name: "LipMakeup";
|
|
3209
|
+
Value: 89;
|
|
3210
|
+
EnumType: typeof globalThis.Enum.AssetType;
|
|
3211
|
+
}
|
|
3212
|
+
export const LipMakeup: LipMakeup;
|
|
3213
|
+
/**
|
|
3214
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AssetType#EyeMakeup)
|
|
3215
|
+
*/
|
|
3216
|
+
export interface EyeMakeup extends globalThis.EnumItem {
|
|
3217
|
+
Name: "EyeMakeup";
|
|
3218
|
+
Value: 90;
|
|
3219
|
+
EnumType: typeof globalThis.Enum.AssetType;
|
|
3220
|
+
}
|
|
3221
|
+
export const EyeMakeup: EyeMakeup;
|
|
3150
3222
|
/**
|
|
3151
3223
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AssetType#EarAccessory)
|
|
3152
3224
|
*/
|
|
@@ -3169,7 +3241,7 @@ declare namespace Enum {
|
|
|
3169
3241
|
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.AssetType | undefined;
|
|
3170
3242
|
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.AssetType | undefined;
|
|
3171
3243
|
}
|
|
3172
|
-
export type AssetType = AssetType.Image | AssetType.TShirt | AssetType.Audio | AssetType.Mesh | AssetType.Lua | AssetType.Hat | AssetType.Place | AssetType.Model | AssetType.Shirt | AssetType.Pants | AssetType.Decal | AssetType.Head | AssetType.Face | AssetType.Gear | AssetType.Badge | AssetType.Animation | AssetType.Torso | AssetType.RightArm | AssetType.LeftArm | AssetType.LeftLeg | AssetType.RightLeg | AssetType.Package | AssetType.GamePass | AssetType.Plugin | AssetType.MeshPart | AssetType.HairAccessory | AssetType.FaceAccessory | AssetType.NeckAccessory | AssetType.ShoulderAccessory | AssetType.FrontAccessory | AssetType.BackAccessory | AssetType.WaistAccessory | AssetType.ClimbAnimation | AssetType.DeathAnimation | AssetType.FallAnimation | AssetType.IdleAnimation | AssetType.JumpAnimation | AssetType.RunAnimation | AssetType.SwimAnimation | AssetType.WalkAnimation | AssetType.PoseAnimation | AssetType.EmoteAnimation | AssetType.Video | AssetType.TShirtAccessory | AssetType.ShirtAccessory | AssetType.PantsAccessory | AssetType.JacketAccessory | AssetType.SweaterAccessory | AssetType.ShortsAccessory | AssetType.LeftShoeAccessory | AssetType.RightShoeAccessory | AssetType.DressSkirtAccessory | AssetType.FontFamily | AssetType.EyebrowAccessory | AssetType.EyelashAccessory | AssetType.MoodAnimation | AssetType.DynamicHead | AssetType.EarAccessory | AssetType.EyeAccessory;
|
|
3244
|
+
export type AssetType = AssetType.Image | AssetType.TShirt | AssetType.Audio | AssetType.Mesh | AssetType.Lua | AssetType.Hat | AssetType.Place | AssetType.Model | AssetType.Shirt | AssetType.Pants | AssetType.Decal | AssetType.Head | AssetType.Face | AssetType.Gear | AssetType.Badge | AssetType.Animation | AssetType.Torso | AssetType.RightArm | AssetType.LeftArm | AssetType.LeftLeg | AssetType.RightLeg | AssetType.Package | AssetType.GamePass | AssetType.Plugin | AssetType.MeshPart | AssetType.HairAccessory | AssetType.FaceAccessory | AssetType.NeckAccessory | AssetType.ShoulderAccessory | AssetType.FrontAccessory | AssetType.BackAccessory | AssetType.WaistAccessory | AssetType.ClimbAnimation | AssetType.DeathAnimation | AssetType.FallAnimation | AssetType.IdleAnimation | AssetType.JumpAnimation | AssetType.RunAnimation | AssetType.SwimAnimation | AssetType.WalkAnimation | AssetType.PoseAnimation | AssetType.EmoteAnimation | AssetType.Video | AssetType.TShirtAccessory | AssetType.ShirtAccessory | AssetType.PantsAccessory | AssetType.JacketAccessory | AssetType.SweaterAccessory | AssetType.ShortsAccessory | AssetType.LeftShoeAccessory | AssetType.RightShoeAccessory | AssetType.DressSkirtAccessory | AssetType.FontFamily | AssetType.EyebrowAccessory | AssetType.EyelashAccessory | AssetType.MoodAnimation | AssetType.DynamicHead | AssetType.FaceMakeup | AssetType.LipMakeup | AssetType.EyeMakeup | AssetType.EarAccessory | AssetType.EyeAccessory;
|
|
3173
3245
|
/**
|
|
3174
3246
|
* Determines the asset type verification mode.
|
|
3175
3247
|
*
|
|
@@ -4143,11 +4215,38 @@ declare namespace Enum {
|
|
|
4143
4215
|
EnumType: typeof globalThis.Enum.AvatarAssetType;
|
|
4144
4216
|
}
|
|
4145
4217
|
export const DynamicHead: DynamicHead;
|
|
4218
|
+
/**
|
|
4219
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarAssetType#FaceMakeup)
|
|
4220
|
+
*/
|
|
4221
|
+
export interface FaceMakeup extends globalThis.EnumItem {
|
|
4222
|
+
Name: "FaceMakeup";
|
|
4223
|
+
Value: 88;
|
|
4224
|
+
EnumType: typeof globalThis.Enum.AvatarAssetType;
|
|
4225
|
+
}
|
|
4226
|
+
export const FaceMakeup: FaceMakeup;
|
|
4227
|
+
/**
|
|
4228
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarAssetType#LipMakeup)
|
|
4229
|
+
*/
|
|
4230
|
+
export interface LipMakeup extends globalThis.EnumItem {
|
|
4231
|
+
Name: "LipMakeup";
|
|
4232
|
+
Value: 89;
|
|
4233
|
+
EnumType: typeof globalThis.Enum.AvatarAssetType;
|
|
4234
|
+
}
|
|
4235
|
+
export const LipMakeup: LipMakeup;
|
|
4236
|
+
/**
|
|
4237
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarAssetType#EyeMakeup)
|
|
4238
|
+
*/
|
|
4239
|
+
export interface EyeMakeup extends globalThis.EnumItem {
|
|
4240
|
+
Name: "EyeMakeup";
|
|
4241
|
+
Value: 90;
|
|
4242
|
+
EnumType: typeof globalThis.Enum.AvatarAssetType;
|
|
4243
|
+
}
|
|
4244
|
+
export const EyeMakeup: EyeMakeup;
|
|
4146
4245
|
export function GetEnumItems(this: globalThis.Enum): Array<globalThis.Enum.AvatarAssetType>;
|
|
4147
4246
|
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.AvatarAssetType | undefined;
|
|
4148
4247
|
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.AvatarAssetType | undefined;
|
|
4149
4248
|
}
|
|
4150
|
-
export type AvatarAssetType = AvatarAssetType.TShirt | AvatarAssetType.Hat | AvatarAssetType.Shirt | AvatarAssetType.Pants | AvatarAssetType.Head | AvatarAssetType.Face | AvatarAssetType.Gear | AvatarAssetType.Torso | AvatarAssetType.RightArm | AvatarAssetType.LeftArm | AvatarAssetType.LeftLeg | AvatarAssetType.RightLeg | AvatarAssetType.HairAccessory | AvatarAssetType.FaceAccessory | AvatarAssetType.NeckAccessory | AvatarAssetType.ShoulderAccessory | AvatarAssetType.FrontAccessory | AvatarAssetType.BackAccessory | AvatarAssetType.WaistAccessory | AvatarAssetType.ClimbAnimation | AvatarAssetType.FallAnimation | AvatarAssetType.IdleAnimation | AvatarAssetType.JumpAnimation | AvatarAssetType.RunAnimation | AvatarAssetType.SwimAnimation | AvatarAssetType.WalkAnimation | AvatarAssetType.MoodAnimation | AvatarAssetType.EmoteAnimation | AvatarAssetType.TShirtAccessory | AvatarAssetType.ShirtAccessory | AvatarAssetType.PantsAccessory | AvatarAssetType.JacketAccessory | AvatarAssetType.SweaterAccessory | AvatarAssetType.ShortsAccessory | AvatarAssetType.LeftShoeAccessory | AvatarAssetType.RightShoeAccessory | AvatarAssetType.DressSkirtAccessory | AvatarAssetType.EyebrowAccessory | AvatarAssetType.EyelashAccessory | AvatarAssetType.DynamicHead;
|
|
4249
|
+
export type AvatarAssetType = AvatarAssetType.TShirt | AvatarAssetType.Hat | AvatarAssetType.Shirt | AvatarAssetType.Pants | AvatarAssetType.Head | AvatarAssetType.Face | AvatarAssetType.Gear | AvatarAssetType.Torso | AvatarAssetType.RightArm | AvatarAssetType.LeftArm | AvatarAssetType.LeftLeg | AvatarAssetType.RightLeg | AvatarAssetType.HairAccessory | AvatarAssetType.FaceAccessory | AvatarAssetType.NeckAccessory | AvatarAssetType.ShoulderAccessory | AvatarAssetType.FrontAccessory | AvatarAssetType.BackAccessory | AvatarAssetType.WaistAccessory | AvatarAssetType.ClimbAnimation | AvatarAssetType.FallAnimation | AvatarAssetType.IdleAnimation | AvatarAssetType.JumpAnimation | AvatarAssetType.RunAnimation | AvatarAssetType.SwimAnimation | AvatarAssetType.WalkAnimation | AvatarAssetType.MoodAnimation | AvatarAssetType.EmoteAnimation | AvatarAssetType.TShirtAccessory | AvatarAssetType.ShirtAccessory | AvatarAssetType.PantsAccessory | AvatarAssetType.JacketAccessory | AvatarAssetType.SweaterAccessory | AvatarAssetType.ShortsAccessory | AvatarAssetType.LeftShoeAccessory | AvatarAssetType.RightShoeAccessory | AvatarAssetType.DressSkirtAccessory | AvatarAssetType.EyebrowAccessory | AvatarAssetType.EyelashAccessory | AvatarAssetType.DynamicHead | AvatarAssetType.FaceMakeup | AvatarAssetType.LipMakeup | AvatarAssetType.EyeMakeup;
|
|
4151
4250
|
/**
|
|
4152
4251
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/AvatarChatServiceFeature)
|
|
4153
4252
|
*/
|
|
@@ -11358,6 +11457,33 @@ declare namespace Enum {
|
|
|
11358
11457
|
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.ExperienceEventStatus | undefined;
|
|
11359
11458
|
}
|
|
11360
11459
|
export type ExperienceEventStatus = ExperienceEventStatus.Active | ExperienceEventStatus.Cancelled | ExperienceEventStatus.Moderated | ExperienceEventStatus.Unpublished | ExperienceEventStatus.Unknown;
|
|
11460
|
+
/**
|
|
11461
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ExperienceStateCaptureSelectionMode)
|
|
11462
|
+
*/
|
|
11463
|
+
export namespace ExperienceStateCaptureSelectionMode {
|
|
11464
|
+
/**
|
|
11465
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ExperienceStateCaptureSelectionMode#Default)
|
|
11466
|
+
*/
|
|
11467
|
+
export interface Default extends globalThis.EnumItem {
|
|
11468
|
+
Name: "Default";
|
|
11469
|
+
Value: 0;
|
|
11470
|
+
EnumType: typeof globalThis.Enum.ExperienceStateCaptureSelectionMode;
|
|
11471
|
+
}
|
|
11472
|
+
export const Default: Default;
|
|
11473
|
+
/**
|
|
11474
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ExperienceStateCaptureSelectionMode#SafetyHighlightMode)
|
|
11475
|
+
*/
|
|
11476
|
+
export interface SafetyHighlightMode extends globalThis.EnumItem {
|
|
11477
|
+
Name: "SafetyHighlightMode";
|
|
11478
|
+
Value: 1;
|
|
11479
|
+
EnumType: typeof globalThis.Enum.ExperienceStateCaptureSelectionMode;
|
|
11480
|
+
}
|
|
11481
|
+
export const SafetyHighlightMode: SafetyHighlightMode;
|
|
11482
|
+
export function GetEnumItems(this: globalThis.Enum): Array<globalThis.Enum.ExperienceStateCaptureSelectionMode>;
|
|
11483
|
+
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.ExperienceStateCaptureSelectionMode | undefined;
|
|
11484
|
+
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.ExperienceStateCaptureSelectionMode | undefined;
|
|
11485
|
+
}
|
|
11486
|
+
export type ExperienceStateCaptureSelectionMode = ExperienceStateCaptureSelectionMode.Default | ExperienceStateCaptureSelectionMode.SafetyHighlightMode;
|
|
11361
11487
|
/**
|
|
11362
11488
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ExperienceStateRecordingLoadMode)
|
|
11363
11489
|
*/
|
|
@@ -16058,6 +16184,8 @@ declare namespace Enum {
|
|
|
16058
16184
|
}
|
|
16059
16185
|
export const Direction3D: Direction3D;
|
|
16060
16186
|
/**
|
|
16187
|
+
* The `InputAction` will receive `Vector2` values representing the absolute pixel (**X**, **Y**) coordinates of a pointer input in the viewport.
|
|
16188
|
+
*
|
|
16061
16189
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/InputActionType#ViewportPosition)
|
|
16062
16190
|
*/
|
|
16063
16191
|
export interface ViewportPosition extends globalThis.EnumItem {
|
|
@@ -18141,6 +18269,8 @@ declare namespace Enum {
|
|
|
18141
18269
|
}
|
|
18142
18270
|
export const Thumbstick2: Thumbstick2;
|
|
18143
18271
|
/**
|
|
18272
|
+
* Up vector on the gamepad primary thumbstick. Primarily used in the [Input Action System](../../../input/input-action-system.md).
|
|
18273
|
+
*
|
|
18144
18274
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/KeyCode#Thumbstick1Up)
|
|
18145
18275
|
*/
|
|
18146
18276
|
export interface Thumbstick1Up extends globalThis.EnumItem {
|
|
@@ -18150,6 +18280,8 @@ declare namespace Enum {
|
|
|
18150
18280
|
}
|
|
18151
18281
|
export const Thumbstick1Up: Thumbstick1Up;
|
|
18152
18282
|
/**
|
|
18283
|
+
* Down vector on the gamepad primary thumbstick. Primarily used in the [Input Action System](../../../input/input-action-system.md).
|
|
18284
|
+
*
|
|
18153
18285
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/KeyCode#Thumbstick1Down)
|
|
18154
18286
|
*/
|
|
18155
18287
|
export interface Thumbstick1Down extends globalThis.EnumItem {
|
|
@@ -18159,6 +18291,8 @@ declare namespace Enum {
|
|
|
18159
18291
|
}
|
|
18160
18292
|
export const Thumbstick1Down: Thumbstick1Down;
|
|
18161
18293
|
/**
|
|
18294
|
+
* Left vector on the gamepad primary thumbstick. Primarily used in the [Input Action System](../../../input/input-action-system.md).
|
|
18295
|
+
*
|
|
18162
18296
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/KeyCode#Thumbstick1Left)
|
|
18163
18297
|
*/
|
|
18164
18298
|
export interface Thumbstick1Left extends globalThis.EnumItem {
|
|
@@ -18168,6 +18302,8 @@ declare namespace Enum {
|
|
|
18168
18302
|
}
|
|
18169
18303
|
export const Thumbstick1Left: Thumbstick1Left;
|
|
18170
18304
|
/**
|
|
18305
|
+
* Right vector on the gamepad primary thumbstick. Primarily used in the [Input Action System](../../../input/input-action-system.md).
|
|
18306
|
+
*
|
|
18171
18307
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/KeyCode#Thumbstick1Right)
|
|
18172
18308
|
*/
|
|
18173
18309
|
export interface Thumbstick1Right extends globalThis.EnumItem {
|
|
@@ -18177,6 +18313,8 @@ declare namespace Enum {
|
|
|
18177
18313
|
}
|
|
18178
18314
|
export const Thumbstick1Right: Thumbstick1Right;
|
|
18179
18315
|
/**
|
|
18316
|
+
* Up vector on the gamepad secondary thumbstick. Primarily used in the [Input Action System](../../../input/input-action-system.md).
|
|
18317
|
+
*
|
|
18180
18318
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/KeyCode#Thumbstick2Up)
|
|
18181
18319
|
*/
|
|
18182
18320
|
export interface Thumbstick2Up extends globalThis.EnumItem {
|
|
@@ -18186,6 +18324,8 @@ declare namespace Enum {
|
|
|
18186
18324
|
}
|
|
18187
18325
|
export const Thumbstick2Up: Thumbstick2Up;
|
|
18188
18326
|
/**
|
|
18327
|
+
* Down vector on the gamepad secondary thumbstick. Primarily used in the [Input Action System](../../../input/input-action-system.md).
|
|
18328
|
+
*
|
|
18189
18329
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/KeyCode#Thumbstick2Down)
|
|
18190
18330
|
*/
|
|
18191
18331
|
export interface Thumbstick2Down extends globalThis.EnumItem {
|
|
@@ -18195,6 +18335,8 @@ declare namespace Enum {
|
|
|
18195
18335
|
}
|
|
18196
18336
|
export const Thumbstick2Down: Thumbstick2Down;
|
|
18197
18337
|
/**
|
|
18338
|
+
* Left vector on the gamepad secondary thumbstick. Primarily used in the [Input Action System](../../../input/input-action-system.md).
|
|
18339
|
+
*
|
|
18198
18340
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/KeyCode#Thumbstick2Left)
|
|
18199
18341
|
*/
|
|
18200
18342
|
export interface Thumbstick2Left extends globalThis.EnumItem {
|
|
@@ -18204,6 +18346,8 @@ declare namespace Enum {
|
|
|
18204
18346
|
}
|
|
18205
18347
|
export const Thumbstick2Left: Thumbstick2Left;
|
|
18206
18348
|
/**
|
|
18349
|
+
* Right vector on the gamepad secondary thumbstick. Primarily used in the [Input Action System](../../../input/input-action-system.md).
|
|
18350
|
+
*
|
|
18207
18351
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/KeyCode#Thumbstick2Right)
|
|
18208
18352
|
*/
|
|
18209
18353
|
export interface Thumbstick2Right extends globalThis.EnumItem {
|
|
@@ -18240,6 +18384,8 @@ declare namespace Enum {
|
|
|
18240
18384
|
}
|
|
18241
18385
|
export const MouseMiddleButton: MouseMiddleButton;
|
|
18242
18386
|
/**
|
|
18387
|
+
* The position of a mouse in the viewport. Primarily used in the [Input Action System](../../../input/input-action-system.md).
|
|
18388
|
+
*
|
|
18243
18389
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/KeyCode#MousePosition)
|
|
18244
18390
|
*/
|
|
18245
18391
|
export interface MousePosition extends globalThis.EnumItem {
|
|
@@ -28977,6 +29123,69 @@ declare namespace Enum {
|
|
|
28977
29123
|
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.Status | undefined;
|
|
28978
29124
|
}
|
|
28979
29125
|
export type Status = Status.Poison | Status.Confusion;
|
|
29126
|
+
/**
|
|
29127
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/StepFrequency)
|
|
29128
|
+
*/
|
|
29129
|
+
export namespace StepFrequency {
|
|
29130
|
+
/**
|
|
29131
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/StepFrequency#Hz60)
|
|
29132
|
+
*/
|
|
29133
|
+
export interface Hz60 extends globalThis.EnumItem {
|
|
29134
|
+
Name: "Hz60";
|
|
29135
|
+
Value: 0;
|
|
29136
|
+
EnumType: typeof globalThis.Enum.StepFrequency;
|
|
29137
|
+
}
|
|
29138
|
+
export const Hz60: Hz60;
|
|
29139
|
+
/**
|
|
29140
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/StepFrequency#Hz30)
|
|
29141
|
+
*/
|
|
29142
|
+
export interface Hz30 extends globalThis.EnumItem {
|
|
29143
|
+
Name: "Hz30";
|
|
29144
|
+
Value: 1;
|
|
29145
|
+
EnumType: typeof globalThis.Enum.StepFrequency;
|
|
29146
|
+
}
|
|
29147
|
+
export const Hz30: Hz30;
|
|
29148
|
+
/**
|
|
29149
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/StepFrequency#Hz15)
|
|
29150
|
+
*/
|
|
29151
|
+
export interface Hz15 extends globalThis.EnumItem {
|
|
29152
|
+
Name: "Hz15";
|
|
29153
|
+
Value: 2;
|
|
29154
|
+
EnumType: typeof globalThis.Enum.StepFrequency;
|
|
29155
|
+
}
|
|
29156
|
+
export const Hz15: Hz15;
|
|
29157
|
+
/**
|
|
29158
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/StepFrequency#Hz10)
|
|
29159
|
+
*/
|
|
29160
|
+
export interface Hz10 extends globalThis.EnumItem {
|
|
29161
|
+
Name: "Hz10";
|
|
29162
|
+
Value: 3;
|
|
29163
|
+
EnumType: typeof globalThis.Enum.StepFrequency;
|
|
29164
|
+
}
|
|
29165
|
+
export const Hz10: Hz10;
|
|
29166
|
+
/**
|
|
29167
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/StepFrequency#Hz5)
|
|
29168
|
+
*/
|
|
29169
|
+
export interface Hz5 extends globalThis.EnumItem {
|
|
29170
|
+
Name: "Hz5";
|
|
29171
|
+
Value: 4;
|
|
29172
|
+
EnumType: typeof globalThis.Enum.StepFrequency;
|
|
29173
|
+
}
|
|
29174
|
+
export const Hz5: Hz5;
|
|
29175
|
+
/**
|
|
29176
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/StepFrequency#Hz1)
|
|
29177
|
+
*/
|
|
29178
|
+
export interface Hz1 extends globalThis.EnumItem {
|
|
29179
|
+
Name: "Hz1";
|
|
29180
|
+
Value: 5;
|
|
29181
|
+
EnumType: typeof globalThis.Enum.StepFrequency;
|
|
29182
|
+
}
|
|
29183
|
+
export const Hz1: Hz1;
|
|
29184
|
+
export function GetEnumItems(this: globalThis.Enum): Array<globalThis.Enum.StepFrequency>;
|
|
29185
|
+
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.StepFrequency | undefined;
|
|
29186
|
+
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.StepFrequency | undefined;
|
|
29187
|
+
}
|
|
29188
|
+
export type StepFrequency = StepFrequency.Hz60 | StepFrequency.Hz30 | StepFrequency.Hz15 | StepFrequency.Hz10 | StepFrequency.Hz5 | StepFrequency.Hz1;
|
|
28980
29189
|
/**
|
|
28981
29190
|
* Determines how content is streamed away from Players.
|
|
28982
29191
|
*
|