v0.13.8

C_PlayerChoice

namespaceavailable in: camelot

Status in wowlua

7 functions: 0 implemented, 3 recorded, 4 guessed. 2 events, 1 of them fired by the emulator on its own.

Functions

functionwhat it doesstatus
GetCurrentPlayerChoiceInfoReturns the choice currently offered to the player, or nil when none is open. · by wowlua
(): PlayerChoiceInfo?
recorded
GetNumRerollsReturns how many times the player can reroll the offered choice. · by wowlua
(): number
guessed
GetRemainingTimeReturns the time left to make the offered choice, or nil when it has no time limit. · by wowlua
(): number?
recorded
IsWaitingForPlayerChoiceResponseReturns true if the player has an outstanding player choice that requires a response.
(): boolean
recorded
OnUIClosedTells the game that the player choice window was closed. · by wowlua
()
guessed
RequestRerollPlayerChoiceRequests rerolling the offered choice's options. · by wowlua
()
guessed
SendPlayerChoiceResponseSelects 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

eventpayloadfired by the emulator
PLAYER_CHOICE_CLOSEno payloadnot implemented
PLAYER_CHOICE_UPDATEno payloadimplemented

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?, consolidateWidgets
  • PlayerChoiceOptionRewardInfo · currencyRewards, itemRewards, repRewards
  • PlayerChoiceRewardCurrencyInfo · currencyId, name, currencyTexture, quantity, isCurrencyContainer
  • PlayerChoiceRewardItemInfo · itemId, name, quantity
  • PlayerChoiceRewardReputationInfo · 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.