v0.13.8

C_LFGInfo

namespaceavailable in: camelot

Status in wowlua

23 functions: 2 implemented, 2 recorded, 19 guessed. 31 events, 3 of them fired by the emulator on its own.

Functions

functionwhat it doesstatus
AreCrossFactionGroupQueuesAllowedWhether groups may queue cross-faction for a dungeon finder activity. · by wowlua
(lfgDungeonID: number): boolean
guessed
CanPlayerUseGroupFinderReturns true if the player is allowed to use group finder tools, or false and a reason string if not.
(): (boolean, string)
guessed
CanPlayerUseLFDReturns true if the player is allowed to queue for instanced dungeon content, or false and a reason string if not.
(): (boolean, string)
recorded
CanPlayerUseLFRReturns true if the player is allowed to queue for instanced raid content, or false and a reason string if not.
(): (boolean, string)
guessed
CanPlayerUsePVPReturns true if the player is allowed to queue for instanced PvP content, or false and a reason string if not.
(): (boolean, string)
guessed
CanPlayerUsePremadeGroupReturns true if the player is allowed to use the premade group finder, or false and a reason string if not.
(): (boolean, string)
recorded
CanPlayerUseScenarioFinderReturns whether the player can use the scenario finder and, if not, the reason. · by wowlua
(): (boolean, string)
guessed
ConfirmLfgExpandSearchConfirms widening the dungeon finder search. · by wowlua
()
guessed
DoesActivePartyMeetPremadeLaunchCountWhether the party has enough members to start a premade queue for an activity. · by wowlua
(lfgDungeonID: number): boolean
guessed
DoesCrossFactionQueueRequireFullPremadeWhether queuing cross-faction for an activity requires a full premade group. · by wowlua
(lfgDungeonID: number): boolean
guessed
GetActiveLFGDungeonNameReturns the name of the dungeon finder activity the player is in. · by wowlua
(): string
guessed
GetAllEntriesForCategoryReturns any dungeons for a LFG category you're queued up for.
(category: number): number[]
guessed
GetDungeonInfoReturns information about a dungeon finder activity. · by wowlua
(lfgDungeonID: number): LFGDungeonInfo?
guessed
GetLFDLockStatesReturns which dungeon finder activities are locked for the player, and why. · by wowlua
(): LFGLockInfo[]
guessed
GetLevelUpInstancesReturns the IDs of the dungeons or raids suggested for a player level. · by wowlua
(currPlayerLevel: number, isRaid: boolean): number[]
guessed
GetRoleCheckDifficultyDetailsReturns details of the difficulty being queued for during a role check. · by wowlua
(): (number?, boolean)
guessed
HideNameFromUIReturns true if a dungeon name has to be hidden in the UI.
(dungeonID: number): boolean
guessed
IsGroupFinderEnabledWhether the group finder is available. · by wowlua
(): boolean
implemented
IsInLFGFollowerDungeonWhether the player is in a follower dungeon. · by wowlua
(): boolean
implemented
IsInMatchmadeRaidWithoutRoleRequirementsWhether the player is in a matchmade raid that has no role requirements. · by wowlua
(): boolean
guessed
IsLFDEnabledWhether the dungeon finder is available. · by wowlua
(): boolean
guessed
IsLFGFollowerDungeonWhether a dungeon finder activity is a follower dungeon. · by wowlua
(dungeonID: number): boolean
guessed
IsLFREnabledWhether the raid finder is available. · by wowlua
(): boolean
guessed

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

Events

eventpayloadfired by the emulator
ISLAND_COMPLETEDmapID: number, winner: numbernot implemented
LFG_BOOT_PROPOSAL_UPDATEno payloadnot implemented
LFG_COMPLETION_REWARDno payloadnot implemented
LFG_COOLDOWNS_UPDATEDno payloadimplemented
LFG_ENABLED_STATE_CHANGEDno payloadnot implemented
LFG_INVALID_ERROR_MESSAGEreason: number, subReason1: number, subReason2: numbernot implemented
LFG_LOCK_INFO_RECEIVEDno payloadimplemented
LFG_OFFER_CONTINUEname: string, lfgDungeonsID: number, typeID: numbernot implemented
LFG_OPEN_FROM_GOSSIPdungeonID: numbernot implemented
LFG_PROPOSAL_DONEno payloadnot implemented
LFG_PROPOSAL_FAILEDno payloadnot implemented
LFG_PROPOSAL_SHOWno payloadnot implemented
LFG_PROPOSAL_SUCCEEDEDno payloadnot implemented
LFG_PROPOSAL_UPDATEno payloadnot implemented
LFG_QUEUE_STATUS_UPDATEno payloadnot implemented
LFG_READY_CHECK_DECLINEDname: stringnot implemented
LFG_READY_CHECK_HIDEno payloadnot implemented
LFG_READY_CHECK_PLAYER_IS_READYname: stringnot implemented
LFG_READY_CHECK_SHOWisRequeue: booleannot implemented
LFG_READY_CHECK_UPDATEno payloadnot implemented
LFG_ROLE_CHECK_DECLINEDno payloadnot implemented
LFG_ROLE_CHECK_HIDEno payloadnot implemented
LFG_ROLE_CHECK_ROLE_CHOSENname: string, isTank: boolean, isHealer: boolean, isDamage: booleannot implemented
LFG_ROLE_CHECK_SHOWisRequeue: booleannot implemented
LFG_ROLE_CHECK_UPDATEno payloadnot implemented
LFG_ROLE_UPDATEno payloadnot implemented
LFG_UPDATEno payloadnot implemented
LFG_UPDATE_RANDOM_INFOno payloadimplemented
SHOW_LFG_EXPAND_SEARCH_PROMPTno payloadnot implemented
UPDATE_LFG_LISTno payloadnot implemented
WARFRONT_COMPLETEDmapID: number, winner: numbernot implemented

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

Structures

  • LFGDungeonInfo · name, iconID, link?
  • LFGLockInfo · lfgID, reason, hideEntry

sources

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