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

93 lines
1.8 KiB
Lua

local InvasionInfo =
{
Name = "InvasionInfo",
Type = "System",
Namespace = "C_InvasionInfo",
Environment = "All",
Functions =
{
{
Name = "AreInvasionsAvailable",
Type = "Function",
Documentation = { "Returns true if invasions are active in the same physical area as the player." },
Returns =
{
{ Name = "areInvasionsAvailable", Type = "bool", Nilable = false },
},
},
{
Name = "GetInvasionForUiMapID",
Type = "Function",
SecretArguments = "AllowedWhenUntainted",
Arguments =
{
{ Name = "uiMapID", Type = "number", Nilable = false },
},
Returns =
{
{ Name = "invasionID", Type = "number", Nilable = true },
},
},
{
Name = "GetInvasionInfo",
Type = "Function",
MayReturnNothing = true,
SecretArguments = "AllowedWhenUntainted",
Arguments =
{
{ Name = "invasionID", Type = "number", Nilable = false },
},
Returns =
{
{ Name = "invasionInfo", Type = "InvasionMapInfo", Nilable = false },
},
},
{
Name = "GetInvasionTimeLeft",
Type = "Function",
SecretArguments = "AllowedWhenUntainted",
Arguments =
{
{ Name = "invasionID", Type = "number", Nilable = false },
},
Returns =
{
{ Name = "timeLeftMinutes", Type = "number", Nilable = true },
},
},
},
Events =
{
},
Tables =
{
{
Name = "InvasionMapInfo",
Type = "Structure",
Fields =
{
{ Name = "invasionID", Type = "number", Nilable = false },
{ Name = "name", Type = "string", Nilable = false },
{ Name = "position", Type = "vector2", Mixin = "Vector2DMixin", Nilable = false },
{ Name = "atlasName", Type = "textureAtlas", Nilable = false },
{ Name = "rewardQuestID", Type = "number", Nilable = true },
},
},
},
Predicates =
{
},
};
APIDocumentation:AddDocumentationTable(InvasionInfo);