Exiles/coa-weakauras
3
0
Fork 0
Code Pull Requests Actions Packages Releases 2 Wiki Activity
Files
d2b59a3f88b09e4bfaaa88bddb7d6910d1587cd0
coa-weakauras/APIDocumentation/Documentation/PvpInfoDocumentation.lua
T

461 lines
12 KiB
Lua
Raw Blame History

local PvpInfo =
{
Name = "PvpInfo",
Type = "System",
Namespace = "C_PvP",
Functions =
{
{
Name = "GetArenaCrowdControlInfo",
Type = "Function",
Arguments =
{
{ Name = "playerToken", Type = "UnitToken", Nilable = false },
},
Returns =
{
{ Name = "spellID", Type = "number", Nilable = false },
{ Name = "itemID", Type = "number", Nilable = false },
{ Name = "startTime", Type = "number", Nilable = false },
{ Name = "duration", Type = "number", Nilable = false },
},
},
{
Name = "GetBattlefieldVehicleInfo",
Type = "Function",
Arguments =
{
{ Name = "vehicleIndex", Type = "luaIndex", Nilable = false },
{ Name = "uiMapID", Type = "number", Nilable = false },
},
Returns =
{
{ Name = "info", Type = "BattlefieldVehicleInfo", Nilable = false },
},
},
{
Name = "GetBattlefieldVehicles",
Type = "Function",
Arguments =
{
{ Name = "uiMapID", Type = "number", Nilable = false },
},
Returns =
{
{ Name = "vehicles", Type = "table", InnerType = "BattlefieldVehicleInfo", Nilable = false },
},
},
{
Name = "GetHolidayBGLossRewards",
Type = "Function",
Returns =
{
{ Name = "honor", Type = "number", Nilable = false },
{ Name = "experience", Type = "number", Nilable = false },
{ Name = "itemRewards", Type = "table", InnerType = "BattlefieldItemReward", Nilable = true },
{ Name = "currencyRewards", Type = "table", InnerType = "BattlefieldCurrencyReward", Nilable = true },
},
},
{
Name = "GetHolidayBGRewards",
Type = "Function",
Returns =
{
{ Name = "honor", Type = "number", Nilable = false },
{ Name = "experience", Type = "number", Nilable = false },
{ Name = "itemRewards", Type = "table", InnerType = "BattlefieldItemReward", Nilable = true },
{ Name = "currencyRewards", Type = "table", InnerType = "BattlefieldCurrencyReward", Nilable = true },
},
},
{
Name = "GetRandomBGLossRewards",
Type = "Function",
Returns =
{
{ Name = "honor", Type = "number", Nilable = false },
{ Name = "experience", Type = "number", Nilable = false },
{ Name = "itemRewards", Type = "table", InnerType = "BattlefieldItemReward", Nilable = true },
{ Name = "currencyRewards", Type = "table", InnerType = "BattlefieldCurrencyReward", Nilable = true },
},
},
{
Name = "GetRandomBGRewards",
Type = "Function",
Returns =
{
{ Name = "honor", Type = "number", Nilable = false },
{ Name = "experience", Type = "number", Nilable = false },
{ Name = "itemRewards", Type = "table", InnerType = "BattlefieldItemReward", Nilable = true },
{ Name = "currencyRewards", Type = "table", InnerType = "BattlefieldCurrencyReward", Nilable = true },
},
},
{
Name = "IsInBrawl",
Type = "Function",
Returns =
{
{ Name = "isInBrawl", Type = "bool", Nilable = false },
},
},
{
Name = "IsPVPMap",
Type = "Function",
Returns =
{
{ Name = "isPVPMap", Type = "bool", Nilable = false },
},
},
{
Name = "IsRatedMap",
Type = "Function",
Returns =
{
{ Name = "isRatedMap", Type = "bool", Nilable = false },
},
},
{
Name = "RequestCrowdControlSpell",
Type = "Function",
Arguments =
{
{ Name = "playerToken", Type = "UnitToken", Nilable = false },
},
},
},
Events =
{
{
Name = "ArenaOpponentUpdate",
Type = "Event",
LiteralName = "ARENA_OPPONENT_UPDATE",
Payload =
{
{ Name = "unitToken", Type = "cstring", Nilable = false },
{ Name = "updateReason", Type = "cstring", Nilable = false },
},
},
{
Name = "ArenaRegistrarClosed",
Type = "Event",
LiteralName = "ARENA_REGISTRAR_CLOSED",
},
{
Name = "ArenaRegistrarShow",
Type = "Event",
LiteralName = "ARENA_REGISTRAR_SHOW",
},
{
Name = "ArenaRegistrarUpdate",
Type = "Event",
LiteralName = "ARENA_REGISTRAR_UPDATE",
},
{
Name = "ArenaSeasonWorldState",
Type = "Event",
LiteralName = "ARENA_SEASON_WORLD_STATE",
},
{
Name = "ArenaTeamInviteRequest",
Type = "Event",
LiteralName = "ARENA_TEAM_INVITE_REQUEST",
Payload =
{
{ Name = "inviter", Type = "cstring", Nilable = false },
{ Name = "teamName", Type = "cstring", Nilable = false },
},
},
{
Name = "ArenaTeamRosterUpdate",
Type = "Event",
LiteralName = "ARENA_TEAM_ROSTER_UPDATE",
Payload =
{
{ Name = "allowQuery", Type = "bool", Nilable = true },
},
},
{
Name = "ArenaTeamUpdate",
Type = "Event",
LiteralName = "ARENA_TEAM_UPDATE",
},
{
Name = "BattlefieldAutoQueue",
Type = "Event",
LiteralName = "BATTLEFIELD_AUTO_QUEUE",
},
{
Name = "BattlefieldAutoQueueEject",
Type = "Event",
LiteralName = "BATTLEFIELD_AUTO_QUEUE_EJECT",
},
{
Name = "BattlefieldQueueTimeout",
Type = "Event",
LiteralName = "BATTLEFIELD_QUEUE_TIMEOUT",
},
{
Name = "BattlefieldsClosed",
Type = "Event",
LiteralName = "BATTLEFIELDS_CLOSED",
},
{
Name = "BattlefieldsShow",
Type = "Event",
LiteralName = "BATTLEFIELDS_SHOW",
Payload =
{
{ Name = "isArena", Type = "bool", Nilable = true },
{ Name = "battleMasterListID", Type = "number", Nilable = true },
},
},
{
Name = "BattlegroundObjectivesUpdate",
Type = "Event",
LiteralName = "BATTLEGROUND_OBJECTIVES_UPDATE",
},
{
Name = "BattlegroundPointsUpdate",
Type = "Event",
LiteralName = "BATTLEGROUND_POINTS_UPDATE",
},
{
Name = "GdfSimComplete",
Type = "Event",
LiteralName = "GDF_SIM_COMPLETE",
},
{
Name = "NotifyPvpAfkResult",
Type = "Event",
LiteralName = "NOTIFY_PVP_AFK_RESULT",
Payload =
{
{ Name = "offender", Type = "cstring", Nilable = false },
{ Name = "numBlackMarksOnOffender", Type = "number", Nilable = false },
{ Name = "numPlayersIHaveReported", Type = "number", Nilable = false },
},
},
{
Name = "PlayerEnteringBattleground",
Type = "Event",
LiteralName = "PLAYER_ENTERING_BATTLEGROUND",
},
{
Name = "PvpRatedStatsUpdate",
Type = "Event",
LiteralName = "PVP_RATED_STATS_UPDATE",
},
{
Name = "PvpVehicleInfoUpdated",
Type = "Event",
LiteralName = "PVP_VEHICLE_INFO_UPDATED",
},
{
Name = "PvpWorldstateUpdate",
Type = "Event",
LiteralName = "PVP_WORLDSTATE_UPDATE",
},
{
Name = "UpdateActiveBattlefield",
Type = "Event",
LiteralName = "UPDATE_ACTIVE_BATTLEFIELD",
},
{
Name = "UpdateBattlefieldScore",
Type = "Event",
LiteralName = "UPDATE_BATTLEFIELD_SCORE",
},
{
Name = "UpdateBattlefieldStatus",
Type = "Event",
LiteralName = "UPDATE_BATTLEFIELD_STATUS",
Payload =
{
{ Name = "battleFieldIndex", Type = "number", Nilable = false },
},
},
{
Name = "WargameRequested",
Type = "Event",
LiteralName = "WARGAME_REQUESTED",
Payload =
{
{ Name = "opposingPartyMemberName", Type = "cstring", Nilable = false },
{ Name = "battlegroundName", Type = "cstring", Nilable = false },
{ Name = "timeoutSeconds", Type = "time_t", Nilable = false },
{ Name = "tournamentRules", Type = "bool", Nilable = false },
},
},
{
Name = "WorldPvpQueue",
Type = "Event",
LiteralName = "WORLD_PVP_QUEUE",
},
},
Tables =
{
{
Name = "BrawlType",
Type = "Enumeration",
NumValues = 5,
MinValue = 0,
MaxValue = 4,
Fields =
{
{ Name = "None", Type = "BrawlType", EnumValue = 0 },
{ Name = "Battleground", Type = "BrawlType", EnumValue = 1 },
{ Name = "Arena", Type = "BrawlType", EnumValue = 2 },
{ Name = "LFG", Type = "BrawlType", EnumValue = 3 },
{ Name = "SoloShuffle", Type = "BrawlType", EnumValue = 4 },
},
},
{
Name = "BattlefieldCurrencyReward",
Type = "Structure",
Fields =
{
{ Name = "id", Type = "number", Nilable = false },
{ Name = "quantity", Type = "number", Nilable = false },
},
},
{
Name = "BattlefieldItemReward",
Type = "Structure",
Fields =
{
{ Name = "id", Type = "number", Nilable = false },
{ Name = "name", Type = "cstring", Nilable = false },
{ Name = "texture", Type = "fileID", Nilable = false },
{ Name = "quantity", Type = "number", Nilable = false },
},
},
{
Name = "BattlefieldRewards",
Type = "Structure",
Fields =
{
{ Name = "honor", Type = "number", Nilable = false },
{ Name = "experience", Type = "number", Nilable = false },
{ Name = "itemRewards", Type = "table", InnerType = "BattlefieldItemReward", Nilable = true },
{ Name = "currencyRewards", Type = "table", InnerType = "BattlefieldCurrencyReward", Nilable = true },
},
},
{
Name = "BattlefieldVehicleInfo",
Type = "Structure",
Fields =
{
{ Name = "x", Type = "number", Nilable = false },
{ Name = "y", Type = "number", Nilable = false },
{ Name = "name", Type = "cstring", Nilable = false },
{ Name = "isOccupied", Type = "bool", Nilable = false },
{ Name = "atlas", Type = "textureAtlas", Nilable = false },
{ Name = "textureWidth", Type = "number", Nilable = false },
{ Name = "textureHeight", Type = "number", Nilable = false },
{ Name = "facing", Type = "number", Nilable = false },
{ Name = "isPlayer", Type = "bool", Nilable = false },
{ Name = "isAlive", Type = "bool", Nilable = false },
{ Name = "shouldDrawBelowPlayerBlips", Type = "bool", Nilable = false },
},
},
{
Name = "BattlemasterListInfo",
Type = "Structure",
Fields =
{
{ Name = "name", Type = "string", Nilable = false },
{ Name = "instanceType", Type = "number", Nilable = false },
{ Name = "minPlayers", Type = "number", Nilable = false },
{ Name = "maxPlayers", Type = "number", Nilable = false },
{ Name = "icon", Type = "fileID", Nilable = false },
{ Name = "longDescription", Type = "string", Nilable = false },
{ Name = "shortDescription", Type = "string", Nilable = false },
},
},
{
Name = "HonorRewardInfo",
Type = "Structure",
Fields =
{
{ Name = "honorLevelName", Type = "string", Nilable = false },
{ Name = "badgeFileDataID", Type = "fileID", Nilable = false },
{ Name = "achievementRewardedID", Type = "number", Nilable = false },
},
},
{
Name = "PvpBrawlInfo",
Type = "Structure",
Fields =
{
{ Name = "brawlID", Type = "number", Nilable = false },
{ Name = "name", Type = "string", Nilable = false },
{ Name = "shortDescription", Type = "string", Nilable = false },
{ Name = "longDescription", Type = "string", Nilable = false },
{ Name = "active", Type = "bool", Nilable = false },
{ Name = "minLevel", Type = "number", Nilable = false },
{ Name = "maxLevel", Type = "number", Nilable = false },
{ Name = "groupsAllowed", Type = "bool", Nilable = false },
{ Name = "timeLeftUntilNextChange", Type = "number", Nilable = true },
{ Name = "lfgDungeonID", Type = "number", Nilable = false },
{ Name = "brawlType", Type = "BrawlType", Nilable = false },
{ Name = "mapNames", Type = "table", InnerType = "string", Nilable = false },
{ Name = "includesAllArenas", Type = "bool", Nilable = false, Default = false },
},
},
{
Name = "PvpScalingData",
Type = "Structure",
Fields =
{
{ Name = "scalingDataID", Type = "number", Nilable = false },
{ Name = "specializationID", Type = "number", Nilable = false },
{ Name = "name", Type = "cstring", Nilable = false },
{ Name = "value", Type = "number", Nilable = false },
},
},
{
Name = "PvpTierInfo",
Type = "Structure",
Fields =
{
{ Name = "name", Type = "string", Nilable = false },
{ Name = "descendRating", Type = "number", Nilable = false },
{ Name = "ascendRating", Type = "number", Nilable = false },
{ Name = "descendTier", Type = "number", Nilable = false },
{ Name = "ascendTier", Type = "number", Nilable = false },
{ Name = "pvpTierEnum", Type = "number", Nilable = false },
{ Name = "tierIconID", Type = "fileID", Nilable = false },
},
},
{
Name = "RandomBGInfo",
Type = "Structure",
Fields =
{
{ Name = "canQueue", Type = "bool", Nilable = false },
{ Name = "bgID", Type = "number", Nilable = false },
{ Name = "hasRandomWinToday", Type = "bool", Nilable = false },
{ Name = "minLevel", Type = "number", Nilable = false },
{ Name = "maxLevel", Type = "number", Nilable = false },
},
},
},
};
APIDocumentation:AddDocumentationTable(PvpInfo);
View Git Blame Copy Permalink