v0.13.8

C_GossipInfo

namespaceavailable in: camelot

Status in wowlua

20 functions: 11 implemented, 0 recorded, 9 guessed. 7 events, 3 of them fired by the emulator on its own.

Functions

functionwhat it doesstatus
CloseGossipCloses the gossip window.
()
implemented
ForceGossipReturns true if gossip text must be displayed. For example making this return true shows the Banker gossip.
(): boolean
guessed
GetActiveQuestsReturns the quests which can be turned in at a quest giver.
(): GossipQuestUIInfo[]
implemented
GetAvailableQuestsReturns the available quests at a quest giver.
(): GossipQuestUIInfo[]
implemented
GetCompletedOptionDescriptionStringReturns the description text for a completed gossip option, or nothing. · by wowlua
(): string?
guessed
GetCustomGossipDescriptionStringReturns the custom description text of the open gossip window, or nothing. · by wowlua
(): string?
guessed
GetFriendshipReputationReturns the player's standing with a friendship faction, or nothing. · by wowlua
(friendshipFactionID: number): FriendshipReputationInfo?
implemented
GetFriendshipReputationRanksReturns the player's current rank and the number of ranks of a friendship faction. · by wowlua
(friendshipFactionID: number): FriendshipReputationRankInfo
guessed
GetNumActiveQuestsReturns the number of active quests that you should eventually turn in to this NPC.
(): number
implemented
GetNumAvailableQuestsReturns the number of quests (that you are not already on) offered by this NPC.
(): number
implemented
GetOptionUIWidgetSetsAndTypesByOptionIDReturns the UI widget sets shown for a gossip option, or nothing. · by wowlua
(gossipOptionID: number): GossipOptionUIWidgetSetAndType[]?
guessed
GetOptionsReturns the available gossip options at a quest giver.
(): GossipOptionUIInfo[]
implemented
GetPoiForUiMapIDReturns any gossip point of interest on the map.
(uiMapID: number): number?
implemented
GetPoiInfoReturns info for a gossip point of interest (e.g. the red flags when asking city guards for directions).
(uiMapID: number, gossipPoiID: number): GossipPoiInfo?
guessed
GetTextReturns the gossip text.
(): string
implemented
RefreshOptionsRefreshes the options of the open gossip window. · by wowlua
()
guessed
SelectActiveQuestSelects an active quest from the gossip window.
(optionID: number)
guessed
SelectAvailableQuestSelects an available quest from the gossip window.
(optionID: number)
guessed
SelectOptionSelects a gossip (conversation) option.
(optionID: number, text: string?, confirmed: boolean?)
implemented
SelectOptionByIndexSelects a gossip option by its position in the list, as C_GossipInfo.SelectOption does by its ID. · by wowlua
(optionID: number, text: string?, confirmed: boolean?)
implemented

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

Events

eventpayloadfired by the emulator
DYNAMIC_GOSSIP_POI_UPDATEDno payloadnot implemented
GOSSIP_CLOSEDinteractionIsContinuing: booleanimplemented
GOSSIP_CONFIRMgossipID: number, text: string, cost: WOWMONEYnot implemented
GOSSIP_CONFIRM_CANCELno payloadimplemented
GOSSIP_ENTER_CODEgossipID: numbernot implemented
GOSSIP_OPTIONS_REFRESHEDno payloadnot implemented
GOSSIP_SHOWuiTextureKit: string?implemented

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

Structures

  • FriendshipReputationInfo · friendshipFactionID, standing, maxRep, name?, text, texture, reaction, reactionThreshold, nextThreshold?, reversedColor, overrideColor?
  • FriendshipReputationRankInfo · currentLevel, maxLevel
  • GossipOptionRewardInfo · id, quantity, rewardType, context
  • GossipOptionUIInfo · gossipOptionID?, name, icon, rewards, status, spellID?, flags, overrideIconID?, selectOptionWhenOnlyOption, orderIndex, failureDescription?
  • GossipOptionUIWidgetSetAndType · widgetType, uiWidgetSetID
  • GossipPoiInfo · name, textureIndex, position, inBattleMap
  • GossipQuestUIInfo · title, questLevel, isTrivial, frequency?, repeatable?, isComplete?, isLegendary, isIgnored, questID, isImportant, isMeta, questInfoID

sources

Signatures, events and structures: Blizzard's API documentation (Blizzard_APIDocumentationGenerated) (GossipInfo 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.