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

60 lines
2.2 KiB
Lua

local LocalizationShared =
{
Tables =
{
{
Name = "AbbreviationDataError",
Type = "Enumeration",
NumValues = 4,
MinValue = 1,
MaxValue = 8,
Fields =
{
{ Name = "InvalidBreakpoint", Type = "AbbreviationDataError", EnumValue = 1 },
{ Name = "InvalidSignificandDivisor", Type = "AbbreviationDataError", EnumValue = 2 },
{ Name = "InvalidFractionDivisor", Type = "AbbreviationDataError", EnumValue = 4 },
{ Name = "NotMultipleOfTen", Type = "AbbreviationDataError", EnumValue = 8 },
},
},
{
Name = "NamePartType",
Type = "Enumeration",
NumValues = 2,
MinValue = 0,
MaxValue = 1,
Fields =
{
{ Name = "Firstname", Type = "NamePartType", EnumValue = 0 },
{ Name = "Surname", Type = "NamePartType", EnumValue = 1 },
},
},
{
Name = "NumberAbbreviationBreakpoint",
Type = "Structure",
Fields =
{
{ Name = "breakpoint", Type = "number", Nilable = false, Documentation = { "Breakpoints should generally be specified as pairs, with one at the named order (1,000) with fractionDivisor = 10, and one a single order higher (eg. 10,000) with fractionDivisor = 1., This ruleset means numbers like '1234' will be abbreviated to '1.2k' and numbers like '12345' to '12k'." } },
{ Name = "abbreviation", Type = "string", Nilable = false, Documentation = { "Abbreviation name to be looked up as a global string." } },
{ Name = "significandDivisor", Type = "number", Nilable = false, Documentation = { "significandDivisor and fractionDivisor should multiply such that they become equal to a named order of magnitude, such as thousands or millions." } },
{ Name = "fractionDivisor", Type = "number", Nilable = false },
{ Name = "abbreviationIsGlobal", Type = "bool", Nilable = false, Default = true, Documentation = { "Defaults to true. Set to false to skip the global string lookup and use the raw abbreviation string when formatting results" } },
},
},
},
Predicates =
{
{
Name = "RequiresRestrictedAbbreviationBreakpoints",
Type = "Precondition",
FailureMode = "Error",
},
{
Name = "RequiresValidAbbreviationBreakpoints",
Type = "Precondition",
FailureMode = "Error",
},
},
};
APIDocumentation:AddDocumentationTable(LocalizationShared);