Blizzard_APIDocumentation/TradeSkillUIDocumentation.lua

Blizzard_APIDocumentation/TradeSkillUIDocumentation.lua (9.0.2.37474; unchanged since 9.0.1.36230)
  1. local TradeSkillUI =
  2. {
  3. Name = "TradeSkillUI",
  4. Type = "System",
  5. Namespace = "C_TradeSkillUI",
  6. Functions =
  7. {
  8. {
  9. Name = "CraftRecipe",
  10. Type = "Function",
  11. Arguments =
  12. {
  13. { Name = "recipeSpellID", Type = "number", Nilable = false },
  14. { Name = "numCasts", Type = "number", Nilable = false, Default = 1 },
  15. { Name = "optionalReagents", Type = "table", InnerType = "OptionalReagentInfo", Nilable = true },
  16. { Name = "recipeLevel", Type = "number", Nilable = true },
  17. },
  18. },
  19. {
  20. Name = "GetAllProfessionTradeSkillLines",
  21. Type = "Function",
  22. Returns =
  23. {
  24. { Name = "skillLineID", Type = "table", InnerType = "number", Nilable = false },
  25. },
  26. },
  27. {
  28. Name = "GetOptionalReagentBonusText",
  29. Type = "Function",
  30. Arguments =
  31. {
  32. { Name = "recipeSpellID", Type = "number", Nilable = false },
  33. { Name = "optionalReagentIndex", Type = "number", Nilable = false },
  34. { Name = "optionalReagents", Type = "table", InnerType = "OptionalReagentInfo", Nilable = false },
  35. },
  36. Returns =
  37. {
  38. { Name = "bonusText", Type = "string", Nilable = false },
  39. },
  40. },
  41. {
  42. Name = "GetOptionalReagentInfo",
  43. Type = "Function",
  44. Arguments =
  45. {
  46. { Name = "recipeSpellID", Type = "number", Nilable = false },
  47. },
  48. Returns =
  49. {
  50. { Name = "slots", Type = "table", InnerType = "OptionalReagentSlot", Nilable = false },
  51. },
  52. },
  53. {
  54. Name = "GetRecipeInfo",
  55. Type = "Function",
  56. Arguments =
  57. {
  58. { Name = "recipeSpellID", Type = "number", Nilable = false },
  59. { Name = "recipeLevel", Type = "number", Nilable = true },
  60. },
  61. Returns =
  62. {
  63. { Name = "recipeInfo", Type = "TradeSkillRecipeInfo", Nilable = true },
  64. },
  65. },
  66. {
  67. Name = "GetRecipeNumReagents",
  68. Type = "Function",
  69. Arguments =
  70. {
  71. { Name = "recipeSpellID", Type = "number", Nilable = false },
  72. { Name = "recipeLevel", Type = "number", Nilable = true },
  73. },
  74. Returns =
  75. {
  76. { Name = "numReagents", Type = "number", Nilable = false },
  77. },
  78. },
  79. {
  80. Name = "GetRecipeReagentInfo",
  81. Type = "Function",
  82. Arguments =
  83. {
  84. { Name = "recipeSpellID", Type = "number", Nilable = false },
  85. { Name = "reagentIndex", Type = "number", Nilable = false },
  86. { Name = "recipeLevel", Type = "number", Nilable = true },
  87. },
  88. Returns =
  89. {
  90. { Name = "reagentName", Type = "string", Nilable = true },
  91. { Name = "reagentFileID", Type = "number", Nilable = true },
  92. { Name = "reagentCount", Type = "number", Nilable = false },
  93. { Name = "playerReagentCount", Type = "number", Nilable = false },
  94. },
  95. },
  96. {
  97. Name = "GetRecipeRepeatCount",
  98. Type = "Function",
  99. Returns =
  100. {
  101. { Name = "recastTimes", Type = "number", Nilable = false },
  102. },
  103. },
  104. {
  105. Name = "GetTradeSkillDisplayName",
  106. Type = "Function",
  107. Arguments =
  108. {
  109. { Name = "skillLineID", Type = "number", Nilable = false },
  110. },
  111. Returns =
  112. {
  113. { Name = "professionDisplayName", Type = "string", Nilable = false },
  114. },
  115. },
  116. {
  117. Name = "GetTradeSkillLine",
  118. Type = "Function",
  119. Returns =
  120. {
  121. { Name = "skillLineID", Type = "number", Nilable = false },
  122. { Name = "skillLineDisplayName", Type = "string", Nilable = false },
  123. { Name = "skillLineRank", Type = "number", Nilable = false },
  124. { Name = "skillLineMaxRank", Type = "number", Nilable = false },
  125. { Name = "skillLineModifier", Type = "number", Nilable = false },
  126. { Name = "parentSkillLineID", Type = "number", Nilable = true },
  127. { Name = "parentSkillLineDisplayName", Type = "string", Nilable = true },
  128. },
  129. },
  130. {
  131. Name = "GetTradeSkillLineInfoByID",
  132. Type = "Function",
  133. Arguments =
  134. {
  135. { Name = "skillLineID", Type = "number", Nilable = false },
  136. },
  137. Returns =
  138. {
  139. { Name = "skillLineDisplayName", Type = "string", Nilable = false },
  140. { Name = "skillLineRank", Type = "number", Nilable = false },
  141. { Name = "skillLineMaxRank", Type = "number", Nilable = false },
  142. { Name = "skillLineModifier", Type = "number", Nilable = false },
  143. { Name = "parentSkillLineID", Type = "number", Nilable = true },
  144. },
  145. },
  146. {
  147. Name = "IsEmptySkillLineCategory",
  148. Type = "Function",
  149. Arguments =
  150. {
  151. { Name = "categoryID", Type = "number", Nilable = false },
  152. },
  153. Returns =
  154. {
  155. { Name = "effectivelyKnown", Type = "bool", Nilable = false },
  156. },
  157. },
  158. {
  159. Name = "SetRecipeRepeatCount",
  160. Type = "Function",
  161. Arguments =
  162. {
  163. { Name = "recipeSpellID", Type = "number", Nilable = false },
  164. { Name = "numCasts", Type = "number", Nilable = false, Default = 1 },
  165. { Name = "optionalReagents", Type = "table", InnerType = "OptionalReagentInfo", Nilable = true },
  166. },
  167. },
  168. },
  169. Events =
  170. {
  171. {
  172. Name = "NewRecipeLearned",
  173. Type = "Event",
  174. LiteralName = "NEW_RECIPE_LEARNED",
  175. Payload =
  176. {
  177. { Name = "recipeID", Type = "number", Nilable = false },
  178. { Name = "recipeLevel", Type = "number", Nilable = true },
  179. { Name = "baseRecipeID", Type = "number", Nilable = true },
  180. },
  181. },
  182. {
  183. Name = "ObliterumForgeClose",
  184. Type = "Event",
  185. LiteralName = "OBLITERUM_FORGE_CLOSE",
  186. },
  187. {
  188. Name = "ObliterumForgePendingItemChanged",
  189. Type = "Event",
  190. LiteralName = "OBLITERUM_FORGE_PENDING_ITEM_CHANGED",
  191. },
  192. {
  193. Name = "ObliterumForgeShow",
  194. Type = "Event",
  195. LiteralName = "OBLITERUM_FORGE_SHOW",
  196. },
  197. {
  198. Name = "TradeSkillClose",
  199. Type = "Event",
  200. LiteralName = "TRADE_SKILL_CLOSE",
  201. },
  202. {
  203. Name = "TradeSkillDataSourceChanged",
  204. Type = "Event",
  205. LiteralName = "TRADE_SKILL_DATA_SOURCE_CHANGED",
  206. },
  207. {
  208. Name = "TradeSkillDataSourceChanging",
  209. Type = "Event",
  210. LiteralName = "TRADE_SKILL_DATA_SOURCE_CHANGING",
  211. },
  212. {
  213. Name = "TradeSkillDetailsUpdate",
  214. Type = "Event",
  215. LiteralName = "TRADE_SKILL_DETAILS_UPDATE",
  216. },
  217. {
  218. Name = "TradeSkillListUpdate",
  219. Type = "Event",
  220. LiteralName = "TRADE_SKILL_LIST_UPDATE",
  221. },
  222. {
  223. Name = "TradeSkillNameUpdate",
  224. Type = "Event",
  225. LiteralName = "TRADE_SKILL_NAME_UPDATE",
  226. },
  227. {
  228. Name = "TradeSkillOptionalReagentBonusTextUpdated",
  229. Type = "Event",
  230. LiteralName = "TRADE_SKILL_OPTIONAL_REAGENT_BONUS_TEXT_UPDATED",
  231. Payload =
  232. {
  233. { Name = "itemID", Type = "number", Nilable = false },
  234. },
  235. },
  236. {
  237. Name = "TradeSkillShow",
  238. Type = "Event",
  239. LiteralName = "TRADE_SKILL_SHOW",
  240. },
  241. {
  242. Name = "UpdateTradeskillRecast",
  243. Type = "Event",
  244. LiteralName = "UPDATE_TRADESKILL_RECAST",
  245. },
  246. },
  247. Tables =
  248. {
  249. {
  250. Name = "OptionalReagentItemFlag",
  251. Type = "Enumeration",
  252. NumValues = 1,
  253. MinValue = 0,
  254. MaxValue = 0,
  255. Fields =
  256. {
  257. { Name = "TooltipShowsAsStatModifications", Type = "OptionalReagentItemFlag", EnumValue = 0 },
  258. },
  259. },
  260. {
  261. Name = "OptionalReagentSlot",
  262. Type = "Structure",
  263. Fields =
  264. {
  265. { Name = "requiredSkillRank", Type = "number", Nilable = false },
  266. { Name = "slotText", Type = "string", Nilable = true },
  267. { Name = "options", Type = "table", InnerType = "number", Nilable = false },
  268. },
  269. },
  270. },
  271. };
  272. APIDocumentation:AddDocumentationTable(TradeSkillUI);