C_PerksProgram

namespaceavailable in: camelot

Status in wowlua

24 functions: 0 implemented, 0 recorded, 24 guessed. 15 events, 0 of them fired by the emulator on its own.

Functions

function	what it does	status
`ClearFrozenPerksVendorItem`	Clears the item frozen at the Trading Post. · by wowlua `()`	guessed
`CloseInteraction`	Closes the Trading Post. · by wowlua `()`	guessed
`GetAvailableCategoryIDs`	Returns the IDs of the Trading Post's item categories. · by wowlua `(): number[]`	guessed
`GetAvailableVendorItemIDs`	Returns the IDs of the items the Trading Post currently offers. · by wowlua `(): number[]`	guessed
`GetCategoryInfo`	Returns information about a Trading Post category. · by wowlua `(categoryID: number): PerksVendorCategoryInfo`	guessed
`GetCurrencyAmount`	Returns how much Trader's Tender the player has. · by wowlua `(): number`	guessed
`GetDraggedPerksVendorItem`	Returns the ID of the Trading Post item the player is dragging. · by wowlua `(): number`	guessed
`GetFrozenPerksVendorItemInfo`	Returns the item frozen at the Trading Post, or nil when none is. · by wowlua `(): PerksVendorItemInfo?`	guessed
`GetPendingChestRewards`	Returns the Trading Post rewards waiting to be collected. · by wowlua `(): PerksProgramPendingChestRewards[]`	guessed
`GetPerksProgramItemDisplayInfo`	Returns how a Trading Post item is displayed in the preview. · by wowlua `(id: number): PerksProgramItemDisplayInfo`	guessed
`GetTimeRemaining`	Returns the time left before a Trading Post item leaves the shop. · by wowlua `(vendorItemID: number): number`	guessed
`GetVendorItemInfo`	Returns information about a Trading Post item. · by wowlua `(vendorItemID: number): PerksVendorItemInfo`	guessed
`GetVendorItemInfoRefundTimeLeft`	Returns the time left to refund a purchased Trading Post item. · by wowlua `(vendorItemID: number): number`	guessed
`IsAttackAnimToggleEnabled`	Whether the Trading Post preview plays the attack animation. · by wowlua `(): boolean`	guessed
`IsFrozenPerksVendorItem`	Whether the Trading Post item is the frozen one. · by wowlua `(perksVendorItemID: number): boolean`	guessed
`IsMountSpecialAnimToggleEnabled`	Whether the Trading Post preview plays a mount's special animation. · by wowlua `(): boolean`	guessed
`ItemSelectedTelemetry`	Reports to the game that the player selected a Trading Post item. · by wowlua `(perksVendorItemID: number)`	guessed
`PickupPerksVendorItem`	Puts a Trading Post item on the cursor. · by wowlua `(perksVendorItemID: number)`	guessed
`RequestCartCheckout`	Requests buying all given Trading Post items at once. · by wowlua `(perksVendorItemIDs: number[])`	guessed
`RequestPendingChestRewards`	Requests the Trading Post rewards waiting to be collected. · by wowlua `()`	guessed
`RequestPurchase`	Requests buying a Trading Post item. · by wowlua `(perksVendorItemID: number)`	guessed
`RequestRefund`	Requests a refund of a purchased Trading Post item. · by wowlua `(perksVendorItemID: number)`	guessed
`ResetHeldItemDragAndDrop`	Cancels dragging a Trading Post item. · by wowlua `()`	guessed
`SetFrozenPerksVendorItem`	Freezes the Trading Post item the player is dragging, so it stays in the shop. · by wowlua `()`	guessed

"by wowlua": no one documents this function, so wowlua wrote the description from its name, signature and behaviour.

Events

event	payload	fired by the emulator
`CHEST_REWARDS_UPDATED_FROM_SERVER`	`no payload`	not implemented
`PERKS_PROGRAM_ADD_PENDING_SHOP_ITEM`	`vendorItemID: number`	not implemented
`PERKS_PROGRAM_CLOSE`	`no payload`	not implemented
`PERKS_PROGRAM_CURRENCY_AWARDED`	`value: number`	not implemented
`PERKS_PROGRAM_CURRENCY_REFRESH`	`oldValue: number, newValue: number`	not implemented
`PERKS_PROGRAM_DATA_REFRESH`	`no payload`	not implemented
`PERKS_PROGRAM_DATA_SPECIFIC_ITEM_REFRESH`	`vendorItemID: number`	not implemented
`PERKS_PROGRAM_DISABLED`	`no payload`	not implemented
`PERKS_PROGRAM_OPEN`	`no payload`	not implemented
`PERKS_PROGRAM_PURCHASE_CART_SUCCESS`	`vendorItemIDs: number[]`	not implemented
`PERKS_PROGRAM_PURCHASE_SUCCESS`	`vendorItemID: number`	not implemented
`PERKS_PROGRAM_REFUND_SUCCESS`	`vendorItemID: number`	not implemented
`PERKS_PROGRAM_REMOVE_PENDING_SHOP_ITEM`	`vendorItemID: number`	not implemented
`PERKS_PROGRAM_RESULT_ERROR`	`no payload`	not implemented
`PERKS_PROGRAM_SET_FROZEN_ITEM`	`vendorItemID: number`	not implemented

An event the emulator doesn't fire on its own can still be fired from a test: mock.fireEvent("CHEST_REWARDS_UPDATED_FROM_SERVER").

Structures

PerksProgramItemDisplayInfo · overrideModelSceneID?, creatureDisplayInfoID?, mainHandItemModifiedAppearanceID?, offHandItemModifiedAppearanceID?
PerksProgramPendingChestRewards · rewardTypeID, perksVendorItemID?, rewardAmount, monthRewarded?, activityMonthID, thresholdOrderIndex
PerksVendorCategoryInfo · ID, displayName, defaultUIModelSceneID
PerksVendorItemInfo · name, perksVendorCategoryID, description, timeRemaining, purchased, refundable, subItemsLoaded, isPurchasePending, doesNotExpire, price, originalPrice?, showSaleBanner, perksVendorItemID, itemID, iconTexture, mountID, mountTypeName, speciesID, transmogSetID, itemModifiedAppearanceID, subItems, uiGroupInfo?, invType, quality
PerksVendorItemUIGroupInfo · ID, name, priority
PerksVendorSubItemInfo · name, itemID, itemModifiedAppearanceID, invType, quality

sources

Signatures, events and structures: Blizzard's API documentation (Blizzard_APIDocumentationGenerated) (PerksProgram system, camelot 1.60.1). Descriptions: written by wowlua where no documentation describes the entry.