Blizzard_APIDocumentation/ContributionCollectorDocumentation.lua

Blizzard_APIDocumentation/ContributionCollectorDocumentation.lua (9.1.0.39617; unchanged since 9.1.0.39229)
  1. local ContributionCollector =
  2. {
  3. Name = "ContributionCollector",
  4. Type = "System",
  5. Namespace = "C_ContributionCollector",
  6. Functions =
  7. {
  8. {
  9. Name = "Close",
  10. Type = "Function",
  11. },
  12. {
  13. Name = "Contribute",
  14. Type = "Function",
  15. Arguments =
  16. {
  17. { Name = "contributionID", Type = "number", Nilable = false },
  18. },
  19. },
  20. {
  21. Name = "GetActive",
  22. Type = "Function",
  23. Returns =
  24. {
  25. { Name = "contributionID", Type = "number", Nilable = false, StrideIndex = 1 },
  26. },
  27. },
  28. {
  29. Name = "GetAtlases",
  30. Type = "Function",
  31. Arguments =
  32. {
  33. { Name = "contributionID", Type = "number", Nilable = false },
  34. },
  35. Returns =
  36. {
  37. { Name = "atlasName", Type = "table", InnerType = "string", Nilable = false },
  38. },
  39. },
  40. {
  41. Name = "GetBuffs",
  42. Type = "Function",
  43. Arguments =
  44. {
  45. { Name = "contributionID", Type = "number", Nilable = false },
  46. },
  47. Returns =
  48. {
  49. { Name = "spellID", Type = "number", Nilable = false, StrideIndex = 1 },
  50. },
  51. },
  52. {
  53. Name = "GetContributionAppearance",
  54. Type = "Function",
  55. Arguments =
  56. {
  57. { Name = "contributionID", Type = "number", Nilable = false },
  58. { Name = "contributionState", Type = "ContributionState", Nilable = false },
  59. },
  60. Returns =
  61. {
  62. { Name = "appearance", Type = "ContributionAppearance", Nilable = true },
  63. },
  64. },
  65. {
  66. Name = "GetContributionCollectorsForMap",
  67. Type = "Function",
  68. Arguments =
  69. {
  70. { Name = "uiMapID", Type = "number", Nilable = false },
  71. },
  72. Returns =
  73. {
  74. { Name = "contributionCollectors", Type = "table", InnerType = "ContributionMapInfo", Nilable = false },
  75. },
  76. },
  77. {
  78. Name = "GetContributionResult",
  79. Type = "Function",
  80. Arguments =
  81. {
  82. { Name = "contributionID", Type = "number", Nilable = false },
  83. },
  84. Returns =
  85. {
  86. { Name = "result", Type = "ContributionResult", Nilable = false },
  87. },
  88. },
  89. {
  90. Name = "GetDescription",
  91. Type = "Function",
  92. Arguments =
  93. {
  94. { Name = "contributionID", Type = "number", Nilable = false },
  95. },
  96. Returns =
  97. {
  98. { Name = "description", Type = "string", Nilable = false, Default = "" },
  99. },
  100. },
  101. {
  102. Name = "GetManagedContributionsForCreatureID",
  103. Type = "Function",
  104. Arguments =
  105. {
  106. { Name = "creatureID", Type = "number", Nilable = false },
  107. },
  108. Returns =
  109. {
  110. { Name = "contributionID", Type = "number", Nilable = false, StrideIndex = 1 },
  111. },
  112. },
  113. {
  114. Name = "GetName",
  115. Type = "Function",
  116. Arguments =
  117. {
  118. { Name = "contributionID", Type = "number", Nilable = false },
  119. },
  120. Returns =
  121. {
  122. { Name = "name", Type = "string", Nilable = false, Default = "" },
  123. },
  124. },
  125. {
  126. Name = "GetOrderIndex",
  127. Type = "Function",
  128. Arguments =
  129. {
  130. { Name = "contributionID", Type = "number", Nilable = false },
  131. },
  132. Returns =
  133. {
  134. { Name = "orderIndex", Type = "number", Nilable = false },
  135. },
  136. },
  137. {
  138. Name = "GetRequiredContributionCurrency",
  139. Type = "Function",
  140. Arguments =
  141. {
  142. { Name = "contributionID", Type = "number", Nilable = false },
  143. },
  144. Returns =
  145. {
  146. { Name = "currencyID", Type = "number", Nilable = false, Default = 0 },
  147. { Name = "currencyAmount", Type = "number", Nilable = false, Default = 0 },
  148. },
  149. },
  150. {
  151. Name = "GetRequiredContributionItem",
  152. Type = "Function",
  153. Arguments =
  154. {
  155. { Name = "contributionID", Type = "number", Nilable = false },
  156. },
  157. Returns =
  158. {
  159. { Name = "itemID", Type = "number", Nilable = false, Default = 0 },
  160. { Name = "itemCount", Type = "number", Nilable = false, Default = 0 },
  161. },
  162. },
  163. {
  164. Name = "GetRewardQuestID",
  165. Type = "Function",
  166. Arguments =
  167. {
  168. { Name = "contributionID", Type = "number", Nilable = false },
  169. },
  170. Returns =
  171. {
  172. { Name = "questID", Type = "number", Nilable = false },
  173. },
  174. },
  175. {
  176. Name = "GetState",
  177. Type = "Function",
  178. Arguments =
  179. {
  180. { Name = "contributionID", Type = "number", Nilable = false },
  181. },
  182. Returns =
  183. {
  184. { Name = "contributionState", Type = "ContributionState", Nilable = false, Default = "None" },
  185. { Name = "contributionPercentageComplete", Type = "number", Nilable = false },
  186. { Name = "timeOfNextStateChange", Type = "number", Nilable = true },
  187. { Name = "startTime", Type = "number", Nilable = false },
  188. },
  189. },
  190. {
  191. Name = "HasPendingContribution",
  192. Type = "Function",
  193. Arguments =
  194. {
  195. { Name = "contributionID", Type = "number", Nilable = false },
  196. },
  197. Returns =
  198. {
  199. { Name = "hasPending", Type = "bool", Nilable = false },
  200. },
  201. },
  202. {
  203. Name = "IsAwaitingRewardQuestData",
  204. Type = "Function",
  205. Arguments =
  206. {
  207. { Name = "contributionID", Type = "number", Nilable = false },
  208. },
  209. Returns =
  210. {
  211. { Name = "awaitingData", Type = "bool", Nilable = false },
  212. },
  213. },
  214. },
  215. Events =
  216. {
  217. {
  218. Name = "ContributionChanged",
  219. Type = "Event",
  220. LiteralName = "CONTRIBUTION_CHANGED",
  221. Payload =
  222. {
  223. { Name = "state", Type = "ContributionState", Nilable = false },
  224. { Name = "result", Type = "ContributionResult", Nilable = false },
  225. { Name = "name", Type = "string", Nilable = false },
  226. { Name = "contributionID", Type = "number", Nilable = false, StrideIndex = 1 },
  227. },
  228. },
  229. {
  230. Name = "ContributionCollectorClose",
  231. Type = "Event",
  232. LiteralName = "CONTRIBUTION_COLLECTOR_CLOSE",
  233. },
  234. {
  235. Name = "ContributionCollectorOpen",
  236. Type = "Event",
  237. LiteralName = "CONTRIBUTION_COLLECTOR_OPEN",
  238. },
  239. {
  240. Name = "ContributionCollectorPending",
  241. Type = "Event",
  242. LiteralName = "CONTRIBUTION_COLLECTOR_PENDING",
  243. Payload =
  244. {
  245. { Name = "contributionID", Type = "number", Nilable = false },
  246. { Name = "isPending", Type = "bool", Nilable = false },
  247. { Name = "result", Type = "number", Nilable = false },
  248. },
  249. },
  250. {
  251. Name = "ContributionCollectorUpdate",
  252. Type = "Event",
  253. LiteralName = "CONTRIBUTION_COLLECTOR_UPDATE",
  254. },
  255. {
  256. Name = "ContributionCollectorUpdateSingle",
  257. Type = "Event",
  258. LiteralName = "CONTRIBUTION_COLLECTOR_UPDATE_SINGLE",
  259. Payload =
  260. {
  261. { Name = "contributionID", Type = "number", Nilable = false },
  262. },
  263. },
  264. },
  265. Tables =
  266. {
  267. {
  268. Name = "ContributionAppearanceFlags",
  269. Type = "Enumeration",
  270. NumValues = 1,
  271. MinValue = 0,
  272. MaxValue = 0,
  273. Fields =
  274. {
  275. { Name = "TooltipUseTimeRemaining", Type = "ContributionAppearanceFlags", EnumValue = 0 },
  276. },
  277. },
  278. {
  279. Name = "ContributionResult",
  280. Type = "Enumeration",
  281. NumValues = 8,
  282. MinValue = 0,
  283. MaxValue = 7,
  284. Fields =
  285. {
  286. { Name = "Success", Type = "ContributionResult", EnumValue = 0 },
  287. { Name = "MustBeNearNpc", Type = "ContributionResult", EnumValue = 1 },
  288. { Name = "IncorrectState", Type = "ContributionResult", EnumValue = 2 },
  289. { Name = "InvalidID", Type = "ContributionResult", EnumValue = 3 },
  290. { Name = "QuestDataMissing", Type = "ContributionResult", EnumValue = 4 },
  291. { Name = "FailedConditionCheck", Type = "ContributionResult", EnumValue = 5 },
  292. { Name = "UnableToCompleteTurnIn", Type = "ContributionResult", EnumValue = 6 },
  293. { Name = "InternalError", Type = "ContributionResult", EnumValue = 7 },
  294. },
  295. },
  296. {
  297. Name = "ContributionAppearance",
  298. Type = "Structure",
  299. Fields =
  300. {
  301. { Name = "stateName", Type = "string", Nilable = false },
  302. { Name = "stateColor", Type = "table", Mixin = "ColorMixin", Nilable = false },
  303. { Name = "tooltipLine", Type = "string", Nilable = false },
  304. { Name = "tooltipUseTimeRemaining", Type = "bool", Nilable = false },
  305. { Name = "statusBarAtlas", Type = "string", Nilable = false },
  306. { Name = "borderAtlas", Type = "string", Nilable = false },
  307. { Name = "bannerAtlas", Type = "string", Nilable = false },
  308. },
  309. },
  310. {
  311. Name = "ContributionMapInfo",
  312. Type = "Structure",
  313. Fields =
  314. {
  315. { Name = "areaPoiID", Type = "number", Nilable = false },
  316. { Name = "position", Type = "table", Mixin = "Vector2DMixin", Nilable = false },
  317. { Name = "name", Type = "string", Nilable = false },
  318. { Name = "atlasName", Type = "string", Nilable = false },
  319. { Name = "collectorCreatureID", Type = "number", Nilable = false },
  320. },
  321. },
  322. },
  323. };
  324. APIDocumentation:AddDocumentationTable(ContributionCollector);