Blizzard_APIDocumentation/UIEventToastManagerDocumentation.lua

Blizzard_APIDocumentation/UIEventToastManagerDocumentation.lua (9.1.5.40906; unchanged since 9.1.5.40871)
  1. local UIEventToastManager =
  2. {
  3. Name = "UIEventToastManagerInfo",
  4. Type = "System",
  5. Namespace = "C_EventToastManager",
  6. Functions =
  7. {
  8. {
  9. Name = "GetLevelUpDisplayToastsFromLevel",
  10. Type = "Function",
  11. Arguments =
  12. {
  13. { Name = "level", Type = "number", Nilable = false },
  14. },
  15. Returns =
  16. {
  17. { Name = "toastInfo", Type = "table", InnerType = "EventToastInfo", Nilable = false },
  18. },
  19. },
  20. {
  21. Name = "GetNextToastToDisplay",
  22. Type = "Function",
  23. Returns =
  24. {
  25. { Name = "toastInfo", Type = "EventToastInfo", Nilable = false },
  26. },
  27. },
  28. {
  29. Name = "RemoveCurrentToast",
  30. Type = "Function",
  31. },
  32. },
  33. Events =
  34. {
  35. {
  36. Name = "DisplayEventToastLink",
  37. Type = "Event",
  38. LiteralName = "DISPLAY_EVENT_TOAST_LINK",
  39. Payload =
  40. {
  41. { Name = "link", Type = "string", Nilable = false },
  42. },
  43. },
  44. {
  45. Name = "DisplayEventToasts",
  46. Type = "Event",
  47. LiteralName = "DISPLAY_EVENT_TOASTS",
  48. },
  49. },
  50. Tables =
  51. {
  52. {
  53. Name = "EventToastDisplayType",
  54. Type = "Enumeration",
  55. NumValues = 9,
  56. MinValue = 0,
  57. MaxValue = 8,
  58. Fields =
  59. {
  60. { Name = "NormalSingleLine", Type = "EventToastDisplayType", EnumValue = 0 },
  61. { Name = "NormalBlockText", Type = "EventToastDisplayType", EnumValue = 1 },
  62. { Name = "NormalTitleAndSubTitle", Type = "EventToastDisplayType", EnumValue = 2 },
  63. { Name = "NormalTextWithIcon", Type = "EventToastDisplayType", EnumValue = 3 },
  64. { Name = "LargeTextWithIcon", Type = "EventToastDisplayType", EnumValue = 4 },
  65. { Name = "NormalTextWithIconAndRarity", Type = "EventToastDisplayType", EnumValue = 5 },
  66. { Name = "Scenario", Type = "EventToastDisplayType", EnumValue = 6 },
  67. { Name = "ChallengeMode", Type = "EventToastDisplayType", EnumValue = 7 },
  68. { Name = "ScenarioClickExpand", Type = "EventToastDisplayType", EnumValue = 8 },
  69. },
  70. },
  71. {
  72. Name = "EventToastEventType",
  73. Type = "Enumeration",
  74. NumValues = 21,
  75. MinValue = 0,
  76. MaxValue = 20,
  77. Fields =
  78. {
  79. { Name = "LevelUp", Type = "EventToastEventType", EnumValue = 0 },
  80. { Name = "LevelUpSpell", Type = "EventToastEventType", EnumValue = 1 },
  81. { Name = "LevelUpDungeon", Type = "EventToastEventType", EnumValue = 2 },
  82. { Name = "LevelUpRaid", Type = "EventToastEventType", EnumValue = 3 },
  83. { Name = "LevelUpPvP", Type = "EventToastEventType", EnumValue = 4 },
  84. { Name = "PetBattleNewAbility", Type = "EventToastEventType", EnumValue = 5 },
  85. { Name = "PetBattleFinalRound", Type = "EventToastEventType", EnumValue = 6 },
  86. { Name = "PetBattleCapture", Type = "EventToastEventType", EnumValue = 7 },
  87. { Name = "BattlePetLevelChanged", Type = "EventToastEventType", EnumValue = 8 },
  88. { Name = "BattlePetLevelUpAbility", Type = "EventToastEventType", EnumValue = 9 },
  89. { Name = "QuestBossEmote", Type = "EventToastEventType", EnumValue = 10 },
  90. { Name = "MythicPlusWeeklyRecord", Type = "EventToastEventType", EnumValue = 11 },
  91. { Name = "QuestTurnedIn", Type = "EventToastEventType", EnumValue = 12 },
  92. { Name = "WorldStateChange", Type = "EventToastEventType", EnumValue = 13 },
  93. { Name = "Scenario", Type = "EventToastEventType", EnumValue = 14 },
  94. { Name = "LevelUpOther", Type = "EventToastEventType", EnumValue = 15 },
  95. { Name = "PlayerAuraAdded", Type = "EventToastEventType", EnumValue = 16 },
  96. { Name = "PlayerAuraRemoved", Type = "EventToastEventType", EnumValue = 17 },
  97. { Name = "SpellScript", Type = "EventToastEventType", EnumValue = 18 },
  98. { Name = "CriteriaUpdated", Type = "EventToastEventType", EnumValue = 19 },
  99. { Name = "PvPTierUpdate", Type = "EventToastEventType", EnumValue = 20 },
  100. },
  101. },
  102. {
  103. Name = "EventToastInfo",
  104. Type = "Structure",
  105. Fields =
  106. {
  107. { Name = "eventToastID", Type = "number", Nilable = false },
  108. { Name = "title", Type = "string", Nilable = false },
  109. { Name = "subtitle", Type = "string", Nilable = false },
  110. { Name = "instructionText", Type = "string", Nilable = false },
  111. { Name = "iconFileID", Type = "number", Nilable = false },
  112. { Name = "subIcon", Type = "string", Nilable = true },
  113. { Name = "link", Type = "string", Nilable = false },
  114. { Name = "qualityString", Type = "string", Nilable = true },
  115. { Name = "quality", Type = "number", Nilable = true },
  116. { Name = "eventType", Type = "EventToastEventType", Nilable = false },
  117. { Name = "displayType", Type = "EventToastDisplayType", Nilable = false },
  118. { Name = "uiTextureKit", Type = "string", Nilable = false },
  119. { Name = "sortOrder", Type = "number", Nilable = false },
  120. { Name = "time", Type = "number", Nilable = true },
  121. { Name = "uiWidgetSetID", Type = "number", Nilable = true },
  122. { Name = "extraUiWidgetSetID", Type = "number", Nilable = true },
  123. { Name = "titleTooltip", Type = "string", Nilable = true },
  124. { Name = "subtitleTooltip", Type = "string", Nilable = true },
  125. { Name = "titleTooltipUiWidgetSetID", Type = "number", Nilable = true },
  126. { Name = "subtitleTooltipUiWidgetSetID", Type = "number", Nilable = true },
  127. { Name = "hideDefaultAtlas", Type = "bool", Nilable = true },
  128. { Name = "showSoundKitID", Type = "number", Nilable = true },
  129. { Name = "hideSoundKitID", Type = "number", Nilable = true },
  130. { Name = "colorTint", Type = "table", Mixin = "ColorMixin", Nilable = true },
  131. },
  132. },
  133. },
  134. };
  135. APIDocumentation:AddDocumentationTable(UIEventToastManager);