C_GuildInfo
namespaceavailable in: camelotStatus in wowlua
39 functions: 24 implemented, 0 recorded, 15 guessed. 33 events, 4 of them fired by the emulator on its own.
Functions
| function | what it does | status |
|---|---|---|
AreGuildEventsEnabled | Whether guild events are available. · by wowlua(): boolean | guessed |
CanEditOfficerNote | Returns true if the player can edit guild officer notes.(): boolean | implemented |
CanSpeakInGuildChat | Returns true if the player can use guild chat.(): boolean | implemented |
CanViewOfficerNote | Returns true if the player can view guild officer notes.(): boolean | implemented |
Demote | Demotes the specified player in the guild.(name: string) | implemented |
Disband | Disbands the guild; no warning is given.() | implemented |
GetGuildNewsInfo | Returns a guild news entry, or nothing. · by wowlua(index: number): GuildNewsInfo? | guessed |
GetGuildRankOrder | Returns the current rank of a guild member.(guid: string): number | implemented |
GetGuildTabardInfo | Returns the colors and emblem of a guild's tabard, or nothing. · by wowlua(unit: string?): GuildTabardInfo? | guessed |
GetInfoText | Returns the guild's info text. · by wowlua(): string | implemented |
GetMOTD | Returns the guild's message of the day. · by wowlua(): string | implemented |
GetPreferredPlaySettings | Returns the guild's preferred play settings. · by wowlua(): (boolean, number, number, number, number, number) | guessed |
GetPreferredPlaySettingsFeatures | Returns which preferred play settings the guild can set. · by wowlua(): (boolean, boolean) | implemented |
GuildControlGetRankFlags | Returns the permission flags for a rank index.(rankOrder: number): boolean[] | implemented |
GuildRoster | Requests updated guild roster information from the server.() | implemented |
Invite | Invites a player to the guild.(name: string) | implemented |
IsDiscordStreamSeparate | Whether the guild's Discord stream is kept separate from guild chat. · by wowlua(): boolean | guessed |
IsEncounterGuildNewsEnabled | Whether boss kills are posted to the guild news. · by wowlua(): boolean | guessed |
IsGuildOfficer | Whether the player is a guild officer. · by wowlua(): boolean | implemented |
IsGuildRankAssignmentAllowed | Whether the player can assign the guild rank to the member. · by wowlua(guid: string, rankOrder: number): boolean | implemented |
IsGuildReputationEnabled | Whether guild reputation is available. · by wowlua(): boolean | guessed |
Leave | Removes you from your current guild.() | implemented |
MemberExistsByName | Whether the guild has a member with the name, as the guild roster names it. · by wowlua(name: string): boolean | implemented |
Promote | Promotes the specified player in the guild.(name: string) | implemented |
QueryGuildMemberRecipes | Shows the guild member recipes for a profession.(guildMemberGUID: string, skillLineID: number) | guessed |
QueryGuildMembersForRecipe | Asks the server which guild members know a recipe. · by wowlua(skillLineID: number, recipeSpellID: number, recipeLevel: number?): number? | guessed |
RemoveFromGuild | Removes a member from the guild.(guid: string) | implemented |
RequestGuildRename | Requests to rename the guild. · by wowlua(desiredName: string) | guessed |
RequestGuildRenameRefund | Requests a refund for a guild rename. · by wowlua() | guessed |
RequestPreferredPlaySettings | Requests the guild's preferred play settings from the server. · by wowlua(): boolean | implemented |
RequestRenameNameCheck | Asks the server whether the name can be used for the guild. · by wowlua(desiredName: string) | guessed |
RequestRenameStatus | Requests the status of the guild's rename from the server. · by wowlua(): boolean | guessed |
SetGuildRankOrder | Sets the guild rank for a member.(guid: string, rankOrder: number) | guessed |
SetInfoText | Sets the guild's info text, for a rank that may change it. · by wowlua(infoText: string) | implemented |
SetLeader | Transfers guild leadership to another player.(name: string) | implemented |
SetMOTD | Sets the guild message of the day.(motd: string) | implemented |
SetNote | Sets the guild note for a member.(guid: string, note: string, isPublic: boolean) | implemented |
SetPreferredPlaySettings | Sets the guild's preferred play settings. · by wowlua(preferredLocaleID: number, preferredDatacenterLocalityID: number): boolean | guessed |
Uninvite | Removes a player from the guild.(name: string) | implemented |
"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 |
|---|---|---|
CLOSE_TABARD_FRAME | no payload | not implemented |
DISABLE_DECLINE_GUILD_INVITE | no payload | not implemented |
ENABLE_DECLINE_GUILD_INVITE | no payload | not implemented |
GUILDTABARD_UPDATE | no payload | not implemented |
GUILD_CHALLENGE_COMPLETED | challengeType: number, currentCount: number, maxCount: number, goldAwarded: number | not implemented |
GUILD_CHALLENGE_UPDATED | no payload | not implemented |
GUILD_EVENT_LOG_UPDATE | no payload | not implemented |
GUILD_INVITE_CANCEL | no payload | not implemented |
GUILD_INVITE_REQUEST | inviter: string, guildName: string, guildAchievementPoints: number, oldGuildName: string, isNewGuild: boolean?, tabardInfo: GuildTabardInfo? | not implemented |
GUILD_MOTD | motdText: string | implemented |
GUILD_NEWS_UPDATE | no payload | not implemented |
GUILD_PARTY_STATE_UPDATED | inGuildParty: boolean | not implemented |
GUILD_PREFERRED_PLAY_SETTINGS_UPDATED | status: PreferredPlaySettingsStatus, preferredLocaleID: number, preferredDatacenterLocalityID: number, lastPreferredLocaleChangeDate: number, lastPreferredDatacenterLocalityChangeDate: number | not implemented |
GUILD_RANKS_UPDATE | no payload | not implemented |
GUILD_RANKS_UPDATE_ACTIVE_PLAYER | no payload | not implemented |
GUILD_RECIPE_KNOWN_BY_MEMBERS | no payload | not implemented |
GUILD_REGISTRAR_CLOSED | no payload | not implemented |
GUILD_REGISTRAR_SHOW | no payload | not implemented |
GUILD_RENAME_NAME_CHECK | desiredName: string, status: GuildErrorType, nameErrorToken: string? | not implemented |
GUILD_RENAME_REFUND_RESULT | guildName: string, status: GuildErrorType | not implemented |
GUILD_RENAME_REQUIRED | flagSet: boolean | not implemented |
GUILD_RENAME_STATUS_UPDATE | status: GuildRenameStatus | not implemented |
GUILD_REWARDS_LIST | no payload | not implemented |
GUILD_REWARDS_LIST_UPDATE | no payload | not implemented |
GUILD_ROSTER_UPDATE | canRequestRosterUpdate: boolean | implemented |
GUILD_TRADESKILL_UPDATE | no payload | not implemented |
OPEN_TABARD_FRAME | no payload | not implemented |
PLAYER_GUILD_UPDATE | unitTarget: string | implemented |
REQUESTED_GUILD_RENAME_RESULT | newName: string, status: GuildErrorType | not implemented |
REQUIRED_GUILD_RENAME_RESULT | success: boolean | not implemented |
TABARD_CANSAVE_CHANGED | no payload | implemented |
TABARD_SAVE_PENDING | no payload | not implemented |
UNIT_GUILD_LEVEL | newLevel: number | not implemented |
An event the emulator doesn't fire on its own can still be fired from a test: mock.fireEvent("CLOSE_TABARD_FRAME").
Structures
GuildNewsInfo· isSticky, isHeader, newsType, whoText?, whatText?, newsDataID, data, weekday, day, month, year, guildMembersPresentGuildRenameStatus· isNameChangeEnabled, isPlayerGuildMaster, refundEligibleEndTime, nextRenameTime, renamePrice, refundAmount, currentGuildMoney, result, oldGuildName, reservedName, reservedNameExpirationTime
sources
Signatures, events and structures: Blizzard's API documentation (Blizzard_APIDocumentationGenerated) (GuildInfo 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.