Blizzard_APIDocumentation/ScenarioInfoDocumentation.lua

Blizzard_APIDocumentation/ScenarioInfoDocumentation.lua (9.1.5.40906; unchanged since 9.1.0.39229)
  1. local ScenarioInfo =
  2. {
  3. Name = "ScenarioInfo",
  4. Type = "System",
  5. Namespace = "C_ScenarioInfo",
  6. Functions =
  7. {
  8. {
  9. Name = "GetJailersTowerTypeString",
  10. Type = "Function",
  11. Arguments =
  12. {
  13. { Name = "runType", Type = "JailersTowerType", Nilable = false },
  14. },
  15. Returns =
  16. {
  17. { Name = "typeString", Type = "string", Nilable = true },
  18. },
  19. },
  20. {
  21. Name = "GetScenarioInfo",
  22. Type = "Function",
  23. Returns =
  24. {
  25. { Name = "scenarioInfo", Type = "ScenarioInformation", Nilable = false },
  26. },
  27. },
  28. {
  29. Name = "GetScenarioStepInfo",
  30. Type = "Function",
  31. Arguments =
  32. {
  33. { Name = "scenarioStepID", Type = "number", Nilable = true },
  34. },
  35. Returns =
  36. {
  37. { Name = "scenarioStepInfo", Type = "ScenarioStepInfo", Nilable = false },
  38. },
  39. },
  40. },
  41. Events =
  42. {
  43. {
  44. Name = "JailersTowerLevelUpdate",
  45. Type = "Event",
  46. LiteralName = "JAILERS_TOWER_LEVEL_UPDATE",
  47. Payload =
  48. {
  49. { Name = "level", Type = "number", Nilable = false },
  50. { Name = "type", Type = "JailersTowerType", Nilable = false },
  51. },
  52. },
  53. {
  54. Name = "ScenarioBonusObjectiveComplete",
  55. Type = "Event",
  56. LiteralName = "SCENARIO_BONUS_OBJECTIVE_COMPLETE",
  57. Payload =
  58. {
  59. { Name = "bonusObjectiveID", Type = "number", Nilable = false },
  60. },
  61. },
  62. {
  63. Name = "ScenarioBonusVisibilityUpdate",
  64. Type = "Event",
  65. LiteralName = "SCENARIO_BONUS_VISIBILITY_UPDATE",
  66. },
  67. {
  68. Name = "ScenarioCompleted",
  69. Type = "Event",
  70. LiteralName = "SCENARIO_COMPLETED",
  71. Payload =
  72. {
  73. { Name = "questID", Type = "number", Nilable = true },
  74. { Name = "xp", Type = "number", Nilable = true },
  75. { Name = "money", Type = "number", Nilable = true },
  76. },
  77. },
  78. {
  79. Name = "ScenarioCriteriaShowStateUpdate",
  80. Type = "Event",
  81. LiteralName = "SCENARIO_CRITERIA_SHOW_STATE_UPDATE",
  82. Payload =
  83. {
  84. { Name = "show", Type = "bool", Nilable = false },
  85. },
  86. },
  87. {
  88. Name = "ScenarioCriteriaUpdate",
  89. Type = "Event",
  90. LiteralName = "SCENARIO_CRITERIA_UPDATE",
  91. Payload =
  92. {
  93. { Name = "criteriaID", Type = "number", Nilable = false },
  94. },
  95. },
  96. {
  97. Name = "ScenarioPoiUpdate",
  98. Type = "Event",
  99. LiteralName = "SCENARIO_POI_UPDATE",
  100. },
  101. {
  102. Name = "ScenarioSpellUpdate",
  103. Type = "Event",
  104. LiteralName = "SCENARIO_SPELL_UPDATE",
  105. },
  106. {
  107. Name = "ScenarioUpdate",
  108. Type = "Event",
  109. LiteralName = "SCENARIO_UPDATE",
  110. Payload =
  111. {
  112. { Name = "newStep", Type = "bool", Nilable = true },
  113. },
  114. },
  115. },
  116. Tables =
  117. {
  118. {
  119. Name = "JailersTowerType",
  120. Type = "Enumeration",
  121. NumValues = 14,
  122. MinValue = 0,
  123. MaxValue = 13,
  124. Fields =
  125. {
  126. { Name = "TwistingCorridors", Type = "JailersTowerType", EnumValue = 0 },
  127. { Name = "SkoldusHalls", Type = "JailersTowerType", EnumValue = 1 },
  128. { Name = "FractureChambers", Type = "JailersTowerType", EnumValue = 2 },
  129. { Name = "Soulforges", Type = "JailersTowerType", EnumValue = 3 },
  130. { Name = "Coldheart", Type = "JailersTowerType", EnumValue = 4 },
  131. { Name = "Mortregar", Type = "JailersTowerType", EnumValue = 5 },
  132. { Name = "UpperReaches", Type = "JailersTowerType", EnumValue = 6 },
  133. { Name = "ArkobanHall", Type = "JailersTowerType", EnumValue = 7 },
  134. { Name = "TormentChamberJaina", Type = "JailersTowerType", EnumValue = 8 },
  135. { Name = "TormentChamberThrall", Type = "JailersTowerType", EnumValue = 9 },
  136. { Name = "TormentChamberAnduin", Type = "JailersTowerType", EnumValue = 10 },
  137. { Name = "AdamantVaults", Type = "JailersTowerType", EnumValue = 11 },
  138. { Name = "ForgottenCatacombs", Type = "JailersTowerType", EnumValue = 12 },
  139. { Name = "Ossuary", Type = "JailersTowerType", EnumValue = 13 },
  140. },
  141. },
  142. {
  143. Name = "ScenarioInformation",
  144. Type = "Structure",
  145. Fields =
  146. {
  147. { Name = "name", Type = "string", Nilable = false },
  148. { Name = "currentStage", Type = "number", Nilable = false },
  149. { Name = "numStages", Type = "number", Nilable = false },
  150. { Name = "flags", Type = "number", Nilable = false },
  151. { Name = "isComplete", Type = "bool", Nilable = false },
  152. { Name = "xp", Type = "number", Nilable = false },
  153. { Name = "money", Type = "number", Nilable = false },
  154. { Name = "type", Type = "number", Nilable = false },
  155. { Name = "area", Type = "string", Nilable = false },
  156. { Name = "uiTextureKit", Type = "string", Nilable = false },
  157. },
  158. },
  159. {
  160. Name = "ScenarioStepInfo",
  161. Type = "Structure",
  162. Fields =
  163. {
  164. { Name = "title", Type = "string", Nilable = false },
  165. { Name = "description", Type = "string", Nilable = false },
  166. { Name = "numCriteria", Type = "number", Nilable = false },
  167. { Name = "stepFailed", Type = "bool", Nilable = false },
  168. { Name = "isBonusStep", Type = "bool", Nilable = false },
  169. { Name = "isForCurrentStepOnly", Type = "bool", Nilable = false },
  170. { Name = "shouldShowBonusObjective", Type = "bool", Nilable = false },
  171. { Name = "spells", Type = "table", InnerType = "ScenarioStepSpellInfo", Nilable = false },
  172. { Name = "weightedProgress", Type = "number", Nilable = true },
  173. { Name = "rewardQuestID", Type = "number", Nilable = false },
  174. { Name = "widgetSetID", Type = "number", Nilable = true },
  175. },
  176. },
  177. {
  178. Name = "ScenarioStepSpellInfo",
  179. Type = "Structure",
  180. Fields =
  181. {
  182. { Name = "spellID", Type = "number", Nilable = false },
  183. { Name = "name", Type = "string", Nilable = false },
  184. { Name = "icon", Type = "number", Nilable = false },
  185. },
  186. },
  187. },
  188. };
  189. APIDocumentation:AddDocumentationTable(ScenarioInfo);