C_ClubFinder

namespaceavailable in: camelot

Status in wowlua

55 functions: 0 implemented, 6 recorded, 49 guessed. 15 events, 0 of them fired by the emulator on its own.

Functions

function	what it does	status
`ApplicantAcceptClubInvite`	Accepts an invitation from a guild or community in the Guild and Community Finder. · by wowlua `(clubFinderGUID: string)`	guessed
`ApplicantDeclineClubInvite`	Declines an invitation from a guild or community in the Guild and Community Finder. · by wowlua `(clubFinderGUID: string)`	guessed
`CancelMembershipRequest`	Withdraws the player's request to join a guild or community. · by wowlua `(clubFinderGUID: string)`	guessed
`CheckAllPlayerApplicantSettings`	Selects all of the player's applicant settings in the Guild and Community Finder. · by wowlua `()`	guessed
`ClearAllFinderCache`	Clears all data the Guild and Community Finder has kept. · by wowlua `()`	guessed
`ClearClubApplicantsCache`	Clears the applicants the Guild and Community Finder has kept. · by wowlua `()`	guessed
`ClearClubFinderPostingsCache`	Clears the postings the Guild and Community Finder has kept. · by wowlua `()`	guessed
`DoesPlayerBelongToClubFromClubGUID`	Whether the player is a member of the guild or community. · by wowlua `(clubFinderGUID: string): boolean`	guessed
`GetClubFinderDisableReason`	Returns why the Guild and Community Finder is disabled, or nil. · by wowlua `(): ClubFinderDisableReason?`	recorded
`GetClubRecruitmentSettings`	Returns the recruitment settings of the player's guild or community posting. · by wowlua `(): ClubSettingsInfo`	recorded
`GetClubTypeFromFinderGUID`	Returns whether the Guild and Community Finder GUID is a guild's or a community's. · by wowlua `(clubFinderGUID: string): ClubFinderRequestType?`	guessed
`GetFocusIndexFromFlag`	Returns the index of the focus (such as dungeons or raids) the flags select. · by wowlua `(flags: number): number`	guessed
`GetPlayerApplicantLocaleFlags`	Returns the languages the player's Guild and Community Finder applications use, as flags. · by wowlua `(): number`	recorded
`GetPlayerApplicantSettings`	Returns the player's applicant settings in the Guild and Community Finder. · by wowlua `(): ClubSettingsInfo`	recorded
`GetPlayerClubApplicationStatus`	Returns the status of the player's request to join a guild or community. · by wowlua `(clubFinderGUID: string): PlayerClubRequestStatus`	guessed
`GetPlayerSettingsFocusFlagsSelectedCount`	Returns how many focuses the player selected in the Guild and Community Finder. · by wowlua `(): number`	guessed
`GetPostingIDFromClubFinderGUID`	Returns the posting ID of a guild or community, or nil. · by wowlua `(clubFinderGUID: string): number?`	guessed
`GetRecruitingClubInfoFromClubID`	Returns the recruitment posting of a guild or community, or nil. · by wowlua `(clubId: ClubId): RecruitingClubInfo?`	guessed
`GetRecruitingClubInfoFromFinderGUID`	Returns the recruitment posting of a guild or community. · by wowlua `(clubFinderGUID: string): RecruitingClubInfo`	guessed
`GetStatusOfPostingFromClubId`	Returns the status flags of a guild or community's posting. · by wowlua `(postingID: ClubId): ClubFinderClubPostingStatusFlags[]`	guessed
`GetTotalMatchingCommunityListSize`	Returns how many communities match the Guild and Community Finder's search. · by wowlua `(): number`	guessed
`GetTotalMatchingGuildListSize`	Returns how many guilds match the Guild and Community Finder's search. · by wowlua `(): number`	guessed
`HasAlreadyAppliedToLinkedPosting`	Whether the player has already applied to the linked posting. · by wowlua `(clubFinderGUID: string): boolean`	guessed
`HasPostingBeenDelisted`	Whether the posting has been removed from the Guild and Community Finder. · by wowlua `(postingID: ClubId): boolean`	guessed
`IsCommunityFinderEnabled`	Whether the Community Finder is enabled. · by wowlua `(): boolean`	recorded
`IsEnabled`	Whether the Guild and Community Finder is enabled. · by wowlua `(): boolean`	recorded
`IsListingEnabledFromFlags`	Whether the posting flags say the posting is listed. · by wowlua `(flags: number): boolean`	guessed
`IsPostingBanned`	Whether the posting is banned from the Guild and Community Finder. · by wowlua `(postingID: ClubId): boolean`	guessed
`IsValidSearchString`	Whether the text can be used to search the Guild and Community Finder. · by wowlua `(name: string): boolean`	guessed
`LookupClubPostingFromClubFinderGUID`	Asks the server for the posting of a guild or community. · by wowlua `(clubFinderGUID: string, isLinkedPosting: boolean)`	guessed
`PlayerGetClubInvitationList`	Returns the guilds and communities that invited the player through the Guild and Community Finder. · by wowlua `(): RecruitingClubInfo[]?`	guessed
`PlayerRequestPendingClubsList`	Asks the server for the guilds or communities the player has applied to. · by wowlua `(type: ClubFinderRequestType)`	guessed
`PlayerReturnPendingCommunitiesList`	Returns the communities the player has applied to. · by wowlua `(): RecruitingClubInfo[]`	guessed
`PlayerReturnPendingGuildsList`	Returns the guilds the player has applied to. · by wowlua `(): RecruitingClubInfo[]`	guessed
`PostClub`	Lists a guild or community in the Guild and Community Finder and returns whether it was posted. · by wowlua `(clubId: ClubId, itemLevelRequirement: number, name: string, description: string, avatarId: number, specs: number[], type: ClubFinderRequestType, crossFaction: boolean): boolean`	guessed
`RequestApplicantList`	Asks the server for the applicants to the player's guild or community. · by wowlua `(type: ClubFinderRequestType)`	guessed
`RequestClubsList`	Searches the Guild and Community Finder for guilds or communities. · by wowlua `(guildListRequested: boolean, searchString: string, specIDs: number[])`	guessed
`RequestMembershipToClub`	Applies to join a guild or community. · by wowlua `(clubFinderGUID: string, comment: string, specIDs: number[])`	guessed
`RequestNextCommunityPage`	Asks the server for the next page of communities matching the search. · by wowlua `(startingIndex: number, pageSize: number)`	guessed
`RequestNextGuildPage`	Asks the server for the next page of guilds matching the search. · by wowlua `(startingIndex: number, pageSize: number)`	guessed
`RequestPostingInformationFromClubId`	Asks the server for the posting of a guild or community and returns whether it was requested. · by wowlua `(clubId: ClubId): boolean`	guessed
`RequestSubscribedClubPostingIDs`	Asks the server for the posting IDs of the player's guild and communities. · by wowlua `()`	guessed
`ResetClubPostingMapCache`	Clears the postings the Guild and Community Finder has kept by ID. · by wowlua `()`	guessed
`RespondToApplicant`	Accepts or declines an applicant to a guild or community. · by wowlua `(clubFinderGUID: string, playerGUID: string, shouldAccept: boolean, requestType: ClubFinderRequestType, playerName: string, forceAccept: boolean, reported: boolean?)`	guessed
`ReturnClubApplicantList`	Returns the applicants to a guild or community. · by wowlua `(clubId: ClubId): ClubFinderApplicantInfo[]`	guessed
`ReturnMatchingCommunityList`	Returns the communities matching the Guild and Community Finder's search. · by wowlua `(): RecruitingClubInfo[]`	guessed
`ReturnMatchingGuildList`	Returns the guilds matching the Guild and Community Finder's search. · by wowlua `(): RecruitingClubInfo[]`	guessed
`ReturnPendingClubApplicantList`	Returns the pending applicants to a guild or community. · by wowlua `(clubId: ClubId): ClubFinderApplicantInfo[]`	guessed
`SendChatWhisper`	Whispers an applicant or a guild or community from the Guild and Community Finder. · by wowlua `(clubFinderGUID: string, playerGUID: string, applicantType: ClubFinderRequestType, name: string)`	guessed
`SetAllRecruitmentSettings`	Sets all recruitment settings of the player's guild or community posting at once. · by wowlua `(value: number)`	guessed
`SetPlayerApplicantLocaleFlags`	Sets the languages the player's Guild and Community Finder applications use. · by wowlua `(localeFlags: number)`	guessed
`SetPlayerApplicantSettings`	Turns one of the player's applicant settings on or off. · by wowlua `(index: number, checked: boolean)`	guessed
`SetRecruitmentLocale`	Sets the language of the player's guild or community posting. · by wowlua `(locale: number)`	guessed
`SetRecruitmentSettings`	Turns one recruitment setting of the player's guild or community posting on or off. · by wowlua `(index: number, checked: boolean)`	guessed
`ShouldShowClubFinder`	Whether the Guild and Community Finder should be shown. · by wowlua `(): 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
`CLUB_FINDER_APPLICANT_INVITE_RECIEVED`	`clubFinderGUIDs: string[]`	not implemented
`CLUB_FINDER_APPLICATIONS_UPDATED`	`type: ClubFinderRequestType, clubFinderGUIDs: string[]`	not implemented
`CLUB_FINDER_CAN_WHISPER_APPLICANT`	`applicant: string`	not implemented
`CLUB_FINDER_CLUB_LIST_RETURNED`	`type: ClubFinderRequestType`	not implemented
`CLUB_FINDER_CLUB_REPORTED`	`type: ClubFinderRequestType, clubFinderGUID: string`	not implemented
`CLUB_FINDER_COMMUNITY_OFFLINE_JOIN`	`clubId: ClubId`	not implemented
`CLUB_FINDER_ENABLED_OR_DISABLED`	`no payload`	not implemented
`CLUB_FINDER_GUILD_REALM_NAME_UPDATED`	`clubFinderGUID: string, realmName: string`	not implemented
`CLUB_FINDER_LINKED_CLUB_RETURNED`	`clubInfo: RecruitingClubInfo`	not implemented
`CLUB_FINDER_MEMBERSHIP_LIST_CHANGED`	`no payload`	not implemented
`CLUB_FINDER_PLAYER_PENDING_LIST_RECIEVED`	`type: ClubFinderRequestType`	not implemented
`CLUB_FINDER_POST_UPDATED`	`clubFinderGUIDs: string[]`	not implemented
`CLUB_FINDER_RECRUITMENT_POST_RETURNED`	`type: ClubFinderRequestType`	not implemented
`CLUB_FINDER_RECRUITS_UPDATED`	`type: ClubFinderRequestType`	not implemented
`CLUB_FINDER_RECRUIT_LIST_CHANGED`	`no payload`	not implemented

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

Structures

ClubFinderApplicantInfo · clubFinderGUID, playerGUID, closed, name, message, level, classID, ilvl, specIds, requestStatus, lookupSuccess, lastUpdatedTime, faction
ClubSettingsInfo · playStyleDungeon, playStyleRaids, playStylePvp, playStyleRP, playStyleSocial, roleTank, roleHealer, roleDps, sizeSmall, sizeMedium, sizeLarge, maxLevelOnly, enableListing, sortRelevance, sortMembers, sortNewest, autoAccept, crossFaction
RecruitingClubInfo · clubFinderGUID, numActiveMembers, name, comment, guildLeader, isGuild, emblemInfo, tabardInfo?, recruitingSpecIds, recruitmentFlags, localeSet, recruitmentLocale, minILvl, cached, cacheRequested, lastPosterGUID, clubId, lastUpdatedTime, isCrossFaction, realmName?

sources

Signatures, events and structures: Blizzard's API documentation (Blizzard_APIDocumentationGenerated) (ClubFinderInfo system, camelot 1.60.1). Descriptions: written by wowlua where no documentation describes the entry.