Files
SessionGoldTracker/docs/blizzard-api/Blizzard_APIDocumentationGenerated/GuildInfoDocumentation.lua
T
2026-10-15 14:27:00 +11:00

750 lines
17 KiB
Lua

local GuildInfo =
{
Name = "GuildInfo",
Type = "System",
Namespace = "C_GuildInfo",
Environment = "All",
Functions =
{
{
Name = "AreGuildEventsEnabled",
Type = "Function",
Returns =
{
{ Name = "enabled", Type = "bool", Nilable = false },
},
},
{
Name = "CanEditOfficerNote",
Type = "Function",
Returns =
{
{ Name = "canEditOfficerNote", Type = "bool", Nilable = false },
},
},
{
Name = "CanSpeakInGuildChat",
Type = "Function",
Returns =
{
{ Name = "canSpeakInGuildChat", Type = "bool", Nilable = false },
},
},
{
Name = "CanViewOfficerNote",
Type = "Function",
Returns =
{
{ Name = "canViewOfficerNote", Type = "bool", Nilable = false },
},
},
{
Name = "Demote",
Type = "Function",
SecretArguments = "AllowedWhenUntainted",
Arguments =
{
{ Name = "name", Type = "cstring", Nilable = false },
},
},
{
Name = "Disband",
Type = "Function",
},
{
Name = "GetGuildNewsInfo",
Type = "Function",
MayReturnNothing = true,
SecretArguments = "AllowedWhenUntainted",
Arguments =
{
{ Name = "index", Type = "luaIndex", Nilable = false },
},
Returns =
{
{ Name = "newsInfo", Type = "GuildNewsInfo", Nilable = false },
},
},
{
Name = "GetGuildRankOrder",
Type = "Function",
SecretArguments = "AllowedWhenUntainted",
Arguments =
{
{ Name = "guid", Type = "WOWGUID", Nilable = false },
},
Returns =
{
{ Name = "rankOrder", Type = "luaIndex", Nilable = false },
},
},
{
Name = "GetGuildTabardInfo",
Type = "Function",
SecretArguments = "AllowedWhenUntainted",
Arguments =
{
{ Name = "unit", Type = "UnitToken", Nilable = true },
},
Returns =
{
{ Name = "tabardInfo", Type = "GuildTabardInfo", Nilable = true },
},
},
{
Name = "GetInfoText",
Type = "Function",
HasRestrictions = true,
Returns =
{
{ Name = "infoText", Type = "string", Nilable = false },
},
},
{
Name = "GetMOTD",
Type = "Function",
HasRestrictions = true,
Returns =
{
{ Name = "motd", Type = "string", Nilable = false },
},
},
{
Name = "GetPreferredPlaySettings",
Type = "Function",
Returns =
{
{ Name = "loaded", Type = "bool", Nilable = false },
{ Name = "preferredLocaleID", Type = "number", Nilable = false },
{ Name = "preferredDatacenterLocalityID", Type = "number", Nilable = false },
{ Name = "lastPreferredLocaleChangeDate", Type = "time_t", Nilable = false },
{ Name = "lastPreferredDatacenterLocalityChangeDate", Type = "time_t", Nilable = false },
{ Name = "changeCooldownDays", Type = "number", Nilable = false },
},
},
{
Name = "GetPreferredPlaySettingsFeatures",
Type = "Function",
Returns =
{
{ Name = "canChangeLocale", Type = "bool", Nilable = false },
{ Name = "canChangeDatacenterLocality", Type = "bool", Nilable = false },
},
},
{
Name = "GuildControlGetRankFlags",
Type = "Function",
SecretArguments = "AllowedWhenUntainted",
Arguments =
{
{ Name = "rankOrder", Type = "luaIndex", Nilable = false },
},
Returns =
{
{ Name = "permissions", Type = "table", InnerType = "bool", Nilable = false },
},
},
{
Name = "GuildRoster",
Type = "Function",
},
{
Name = "Invite",
Type = "Function",
SecretArguments = "AllowedWhenUntainted",
Arguments =
{
{ Name = "name", Type = "cstring", Nilable = false },
},
},
{
Name = "IsDiscordStreamSeparate",
Type = "Function",
Returns =
{
{ Name = "separateStream", Type = "bool", Nilable = false },
},
},
{
Name = "IsEncounterGuildNewsEnabled",
Type = "Function",
Returns =
{
{ Name = "enabled", Type = "bool", Nilable = false },
},
},
{
Name = "IsGuildOfficer",
Type = "Function",
Returns =
{
{ Name = "isOfficer", Type = "bool", Nilable = false },
},
},
{
Name = "IsGuildRankAssignmentAllowed",
Type = "Function",
SecretArguments = "AllowedWhenUntainted",
Arguments =
{
{ Name = "guid", Type = "WOWGUID", Nilable = false },
{ Name = "rankOrder", Type = "luaIndex", Nilable = false },
},
Returns =
{
{ Name = "isGuildRankAssignmentAllowed", Type = "bool", Nilable = false },
},
},
{
Name = "IsGuildReputationEnabled",
Type = "Function",
Returns =
{
{ Name = "enabled", Type = "bool", Nilable = false },
},
},
{
Name = "Leave",
Type = "Function",
},
{
Name = "MemberExistsByName",
Type = "Function",
SecretArguments = "AllowedWhenUntainted",
Arguments =
{
{ Name = "name", Type = "cstring", Nilable = false },
},
Returns =
{
{ Name = "exists", Type = "bool", Nilable = false },
},
},
{
Name = "Promote",
Type = "Function",
SecretArguments = "AllowedWhenUntainted",
Arguments =
{
{ Name = "name", Type = "cstring", Nilable = false },
},
},
{
Name = "QueryGuildMemberRecipes",
Type = "Function",
SecretArguments = "AllowedWhenUntainted",
Arguments =
{
{ Name = "guildMemberGUID", Type = "WOWGUID", Nilable = false },
{ Name = "skillLineID", Type = "number", Nilable = false },
},
},
{
Name = "QueryGuildMembersForRecipe",
Type = "Function",
MayReturnNothing = true,
SecretArguments = "AllowedWhenUntainted",
Arguments =
{
{ Name = "skillLineID", Type = "number", Nilable = false },
{ Name = "recipeSpellID", Type = "number", Nilable = false },
{ Name = "recipeLevel", Type = "luaIndex", Nilable = true },
},
Returns =
{
{ Name = "updatedRecipeSpellID", Type = "number", Nilable = false },
},
},
{
Name = "RemoveFromGuild",
Type = "Function",
HasRestrictions = true,
SecretArguments = "AllowedWhenUntainted",
Arguments =
{
{ Name = "guid", Type = "WOWGUID", Nilable = false },
},
},
{
Name = "RequestGuildRename",
Type = "Function",
HasRestrictions = true,
SecretArguments = "AllowedWhenUntainted",
Arguments =
{
{ Name = "desiredName", Type = "cstring", Nilable = false },
},
},
{
Name = "RequestGuildRenameRefund",
Type = "Function",
HasRestrictions = true,
},
{
Name = "RequestPreferredPlaySettings",
Type = "Function",
Returns =
{
{ Name = "startedSuccessfully", Type = "bool", Nilable = false },
},
},
{
Name = "RequestRenameNameCheck",
Type = "Function",
SecretArguments = "AllowedWhenUntainted",
Arguments =
{
{ Name = "desiredName", Type = "cstring", Nilable = false },
},
},
{
Name = "RequestRenameStatus",
Type = "Function",
Returns =
{
{ Name = "ableToRequest", Type = "bool", Nilable = false },
},
},
{
Name = "SetGuildRankOrder",
Type = "Function",
HasRestrictions = true,
SecretArguments = "AllowedWhenUntainted",
Arguments =
{
{ Name = "guid", Type = "WOWGUID", Nilable = false },
{ Name = "rankOrder", Type = "luaIndex", Nilable = false },
},
},
{
Name = "SetInfoText",
Type = "Function",
HasRestrictions = true,
SecretArguments = "AllowedWhenUntainted",
Arguments =
{
{ Name = "infoText", Type = "cstring", Nilable = false },
},
},
{
Name = "SetLeader",
Type = "Function",
SecretArguments = "AllowedWhenUntainted",
Arguments =
{
{ Name = "name", Type = "cstring", Nilable = false },
},
},
{
Name = "SetMOTD",
Type = "Function",
HasRestrictions = true,
SecretArguments = "AllowedWhenUntainted",
Arguments =
{
{ Name = "motd", Type = "cstring", Nilable = false },
},
},
{
Name = "SetNote",
Type = "Function",
HasRestrictions = true,
SecretArguments = "AllowedWhenUntainted",
Arguments =
{
{ Name = "guid", Type = "WOWGUID", Nilable = false },
{ Name = "note", Type = "cstring", Nilable = false },
{ Name = "isPublic", Type = "bool", Nilable = false },
},
},
{
Name = "SetPreferredPlaySettings",
Type = "Function",
SecretArguments = "AllowedWhenUntainted",
Arguments =
{
{ Name = "preferredLocaleID", Type = "number", Nilable = false, Default = 0 },
{ Name = "preferredDatacenterLocalityID", Type = "number", Nilable = false, Default = 0 },
},
Returns =
{
{ Name = "startedSuccessfully", Type = "bool", Nilable = false },
},
},
{
Name = "Uninvite",
Type = "Function",
SecretArguments = "AllowedWhenUntainted",
Arguments =
{
{ Name = "name", Type = "cstring", Nilable = false },
},
},
},
Events =
{
{
Name = "CloseTabardFrame",
Type = "Event",
LiteralName = "CLOSE_TABARD_FRAME",
SynchronousEvent = true,
},
{
Name = "DisableDeclineGuildInvite",
Type = "Event",
LiteralName = "DISABLE_DECLINE_GUILD_INVITE",
SynchronousEvent = true,
},
{
Name = "EnableDeclineGuildInvite",
Type = "Event",
LiteralName = "ENABLE_DECLINE_GUILD_INVITE",
SynchronousEvent = true,
},
{
Name = "GuildChallengeCompleted",
Type = "Event",
LiteralName = "GUILD_CHALLENGE_COMPLETED",
SynchronousEvent = true,
Payload =
{
{ Name = "challengeType", Type = "number", Nilable = false },
{ Name = "currentCount", Type = "number", Nilable = false },
{ Name = "maxCount", Type = "number", Nilable = false },
{ Name = "goldAwarded", Type = "number", Nilable = false },
},
},
{
Name = "GuildChallengeUpdated",
Type = "Event",
LiteralName = "GUILD_CHALLENGE_UPDATED",
SynchronousEvent = true,
},
{
Name = "GuildEventLogUpdate",
Type = "Event",
LiteralName = "GUILD_EVENT_LOG_UPDATE",
SynchronousEvent = true,
},
{
Name = "GuildInviteCancel",
Type = "Event",
LiteralName = "GUILD_INVITE_CANCEL",
SynchronousEvent = true,
},
{
Name = "GuildInviteRequest",
Type = "Event",
LiteralName = "GUILD_INVITE_REQUEST",
SynchronousEvent = true,
Payload =
{
{ Name = "inviter", Type = "cstring", Nilable = false },
{ Name = "guildName", Type = "cstring", Nilable = false },
{ Name = "guildAchievementPoints", Type = "number", Nilable = false },
{ Name = "oldGuildName", Type = "cstring", Nilable = false },
{ Name = "isNewGuild", Type = "bool", Nilable = true },
{ Name = "tabardInfo", Type = "GuildTabardInfo", Nilable = true },
},
},
{
Name = "GuildMotd",
Type = "Event",
LiteralName = "GUILD_MOTD",
SecretInChatMessagingLockdown = true,
SynchronousEvent = true,
Payload =
{
{ Name = "motdText", Type = "cstring", Nilable = false },
},
},
{
Name = "GuildNewsUpdate",
Type = "Event",
LiteralName = "GUILD_NEWS_UPDATE",
UniqueEvent = true,
},
{
Name = "GuildPartyStateUpdated",
Type = "Event",
LiteralName = "GUILD_PARTY_STATE_UPDATED",
SynchronousEvent = true,
Payload =
{
{ Name = "inGuildParty", Type = "bool", Nilable = false },
},
},
{
Name = "GuildPreferredPlaySettingsUpdated",
Type = "Event",
LiteralName = "GUILD_PREFERRED_PLAY_SETTINGS_UPDATED",
SynchronousEvent = true,
Payload =
{
{ Name = "status", Type = "PreferredPlaySettingsStatus", Nilable = false },
{ Name = "preferredLocaleID", Type = "number", Nilable = false },
{ Name = "preferredDatacenterLocalityID", Type = "number", Nilable = false },
{ Name = "lastPreferredLocaleChangeDate", Type = "time_t", Nilable = false },
{ Name = "lastPreferredDatacenterLocalityChangeDate", Type = "time_t", Nilable = false },
},
},
{
Name = "GuildRanksUpdate",
Type = "Event",
LiteralName = "GUILD_RANKS_UPDATE",
SynchronousEvent = true,
},
{
Name = "GuildRanksUpdateActivePlayer",
Type = "Event",
LiteralName = "GUILD_RANKS_UPDATE_ACTIVE_PLAYER",
SynchronousEvent = true,
},
{
Name = "GuildRecipeKnownByMembers",
Type = "Event",
LiteralName = "GUILD_RECIPE_KNOWN_BY_MEMBERS",
SynchronousEvent = true,
},
{
Name = "GuildRegistrarClosed",
Type = "Event",
LiteralName = "GUILD_REGISTRAR_CLOSED",
SynchronousEvent = true,
},
{
Name = "GuildRegistrarShow",
Type = "Event",
LiteralName = "GUILD_REGISTRAR_SHOW",
SynchronousEvent = true,
},
{
Name = "GuildRenameNameCheck",
Type = "Event",
LiteralName = "GUILD_RENAME_NAME_CHECK",
SynchronousEvent = true,
Payload =
{
{ Name = "desiredName", Type = "cstring", Nilable = false },
{ Name = "status", Type = "GuildErrorType", Nilable = false },
{ Name = "nameErrorToken", Type = "cstring", Nilable = true },
},
},
{
Name = "GuildRenameRefundResult",
Type = "Event",
LiteralName = "GUILD_RENAME_REFUND_RESULT",
SynchronousEvent = true,
Payload =
{
{ Name = "guildName", Type = "cstring", Nilable = false },
{ Name = "status", Type = "GuildErrorType", Nilable = false },
},
},
{
Name = "GuildRenameRequired",
Type = "Event",
LiteralName = "GUILD_RENAME_REQUIRED",
SynchronousEvent = true,
Payload =
{
{ Name = "flagSet", Type = "bool", Nilable = false },
},
},
{
Name = "GuildRenameStatusUpdate",
Type = "Event",
LiteralName = "GUILD_RENAME_STATUS_UPDATE",
SynchronousEvent = true,
Payload =
{
{ Name = "status", Type = "GuildRenameStatus", Nilable = false },
},
},
{
Name = "GuildRewardsList",
Type = "Event",
LiteralName = "GUILD_REWARDS_LIST",
SynchronousEvent = true,
},
{
Name = "GuildRewardsListUpdate",
Type = "Event",
LiteralName = "GUILD_REWARDS_LIST_UPDATE",
UniqueEvent = true,
},
{
Name = "GuildRosterUpdate",
Type = "Event",
LiteralName = "GUILD_ROSTER_UPDATE",
SynchronousEvent = true,
Payload =
{
{ Name = "canRequestRosterUpdate", Type = "bool", Nilable = false },
},
},
{
Name = "GuildTradeskillUpdate",
Type = "Event",
LiteralName = "GUILD_TRADESKILL_UPDATE",
SynchronousEvent = true,
},
{
Name = "GuildtabardUpdate",
Type = "Event",
LiteralName = "GUILDTABARD_UPDATE",
SynchronousEvent = true,
},
{
Name = "OpenTabardFrame",
Type = "Event",
LiteralName = "OPEN_TABARD_FRAME",
SynchronousEvent = true,
},
{
Name = "PlayerGuildUpdate",
Type = "Event",
LiteralName = "PLAYER_GUILD_UPDATE",
SynchronousEvent = true,
Payload =
{
{ Name = "unitTarget", Type = "UnitTokenVariant", Nilable = false },
},
},
{
Name = "RequestedGuildRenameResult",
Type = "Event",
LiteralName = "REQUESTED_GUILD_RENAME_RESULT",
SynchronousEvent = true,
Payload =
{
{ Name = "newName", Type = "cstring", Nilable = false },
{ Name = "status", Type = "GuildErrorType", Nilable = false },
},
},
{
Name = "RequiredGuildRenameResult",
Type = "Event",
LiteralName = "REQUIRED_GUILD_RENAME_RESULT",
SynchronousEvent = true,
Payload =
{
{ Name = "success", Type = "bool", Nilable = false },
},
},
{
Name = "TabardCansaveChanged",
Type = "Event",
LiteralName = "TABARD_CANSAVE_CHANGED",
SynchronousEvent = true,
},
{
Name = "TabardSavePending",
Type = "Event",
LiteralName = "TABARD_SAVE_PENDING",
SynchronousEvent = true,
},
{
Name = "UnitGuildLevel",
Type = "Event",
LiteralName = "UNIT_GUILD_LEVEL",
SynchronousEvent = true,
Payload =
{
{ Name = "newLevel", Type = "number", Nilable = false },
},
},
},
Tables =
{
{
Name = "GuildNewsInfo",
Type = "Structure",
Fields =
{
{ Name = "isSticky", Type = "bool", Nilable = false },
{ Name = "isHeader", Type = "bool", Nilable = false },
{ Name = "newsType", Type = "number", Nilable = false },
{ Name = "whoText", Type = "string", Nilable = true },
{ Name = "whatText", Type = "string", Nilable = true },
{ Name = "newsDataID", Type = "number", Nilable = false },
{ Name = "data", Type = "table", InnerType = "number", Nilable = false },
{ Name = "weekday", Type = "number", Nilable = false },
{ Name = "day", Type = "number", Nilable = false },
{ Name = "month", Type = "number", Nilable = false },
{ Name = "year", Type = "number", Nilable = false },
{ Name = "guildMembersPresent", Type = "number", Nilable = false },
},
},
{
Name = "GuildRenameStatus",
Type = "Structure",
Fields =
{
{ Name = "isNameChangeEnabled", Type = "bool", Nilable = false },
{ Name = "isPlayerGuildMaster", Type = "bool", Nilable = false },
{ Name = "refundEligibleEndTime", Type = "time_t", Nilable = false },
{ Name = "nextRenameTime", Type = "time_t", Nilable = false },
{ Name = "renamePrice", Type = "WOWMONEY", Nilable = false },
{ Name = "refundAmount", Type = "WOWMONEY", Nilable = false },
{ Name = "currentGuildMoney", Type = "WOWMONEY", Nilable = false },
{ Name = "result", Type = "GuildErrorType", Nilable = false },
{ Name = "oldGuildName", Type = "cstring", Nilable = false },
{ Name = "reservedName", Type = "cstring", Nilable = false },
{ Name = "reservedNameExpirationTime", Type = "time_t", Nilable = false },
},
},
},
Predicates =
{
},
};
APIDocumentation:AddDocumentationTable(GuildInfo);