@rbxts/types 1.0.800 → 1.0.802
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.
|
@@ -148,6 +148,7 @@ interface Services {
|
|
|
148
148
|
StarterGui: StarterGui;
|
|
149
149
|
StarterPack: StarterPack;
|
|
150
150
|
StarterPlayer: StarterPlayer;
|
|
151
|
+
StartPageService: StartPageService;
|
|
151
152
|
StartupMessageService: StartupMessageService;
|
|
152
153
|
Stats: Stats;
|
|
153
154
|
StreamingService: StreamingService;
|
|
@@ -3190,6 +3191,10 @@ interface AvatarCreationService extends Instance {
|
|
|
3190
3191
|
* @deprecated
|
|
3191
3192
|
*/
|
|
3192
3193
|
readonly _nominal_AvatarCreationService: unique symbol;
|
|
3194
|
+
/**
|
|
3195
|
+
* Tags: CustomLuaState
|
|
3196
|
+
*/
|
|
3197
|
+
GetValidationRules(this: AvatarCreationService): object;
|
|
3193
3198
|
SendAnalyticsEvent(this: AvatarCreationService, eventName: string, params: object): void;
|
|
3194
3199
|
/**
|
|
3195
3200
|
* Tags: Yields
|
|
@@ -7812,11 +7817,13 @@ interface CommerceService extends Instance {
|
|
|
7812
7817
|
* @deprecated
|
|
7813
7818
|
*/
|
|
7814
7819
|
readonly _nominal_CommerceService: unique symbol;
|
|
7820
|
+
PromptCommerceProductPurchase(this: CommerceService, user: Player, commerceProductId: number): void;
|
|
7815
7821
|
PromptRealWorldCommerceBrowser(this: CommerceService, player: Player, url: string): void;
|
|
7816
7822
|
/**
|
|
7817
7823
|
* Tags: Yields
|
|
7818
7824
|
*/
|
|
7819
7825
|
UserEligibleForRealWorldCommerceAsync(this: CommerceService): boolean;
|
|
7826
|
+
readonly PromptCommerceProductPurchaseFinished: RBXScriptSignal<(user: Player, productId: number) => void>;
|
|
7820
7827
|
}
|
|
7821
7828
|
|
|
7822
7829
|
/** The Configuration object is a container object that is designed to hold value objects to make values used in [Tool](https://developer.roblox.com/en-us/api-reference/class/Tool)s or any model using [Script](https://developer.roblox.com/en-us/api-reference/class/Script)s more accessible.
|
|
@@ -10009,29 +10016,92 @@ interface EditableMesh extends DataModelMesh {
|
|
|
10009
10016
|
*/
|
|
10010
10017
|
readonly _nominal_EditableMesh: unique symbol;
|
|
10011
10018
|
SkinningEnabled: boolean;
|
|
10019
|
+
AddColor(this: EditableMesh, color: Color3, alpha: number): number;
|
|
10020
|
+
AddNormal(this: EditableMesh, normal: Vector3 | undefined): number;
|
|
10012
10021
|
AddTriangle(this: EditableMesh, vertexId0: number, vertexId1: number, vertexId2: number): number;
|
|
10022
|
+
AddUV(this: EditableMesh, uv: Vector2): number;
|
|
10013
10023
|
AddVertex(this: EditableMesh, p: Vector3): number;
|
|
10014
10024
|
FindClosestPointOnSurface(this: EditableMesh, point: Vector3): LuaTuple<[number, Vector3, Vector3]>;
|
|
10015
10025
|
FindClosestVertex(this: EditableMesh, toThisPoint: Vector3): number;
|
|
10016
10026
|
FindVerticesWithinSphere(this: EditableMesh, center: Vector3, radius: number): Array<number>;
|
|
10027
|
+
GetAdjacentFaces(this: EditableMesh, faceId: number): unknown;
|
|
10028
|
+
/**
|
|
10029
|
+
* @deprecated
|
|
10030
|
+
*/
|
|
10017
10031
|
GetAdjacentTriangles(this: EditableMesh, triangleId: number): Array<number>;
|
|
10018
10032
|
GetAdjacentVertices(this: EditableMesh, vertexId: number): Array<number>;
|
|
10033
|
+
GetColor(this: EditableMesh, colorId: number): Color3 | undefined;
|
|
10034
|
+
GetColorAlpha(this: EditableMesh, colorId: number): number | undefined;
|
|
10035
|
+
GetColors(this: EditableMesh): unknown;
|
|
10036
|
+
GetFaceColors(this: EditableMesh, faceId: number): unknown;
|
|
10037
|
+
GetFaceNormals(this: EditableMesh, faceId: number): unknown;
|
|
10038
|
+
GetFaceUVs(this: EditableMesh, faceId: number): unknown;
|
|
10039
|
+
GetFaceVertices(this: EditableMesh, faceId: number): unknown;
|
|
10040
|
+
GetFaces(this: EditableMesh): unknown;
|
|
10041
|
+
GetFacesWithAttribute(this: EditableMesh, id: number): unknown;
|
|
10042
|
+
GetNormal(this: EditableMesh, normalId: number): Vector3 | undefined;
|
|
10043
|
+
GetNormals(this: EditableMesh): unknown;
|
|
10019
10044
|
GetPosition(this: EditableMesh, vertexId: number): Vector3;
|
|
10045
|
+
/**
|
|
10046
|
+
* @deprecated
|
|
10047
|
+
*/
|
|
10020
10048
|
GetTriangleVertices(this: EditableMesh, triangleId: number): LuaTuple<[number, number, number]>;
|
|
10049
|
+
/**
|
|
10050
|
+
* @deprecated
|
|
10051
|
+
*/
|
|
10021
10052
|
GetTriangles(this: EditableMesh): Array<number>;
|
|
10022
|
-
GetUV(this: EditableMesh,
|
|
10053
|
+
GetUV(this: EditableMesh, uvId: number): Vector2 | undefined;
|
|
10054
|
+
GetUVs(this: EditableMesh): unknown;
|
|
10055
|
+
/**
|
|
10056
|
+
* @deprecated
|
|
10057
|
+
*/
|
|
10023
10058
|
GetVertexColor(this: EditableMesh, vertexId: number): Color3;
|
|
10059
|
+
/**
|
|
10060
|
+
* @deprecated
|
|
10061
|
+
*/
|
|
10024
10062
|
GetVertexColorAlpha(this: EditableMesh, vertexId: number): number;
|
|
10063
|
+
/**
|
|
10064
|
+
* @deprecated
|
|
10065
|
+
*/
|
|
10025
10066
|
GetVertexNormal(this: EditableMesh, vertexId: number): Vector3;
|
|
10026
10067
|
GetVertices(this: EditableMesh): Array<number>;
|
|
10068
|
+
GetVerticesWithAttribute(this: EditableMesh, id: number): unknown;
|
|
10069
|
+
IdDebugString(this: EditableMesh, id: number): string;
|
|
10070
|
+
MergeVertices(this: EditableMesh, mergeTolerance: number): object;
|
|
10027
10071
|
RaycastLocal(this: EditableMesh, origin: Vector3, direction: Vector3): LuaTuple<[number, Vector3, Vector3]>;
|
|
10072
|
+
RemoveFace(this: EditableMesh, faceId: number): void;
|
|
10073
|
+
/**
|
|
10074
|
+
* @deprecated
|
|
10075
|
+
*/
|
|
10028
10076
|
RemoveTriangle(this: EditableMesh, triangleId: number): void;
|
|
10077
|
+
RemoveUnused(this: EditableMesh): unknown;
|
|
10078
|
+
/**
|
|
10079
|
+
* @deprecated
|
|
10080
|
+
*/
|
|
10029
10081
|
RemoveVertex(this: EditableMesh, vertexId: number): void;
|
|
10082
|
+
ResetNormal(this: EditableMesh, normalId: number): void;
|
|
10083
|
+
SetColor(this: EditableMesh, colorId: number, color: Color3): void;
|
|
10084
|
+
SetColorAlpha(this: EditableMesh, colorId: number, alpha: number): void;
|
|
10085
|
+
SetFaceColors(this: EditableMesh, faceId: number, ids: Array<any>): void;
|
|
10086
|
+
SetFaceNormals(this: EditableMesh, faceId: number, ids: Array<any>): void;
|
|
10087
|
+
SetFaceUVs(this: EditableMesh, faceId: number, ids: Array<any>): void;
|
|
10088
|
+
SetFaceVertices(this: EditableMesh, faceId: number, ids: Array<any>): void;
|
|
10089
|
+
SetNormal(this: EditableMesh, normalId: number, normal: Vector3): void;
|
|
10030
10090
|
SetPosition(this: EditableMesh, vertexId: number, p: Vector3): void;
|
|
10031
|
-
SetUV(this: EditableMesh,
|
|
10091
|
+
SetUV(this: EditableMesh, uvId: number, uv: Vector2): void;
|
|
10092
|
+
/**
|
|
10093
|
+
* @deprecated
|
|
10094
|
+
*/
|
|
10032
10095
|
SetVertexColor(this: EditableMesh, vertexId: number, color: Color3): void;
|
|
10096
|
+
/**
|
|
10097
|
+
* @deprecated
|
|
10098
|
+
*/
|
|
10033
10099
|
SetVertexColorAlpha(this: EditableMesh, vertexId: number, alpha: number): void;
|
|
10100
|
+
/**
|
|
10101
|
+
* @deprecated
|
|
10102
|
+
*/
|
|
10034
10103
|
SetVertexNormal(this: EditableMesh, vertexId: number, vnormal: Vector3): void;
|
|
10104
|
+
Triangulate(this: EditableMesh): void;
|
|
10035
10105
|
/**
|
|
10036
10106
|
* Tags: Yields
|
|
10037
10107
|
*/
|
|
@@ -10961,12 +11031,20 @@ interface EditableImage extends Instance {
|
|
|
10961
11031
|
* Tags: CustomLuaState
|
|
10962
11032
|
*/
|
|
10963
11033
|
ReadPixels(this: EditableImage, position: Vector2, size: Vector2): Array<number>;
|
|
11034
|
+
/**
|
|
11035
|
+
* Tags: CustomLuaState
|
|
11036
|
+
*/
|
|
11037
|
+
ReadPixelsBuffer(this: EditableImage, position: Vector2, size: Vector2): buffer;
|
|
10964
11038
|
Resize(this: EditableImage, size: Vector2): void;
|
|
10965
11039
|
Rotate(this: EditableImage, degrees: number, changeSize: boolean): void;
|
|
10966
11040
|
/**
|
|
10967
11041
|
* Tags: CustomLuaState
|
|
10968
11042
|
*/
|
|
10969
11043
|
WritePixels(this: EditableImage, position: Vector2, size: Vector2, pixels: Array<any>): void;
|
|
11044
|
+
/**
|
|
11045
|
+
* Tags: CustomLuaState
|
|
11046
|
+
*/
|
|
11047
|
+
WritePixelsBuffer(this: EditableImage, position: Vector2, size: Vector2, buffer: buffer): void;
|
|
10970
11048
|
}
|
|
10971
11049
|
|
|
10972
11050
|
interface RobloxEditableImage extends EditableImage {
|
|
@@ -23063,19 +23141,31 @@ interface MarketplaceService extends Instance {
|
|
|
23063
23141
|
/**
|
|
23064
23142
|
* Tags: Yields
|
|
23065
23143
|
*/
|
|
23066
|
-
GetSubscriptionProductInfoAsync(this: MarketplaceService, subscriptionId: string):
|
|
23144
|
+
GetSubscriptionProductInfoAsync(this: MarketplaceService, subscriptionId: string): SubscriptionInfo;
|
|
23067
23145
|
/**
|
|
23068
23146
|
* Tags: Yields
|
|
23069
23147
|
*/
|
|
23070
|
-
GetUserSubscriptionDetailsAsync(
|
|
23148
|
+
GetUserSubscriptionDetailsAsync(
|
|
23149
|
+
this: MarketplaceService,
|
|
23150
|
+
user: Player,
|
|
23151
|
+
subscriptionId: string,
|
|
23152
|
+
): UserSubscriptionDetails;
|
|
23071
23153
|
/**
|
|
23072
23154
|
* Tags: Yields
|
|
23073
23155
|
*/
|
|
23074
|
-
GetUserSubscriptionPaymentHistoryAsync(
|
|
23156
|
+
GetUserSubscriptionPaymentHistoryAsync(
|
|
23157
|
+
this: MarketplaceService,
|
|
23158
|
+
user: Player,
|
|
23159
|
+
subscriptionId: string,
|
|
23160
|
+
): Array<UserSubscriptionPaymentHistory>;
|
|
23075
23161
|
/**
|
|
23076
23162
|
* Tags: Yields
|
|
23077
23163
|
*/
|
|
23078
|
-
GetUserSubscriptionStatusAsync(
|
|
23164
|
+
GetUserSubscriptionStatusAsync(
|
|
23165
|
+
this: MarketplaceService,
|
|
23166
|
+
user: Player,
|
|
23167
|
+
subscriptionId: string,
|
|
23168
|
+
): UserSubscriptionStatus;
|
|
23079
23169
|
/**
|
|
23080
23170
|
* Returns whether the inventory of given [Player](https://developer.roblox.com/en-us/api-reference/class/Player) contains an asset, given the ID. This method can query for hats, models, sounds, etc. This function takes a small amount of time to send a request the Roblox website.
|
|
23081
23171
|
*
|
|
@@ -33026,6 +33116,17 @@ interface StackFrame extends Instance {
|
|
|
33026
33116
|
readonly _nominal_StackFrame: unique symbol;
|
|
33027
33117
|
}
|
|
33028
33118
|
|
|
33119
|
+
interface StartPageService extends Instance {
|
|
33120
|
+
/**
|
|
33121
|
+
* **DO NOT USE!**
|
|
33122
|
+
*
|
|
33123
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
33124
|
+
* @hidden
|
|
33125
|
+
* @deprecated
|
|
33126
|
+
*/
|
|
33127
|
+
readonly _nominal_StartPageService: unique symbol;
|
|
33128
|
+
}
|
|
33129
|
+
|
|
33029
33130
|
/** StarterGear is a container that is automatically inserted into each [Player](https://developer.roblox.com/en-us/api-reference/class/Player) when the player joins the game. When a player spawns, the contents of that player's StarterGear is copied into the player's [Backpack](https://developer.roblox.com/en-us/api-reference/class/Backpack). Additionally, when a player connects to a game that permits gear, all of the appropriate gear [Tool](https://developer.roblox.com/en-us/api-reference/class/Tool) objects that the player owns are inserted into that player's StarterGear.
|
|
33030
33131
|
*
|
|
33031
33132
|
* Unlike [StarterPack](https://developer.roblox.com/en-us/api-reference/class/StarterPack), StarterGear is not a service but rather a child of each [Player](https://developer.roblox.com/en-us/api-reference/class/Player) object – this means that its contents are player-specific so that each player can have different [Tool](https://developer.roblox.com/en-us/api-reference/class/Tool)s within their [StarterGear](https://developer.roblox.com/en-us/api-reference/class/StarterGear). It is not replicated to any client, including the owning player.
|
|
@@ -33640,6 +33741,7 @@ interface StyleRule extends StyleBase {
|
|
|
33640
33741
|
* @deprecated
|
|
33641
33742
|
*/
|
|
33642
33743
|
readonly _nominal_StyleRule: unique symbol;
|
|
33744
|
+
Priority: number;
|
|
33643
33745
|
Selector: string;
|
|
33644
33746
|
/**
|
|
33645
33747
|
* Tags: NotReplicated
|
|
@@ -4301,14 +4301,10 @@ interface TestService extends Instance {
|
|
|
4301
4301
|
ExecuteWithStudioRun: boolean;
|
|
4302
4302
|
/**
|
|
4303
4303
|
* Sets whether or not the physics engine should be throttled to 30 FPS while the test is being ran.
|
|
4304
|
-
*
|
|
4305
|
-
* Tags: Hidden, NotReplicated
|
|
4306
4304
|
*/
|
|
4307
4305
|
Is30FpsThrottleEnabled: boolean;
|
|
4308
4306
|
/**
|
|
4309
4307
|
* Sets whether or not the physics environment should be throttled while running this test.
|
|
4310
|
-
*
|
|
4311
|
-
* Tags: Hidden, NotReplicated
|
|
4312
4308
|
*/
|
|
4313
4309
|
IsPhysicsEnvironmentalThrottled: boolean;
|
|
4314
4310
|
/**
|
|
@@ -3393,17 +3393,17 @@ declare namespace Enum {
|
|
|
3393
3393
|
|
|
3394
3394
|
export const Disabled: Disabled;
|
|
3395
3395
|
|
|
3396
|
-
export interface
|
|
3397
|
-
Name: "
|
|
3396
|
+
export interface Enabled extends globalThis.EnumItem {
|
|
3397
|
+
Name: "Enabled";
|
|
3398
3398
|
Value: 2;
|
|
3399
3399
|
EnumType: typeof globalThis.Enum.CSGAsyncDynamicCollision;
|
|
3400
3400
|
}
|
|
3401
3401
|
|
|
3402
|
-
export const
|
|
3402
|
+
export const Enabled: Enabled;
|
|
3403
3403
|
|
|
3404
3404
|
export function GetEnumItems(this: globalThis.Enum): Array<globalThis.Enum.CSGAsyncDynamicCollision>;
|
|
3405
3405
|
}
|
|
3406
|
-
export type CSGAsyncDynamicCollision = CSGAsyncDynamicCollision.Default | CSGAsyncDynamicCollision.Disabled | CSGAsyncDynamicCollision.
|
|
3406
|
+
export type CSGAsyncDynamicCollision = CSGAsyncDynamicCollision.Default | CSGAsyncDynamicCollision.Disabled | CSGAsyncDynamicCollision.Enabled;
|
|
3407
3407
|
|
|
3408
3408
|
export namespace CageType {
|
|
3409
3409
|
export interface Inner extends globalThis.EnumItem {
|
|
@@ -8569,6 +8569,35 @@ declare namespace Enum {
|
|
|
8569
8569
|
}
|
|
8570
8570
|
export type GraphicsMode = GraphicsMode.Automatic | GraphicsMode.Direct3D11 | GraphicsMode.OpenGL | GraphicsMode.Metal | GraphicsMode.Vulkan | GraphicsMode.NoGraphics;
|
|
8571
8571
|
|
|
8572
|
+
export namespace GraphicsOptimizationMode {
|
|
8573
|
+
export interface Performance extends globalThis.EnumItem {
|
|
8574
|
+
Name: "Performance";
|
|
8575
|
+
Value: 0;
|
|
8576
|
+
EnumType: typeof globalThis.Enum.GraphicsOptimizationMode;
|
|
8577
|
+
}
|
|
8578
|
+
|
|
8579
|
+
export const Performance: Performance;
|
|
8580
|
+
|
|
8581
|
+
export interface Balanced extends globalThis.EnumItem {
|
|
8582
|
+
Name: "Balanced";
|
|
8583
|
+
Value: 1;
|
|
8584
|
+
EnumType: typeof globalThis.Enum.GraphicsOptimizationMode;
|
|
8585
|
+
}
|
|
8586
|
+
|
|
8587
|
+
export const Balanced: Balanced;
|
|
8588
|
+
|
|
8589
|
+
export interface Quality extends globalThis.EnumItem {
|
|
8590
|
+
Name: "Quality";
|
|
8591
|
+
Value: 2;
|
|
8592
|
+
EnumType: typeof globalThis.Enum.GraphicsOptimizationMode;
|
|
8593
|
+
}
|
|
8594
|
+
|
|
8595
|
+
export const Quality: Quality;
|
|
8596
|
+
|
|
8597
|
+
export function GetEnumItems(this: globalThis.Enum): Array<globalThis.Enum.GraphicsOptimizationMode>;
|
|
8598
|
+
}
|
|
8599
|
+
export type GraphicsOptimizationMode = GraphicsOptimizationMode.Performance | GraphicsOptimizationMode.Balanced | GraphicsOptimizationMode.Quality;
|
|
8600
|
+
|
|
8572
8601
|
export namespace GuiState {
|
|
8573
8602
|
export interface Idle extends globalThis.EnumItem {
|
|
8574
8603
|
Name: "Idle";
|
|
@@ -13721,6 +13750,27 @@ declare namespace Enum {
|
|
|
13721
13750
|
}
|
|
13722
13751
|
export type NormalId = NormalId.Right | NormalId.Top | NormalId.Back | NormalId.Left | NormalId.Bottom | NormalId.Front;
|
|
13723
13752
|
|
|
13753
|
+
export namespace NotificationButtonType {
|
|
13754
|
+
export interface Primary extends globalThis.EnumItem {
|
|
13755
|
+
Name: "Primary";
|
|
13756
|
+
Value: 0;
|
|
13757
|
+
EnumType: typeof globalThis.Enum.NotificationButtonType;
|
|
13758
|
+
}
|
|
13759
|
+
|
|
13760
|
+
export const Primary: Primary;
|
|
13761
|
+
|
|
13762
|
+
export interface Secondary extends globalThis.EnumItem {
|
|
13763
|
+
Name: "Secondary";
|
|
13764
|
+
Value: 1;
|
|
13765
|
+
EnumType: typeof globalThis.Enum.NotificationButtonType;
|
|
13766
|
+
}
|
|
13767
|
+
|
|
13768
|
+
export const Secondary: Secondary;
|
|
13769
|
+
|
|
13770
|
+
export function GetEnumItems(this: globalThis.Enum): Array<globalThis.Enum.NotificationButtonType>;
|
|
13771
|
+
}
|
|
13772
|
+
export type NotificationButtonType = NotificationButtonType.Primary | NotificationButtonType.Secondary;
|
|
13773
|
+
|
|
13724
13774
|
export namespace OperationType {
|
|
13725
13775
|
export interface Null extends globalThis.EnumItem {
|
|
13726
13776
|
Name: "Null";
|
|
@@ -14302,6 +14352,35 @@ declare namespace Enum {
|
|
|
14302
14352
|
}
|
|
14303
14353
|
export type PathWaypointAction = PathWaypointAction.Walk | PathWaypointAction.Jump | PathWaypointAction.Custom;
|
|
14304
14354
|
|
|
14355
|
+
export namespace PathfindingUseImprovedSearch {
|
|
14356
|
+
export interface Default extends globalThis.EnumItem {
|
|
14357
|
+
Name: "Default";
|
|
14358
|
+
Value: 0;
|
|
14359
|
+
EnumType: typeof globalThis.Enum.PathfindingUseImprovedSearch;
|
|
14360
|
+
}
|
|
14361
|
+
|
|
14362
|
+
export const Default: Default;
|
|
14363
|
+
|
|
14364
|
+
export interface Disabled extends globalThis.EnumItem {
|
|
14365
|
+
Name: "Disabled";
|
|
14366
|
+
Value: 1;
|
|
14367
|
+
EnumType: typeof globalThis.Enum.PathfindingUseImprovedSearch;
|
|
14368
|
+
}
|
|
14369
|
+
|
|
14370
|
+
export const Disabled: Disabled;
|
|
14371
|
+
|
|
14372
|
+
export interface Enabled extends globalThis.EnumItem {
|
|
14373
|
+
Name: "Enabled";
|
|
14374
|
+
Value: 2;
|
|
14375
|
+
EnumType: typeof globalThis.Enum.PathfindingUseImprovedSearch;
|
|
14376
|
+
}
|
|
14377
|
+
|
|
14378
|
+
export const Enabled: Enabled;
|
|
14379
|
+
|
|
14380
|
+
export function GetEnumItems(this: globalThis.Enum): Array<globalThis.Enum.PathfindingUseImprovedSearch>;
|
|
14381
|
+
}
|
|
14382
|
+
export type PathfindingUseImprovedSearch = PathfindingUseImprovedSearch.Default | PathfindingUseImprovedSearch.Disabled | PathfindingUseImprovedSearch.Enabled;
|
|
14383
|
+
|
|
14305
14384
|
export namespace PermissionLevelShown {
|
|
14306
14385
|
export interface Game extends globalThis.EnumItem {
|
|
14307
14386
|
Name: "Game";
|
package/include/roblox.d.ts
CHANGED
|
@@ -3067,3 +3067,91 @@ interface VoxelChannels {
|
|
|
3067
3067
|
*/
|
|
3068
3068
|
LiquidOccupancy: number;
|
|
3069
3069
|
}
|
|
3070
|
+
|
|
3071
|
+
interface SubscriptionInfo {
|
|
3072
|
+
/**
|
|
3073
|
+
* The name of the subscription product.
|
|
3074
|
+
*/
|
|
3075
|
+
Name: string;
|
|
3076
|
+
/**
|
|
3077
|
+
* The description of the subscription product.
|
|
3078
|
+
*/
|
|
3079
|
+
Description: string;
|
|
3080
|
+
/**
|
|
3081
|
+
* The asset ID of the subscription product icon.
|
|
3082
|
+
*/
|
|
3083
|
+
IconImageAssetID: number;
|
|
3084
|
+
/**
|
|
3085
|
+
* The duration of the subscription (for example, `Month`, `Year`, etc.).
|
|
3086
|
+
*/
|
|
3087
|
+
SubscriptionPeriod: Enum.SubscriptionPeriod;
|
|
3088
|
+
/**
|
|
3089
|
+
* Localized price with the appropriate currency symbol for display (for example, `$4.99`). For users in unsupported countries, `DisplayPrice` returns a string without specific price information.
|
|
3090
|
+
*/
|
|
3091
|
+
DisplayPrice: string;
|
|
3092
|
+
/**
|
|
3093
|
+
* Localized subscription period text for display (for example, `/month`). Can be used together with `DisplayPrice`.
|
|
3094
|
+
*/
|
|
3095
|
+
DisplaySubscriptionPeriod: number;
|
|
3096
|
+
/**
|
|
3097
|
+
* Name of the subscription benefit provider (for example, the name of the associated experience).
|
|
3098
|
+
*/
|
|
3099
|
+
SubscriptionProviderName: string;
|
|
3100
|
+
/**
|
|
3101
|
+
* True if the subscription product is available for sale.
|
|
3102
|
+
*/
|
|
3103
|
+
IsForSale: boolean;
|
|
3104
|
+
/**
|
|
3105
|
+
* A number that can be used to compare the price of different subscription products. This is not the actual price of the subscription (for example, 499).
|
|
3106
|
+
*/
|
|
3107
|
+
PriceTier: number;
|
|
3108
|
+
}
|
|
3109
|
+
|
|
3110
|
+
interface UserSubscriptionDetails {
|
|
3111
|
+
/**
|
|
3112
|
+
* Current state of this particular subscription.
|
|
3113
|
+
*/
|
|
3114
|
+
SubscriptionState: Enum.SubscriptionState;
|
|
3115
|
+
/**
|
|
3116
|
+
* Renewal time for this current subscription. May be in the past if the subscription is in [SubscribedRenewalPaymentPending](https://create.roblox.com/docs/reference/engine/enums/SubscriptionState#SubscribedRenewalPaymentPending) state. This field is will be `nil` if the subscription will not renew, is [Expired](https://create.roblox.com/docs/reference/engine/enums/SubscriptionState#Expired), or the user never subscribed.
|
|
3117
|
+
*/
|
|
3118
|
+
NextRenewTime: DateTime | undefined;
|
|
3119
|
+
/**
|
|
3120
|
+
* When this subscription expires. This field will be nil if the subscription is not cancelled or the user never subscribed.
|
|
3121
|
+
*/
|
|
3122
|
+
ExpireTime: DateTime | undefined;
|
|
3123
|
+
/**
|
|
3124
|
+
* Table containing the details of the subscription expiration. This field will be `nil` if the subscription is not in the [Expired](https://create.roblox.com/docs/reference/engine/enums/SubscriptionState#Expired) state. If populated, the table contains a ExpirationReason key of type [Enum.SubscriptionExpirationReason](https://create.roblox.com/docs/reference/engine/enums/SubscriptionExpirationReason) describing why the subscription is expired.
|
|
3125
|
+
*/
|
|
3126
|
+
ExpirationDetails: ExpirationDetails | undefined;
|
|
3127
|
+
}
|
|
3128
|
+
|
|
3129
|
+
interface UserSubscriptionPaymentHistory {
|
|
3130
|
+
/**
|
|
3131
|
+
* [DateTime](https://create.roblox.com/docs/reference/engine/datatypes/DateTime) at the start of this particular subscription period.
|
|
3132
|
+
*/
|
|
3133
|
+
CycleStartTime: DateTime;
|
|
3134
|
+
/**
|
|
3135
|
+
* [DateTime](https://create.roblox.com/docs/reference/engine/datatypes/DateTime) at the end of this particular subscription period.
|
|
3136
|
+
*/
|
|
3137
|
+
CycleEndTime: DateTime;
|
|
3138
|
+
/**
|
|
3139
|
+
* [Enum.SubscriptionPaymentStatus.Paid](https://create.roblox.com/docs/reference/engine/enums/SubscriptionPaymentStatus#Paid) if the user paid for this particular subscription period. [Enum.SubscriptionPaymentStatus.Refunded](https://create.roblox.com/docs/reference/engine/enums/SubscriptionPaymentStatus#Refunded) if the user refunded this particular subscription period.
|
|
3140
|
+
*/
|
|
3141
|
+
PaymentStatus: Enum.SubscriptionPaymentStatus;
|
|
3142
|
+
}
|
|
3143
|
+
|
|
3144
|
+
interface UserSubscriptionStatus {
|
|
3145
|
+
/**
|
|
3146
|
+
* True if the user's subscription is active.
|
|
3147
|
+
*/
|
|
3148
|
+
IsSubscribed: boolean;
|
|
3149
|
+
/**
|
|
3150
|
+
* True if the user is set to renew this subscription after the current subscription period ends.
|
|
3151
|
+
*/
|
|
3152
|
+
IsRenewing: boolean;
|
|
3153
|
+
}
|
|
3154
|
+
|
|
3155
|
+
interface ExpirationDetails {
|
|
3156
|
+
ExpirationReason: Enum.SubscriptionExpirationReason;
|
|
3157
|
+
}
|