Blizzard_APIDocumentation/CovenantSanctumDocumentation.lua

Blizzard_APIDocumentation/CovenantSanctumDocumentation.lua (9.1.5.40906; unchanged since 9.0.5.37864)
  1. local CovenantSanctum =
  2. {
  3. Name = "CovenantSanctumUI",
  4. Type = "System",
  5. Namespace = "C_CovenantSanctumUI",
  6. Functions =
  7. {
  8. {
  9. Name = "CanAccessReservoir",
  10. Type = "Function",
  11. Returns =
  12. {
  13. { Name = "canAccess", Type = "bool", Nilable = false },
  14. },
  15. },
  16. {
  17. Name = "CanDepositAnima",
  18. Type = "Function",
  19. Returns =
  20. {
  21. { Name = "canDeposit", Type = "bool", Nilable = false },
  22. },
  23. },
  24. {
  25. Name = "DepositAnima",
  26. Type = "Function",
  27. },
  28. {
  29. Name = "EndInteraction",
  30. Type = "Function",
  31. },
  32. {
  33. Name = "GetAnimaInfo",
  34. Type = "Function",
  35. Returns =
  36. {
  37. { Name = "currencyID", Type = "number", Nilable = false },
  38. { Name = "maxDisplayableValue", Type = "number", Nilable = false },
  39. },
  40. },
  41. {
  42. Name = "GetCurrentTalentTreeID",
  43. Type = "Function",
  44. Returns =
  45. {
  46. { Name = "currentTalentTreeID", Type = "number", Nilable = true },
  47. },
  48. },
  49. {
  50. Name = "GetFeatures",
  51. Type = "Function",
  52. Returns =
  53. {
  54. { Name = "features", Type = "table", InnerType = "CovenantSanctumFeatureInfo", Nilable = false },
  55. },
  56. },
  57. {
  58. Name = "GetRenownLevel",
  59. Type = "Function",
  60. Returns =
  61. {
  62. { Name = "level", Type = "number", Nilable = false },
  63. },
  64. },
  65. {
  66. Name = "GetRenownLevels",
  67. Type = "Function",
  68. Arguments =
  69. {
  70. { Name = "covenantID", Type = "number", Nilable = false },
  71. },
  72. Returns =
  73. {
  74. { Name = "levels", Type = "table", InnerType = "CovenantSanctumRenownLevelInfo", Nilable = false },
  75. },
  76. },
  77. {
  78. Name = "GetRenownRewardsForLevel",
  79. Type = "Function",
  80. Arguments =
  81. {
  82. { Name = "covenantID", Type = "number", Nilable = false },
  83. { Name = "renownLevel", Type = "number", Nilable = false },
  84. },
  85. Returns =
  86. {
  87. { Name = "rewards", Type = "table", InnerType = "CovenantSanctumRenownRewardInfo", Nilable = false },
  88. },
  89. },
  90. {
  91. Name = "GetSanctumType",
  92. Type = "Function",
  93. Returns =
  94. {
  95. { Name = "sanctumType", Type = "GarrTalentFeatureSubtype", Nilable = true },
  96. },
  97. },
  98. {
  99. Name = "GetSoulCurrencies",
  100. Type = "Function",
  101. Returns =
  102. {
  103. { Name = "currencyIDs", Type = "table", InnerType = "number", Nilable = false },
  104. },
  105. },
  106. {
  107. Name = "HasMaximumRenown",
  108. Type = "Function",
  109. Returns =
  110. {
  111. { Name = "hasMaxRenown", Type = "bool", Nilable = false },
  112. },
  113. },
  114. {
  115. Name = "IsPlayerInRenownCatchUpMode",
  116. Type = "Function",
  117. Returns =
  118. {
  119. { Name = "isInCatchUpMode", Type = "bool", Nilable = false },
  120. },
  121. },
  122. {
  123. Name = "IsWeeklyRenownCapped",
  124. Type = "Function",
  125. Returns =
  126. {
  127. { Name = "isWeeklyCapped", Type = "bool", Nilable = false },
  128. },
  129. },
  130. {
  131. Name = "RequestCatchUpState",
  132. Type = "Function",
  133. },
  134. },
  135. Events =
  136. {
  137. {
  138. Name = "CovenantRenownCatchUpStateUpdate",
  139. Type = "Event",
  140. LiteralName = "COVENANT_RENOWN_CATCH_UP_STATE_UPDATE",
  141. },
  142. {
  143. Name = "CovenantRenownInteractionEnded",
  144. Type = "Event",
  145. LiteralName = "COVENANT_RENOWN_INTERACTION_ENDED",
  146. },
  147. {
  148. Name = "CovenantRenownInteractionStarted",
  149. Type = "Event",
  150. LiteralName = "COVENANT_RENOWN_INTERACTION_STARTED",
  151. },
  152. {
  153. Name = "CovenantSanctumInteractionEnded",
  154. Type = "Event",
  155. LiteralName = "COVENANT_SANCTUM_INTERACTION_ENDED",
  156. },
  157. {
  158. Name = "CovenantSanctumInteractionStarted",
  159. Type = "Event",
  160. LiteralName = "COVENANT_SANCTUM_INTERACTION_STARTED",
  161. },
  162. {
  163. Name = "CovenantSanctumRenownLevelChanged",
  164. Type = "Event",
  165. LiteralName = "COVENANT_SANCTUM_RENOWN_LEVEL_CHANGED",
  166. Payload =
  167. {
  168. { Name = "newRenownLevel", Type = "number", Nilable = false },
  169. { Name = "oldRenownLevel", Type = "number", Nilable = false },
  170. },
  171. },
  172. },
  173. Tables =
  174. {
  175. {
  176. Name = "CovenantSanctumFeatureInfo",
  177. Type = "Structure",
  178. Fields =
  179. {
  180. { Name = "garrTalentTreeID", Type = "number", Nilable = false },
  181. { Name = "featureType", Type = "number", Nilable = false },
  182. { Name = "uiOrder", Type = "number", Nilable = false },
  183. },
  184. },
  185. {
  186. Name = "CovenantSanctumRenownLevelInfo",
  187. Type = "Structure",
  188. Fields =
  189. {
  190. { Name = "level", Type = "number", Nilable = false },
  191. { Name = "locked", Type = "bool", Nilable = false },
  192. { Name = "isMilestone", Type = "bool", Nilable = false },
  193. { Name = "isCapstone", Type = "bool", Nilable = false },
  194. },
  195. },
  196. {
  197. Name = "CovenantSanctumRenownRewardInfo",
  198. Type = "Structure",
  199. Fields =
  200. {
  201. { Name = "uiOrder", Type = "number", Nilable = false },
  202. { Name = "itemID", Type = "number", Nilable = true },
  203. { Name = "spellID", Type = "number", Nilable = true },
  204. { Name = "mountID", Type = "number", Nilable = true },
  205. { Name = "transmogID", Type = "number", Nilable = true },
  206. { Name = "transmogSetID", Type = "number", Nilable = true },
  207. { Name = "titleMaskID", Type = "number", Nilable = true },
  208. { Name = "garrFollowerID", Type = "number", Nilable = true },
  209. { Name = "transmogIllusionSourceID", Type = "number", Nilable = true },
  210. { Name = "icon", Type = "number", Nilable = true },
  211. { Name = "name", Type = "string", Nilable = true },
  212. { Name = "description", Type = "string", Nilable = true },
  213. { Name = "toastDescription", Type = "string", Nilable = true },
  214. },
  215. },
  216. },
  217. };
  218. APIDocumentation:AddDocumentationTable(CovenantSanctum);