Files
coa-weakauras/APIDocumentation/Documentation/BattleNetDocumentation.lua
T

172 lines
4.6 KiB
Lua

local BattleNet =
{
Name = "BattleNet",
Type = "System",
Namespace = "C_BattleNet",
Functions =
{
{
Name = "GetAccountInfoByGUID",
Type = "Function",
Arguments =
{
{ Name = "guid", Type = "WOWGUID", Nilable = false },
},
Returns =
{
{ Name = "accountInfo", Type = "BNetAccountInfo", Nilable = true },
},
},
{
Name = "GetAccountInfoByID",
Type = "Function",
Arguments =
{
{ Name = "id", Type = "number", Nilable = false },
{ Name = "wowAccountGUID", Type = "WOWGUID", Nilable = true },
},
Returns =
{
{ Name = "accountInfo", Type = "BNetAccountInfo", Nilable = true },
},
},
{
Name = "GetFriendAccountInfo",
Type = "Function",
Arguments =
{
{ Name = "friendIndex", Type = "luaIndex", Nilable = false },
{ Name = "wowAccountGUID", Type = "WOWGUID", Nilable = true },
},
Returns =
{
{ Name = "accountInfo", Type = "BNetAccountInfo", Nilable = true },
},
},
{
Name = "GetFriendGameAccountInfo",
Type = "Function",
Arguments =
{
{ Name = "friendIndex", Type = "luaIndex", Nilable = false },
{ Name = "accountIndex", Type = "luaIndex", Nilable = false },
},
Returns =
{
{ Name = "gameAccountInfo", Type = "BNetGameAccountInfo", Nilable = true },
},
},
{
Name = "GetFriendNumGameAccounts",
Type = "Function",
Arguments =
{
{ Name = "friendIndex", Type = "luaIndex", Nilable = false },
},
Returns =
{
{ Name = "numGameAccounts", Type = "number", Nilable = false },
},
},
{
Name = "GetGameAccountInfoByGUID",
Type = "Function",
Arguments =
{
{ Name = "guid", Type = "WOWGUID", Nilable = false },
},
Returns =
{
{ Name = "gameAccountInfo", Type = "BNetGameAccountInfo", Nilable = true },
},
},
{
Name = "GetGameAccountInfoByID",
Type = "Function",
Arguments =
{
{ Name = "id", Type = "number", Nilable = false },
},
Returns =
{
{ Name = "gameAccountInfo", Type = "BNetGameAccountInfo", Nilable = true },
},
},
},
Events =
{
},
Tables =
{
{
Name = "BNetAccountInfo",
Type = "Structure",
Fields =
{
{ Name = "bnetAccountID", Type = "number", Nilable = false },
{ Name = "accountName", Type = "string", Nilable = false },
{ Name = "battleTag", Type = "string", Nilable = false },
{ Name = "isFriend", Type = "bool", Nilable = false },
{ Name = "isBattleTagFriend", Type = "bool", Nilable = false },
{ Name = "lastOnlineTime", Type = "number", Nilable = false },
{ Name = "isAFK", Type = "bool", Nilable = false },
{ Name = "isDND", Type = "bool", Nilable = false },
{ Name = "isFavorite", Type = "bool", Nilable = false },
{ Name = "appearOffline", Type = "bool", Nilable = false },
{ Name = "customMessage", Type = "string", Nilable = false },
{ Name = "customMessageTime", Type = "number", Nilable = false },
{ Name = "note", Type = "string", Nilable = false },
{ Name = "rafLinkType", Type = "RafLinkType", Nilable = false },
{ Name = "gameAccountInfo", Type = "BNetGameAccountInfo", Nilable = false },
},
},
{
Name = "BNetGameAccountInfo",
Type = "Structure",
Fields =
{
{ Name = "gameAccountID", Type = "number", Nilable = false },
{ Name = "clientProgram", Type = "string", Nilable = false },
{ Name = "isOnline", Type = "bool", Nilable = false },
{ Name = "isGameBusy", Type = "bool", Nilable = false },
{ Name = "isGameAFK", Type = "bool", Nilable = false },
{ Name = "wowProjectID", Type = "number", Nilable = true },
{ Name = "characterName", Type = "string", Nilable = true },
{ Name = "realmName", Type = "string", Nilable = true },
{ Name = "realmDisplayName", Type = "string", Nilable = true },
{ Name = "realmID", Type = "number", Nilable = true },
{ Name = "factionName", Type = "string", Nilable = true },
{ Name = "raceName", Type = "string", Nilable = true },
{ Name = "className", Type = "string", Nilable = true },
{ Name = "areaName", Type = "string", Nilable = true },
{ Name = "characterLevel", Type = "number", Nilable = true },
{ Name = "richPresence", Type = "string", Nilable = true },
{ Name = "playerGuid", Type = "WOWGUID", Nilable = true },
{ Name = "isWowMobile", Type = "bool", Nilable = false },
{ Name = "canSummon", Type = "bool", Nilable = false },
{ Name = "hasFocus", Type = "bool", Nilable = false },
{ Name = "regionID", Type = "number", Nilable = false },
{ Name = "isInCurrentRegion", Type = "bool", Nilable = false },
},
},
},
};
APIDocumentation:AddDocumentationTable(BattleNet);