Class GachaConstructor

Hierarchy

Pseudo
- GachaConstructor

Constructors

constructor

new GachaConstructor(): GachaConstructor
Returns GachaConstructor
Overrides Pseudo.constructor
- Defined in Gacha.ts:819

Properties

_SPCR

_SPCR: PseudoClientReplicator

Deprecated

DatastoreGet

DatastoreGet: DatastoreGet = ...

DatastoreSet

DatastoreSet: DatastoreSet = ...

GachaPass

GachaPass: typeof GachaPass = GachaPass

GachaPassPurchased

GachaPassPurchased: Signal<GachaPassPurchasedParams>

GachaProduct

GachaProduct: typeof GachaProduct = GachaProduct

GachaProductPurchased

GachaProductPurchased: Signal<GachaProductPurchasedParams>

Mock

Mock: {
    Datastore: Record<string, Record<string, unknown>>;
    DatastoreGet: DatastoreGet;
    DatastoreSet: DatastoreSet;
    ProcessReceipt: () => ProductPurchaseDecision;
} = ...

While testing in studio, you can quickly use these Mock values to setup gacha.

ProcessProductInfo

ProcessProductInfo:
    | undefined
    | (
        (
            Product: GachaProduct | GachaPass,
            Inquirer?: Player,
        ) => GachaProductInfo
    ) = undefined

ProcessReceipt

ProcessReceipt: (
receiptInfo: ReceiptInfo,
processedByGacha: boolean,
) => ProductPurchaseDecision = ...

Set this value to be your Marketplace.ProcessReceipt callback, Gacha will override the Marketplace.ProcessReceipt to be our custom handler.

You can also provide ProcessProductReceipt for each product to have unique processors.

ProcessRequestPromptGachaGift

ProcessRequestPromptGachaGift:
    | undefined
    | (
        (
            Sender: Player,
            Receiver: Player,
            targetGift: GachaPass,
            withGiftProduct: GachaProduct,
        ) => void
    )

Methods

BindToGachaPassOwnership

BindToGachaPassOwnership(
    Player: Player,
    GachaPass: string | number,
    Callback: (isOwned: boolean) => usePropertyEffectCleanup,
): ServantNext
Parameters
- Player: Player
- GachaPass: string | number
- Callback: (isOwned: boolean) => usePropertyEffectCleanup
Returns ServantNext
Server
- Defined in Gacha.ts:717
BindToGachaPassOwnership(
GachaPass: string | number,
Callback: (isOwned: boolean) => usePropertyEffectCleanup,
): ServantNext
Parameters
- GachaPass: string | number
- Callback: (isOwned: boolean) => usePropertyEffectCleanup
Returns ServantNext
Client
- Defined in Gacha.ts:725

GetGachaPass

GetGachaPass(query: string | number, timeout?: number): undefined | GachaPass
Parameters
- query: string | number
- timeout: number = 300
Returns undefined | GachaPass
Server
- Defined in Gacha.ts:225

GetGachaProduct

GetGachaProduct(
query: string | number,
timeout?: number,
): undefined | GachaProduct
Parameters
- query: string | number
- timeout: number = 300
Returns undefined | GachaProduct
Server
- Defined in Gacha.ts:263

GetProductInfo

GetProductInfo(
    ...args: [
        ProductNameOrId: string
        | number,
        InfoType: InfoType,
        timeout?: number,
        Inquirer?: Player,
    ],
): Promise<GachaProductInfo>
Parameters
- ...args: [
      ProductNameOrId: string
      | number,
      InfoType: InfoType,
      timeout?: number,
      Inquirer?: Player,
  ]
Returns Promise<GachaProductInfo>
- Defined in Gacha.ts:400

GetProductInfoAsync

GetProductInfoAsync(
    ProductNameOrId: string | number,
    InfoType: InfoType,
    timeout?: number,
    Inquirer?: Player,
): GachaProductInfo
Parameters
- ProductNameOrId: string | number
- InfoType: InfoType
- Optionaltimeout: number
- OptionalInquirer: Player
Returns GachaProductInfo
- Defined in Gacha.ts:406

OnGachaPassPurchased

OnGachaPassPurchased(
    GachaPass: string | number,
    Callback: (
        ...args: [
            Player: Player,
            PassInfo: { Id: string
            | number; Name: string },
            wasGifted: false | GiftedPurchaseInfo,
        ],
    ) => void,
): RBXScriptConnection
Parameters
- GachaPass: string | number
- Callback: (
      ...args: [
          Player: Player,
          PassInfo: { Id: string
          | number; Name: string },
          wasGifted: false | GiftedPurchaseInfo,
      ],
  ) => void
Returns RBXScriptConnection
- Defined in Gacha.ts:691

OnGachaProductPurchased

OnGachaProductPurchased(
    GachaProduct: string | number,
    Callback: (
        ...args: [
            UserId: number,
            ProductInfo: {
                Id: string
                | number;
                Name: string;
                SubProductUsed?: { Name: string; ProductId: number };
            },
            PlayerInGame?: Player,
        ],
    ) => void,
): RBXScriptConnection
Parameters
- GachaProduct: string | number
- Callback: (
      ...args: [
          UserId: number,
          ProductInfo: {
              Id: string
              | number;
              Name: string;
              SubProductUsed?: { Name: string; ProductId: number };
          },
          PlayerInGame?: Player,
      ],
  ) => void
Returns RBXScriptConnection
- Defined in Gacha.ts:702

PromptGachaPassPurchase

