Class GachaPass

Hierarchy

Pseudo
- GachaPass

Constructors

constructor

new GachaPass(
    GamepassId: string | number,
    _Name?: undefined | string,
    ProxyPass?: boolean,
): GachaPass
Parameters
- GamepassId: string | number
- _Name: undefined | string = ...
- ProxyPass: boolean = false
Returns GachaPass
Overrides Pseudo.constructor
- Defined in GachaPass.ts:485

Properties

_BundleLinks

_BundleLinks: GachaPass[] = []

AllowNonInventoryOwnedEntries

AllowNonInventoryOwnedEntries: boolean = false

This makes gacha allow users that may have deleted the Gamepass from their inventory to still have it in game.

You must set this property immediately as it only does the check once per player whenever they join. If a player joins and this is false, the entry will be deleted and will not be recoverable. Changing this to true after an entry is removed from a Player will have no effect on them.

GamepassId

GamepassId: string | number

Giftable

Giftable: boolean = false

Gifted

Gifted: Signal<(GiftInfo: GiftedPurchaseInfo) => void>

`Readonly`IsSubscription

IsSubscription: false

MultiPurchase

MultiPurchase: boolean = false

Only used if the Pass is a ProxyPass.

OtherUsersCanQueryOwnership

OtherUsersCanQueryOwnership: undefined | boolean = undefined

ProcessProductInfo

ProcessProductInfo:
    | undefined
    | (
        (
            CurrentProductInfo: GachaProductInfo,
            Inquirer?: Player,
        ) => GachaProductInfo
    ) = undefined

Runs only after the main/root ProcessProductInfo is ran, passing the results as the second argument. Here you can modify it more to fit the current state of the GachaProduct.

ProcessPrompt

ProxyPass

ProxyPass: boolean = false

Purchased

Purchased: Signal<
    (
        Player: Player,
        wasGifted: false | GiftedPurchaseInfo,
        wasSubscriptionPurchase: boolean,
    ) => void,
>

Methods

AddBundleLink

AddBundleLink(GachaPassBundle: GachaPass): void
Parameters
- GachaPassBundle: GachaPass
Returns void
- Defined in GachaPass.ts:141

AddGiftProduct

AddGiftProduct(GiftProduct: GachaProduct): void
Parameters
- GiftProduct: GachaProduct
Returns void
- Defined in GachaPass.ts:134

AddOwnedEntryAsync

AddOwnedEntryAsync(
    Player: Player,
    wasGfifted?: false | GiftedPurchaseInfo,
    wasSubscriptionPurchase?: boolean,
): void
Parameters
- Player: Player
- OptionalwasGfifted: false | GiftedPurchaseInfo
- OptionalwasSubscriptionPurchase: boolean
Returns void
- Defined in GachaPass.ts:339

BindToOwners

BindToOwners(
    Callback: (
        Owner: Player,
        GachaBindedPass: GachaBindedPass,
    ) => usePropertyEffectCleanup,
): ServantNext
Parameters
- Callback: (Owner: Player, GachaBindedPass: GachaBindedPass) => usePropertyEffectCleanup
Returns ServantNext
- Defined in GachaPass.ts:269

CanPromptPurchaseBasedOnRequiresOwnerships

CanPromptPurchaseBasedOnRequiresOwnerships(Player: Player): boolean
Parameters
- Player: Player
Returns boolean
- Defined in GachaPass.ts:476

CreateGiftToken

CreateGiftToken(
    GiftProduct: GachaProduct,
    Gifter: Player,
    Receiver: Player,
    Expires?: number,
): GachaGiftToken
Parameters
- GiftProduct: GachaProduct
- Gifter: Player
- Receiver: Player
- Expires: number = 300
Returns GachaGiftToken
- Defined in GachaPass.ts:174

CreateSubProduct

CreateSubProduct(...args: [ProductId: number, Name: string]): GachaProduct
Useful in cases where you can have a discounted price for the pass.

The Purchased event for this GachaPass will be fired if the SubProduct is Purchased.
Parameters
- ...args: [ProductId: number, Name: string]
Returns GachaProduct
- Defined in GachaPass.ts:206

GetBundleLink

GetBundleLink(Query: string | number): undefined | GachaPass
Parameters
- Query: string | number
Returns undefined | GachaPass
- Defined in GachaPass.ts:165

GetGiftProduct

GetGiftProduct(Query: string | number | GachaProduct): undefined | GachaProduct
Parameters
- Query: string | number | GachaProduct
Returns undefined | GachaProduct
- Defined in GachaPass.ts:122

GetOwnedInfoAsync

