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

328 lines
6.9 KiB
Lua

local Expansion =
{
Name = "Expansion",
Type = "System",
Environment = "All",
Functions =
{
{
Name = "CanUpgradeToCurrentExpansion",
Type = "Function",
Returns =
{
{ Name = "canUpgradeExpansion", Type = "bool", Nilable = false },
},
},
{
Name = "DoesCurrentLocaleSellExpansionLevels",
Type = "Function",
Returns =
{
{ Name = "regionSellsExpansions", Type = "bool", Nilable = false },
},
},
{
Name = "GetAccountExpansionLevel",
Type = "Function",
Returns =
{
{ Name = "expansionLevel", Type = "number", Nilable = false },
},
},
{
Name = "GetClientDisplayExpansionLevel",
Type = "Function",
Returns =
{
{ Name = "expansionLevel", Type = "number", Nilable = false },
},
},
{
Name = "GetCurrentRegionName",
Type = "Function",
Returns =
{
{ Name = "regionName", Type = "cstring", Nilable = false },
},
},
{
Name = "GetExpansionDisplayInfo",
Type = "Function",
SecretArguments = "AllowedWhenUntainted",
Arguments =
{
{ Name = "expansionLevel", Type = "number", Nilable = false },
{ Name = "desiredReleaseType", Type = "ReleaseType", Nilable = true },
},
Returns =
{
{ Name = "info", Type = "ExpansionDisplayInfo", Nilable = true },
},
},
{
Name = "GetExpansionForLevel",
Type = "Function",
MayReturnNothing = true,
SecretArguments = "AllowedWhenUntainted",
Arguments =
{
{ Name = "playerLevel", Type = "number", Nilable = false },
},
Returns =
{
{ Name = "expansionLevel", Type = "number", Nilable = false },
},
},
{
Name = "GetExpansionLevel",
Type = "Function",
Returns =
{
{ Name = "expansionLevel", Type = "number", Nilable = false },
},
},
{
Name = "GetExpansionTrialInfo",
Type = "Function",
Returns =
{
{ Name = "isExpansionTrialAccount", Type = "bool", Nilable = false },
{ Name = "expansionTrialRemainingSeconds", Type = "time_t", Nilable = true },
},
},
{
Name = "GetMaxLevelForExpansionLevel",
Type = "Function",
SecretArguments = "AllowedWhenUntainted",
Documentation = { "Maps an expansion level to a maximum character level for that expansion." },
Arguments =
{
{ Name = "expansionLevel", Type = "number", Nilable = false },
},
Returns =
{
{ Name = "maxLevel", Type = "number", Nilable = false },
},
},
{
Name = "GetMaxLevelForLatestExpansion",
Type = "Function",
Returns =
{
{ Name = "maxLevel", Type = "number", Nilable = false },
},
},
{
Name = "GetMaxLevelForPlayerExpansion",
Type = "Function",
Returns =
{
{ Name = "maxLevel", Type = "number", Nilable = false },
},
},
{
Name = "GetMaximumExpansionLevel",
Type = "Function",
Returns =
{
{ Name = "expansionLevel", Type = "number", Nilable = false },
},
},
{
Name = "GetMinimumExpansionLevel",
Type = "Function",
Returns =
{
{ Name = "expansionLevel", Type = "number", Nilable = false },
},
},
{
Name = "GetNumExpansions",
Type = "Function",
Returns =
{
{ Name = "numExpansions", Type = "number", Nilable = false },
},
},
{
Name = "GetServerExpansionLevel",
Type = "Function",
Returns =
{
{ Name = "serverExpansionLevel", Type = "number", Nilable = false },
},
},
{
Name = "GetUpgradeExpansionLevel",
Type = "Function",
Returns =
{
{ Name = "upgradeExpansionLevel", Type = "number", Nilable = false },
},
},
{
Name = "IsDemonHunterAvailable",
Type = "Function",
Returns =
{
{ Name = "available", Type = "bool", Nilable = false },
},
},
{
Name = "IsExpansionTrial",
Type = "Function",
Returns =
{
{ Name = "isExpansionTrialAccount", Type = "bool", Nilable = false },
},
},
{
Name = "IsTrialAccount",
Type = "Function",
Returns =
{
{ Name = "isTrialAccount", Type = "bool", Nilable = false },
},
},
{
Name = "IsVeteranTrialAccount",
Type = "Function",
Returns =
{
{ Name = "isVeteranTrialAccount", Type = "bool", Nilable = false },
},
},
{
Name = "SendSubscriptionInterstitialResponse",
Type = "Function",
HasRestrictions = true,
SecretArguments = "AllowedWhenUntainted",
Arguments =
{
{ Name = "response", Type = "SubscriptionInterstitialResponseType", Nilable = false },
},
},
{
Name = "ShouldShowExpansionUpgradeBanner",
Type = "Function",
Returns =
{
{ Name = "showUpgradeBanner", Type = "bool", Nilable = false },
},
},
},
Events =
{
{
Name = "MaxExpansionLevelUpdated",
Type = "Event",
LiteralName = "MAX_EXPANSION_LEVEL_UPDATED",
SynchronousEvent = true,
},
{
Name = "MinExpansionLevelUpdated",
Type = "Event",
LiteralName = "MIN_EXPANSION_LEVEL_UPDATED",
SynchronousEvent = true,
},
{
Name = "ShowSubscriptionInterstitial",
Type = "Event",
LiteralName = "SHOW_SUBSCRIPTION_INTERSTITIAL",
SynchronousEvent = true,
Payload =
{
{ Name = "type", Type = "SubscriptionInterstitialType", Nilable = false },
},
},
},
Tables =
{
{
Name = "SubscriptionInterstitialResponseType",
Type = "Enumeration",
NumValues = 3,
MinValue = 0,
MaxValue = 2,
Fields =
{
{ Name = "Clicked", Type = "SubscriptionInterstitialResponseType", EnumValue = 0 },
{ Name = "Closed", Type = "SubscriptionInterstitialResponseType", EnumValue = 1 },
{ Name = "WebRedirect", Type = "SubscriptionInterstitialResponseType", EnumValue = 2 },
},
},
{
Name = "SubscriptionInterstitialType",
Type = "Enumeration",
NumValues = 3,
MinValue = 0,
MaxValue = 2,
Fields =
{
{ Name = "Standard", Type = "SubscriptionInterstitialType", EnumValue = 0 },
{ Name = "LeftNpeArea", Type = "SubscriptionInterstitialType", EnumValue = 1 },
{ Name = "MaxLevel", Type = "SubscriptionInterstitialType", EnumValue = 2 },
},
},
{
Name = "ExpansionDisplayInfo",
Type = "Structure",
Fields =
{
{ Name = "logo", Type = "fileID", Nilable = false },
{ Name = "banner", Type = "textureAtlas", Nilable = false },
{ Name = "features", Type = "table", InnerType = "ExpansionDisplayInfoFeature", Nilable = false },
{ Name = "highResBackgroundID", Type = "fileID", Nilable = false },
{ Name = "lowResBackgroundID", Type = "fileID", Nilable = false },
{ Name = "textureKit", Type = "textureKit", Nilable = false },
{ Name = "glueAmbianceSoundKit", Type = "number", Nilable = true },
{ Name = "glueMusicSoundKit", Type = "number", Nilable = true },
{ Name = "glueCreditsSoundKit", Type = "number", Nilable = true },
},
},
{
Name = "ExpansionDisplayInfoFeature",
Type = "Structure",
Fields =
{
{ Name = "icon", Type = "fileID", Nilable = false },
{ Name = "text", Type = "cstring", Nilable = false },
},
},
},
Predicates =
{
},
};
APIDocumentation:AddDocumentationTable(Expansion);