Blizzard_APIDocumentation/AzeriteEssenceDocumentation.lua

Blizzard_APIDocumentation/AzeriteEssenceDocumentation.lua (9.1.5.40906; unchanged since 9.1.5.40871)
  1. local AzeriteEssence =
  2. {
  3. Name = "AzeriteEssence",
  4. Type = "System",
  5. Namespace = "C_AzeriteEssence",
  6. Functions =
  7. {
  8. {
  9. Name = "ActivateEssence",
  10. Type = "Function",
  11. Arguments =
  12. {
  13. { Name = "essenceID", Type = "number", Nilable = false },
  14. { Name = "milestoneID", Type = "number", Nilable = false },
  15. },
  16. },
  17. {
  18. Name = "CanActivateEssence",
  19. Type = "Function",
  20. Arguments =
  21. {
  22. { Name = "essenceID", Type = "number", Nilable = false },
  23. { Name = "milestoneID", Type = "number", Nilable = false },
  24. },
  25. Returns =
  26. {
  27. { Name = "canActivate", Type = "bool", Nilable = false },
  28. },
  29. },
  30. {
  31. Name = "CanDeactivateEssence",
  32. Type = "Function",
  33. Arguments =
  34. {
  35. { Name = "milestoneID", Type = "number", Nilable = false },
  36. },
  37. Returns =
  38. {
  39. { Name = "canDeactivate", Type = "bool", Nilable = false },
  40. },
  41. },
  42. {
  43. Name = "CanOpenUI",
  44. Type = "Function",
  45. Returns =
  46. {
  47. { Name = "canOpen", Type = "bool", Nilable = false },
  48. },
  49. },
  50. {
  51. Name = "ClearPendingActivationEssence",
  52. Type = "Function",
  53. },
  54. {
  55. Name = "CloseForge",
  56. Type = "Function",
  57. },
  58. {
  59. Name = "GetEssenceHyperlink",
  60. Type = "Function",
  61. Arguments =
  62. {
  63. { Name = "essenceID", Type = "number", Nilable = false },
  64. { Name = "rank", Type = "number", Nilable = false },
  65. },
  66. Returns =
  67. {
  68. { Name = "link", Type = "string", Nilable = false },
  69. },
  70. },
  71. {
  72. Name = "GetEssenceInfo",
  73. Type = "Function",
  74. Arguments =
  75. {
  76. { Name = "essenceID", Type = "number", Nilable = false },
  77. },
  78. Returns =
  79. {
  80. { Name = "info", Type = "AzeriteEssenceInfo", Nilable = false },
  81. },
  82. },
  83. {
  84. Name = "GetEssences",
  85. Type = "Function",
  86. Returns =
  87. {
  88. { Name = "essences", Type = "table", InnerType = "AzeriteEssenceInfo", Nilable = false },
  89. },
  90. },
  91. {
  92. Name = "GetMilestoneEssence",
  93. Type = "Function",
  94. Arguments =
  95. {
  96. { Name = "milestoneID", Type = "number", Nilable = false },
  97. },
  98. Returns =
  99. {
  100. { Name = "essenceID", Type = "number", Nilable = false },
  101. },
  102. },
  103. {
  104. Name = "GetMilestoneInfo",
  105. Type = "Function",
  106. Arguments =
  107. {
  108. { Name = "milestoneID", Type = "number", Nilable = false },
  109. },
  110. Returns =
  111. {
  112. { Name = "info", Type = "AzeriteMilestoneInfo", Nilable = false },
  113. },
  114. },
  115. {
  116. Name = "GetMilestoneSpell",
  117. Type = "Function",
  118. Arguments =
  119. {
  120. { Name = "milestoneID", Type = "number", Nilable = false },
  121. },
  122. Returns =
  123. {
  124. { Name = "spellID", Type = "number", Nilable = false },
  125. },
  126. },
  127. {
  128. Name = "GetMilestones",
  129. Type = "Function",
  130. Returns =
  131. {
  132. { Name = "milestones", Type = "table", InnerType = "AzeriteMilestoneInfo", Nilable = false },
  133. },
  134. },
  135. {
  136. Name = "GetNumUnlockedEssences",
  137. Type = "Function",
  138. Returns =
  139. {
  140. { Name = "numUnlockedEssences", Type = "number", Nilable = false },
  141. },
  142. },
  143. {
  144. Name = "GetNumUsableEssences",
  145. Type = "Function",
  146. Returns =
  147. {
  148. { Name = "numUsableEssences", Type = "number", Nilable = false },
  149. },
  150. },
  151. {
  152. Name = "GetPendingActivationEssence",
  153. Type = "Function",
  154. Returns =
  155. {
  156. { Name = "essenceID", Type = "number", Nilable = false },
  157. },
  158. },
  159. {
  160. Name = "HasNeverActivatedAnyEssences",
  161. Type = "Function",
  162. Returns =
  163. {
  164. { Name = "hasNeverActivatedAnyEssences", Type = "bool", Nilable = false },
  165. },
  166. },
  167. {
  168. Name = "HasPendingActivationEssence",
  169. Type = "Function",
  170. Returns =
  171. {
  172. { Name = "hasEssence", Type = "bool", Nilable = false },
  173. },
  174. },
  175. {
  176. Name = "IsAtForge",
  177. Type = "Function",
  178. Returns =
  179. {
  180. { Name = "isAtForge", Type = "bool", Nilable = false },
  181. },
  182. },
  183. {
  184. Name = "SetPendingActivationEssence",
  185. Type = "Function",
  186. Arguments =
  187. {
  188. { Name = "essenceID", Type = "number", Nilable = false },
  189. },
  190. },
  191. {
  192. Name = "UnlockMilestone",
  193. Type = "Function",
  194. Arguments =
  195. {
  196. { Name = "milestoneID", Type = "number", Nilable = false },
  197. },
  198. },
  199. },
  200. Events =
  201. {
  202. {
  203. Name = "AzeriteEssenceActivated",
  204. Type = "Event",
  205. LiteralName = "AZERITE_ESSENCE_ACTIVATED",
  206. Payload =
  207. {
  208. { Name = "slot", Type = "AzeriteEssenceSlot", Nilable = false },
  209. { Name = "essenceID", Type = "number", Nilable = false },
  210. },
  211. },
  212. {
  213. Name = "AzeriteEssenceActivationFailed",
  214. Type = "Event",
  215. LiteralName = "AZERITE_ESSENCE_ACTIVATION_FAILED",
  216. Payload =
  217. {
  218. { Name = "slot", Type = "AzeriteEssenceSlot", Nilable = false },
  219. { Name = "essenceID", Type = "number", Nilable = false },
  220. },
  221. },
  222. {
  223. Name = "AzeriteEssenceChanged",
  224. Type = "Event",
  225. LiteralName = "AZERITE_ESSENCE_CHANGED",
  226. Payload =
  227. {
  228. { Name = "essenceID", Type = "number", Nilable = false },
  229. { Name = "newRank", Type = "number", Nilable = false },
  230. },
  231. },
  232. {
  233. Name = "AzeriteEssenceForgeClose",
  234. Type = "Event",
  235. LiteralName = "AZERITE_ESSENCE_FORGE_CLOSE",
  236. },
  237. {
  238. Name = "AzeriteEssenceForgeOpen",
  239. Type = "Event",
  240. LiteralName = "AZERITE_ESSENCE_FORGE_OPEN",
  241. },
  242. {
  243. Name = "AzeriteEssenceMilestoneUnlocked",
  244. Type = "Event",
  245. LiteralName = "AZERITE_ESSENCE_MILESTONE_UNLOCKED",
  246. Payload =
  247. {
  248. { Name = "milestoneID", Type = "number", Nilable = false },
  249. },
  250. },
  251. {
  252. Name = "AzeriteEssenceUpdate",
  253. Type = "Event",
  254. LiteralName = "AZERITE_ESSENCE_UPDATE",
  255. },
  256. {
  257. Name = "PendingAzeriteEssenceChanged",
  258. Type = "Event",
  259. LiteralName = "PENDING_AZERITE_ESSENCE_CHANGED",
  260. Payload =
  261. {
  262. { Name = "essenceID", Type = "number", Nilable = true },
  263. },
  264. },
  265. },
  266. Tables =
  267. {
  268. {
  269. Name = "AzeriteEssenceInfo",
  270. Type = "Structure",
  271. Fields =
  272. {
  273. { Name = "ID", Type = "number", Nilable = false },
  274. { Name = "name", Type = "string", Nilable = false },
  275. { Name = "rank", Type = "number", Nilable = false },
  276. { Name = "unlocked", Type = "bool", Nilable = false },
  277. { Name = "valid", Type = "bool", Nilable = false },
  278. { Name = "icon", Type = "number", Nilable = false },
  279. },
  280. },
  281. {
  282. Name = "AzeriteMilestoneInfo",
  283. Type = "Structure",
  284. Fields =
  285. {
  286. { Name = "ID", Type = "number", Nilable = false },
  287. { Name = "requiredLevel", Type = "number", Nilable = false },
  288. { Name = "canUnlock", Type = "bool", Nilable = false },
  289. { Name = "unlocked", Type = "bool", Nilable = false },
  290. { Name = "rank", Type = "number", Nilable = true },
  291. { Name = "slot", Type = "AzeriteEssenceSlot", Nilable = true },
  292. },
  293. },
  294. },
  295. };
  296. APIDocumentation:AddDocumentationTable(AzeriteEssence);