GetOwnedInfoAsync(
    Player: Player,
): {
    Bundled: GachaPass[];
    Gifted: { GifterId: number; GiftProduct: number; GiftTimestamp: number }[];
    IsBundled: boolean;
    Owned: boolean;
    OwnedTimestamp?: number;
    PurchaseCount?: number;
    PurchaseTimestamp?: number;
    Subscription?: boolean;
    WasGifted: boolean;
}
Parameters
- Player: Player
Returns {
    Bundled: GachaPass[];
    Gifted: { GifterId: number; GiftProduct: number; GiftTimestamp: number }[];
    IsBundled: boolean;
    Owned: boolean;
    OwnedTimestamp?: number;
    PurchaseCount?: number;
    PurchaseTimestamp?: number;
    Subscription?: boolean;
    WasGifted: boolean;
}
- Defined in GachaPass.ts:403

GetProductInfo

GetProductInfo(
noCache?: boolean,
): undefined | GamePassProductInfo | ProductInfo | SubscriptionProductInfo
Parameters
- OptionalnoCache: boolean
Returns undefined | GamePassProductInfo | ProductInfo | SubscriptionProductInfo
- Defined in GachaPass.ts:75

Prompt

Prompt(Player: Player): boolean
Parameters
- Player: Player
Returns boolean
- Defined in GachaPass.ts:218

PromptPurchase

PromptPurchase(Player: Player): boolean
Parameters
- Player: Player
Returns boolean
boolean - If the prompt was successfully made.
- Defined in GachaPass.ts:224

RemoveBundleLink

RemoveBundleLink(GachaPassBundle: GachaPass): void
Parameters
- GachaPassBundle: GachaPass
Returns void
- Defined in GachaPass.ts:155

RemoveGiftProduct

RemoveGiftProduct(GiftProduct: GachaProduct): void
Parameters
- GiftProduct: GachaProduct
Returns void
- Defined in GachaPass.ts:137

RemoveOwnedEntryAsync

RemoveOwnedEntryAsync(Player: Player): void
Parameters
- Player: Player
Returns void
- Defined in GachaPass.ts:347

RemoveOwnedGiftEntryAsync

RemoveOwnedGiftEntryAsync(
    Player: Player,
    GiftId?: number,
    GifterId?: number,
    MaximumRemoves?: number,
): void
Parameters
- Player: Player
- OptionalGiftId: number
- OptionalGifterId: number
- MaximumRemoves: number = 30
Returns void
- Defined in GachaPass.ts:361

RequiresOwnershipOf

RequiresOwnershipOf(...OtherPasses: (string | number | GachaPass)[]): void
Parameters
- ...OtherPasses: (string | number | GachaPass)[]
Returns void
- Defined in GachaPass.ts:462

UserOwnsAsync

UserOwnsAsync(Player: Player): boolean
Parameters
- Player: Player
Returns boolean
- Defined in GachaPass.ts:457

Class GachaPass

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns GachaPass

Properties

_BundleLinks

AllowNonInventoryOwnedEntries

GamepassId

Giftable

Gifted

ReadonlyIsSubscription

MultiPurchase

OtherUsersCanQueryOwnership

ProcessProductInfo

ProcessPrompt

ProxyPass

Purchased

Methods

AddBundleLink

Parameters

Returns void

AddGiftProduct

Parameters

Returns void

AddOwnedEntryAsync

Parameters

Returns void

BindToOwners

Parameters

Returns ServantNext

CanPromptPurchaseBasedOnRequiresOwnerships

Parameters

Returns boolean

CreateGiftToken

Parameters

Returns GachaGiftToken

CreateSubProduct

Parameters

Returns GachaProduct

GetBundleLink

Parameters

Returns undefined | GachaPass

GetGiftProduct

Parameters

Returns undefined | GachaProduct

GetOwnedInfoAsync

Parameters

Returns { Bundled: GachaPass[]; Gifted: { GifterId: number; GiftProduct: number; GiftTimestamp: number }[]; IsBundled: boolean; Owned: boolean; OwnedTimestamp?: number; PurchaseCount?: number; PurchaseTimestamp?: number; Subscription?: boolean; WasGifted: boolean;}

GetProductInfo

Parameters

Returns undefined | GamePassProductInfo | ProductInfo | SubscriptionProductInfo

Prompt

Parameters

Returns boolean

PromptPurchase

Parameters

Returns boolean

RemoveBundleLink

Parameters

Returns void

RemoveGiftProduct

Parameters

Returns void

RemoveOwnedEntryAsync

Parameters

Returns void

RemoveOwnedGiftEntryAsync

Parameters

Returns void

RequiresOwnershipOf

Parameters

Returns void

UserOwnsAsync

Parameters

`Readonly`IsSubscription

Returns {
Bundled: GachaPass[];
Gifted: { GifterId: number; GiftProduct: number; GiftTimestamp: number }[];
IsBundled: boolean;
Owned: boolean;
OwnedTimestamp?: number;
PurchaseCount?: number;
PurchaseTimestamp?: number;
Subscription?: boolean;
WasGifted: boolean;
}