C_LFGList

namespaceavailable in: camelot

Status in wowlua

88 functions: 31 implemented, 2 recorded, 55 guessed. 17 events, 6 of them fired by the emulator on its own.

Functions

function	what it does	status
`AcceptInvite`	Accepts the invitation from a premade group the player applied to, by search result ID. · by wowlua `not in Blizzard's documentation`	guessed
`ApplyToGroup`	Applies to a group in the premade group finder. · by wowlua `not in Blizzard's documentation`	guessed
`CanActiveEntryUseAutoAccept`	Whether the player's group listing can use auto-accept. · by wowlua `(): boolean`	guessed
`CanCreateQuestGroup`	Whether the player can list a group for a quest. · by wowlua `(questID: number): boolean`	implemented
`CanCreateScenarioGroup`	Whether the player can list a group for a scenario. · by wowlua `(scenarioID: number): boolean`	guessed
`CancelApplication`	Withdraws the player's application to a premade group, by search result ID. Blizzard's queue menu disables this for group members who aren't the leader. · by wowlua `not in Blizzard's documentation`	guessed
`ClearApplicationTextFields`	Clears the text fields of the group application. · by wowlua `()`	guessed
`ClearCreationTextFields`	Clears the text fields of the group listing being created. · by wowlua `()`	implemented
`ClearSearchResults`	Clears the premade group finder's search results. · by wowlua `not in Blizzard's documentation`	implemented
`ClearSearchTextFields`	Clears the premade group finder's search text. · by wowlua `()`	guessed
`ConfirmCensoredActiveEntry`	Confirms the player's group listing after its text was censored. · by wowlua `()`	guessed
`CopyActiveEntryInfoToCreationFields`	Copies the player's current group listing into the listing creation fields. · by wowlua `()`	implemented
`CreateListing`	Creates a group finder listing. `(createData: LfgListingCreateData): boolean`	implemented
`CreateScenarioListing`	Lists a group for a scenario and returns whether it worked. · by wowlua `(activityID: number, itemLevel: number, autoAccept: boolean, privateGroup: boolean, scenarioID: number): boolean`	guessed
`DeclineApplicant`	Declines an applicant to the player's premade group listing, by applicant ID. · by wowlua `not in Blizzard's documentation`	guessed
`DeclineInvite`	Declines the invitation from a premade group the player applied to, by search result ID. · by wowlua `not in Blizzard's documentation`	guessed
`DoesCensoredTextMatch`	Whether the given name and comment match the listing's censored text. · by wowlua `(name: string, comment: string): boolean`	guessed
`DoesEntryTitleMatchPrebuiltTitle`	Whether a listing's title matches the title built from its activity, group and playstyle. · by wowlua `(activityID: number, groupID: number, playstyle: LFGEntryPlaystyle?, generalPlaystyle: LFGEntryGeneralPlaystyle?): boolean`	guessed
`GetActiveEntryInfo`	Returns information about your currently listed group. `(): LfgEntryData?`	implemented
`GetActivityFullName`	Returns the full name of a group finder activity. · by wowlua `(activityID: number, questID: number?, showWarmode: boolean?): string`	implemented
`GetActivityGroupInfo`	Returns info for an activity group. `(groupID: number): (string?, number?)`	implemented
`GetActivityIDForQuestID`	Returns the premade group finder activity for a quest, or `nil` if the quest has none. Blizzard's UI uses it to search for groups doing a quest. · by wowlua `not in Blizzard's documentation`	guessed
`GetActivityInfoExpensive`	Returns the zone associated with an activity. `not in Blizzard's documentation`	guessed
`GetActivityInfoTable`	Returns information about a group finder activity. · by wowlua `(activityID: number, questID: number?, showWarmode: boolean?): GroupFinderActivityInfo?`	implemented
`GetAdvancedFilter`	Returns the premade group finder's advanced search filter. · by wowlua `(): AdvancedFilterOptions`	guessed
`GetApplicantBestDungeonScore`	Returns an applicant's best Mythic+ run for the listing's dungeon. · by wowlua `(localID: number, applicantIndex: number): BestDungeonScoreMapInfo?`	guessed
`GetApplicantDungeonScoreForListing`	Returns an applicant's Mythic+ score for an activity. · by wowlua `(localID: number, applicantIndex: number, activityID: number): BestDungeonScoreMapInfo?`	guessed
`GetApplicantInfo`	Returns status informations and custom message of an applicant. `(applicantID: number): LfgApplicantData?`	guessed
`GetApplicantMemberInfo`	Returns info for an applicant. `not in Blizzard's documentation`	guessed
`GetApplicantMemberStats`	Returns the Proving Grounds stats of an applicant. `not in Blizzard's documentation`	guessed
`GetApplicantPvpRatingInfoForListing`	Returns an applicant's PvP rating for an activity. · by wowlua `(localID: number, applicantIndex: number, activityID: number): PvpRatingInfo?`	guessed
`GetApplicants`	Returns the list of applicants to your group. `not in Blizzard's documentation`	guessed
`GetApplicationInfo`	Returns the state of the player's application to a search result: the result ID, the application status (such as `"none"`, `"applied"`, `"invited"`, `"declined"`, `"cancelled"` or `"failed"`), a pending status and the time left before it expires. · by wowlua `not in Blizzard's documentation`	guessed
`GetApplications`	Returns the search result IDs of the groups the player has applied to. · by wowlua `not in Blizzard's documentation`	implemented
`GetAvailableActivities`	Returns a list of available LFG activities. `not in Blizzard's documentation`	implemented
`GetAvailableActivityGroups`	Returns a list of available LFG groups. `(categoryID: number, filter: number): number[]`	implemented
`GetAvailableCategories`	Returns a list of available LFG categories. `not in Blizzard's documentation`	implemented
`GetAvailableLanguageSearchFilter`	Returns the language codes the premade group finder's search can be filtered by. Blizzard's language menu has one checkbox for each, labelled with `LFG_LIST_LANGUAGE_<CODE>`. · by wowlua `not in Blizzard's documentation`	implemented
`GetAvailableRoles`	Returns whether the player can sign up as tank, healer and damage dealer, as three booleans. · by wowlua `not in Blizzard's documentation`	recorded
`GetDefaultLanguageSearchFilter`	Returns the languages always included in premade group searches, as a table keyed by language code. Blizzard's language menu shows them checked and disabled. · by wowlua `not in Blizzard's documentation`	implemented
`GetFilteredSearchResults`	Returns the number of the last search's results that pass the filters, and their IDs. · by wowlua `(): (number, number[])`	implemented
`GetGroupLeaverCountsByRole`	Returns how many tanks, healers and damage dealers left the group. · by wowlua `(): (number, number, number)`	guessed
`GetKeystoneForActivity`	Returns the keystone ID of a Mythic+ activity. · by wowlua `(activityID: number): number?`	guessed
`GetLanguageSearchFilter`	Returns the languages the player chose for premade group searches, as a table keyed by language code. · by wowlua `not in Blizzard's documentation`	implemented
`GetLfgCategoryInfo`	Returns information about a premade group finder category. · by wowlua `(categoryID: number): LfgCategoryData?`	implemented
`GetNumApplicants`	Returns how many applicants the player's group listing has, and how many of them are still active. · by wowlua `not in Blizzard's documentation`	guessed
`GetNumApplications`	Returns how many groups the player has applied to, and how many of those applications are still active. Blizzard's UI blocks new sign-ups at `MAX_LFG_LIST_APPLICATIONS` active ones. · by wowlua `not in Blizzard's documentation`	guessed
`GetNumInvitedApplicantMembers`	Returns how many players in applicant groups the player's listing has invited. Blizzard's UI adds it to the group size to tell whether another invite would overfill the group. · by wowlua `not in Blizzard's documentation`	guessed
`GetNumPendingApplicantMembers`	Returns how many players in applicant groups are still pending for the player's listing. Blizzard's UI counts them with the invited ones to tell whether auto-accept would overfill a party. · by wowlua `not in Blizzard's documentation`	guessed
`GetOwnedKeystoneActivityAndGroupAndLevel`	Returns the activity ID, group ID and level of the player's keystone. · by wowlua `(getTimewalking: boolean): (number?, number?, number?)`	guessed
`GetPlaystyleString`	Returns the display text of a listing's playstyle for an activity. · by wowlua `(playstyle: LFGEntryPlaystyle, generalPlaystyle: LFGEntryGeneralPlaystyle, activityInfo: GroupFinderActivityInfo): string`	guessed
`GetPremadeGroupFinderStyle`	Returns which style of premade group finder the game uses. · by wowlua `(): PremadeGroupFinderStyle`	implemented
`GetRoleCheckInfo`	Returns whether the current role check is for a premade group application, and the activity ID it is for. · by wowlua `not in Blizzard's documentation`	guessed
`GetSearchResultEncounterInfo`	Returns the names of the bosses a search result's group has already defeated, or `nil`. Blizzard's tooltip lists them under "Bosses Defeated". · by wowlua `not in Blizzard's documentation`	guessed
`GetSearchResultFriends`	Returns 3 arrays of "related" member names for the given LFGList search result ID `not in Blizzard's documentation`	guessed
`GetSearchResultInfo`	Returns information about a premade group finder search result. · by wowlua `(searchResultID: number): LfgSearchResultData?`	implemented
`GetSearchResultLeaderInfo`	Returns information about the leader of a search result's group. · by wowlua `(searchResultID: number): LfgSearchResultPlayerInfo?`	implemented
`GetSearchResultMemberCounts`	Returns a table counting a search result's members by role, with the fields `TANK`, `HEALER`, `DAMAGER` and `NOROLE`, the open slots per role (`TANK_REMAINING`, `HEALER_REMAINING`, `DAMAGER_REMAINING`) and `classesByRole`. · by wowlua `not in Blizzard's documentation`	implemented
`GetSearchResultPlayerInfo`	Returns information about a member of a search result's group. · by wowlua `(searchResultID: number, memberIndex: number): LfgSearchResultPlayerInfo?`	implemented
`GetSearchResults`	Returns a table of search result IDs. `(): (number, number[])`	implemented
`HasActiveEntryInfo`	Whether the player's group is listed in the premade group finder. · by wowlua `(): boolean`	implemented
`HasActivityList`	Returns whether the premade group finder's list of activities has loaded. Blizzard's UI shows a loading text until it has. · by wowlua `not in Blizzard's documentation`	guessed
`HasSearchResultInfo`	Whether there is information about a search result. · by wowlua `(searchResultID: number): boolean`	implemented
`InviteApplicant`	Invites a queued applicant to your group. `not in Blizzard's documentation`	guessed
`IsCensoredActiveEntryUnresolved`	Whether the player's group listing has censored text not yet resolved. · by wowlua `(): boolean`	guessed
`IsCurrentlyApplying`	Returns whether the player's group is in the middle of applying to a premade group. Blizzard's search panel disables its sign-up button meanwhile. · by wowlua `not in Blizzard's documentation`	guessed
`IsPlayerAuthenticatedForLFG`	Whether the player's account is authenticated as the premade group finder requires. · by wowlua `(activityCategoryID: number?): boolean`	implemented
`IsPlayerValidForEndgameFieldEdits`	Whether the player may edit a listing's endgame fields. · by wowlua `(): boolean`	guessed
`IsPremadeGroupFinderEnabled`	Whether the premade group finder is available. · by wowlua `(): boolean`	recorded
`ListingUsesEndgameEditRestrictions`	Whether listings for an activity have restricted endgame fields. · by wowlua `(activityID: number): boolean`	guessed
`RefreshApplicants`	Refreshes the list of applicants to the player's group listing. Blizzard's application viewer calls it when it is shown and from its refresh button. · by wowlua `not in Blizzard's documentation`	guessed
`RemoveApplicant`	Removes an applicant from the player's group listing, by applicant ID. · by wowlua `not in Blizzard's documentation`	guessed
`RemoveListing`	Removes the player's group from the premade group finder. · by wowlua `not in Blizzard's documentation`	implemented
`ReportGroupAsAdvertisement`	Reports a listed group as an advertisement. · by wowlua `(searchResultID: number)`	guessed
`RequestAvailableActivities`	Signals the server to request that it send the client information about available activities. `not in Blizzard's documentation`	guessed
`RevealCensoredActiveEntry`	Shows the censored text of the player's group listing. · by wowlua `()`	guessed
`RevealCensoredSearchResult`	Shows the censored text of a search result. · by wowlua `(searchResultID: number)`	guessed
`SaveAdvancedFilter`	Saves the premade group finder's advanced search filter. · by wowlua `(options: AdvancedFilterOptions)`	guessed
`SaveLanguageSearchFilter`	Saves the languages used to filter premade group searches. Blizzard's UI passes a table keyed by language code with `true` for each chosen language. · by wowlua `not in Blizzard's documentation`	implemented
`Search`	Searches the premade group finder for listed groups. · by wowlua `(categoryID: number, filter: number, preferredFilters: number, languageFilter: WowLocale?, searchCrossFactionListings: boolean?, advancedFilter: AdvancedFilterOptions?, activityIDsFilter: number[]?)`	implemented
`SetApplicantMemberRole`	Sets the role a member of an applicant group would fill. Blizzard's UI calls it with the applicant ID, the member's index and the role. · by wowlua `not in Blizzard's documentation`	guessed
`SetEntryTitle`	Sets the title of the group listing being created from its activity, group and playstyle. · by wowlua `(activityID: number, groupID: number, playstyle: LFGEntryPlaystyle?, generalPlaystyle: LFGEntryGeneralPlaystyle?)`	guessed
`SetSearchToActivity`	Sets the premade group finder's search to an activity. · by wowlua `(activityID: number)`	guessed
`SetSearchToQuestID`	Sets the premade group finder's search to a quest. · by wowlua `(questID: number)`	guessed
`SetSearchToScenarioID`	Sets the premade group finder's search to a scenario. · by wowlua `(scenarioID: number)`	guessed
`UpdateListing`	Updates the player's group listing and returns whether it worked. · by wowlua `(createData: LfgListingCreateData): boolean`	implemented
`ValidateRequiredDungeonScore`	Whether the given dungeon score is valid as a listing's required score. · by wowlua `(dungeonScore: number): boolean`	guessed
`ValidateRequiredPvpRatingForActivity`	Whether the given PvP rating is valid as a required rating for an activity. · by wowlua `(activityID: number, rating: number): boolean`	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
`LFG_GROUP_DELISTED_LEADERSHIP_CHANGE`	`listingName: string, automaticDelistTimeRemaining: number`	not implemented
`LFG_LIST_ACTIVE_ENTRY_UPDATE`	`created: boolean?`	implemented
`LFG_LIST_APPLICANT_LIST_UPDATED`	`newPendingEntry: boolean?, newPendingEntryWithData: boolean?`	not implemented
`LFG_LIST_APPLICANT_UPDATED`	`applicantID: number`	not implemented
`LFG_LIST_APPLICATION_STATUS_UPDATED`	`searchResultID: number, newStatus: string, oldStatus: string, groupName: kstringLfgListChat`	not implemented
`LFG_LIST_AVAILABILITY_UPDATE`	`no payload`	implemented
`LFG_LIST_CENSORED_ACTIVE_ENTRY_UPDATE`	`isCensored: boolean`	implemented
`LFG_LIST_ENTRY_CREATION_FAILED`	`no payload`	not implemented
`LFG_LIST_ENTRY_EXPIRED_TIMEOUT`	`no payload`	not implemented
`LFG_LIST_ENTRY_EXPIRED_TOO_MANY_PLAYERS`	`no payload`	not implemented
`LFG_LIST_JOINED_GROUP`	`searchResultID: number, groupName: kstringLfgListChat`	not implemented
`LFG_LIST_REVEALED_CENSORED_ACTIVE_ENTRY`	`no payload`	not implemented
`LFG_LIST_SEARCH_FAILED`	`reason: string?`	implemented
`LFG_LIST_SEARCH_RESULTS_RECEIVED`	`no payload`	implemented
`LFG_LIST_SEARCH_RESULT_UPDATED`	`searchResultID: number`	implemented
`LFG_LIST_SHOW_SEARCH`	`activityIDsFilter: number[]?, showAllLevelRanges: boolean`	not implemented
`LFG_LIST_UPDATE_SEARCH_RESULTS`	`no payload`	not implemented

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

