Functions
20PlayerCanMakePurchases
(player: Instance) → bool
| Field | XML type | Value |
|---|
Name | string | PlayerCanMakePurchases |
PromptBundlePurchase
(player: Instance, bundleId: int64) → void
| Field | XML type | Value |
|---|
Name | string | PromptBundlePurchase |
PromptGamePassPurchase
(player: Instance, gamePassId: int) → void
| Field | XML type | Value |
|---|
Name | string | PromptGamePassPurchase |
PromptNativePurchase
(player: Instance, productId: string) → void
| Field | XML type | Value |
|---|
Name | string | PromptNativePurchase |
PromptNativePurchaseWithLocalPlayer
(productId: string) → void
| Field | XML type | Value |
|---|
Name | string | PromptNativePurchaseWithLocalPlayer |
PromptProductPurchase
(player: Instance, productId: int, equipIfPurchased: bool = …, currencyType: CurrencyType = …) → void
| Field | XML type | Value |
|---|
Name | string | PromptProductPurchase |
PromptPurchase
(player: Instance, assetId: int64, equipIfPurchased: bool = …, currencyType: CurrencyType = …) → void
| Field | XML type | Value |
|---|
Name | string | PromptPurchase |
summary | string | Will prompt 'player' to purchase the item associated with 'assetId'. 'equipIfPurchased' is an optional argument that will give the item to the player immediately if they buy it (only applies to gear). 'currencyType' is also optional and will attempt to prompt the user with a specified currency if the product can be purchased with this currency, otherwise we use the default currency of the product. |
PromptRobloxPurchase
(assetId: int64, equipIfPurchased: bool) → void
| Field | XML type | Value |
|---|
Name | string | PromptRobloxPurchase |
PromptThirdPartyPurchase
(player: Instance, productId: string) → void
| Field | XML type | Value |
|---|
Name | string | PromptThirdPartyPurchase |
ReportAssetSale
(assetId: string, robuxAmount: int) → void
| Field | XML type | Value |
|---|
Name | string | ReportAssetSale |
ReportRobuxUpsellStarted
() → void
| Field | XML type | Value |
|---|
Name | string | ReportRobuxUpsellStarted |
SignalAssetTypePurchased
(player: Instance, assetType: AssetType) → void
| Field | XML type | Value |
|---|
Name | string | SignalAssetTypePurchased |
SignalClientPurchaseSuccess
(ticket: string, playerId: int, productId: int) → void
| Field | XML type | Value |
|---|
Name | string | SignalClientPurchaseSuccess |
SignalMockPurchasePremium
() → void
| Field | XML type | Value |
|---|
Name | string | SignalMockPurchasePremium |
SignalPromptBundlePurchaseFinished
(player: Instance, bundleId: int64, success: bool) → void
| Field | XML type | Value |
|---|
Name | string | SignalPromptBundlePurchaseFinished |
SignalPromptGamePassPurchaseFinished
(player: Instance, gamePassId: int, success: bool) → void
| Field | XML type | Value |
|---|
Name | string | SignalPromptGamePassPurchaseFinished |
SignalPromptPremiumPurchaseFinished
(didTryPurchasing: bool) → void
| Field | XML type | Value |
|---|
Name | string | SignalPromptPremiumPurchaseFinished |
SignalPromptProductPurchaseFinished
(userId: int, productId: int, success: bool) → void
| Field | XML type | Value |
|---|
Name | string | SignalPromptProductPurchaseFinished |
SignalPromptPurchaseFinished
(player: Instance, assetId: int, success: bool) → void
| Field | XML type | Value |
|---|
Name | string | SignalPromptPurchaseFinished |
SignalServerLuaDialogClosed
(value: bool) → void
| Field | XML type | Value |
|---|
Name | string | SignalServerLuaDialogClosed |
Yield functions
8GetDeveloperProductsAsync
() → Instance
| Field | XML type | Value |
|---|
Name | string | GetDeveloperProductsAsync |
GetProductInfo
(assetId: int64, infoType: InfoType = …) → Dictionary
| Field | XML type | Value |
|---|
Name | string | GetProductInfo |
summary | string | Takes one argument "assetId" which should be a number of an asset on www.roblox.com. Returns a table containing the product information (if this process fails, returns an empty table). |
GetRobuxBalance
() → int
| Field | XML type | Value |
|---|
Name | string | GetRobuxBalance |
IsPlayerSubscribed
(player: Instance, subscriptionId: int64) → bool
| Field | XML type | Value |
|---|
Name | string | IsPlayerSubscribed |
PerformPurchase
(infoType: InfoType = …, productId: int64 = …, expectedPrice: int = …, requestId: string = …, isRobloxPurchase: bool = …) → Dictionary
| Field | XML type | Value |
|---|
Name | string | PerformPurchase |
PlayerOwnsAsset
(player: Instance, assetId: int64) → bool
| Field | XML type | Value |
|---|
Name | string | PlayerOwnsAsset |
summary | string | Checks to see if 'Player' owns the product associated with 'assetId'. Returns true if the player owns it, false otherwise. This call will produce a warning if called on a guest player. |
PlayerOwnsBundle
(player: Instance, bundleId: int64) → bool
| Field | XML type | Value |
|---|
Name | string | PlayerOwnsBundle |
UserOwnsGamePassAsync
(userId: int64, gamePassId: int64) → bool
| Field | XML type | Value |
|---|
Name | string | UserOwnsGamePassAsync |
Events
19ClientLuaDialogRequested
(arguments: Tuple) → void
| Field | XML type | Value |
|---|
Name | string | ClientLuaDialogRequested |
ClientPurchaseSuccess
(ticket: string, playerId: int, productId: int) → void
| Field | XML type | Value |
|---|
Name | string | ClientPurchaseSuccess |
LuaDialogCallbackSignal
(value: bool, player: Instance) → void
| Field | XML type | Value |
|---|
Name | string | LuaDialogCallbackSignal |
NativePurchaseFinished
(player: Instance, productId: string, wasPurchased: bool) → void
| Field | XML type | Value |
|---|
Name | string | NativePurchaseFinished |
NativePurchaseFinishedWithLocalPlayer
(productId: string, wasPurchased: bool) → void
| Field | XML type | Value |
|---|
Name | string | NativePurchaseFinishedWithLocalPlayer |
PromptBundlePurchaseFinished
(player: Instance, bundleId: int64, wasPurchased: bool) → void
| Field | XML type | Value |
|---|
Name | string | PromptBundlePurchaseFinished |
PromptBundlePurchaseRequested
(player: Instance, bundleId: int64) → void
| Field | XML type | Value |
|---|
Name | string | PromptBundlePurchaseRequested |
PromptGamePassPurchaseFinished
(player: Instance, gamePassId: int, wasPurchased: bool) → void
| Field | XML type | Value |
|---|
Name | string | PromptGamePassPurchaseFinished |
PromptGamePassPurchaseRequested
(player: Instance, gamePassId: int) → void
| Field | XML type | Value |
|---|
Name | string | PromptGamePassPurchaseRequested |
PromptNativePurchaseRequested
(player: Instance, productId: string) → void
| Field | XML type | Value |
|---|
Name | string | PromptNativePurchaseRequested |
PromptPremiumPurchaseRequested
(player: Instance) → void
| Field | XML type | Value |
|---|
Name | string | PromptPremiumPurchaseRequested |
PromptProductPurchaseFinished
(userId: int, productId: int, isPurchased: bool) → void
| Field | XML type | Value |
|---|
Name | string | PromptProductPurchaseFinished |
PromptProductPurchaseRequested
(player: Instance, productId: int, equipIfPurchased: bool, currencyType: CurrencyType) → void
| Field | XML type | Value |
|---|
Name | string | PromptProductPurchaseRequested |
PromptPurchaseFinished
(player: Instance, assetId: int, isPurchased: bool) → void
| Field | XML type | Value |
|---|
Name | string | PromptPurchaseFinished |
summary | string | Fired when a 'player' dismisses a purchase dialog for 'assetId'. If the player purchased the item 'isPurchased' will be true, otherwise it will be false. This call will produce a warning if called on a guest player. |
PromptPurchaseRequested
(player: Instance, assetId: int, equipIfPurchased: bool, currencyType: CurrencyType) → void
| Field | XML type | Value |
|---|
Name | string | PromptPurchaseRequested |
PromptRobloxPurchaseRequested
(assetId: int64, equipIfPurchased: bool) → void
| Field | XML type | Value |
|---|
Name | string | PromptRobloxPurchaseRequested |
PromptThirdPartyPurchaseRequested
(player: Instance, productId: string) → void
| Field | XML type | Value |
|---|
Name | string | PromptThirdPartyPurchaseRequested |
ServerPurchaseVerification
(serverResponseTable: Dictionary) → void
| Field | XML type | Value |
|---|
Name | string | ServerPurchaseVerification |
ThirdPartyPurchaseFinished
(player: Instance, productId: string, receipt: string, wasPurchased: bool) → void
| Field | XML type | Value |
|---|
Name | string | ThirdPartyPurchaseFinished |