PromptGachaPassPurchase(GachaPass: string | number, timeOut?: number): void
Parameters
- GachaPass: string | number
- OptionaltimeOut: number
Returns void
- Defined in Gacha.ts:493
PromptGachaPassPurchase(
    Player: Player,
    GachaPass: string | number,
    timeOut?: number,
): void
Parameters
- Player: Player
- GachaPass: string | number
- OptionaltimeOut: number
Returns void
- Defined in Gacha.ts:494

PromptGachaProductPurchase

PromptGachaProductPurchase(
GachaProduct: string | number,
timeOut?: number,
): void
Parameters
- GachaProduct: string | number
- OptionaltimeOut: number
Returns void
- Defined in Gacha.ts:544
PromptGachaProductPurchase(
    Player: Player,
    GachaProduct: string | number,
    timeOut?: number,
): void
Parameters
- Player: Player
- GachaProduct: string | number
- OptionaltimeOut: number
Returns void
- Defined in Gacha.ts:545

PromptGamePassPurchase

PromptGamePassPurchase(
...args: [Player: Player, GachaPass: string | number, timeOut?: number],
): void
Parameters
- ...args: [Player: Player, GachaPass: string | number, timeOut?: number]
Returns void
- Defined in Gacha.ts:488

PromptProductPurchase

PromptProductPurchase(
    ...args: [
        Player: Player,
        GachaProduct: string
        | number,
        timeOut?: number,
    ],
): void
Parameters
- ...args: [Player: Player, GachaProduct: string | number, timeOut?: number]
Returns void
- Defined in Gacha.ts:539

Register

Register<T extends "product" | "pass">(
item: GachaRegisterItem<T>,
): T extends "pass" ? GachaPass : GachaProduct
Type Parameters
- T extends "product" | "pass"
Parameters
- item: GachaRegisterItem<T>
Returns T extends "pass" ? GachaPass : GachaProduct
- Defined in Gacha.ts:188

RegisterTree

RegisterTree(
tree: GachaRegisterItem<"product" | "pass">[],
): LuaTuple<[GachaPass[], GachaProduct[]]>
Parameters
- tree: GachaRegisterItem<"product" | "pass">[]
Returns LuaTuple<[GachaPass[], GachaProduct[]]>
- Defined in Gacha.ts:84

RequestPromptGachaGift

RequestPromptGachaGift(
    ...args: [
        Receiver: Player,
        GiftingPass: string
        | number,
        withGiftProduct: string | number,
    ],
): Promise<boolean>
Parameters
- ...args: [
      Receiver: Player,
      GiftingPass: string
      | number,
      withGiftProduct: string | number,
  ]
Returns Promise<boolean>
Client
- Defined in Gacha.ts:367

RequestPromptGachaGiftAsync

RequestPromptGachaGiftAsync(
    Receiver: Player,
    GiftingPass: string | number,
    withGiftProduct: string | number,
): boolean
Parameters
- Receiver: Player
- GiftingPass: string | number
- withGiftProduct: string | number
Returns boolean
Client
- Defined in Gacha.ts:345

requestPromptGachaGiftServer

requestPromptGachaGiftServer(...args: unknown[]): Promise<true>
Parameters
- ...args: unknown[]
Returns Promise<true>
- Defined in Gacha.ts:307

UserOwnsGachaPassAsync

UserOwnsGachaPassAsync(Pass: string | number, timeOut?: number): boolean
Parameters
- Pass: string | number
- OptionaltimeOut: number
Returns boolean
- Defined in Gacha.ts:617
UserOwnsGachaPassAsync(
    Player: Player,
    Pass: string | number,
    timeOut?: number,
    QueryOtherPlayer?: Player,
): boolean
Parameters
- Player: Player
- Pass: string | number
- OptionaltimeOut: number
- OptionalQueryOtherPlayer: Player
Returns boolean
- Defined in Gacha.ts:618

UserOwnsGamePassAsync

UserOwnsGamePassAsync(
    ...args: [
        Player: Player,
        Pass: string
        | number,
        timeOut?: number,
        QueryOtherPlayer?: Player,
    ],
): boolean
Parameters
- ...args: [
      Player: Player,
      Pass: string
      | number,
      timeOut?: number,
      QueryOtherPlayer?: Player,
  ]
Returns boolean
- Defined in Gacha.ts:612

Class GachaConstructor

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns GachaConstructor

Properties

_SPCR

Deprecated

DatastoreGet

DatastoreSet

GachaPass

GachaPassPurchased

GachaProduct

GachaProductPurchased

Mock

ProcessProductInfo

ProcessReceipt

ProcessRequestPromptGachaGift

Methods

BindToGachaPassOwnership

Parameters

Returns ServantNext

Server

Parameters

Returns ServantNext

Client

GetGachaPass

Parameters

Returns undefined | GachaPass

Server

GetGachaProduct

Parameters

Returns undefined | GachaProduct

Server

GetProductInfo

Parameters

Returns Promise<GachaProductInfo>

GetProductInfoAsync

Parameters

Returns GachaProductInfo

OnGachaPassPurchased

Parameters

Returns RBXScriptConnection

OnGachaProductPurchased

Parameters

Returns RBXScriptConnection

PromptGachaPassPurchase

Parameters

Returns void

Parameters

Returns void

PromptGachaProductPurchase

Parameters

Returns void

Parameters

Returns void

PromptGamePassPurchase

Parameters

Returns void

PromptProductPurchase

Parameters

Returns void

Register

Type Parameters

Parameters

Returns T extends "pass" ? GachaPass : GachaProduct

RegisterTree

Parameters

Returns LuaTuple<[GachaPass[], GachaProduct[]]>

RequestPromptGachaGift

Parameters

Returns Promise<boolean>

Client

RequestPromptGachaGiftAsync

Parameters

Returns boolean