Structures

AdvancedFilterOptions · needsTank, needsHealer, needsDamage, needsMyClass, hasTank, hasHealer, activities, minimumRating, difficultyNormal, difficultyHeroic, difficultyMythic, difficultyMythicPlus, generalPlaystyle1, generalPlaystyle2, generalPlaystyle3, generalPlaystyle4
BestDungeonScoreMapInfo · mapScore, mapName, bestRunLevel, finishedSuccess, bestRunDurationMs, bestLevelIncrement
GroupFinderActivityInfo · fullName, shortName, categoryID, groupFinderActivityGroupID, ilvlSuggestion, filters, minLevel, minLevelSuggestion, maxLevelSuggestion, maxNumPlayers, displayType, orderIndex, useHonorLevel, showQuickJoinToast, isMythicPlusActivity, isRatedPvpActivity, isCurrentRaidActivity, isPvpActivity, isMythicActivity, allowCrossFaction, isHeroicActivity, isNormalActivity, mapID, difficultyID, redirectedDifficultyID, useDungeonRoleExpectations
LfgApplicantData · applicantID, applicationStatus, pendingApplicationStatus?, numMembers, isNew, comment, displayOrderID
LfgCategoryData · name, searchPromptOverride?, separateRecommended, autoChooseActivity, preferCurrentArea, showPlaystyleDropdown, allowCrossFaction
LfgEntryData · activityIDs, requiredItemLevel, requiredHonorLevel, name, comment, voiceChat, voiceMode, censored, duration, autoAccept, privateGroup, questID?, requiredDungeonScore?, requiredPvpRating?, playstyle?, generalPlaystyle?, isCrossFactionListing, newPlayerFriendly
LfgListingCreateData · activityIDs, questID?, isAutoAccept, isCrossFactionListing, isPrivateGroup, newPlayerFriendly, playstyle, generalPlaystyle, requiredDungeonScore, requiredItemLevel, requiredPvpRating, voiceMode
LfgSearchResultData · searchResultID, activityIDs, leaderName?, name, comment, voiceChat, voiceMode, censored, requiredItemLevel, requiredHonorLevel, hasSelf, numMembers, numBNetFriends, numCharFriends, numGuildMates, isDelisted, autoAccept, isWarMode, age, questID?, leaderOverallDungeonScore?, leaderDungeonScoreInfo, leaderBestDungeonScoreInfo?, leaderPvpRatingInfo, requiredDungeonScore?, requiredPvpRating?, playstyle?, generalPlaystyle?, crossFactionListing?, leaderFactionGroup, newPlayerFriendly?, partyGUID
LfgSearchResultPlayerInfo · name?, level?, areaName?, className, classFilename, specName?, assignedRole, lfgRoles, isLeader, isLeaver
PvpRatingInfo · bracket, rating, activityName, tier
WowLocale · enUS, koKR, frFR, deDE, zhCN, zhTW, esES, esMX, ruRU, ptBR, itIT

sources

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