C_PlayerChoice
namespaceavailable in: camelotStatus in wowlua
7 functions: 0 implemented, 3 recorded, 4 guessed. 2 events, 1 of them fired by the emulator on its own.
Functions
| function | what it does | status |
|---|---|---|
GetCurrentPlayerChoiceInfo | Returns the choice currently offered to the player, or nil when none is open. · by wowlua(): PlayerChoiceInfo? | recorded |
GetNumRerolls | Returns how many times the player can reroll the offered choice. · by wowlua(): number | guessed |
GetRemainingTime | Returns the time left to make the offered choice, or nil when it has no time limit. · by wowlua(): number? | recorded |
IsWaitingForPlayerChoiceResponse | Returns true if the player has an outstanding player choice that requires a response.(): boolean | recorded |
OnUIClosed | Tells the game that the player choice window was closed. · by wowlua() | guessed |
RequestRerollPlayerChoice | Requests rerolling the offered choice's options. · by wowlua() | guessed |
SendPlayerChoiceResponse | Selects a quest option to pursue.(responseID: number) | 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 |
|---|---|---|
PLAYER_CHOICE_CLOSE | no payload | not implemented |
PLAYER_CHOICE_UPDATE | no payload | implemented |
An event the emulator doesn't fire on its own can still be fired from a test: mock.fireEvent("PLAYER_CHOICE_CLOSE").
Structures
PlayerChoiceInfo· objectGUID, choiceID, questionText, pendingChoiceText, uiTextureKit, hideWarboardHeader, keepOpenAfterChoice, requiresSelection, hideAnswerArt, playerChoiceLayout, options, soundKitID?, closeUISoundKitID?PlayerChoiceOptionButtonInfo· id, text, disabled, showCheckmark, hideButtonShowText, selected, confirmation?, tooltip?, rewardQuestID?, soundKitID?, listText?PlayerChoiceOptionInfo· id, description, header, choiceArtID, desaturatedArt, disabledOption, hasRewards, rewardInfo, uiTextureKit, maxStacks, buttons, widgetSetID?, spellID?, rarity?, typeArtID?, headerIconAtlasElement?, subHeader?, consolidateWidgetsPlayerChoiceOptionRewardInfo· currencyRewards, itemRewards, repRewardsPlayerChoiceRewardCurrencyInfo· currencyId, name, currencyTexture, quantity, isCurrencyContainerPlayerChoiceRewardItemInfo· itemId, name, quantityPlayerChoiceRewardReputationInfo· factionId, quantity
sources
Signatures, events and structures: Blizzard's API documentation (Blizzard_APIDocumentationGenerated) (PlayerChoice system, camelot 1.60.1). Descriptions: warcraft.wiki.gg's API pages, by its contributors, CC BY-SA 4.0 ↗; written by wowlua where no documentation describes the entry.