218 lines
4.5 KiB
Lua
218 lines
4.5 KiB
Lua
local WarCampaign =
|
|
{
|
|
Name = "WarCampaign",
|
|
Type = "System",
|
|
Namespace = "C_CampaignInfo",
|
|
Environment = "All",
|
|
|
|
Functions =
|
|
{
|
|
{
|
|
Name = "GetAvailableCampaigns",
|
|
Type = "Function",
|
|
|
|
Returns =
|
|
{
|
|
{ Name = "campaignIDs", Type = "table", InnerType = "number", Nilable = false },
|
|
},
|
|
},
|
|
{
|
|
Name = "GetCampaignChapterInfo",
|
|
Type = "Function",
|
|
SecretArguments = "AllowedWhenUntainted",
|
|
|
|
Arguments =
|
|
{
|
|
{ Name = "campaignChapterID", Type = "number", Nilable = false },
|
|
},
|
|
|
|
Returns =
|
|
{
|
|
{ Name = "campaignChapterInfo", Type = "CampaignChapterInfo", Nilable = true },
|
|
},
|
|
},
|
|
{
|
|
Name = "GetCampaignID",
|
|
Type = "Function",
|
|
SecretArguments = "AllowedWhenUntainted",
|
|
|
|
Arguments =
|
|
{
|
|
{ Name = "questID", Type = "number", Nilable = false },
|
|
},
|
|
|
|
Returns =
|
|
{
|
|
{ Name = "campaignID", Type = "number", Nilable = false },
|
|
},
|
|
},
|
|
{
|
|
Name = "GetCampaignInfo",
|
|
Type = "Function",
|
|
SecretArguments = "AllowedWhenUntainted",
|
|
|
|
Arguments =
|
|
{
|
|
{ Name = "campaignID", Type = "number", Nilable = false },
|
|
},
|
|
|
|
Returns =
|
|
{
|
|
{ Name = "campaignInfo", Type = "CampaignInfo", Nilable = true },
|
|
},
|
|
},
|
|
{
|
|
Name = "GetChapterIDs",
|
|
Type = "Function",
|
|
SecretArguments = "AllowedWhenUntainted",
|
|
|
|
Arguments =
|
|
{
|
|
{ Name = "campaignID", Type = "number", Nilable = false },
|
|
},
|
|
|
|
Returns =
|
|
{
|
|
{ Name = "chapterIDs", Type = "table", InnerType = "number", Nilable = true },
|
|
},
|
|
},
|
|
{
|
|
Name = "GetCurrentChapterID",
|
|
Type = "Function",
|
|
SecretArguments = "AllowedWhenUntainted",
|
|
|
|
Arguments =
|
|
{
|
|
{ Name = "campaignID", Type = "number", Nilable = false },
|
|
},
|
|
|
|
Returns =
|
|
{
|
|
{ Name = "currentChapterID", Type = "number", Nilable = true },
|
|
},
|
|
},
|
|
{
|
|
Name = "GetFailureReason",
|
|
Type = "Function",
|
|
SecretArguments = "AllowedWhenUntainted",
|
|
|
|
Arguments =
|
|
{
|
|
{ Name = "campaignID", Type = "number", Nilable = false },
|
|
},
|
|
|
|
Returns =
|
|
{
|
|
{ Name = "failureReason", Type = "CampaignFailureReason", Nilable = true },
|
|
},
|
|
},
|
|
{
|
|
Name = "GetState",
|
|
Type = "Function",
|
|
SecretArguments = "AllowedWhenUntainted",
|
|
|
|
Arguments =
|
|
{
|
|
{ Name = "campaignID", Type = "number", Nilable = false },
|
|
},
|
|
|
|
Returns =
|
|
{
|
|
{ Name = "state", Type = "CampaignState", Nilable = false },
|
|
},
|
|
},
|
|
{
|
|
Name = "IsCampaignQuest",
|
|
Type = "Function",
|
|
SecretArguments = "AllowedWhenUntainted",
|
|
|
|
Arguments =
|
|
{
|
|
{ Name = "questID", Type = "number", Nilable = false },
|
|
},
|
|
|
|
Returns =
|
|
{
|
|
{ Name = "isCampaignQuest", Type = "bool", Nilable = false },
|
|
},
|
|
},
|
|
{
|
|
Name = "SortAsNormalQuest",
|
|
Type = "Function",
|
|
SecretArguments = "AllowedWhenUntainted",
|
|
|
|
Arguments =
|
|
{
|
|
{ Name = "campaignID", Type = "number", Nilable = false },
|
|
},
|
|
|
|
Returns =
|
|
{
|
|
{ Name = "sortAsNormalQuest", Type = "bool", Nilable = false },
|
|
},
|
|
},
|
|
},
|
|
|
|
Events =
|
|
{
|
|
},
|
|
|
|
Tables =
|
|
{
|
|
{
|
|
Name = "CampaignState",
|
|
Type = "Enumeration",
|
|
NumValues = 4,
|
|
MinValue = 0,
|
|
MaxValue = 3,
|
|
Fields =
|
|
{
|
|
{ Name = "Invalid", Type = "CampaignState", EnumValue = 0 },
|
|
{ Name = "Complete", Type = "CampaignState", EnumValue = 1 },
|
|
{ Name = "InProgress", Type = "CampaignState", EnumValue = 2 },
|
|
{ Name = "Stalled", Type = "CampaignState", EnumValue = 3 },
|
|
},
|
|
},
|
|
{
|
|
Name = "CampaignChapterInfo",
|
|
Type = "Structure",
|
|
Fields =
|
|
{
|
|
{ Name = "name", Type = "cstring", Nilable = false },
|
|
{ Name = "description", Type = "cstring", Nilable = false },
|
|
{ Name = "rewardQuestID", Type = "number", Nilable = false },
|
|
},
|
|
},
|
|
{
|
|
Name = "CampaignFailureReason",
|
|
Type = "Structure",
|
|
Fields =
|
|
{
|
|
{ Name = "text", Type = "string", Nilable = false },
|
|
{ Name = "questID", Type = "number", Nilable = true },
|
|
{ Name = "mapID", Type = "number", Nilable = true },
|
|
},
|
|
},
|
|
{
|
|
Name = "CampaignInfo",
|
|
Type = "Structure",
|
|
Fields =
|
|
{
|
|
{ Name = "name", Type = "cstring", Nilable = false },
|
|
{ Name = "description", Type = "cstring", Nilable = false },
|
|
{ Name = "uiTextureKit", Type = "textureKit", Nilable = false },
|
|
{ Name = "isWarCampaign", Type = "bool", Nilable = false },
|
|
{ Name = "usesNormalQuestIcons", Type = "bool", Nilable = false },
|
|
{ Name = "isContainerCampaign", Type = "bool", Nilable = false },
|
|
{ Name = "sortAsNormalQuest", Type = "bool", Nilable = false },
|
|
{ Name = "hideFutureChapters", Type = "bool", Nilable = false },
|
|
},
|
|
},
|
|
},
|
|
|
|
Predicates =
|
|
{
|
|
},
|
|
};
|
|
|
|
APIDocumentation:AddDocumentationTable(WarCampaign); |