Blizzard_APIDocumentation/EquipmentManagerDocumentation.lua

Blizzard_APIDocumentation/EquipmentManagerDocumentation.lua (9.1.5.40906; unchanged since 8.0.1.27101)
  1. local EquipmentManager =
  2. {
  3. Name = "EquipmentSet",
  4. Type = "System",
  5. Namespace = "C_EquipmentSet",
  6. Functions =
  7. {
  8. {
  9. Name = "AssignSpecToEquipmentSet",
  10. Type = "Function",
  11. Arguments =
  12. {
  13. { Name = "equipmentSetID", Type = "number", Nilable = false },
  14. { Name = "specIndex", Type = "number", Nilable = false },
  15. },
  16. },
  17. {
  18. Name = "CanUseEquipmentSets",
  19. Type = "Function",
  20. Returns =
  21. {
  22. { Name = "canUseEquipmentSets", Type = "bool", Nilable = false },
  23. },
  24. },
  25. {
  26. Name = "ClearIgnoredSlotsForSave",
  27. Type = "Function",
  28. },
  29. {
  30. Name = "CreateEquipmentSet",
  31. Type = "Function",
  32. Arguments =
  33. {
  34. { Name = "equipmentSetName", Type = "string", Nilable = false },
  35. { Name = "icon", Type = "string", Nilable = true },
  36. },
  37. },
  38. {
  39. Name = "DeleteEquipmentSet",
  40. Type = "Function",
  41. Arguments =
  42. {
  43. { Name = "equipmentSetID", Type = "number", Nilable = false },
  44. },
  45. },
  46. {
  47. Name = "EquipmentSetContainsLockedItems",
  48. Type = "Function",
  49. Arguments =
  50. {
  51. { Name = "equipmentSetID", Type = "number", Nilable = false },
  52. },
  53. Returns =
  54. {
  55. { Name = "hasLockedItems", Type = "bool", Nilable = false },
  56. },
  57. },
  58. {
  59. Name = "GetEquipmentSetAssignedSpec",
  60. Type = "Function",
  61. Arguments =
  62. {
  63. { Name = "equipmentSetID", Type = "number", Nilable = false },
  64. },
  65. Returns =
  66. {
  67. { Name = "specIndex", Type = "number", Nilable = false },
  68. },
  69. },
  70. {
  71. Name = "GetEquipmentSetForSpec",
  72. Type = "Function",
  73. Arguments =
  74. {
  75. { Name = "specIndex", Type = "number", Nilable = false },
  76. },
  77. Returns =
  78. {
  79. { Name = "equipmentSetID", Type = "number", Nilable = false },
  80. },
  81. },
  82. {
  83. Name = "GetEquipmentSetID",
  84. Type = "Function",
  85. Arguments =
  86. {
  87. { Name = "equipmentSetName", Type = "string", Nilable = false },
  88. },
  89. Returns =
  90. {
  91. { Name = "equipmentSetID", Type = "number", Nilable = false },
  92. },
  93. },
  94. {
  95. Name = "GetEquipmentSetIDs",
  96. Type = "Function",
  97. Returns =
  98. {
  99. { Name = "equipmentSetIDs", Type = "table", InnerType = "number", Nilable = false },
  100. },
  101. },
  102. {
  103. Name = "GetEquipmentSetInfo",
  104. Type = "Function",
  105. Arguments =
  106. {
  107. { Name = "equipmentSetID", Type = "number", Nilable = false },
  108. },
  109. Returns =
  110. {
  111. { Name = "name", Type = "string", Nilable = false },
  112. { Name = "iconFileID", Type = "number", Nilable = false },
  113. { Name = "setID", Type = "number", Nilable = false },
  114. { Name = "isEquipped", Type = "bool", Nilable = false },
  115. { Name = "numItems", Type = "number", Nilable = false },
  116. { Name = "numEquipped", Type = "number", Nilable = false },
  117. { Name = "numInInventory", Type = "number", Nilable = false },
  118. { Name = "numLost", Type = "number", Nilable = false },
  119. { Name = "numIgnored", Type = "number", Nilable = false },
  120. },
  121. },
  122. {
  123. Name = "GetIgnoredSlots",
  124. Type = "Function",
  125. Arguments =
  126. {
  127. { Name = "equipmentSetID", Type = "number", Nilable = false },
  128. },
  129. Returns =
  130. {
  131. { Name = "slotIgnored", Type = "table", InnerType = "bool", Nilable = false },
  132. },
  133. },
  134. {
  135. Name = "GetItemIDs",
  136. Type = "Function",
  137. Arguments =
  138. {
  139. { Name = "equipmentSetID", Type = "number", Nilable = false },
  140. },
  141. Returns =
  142. {
  143. { Name = "itemIDs", Type = "table", InnerType = "number", Nilable = false },
  144. },
  145. },
  146. {
  147. Name = "GetItemLocations",
  148. Type = "Function",
  149. Arguments =
  150. {
  151. { Name = "equipmentSetID", Type = "number", Nilable = false },
  152. },
  153. Returns =
  154. {
  155. { Name = "locations", Type = "table", InnerType = "number", Nilable = false },
  156. },
  157. },
  158. {
  159. Name = "GetNumEquipmentSets",
  160. Type = "Function",
  161. Returns =
  162. {
  163. { Name = "numEquipmentSets", Type = "number", Nilable = false },
  164. },
  165. },
  166. {
  167. Name = "IgnoreSlotForSave",
  168. Type = "Function",
  169. Arguments =
  170. {
  171. { Name = "slot", Type = "number", Nilable = false },
  172. },
  173. },
  174. {
  175. Name = "IsSlotIgnoredForSave",
  176. Type = "Function",
  177. Arguments =
  178. {
  179. { Name = "slot", Type = "number", Nilable = false },
  180. },
  181. Returns =
  182. {
  183. { Name = "isSlotIgnored", Type = "bool", Nilable = false },
  184. },
  185. },
  186. {
  187. Name = "ModifyEquipmentSet",
  188. Type = "Function",
  189. Arguments =
  190. {
  191. { Name = "equipmentSetID", Type = "number", Nilable = false },
  192. { Name = "newName", Type = "string", Nilable = false },
  193. { Name = "newIcon", Type = "string", Nilable = true },
  194. },
  195. },
  196. {
  197. Name = "PickupEquipmentSet",
  198. Type = "Function",
  199. Arguments =
  200. {
  201. { Name = "equipmentSetID", Type = "number", Nilable = false },
  202. },
  203. },
  204. {
  205. Name = "SaveEquipmentSet",
  206. Type = "Function",
  207. Arguments =
  208. {
  209. { Name = "equipmentSetID", Type = "number", Nilable = false },
  210. { Name = "icon", Type = "string", Nilable = true },
  211. },
  212. },
  213. {
  214. Name = "UnassignEquipmentSetSpec",
  215. Type = "Function",
  216. Arguments =
  217. {
  218. { Name = "equipmentSetID", Type = "number", Nilable = false },
  219. },
  220. },
  221. {
  222. Name = "UnignoreSlotForSave",
  223. Type = "Function",
  224. Arguments =
  225. {
  226. { Name = "slot", Type = "number", Nilable = false },
  227. },
  228. },
  229. {
  230. Name = "UseEquipmentSet",
  231. Type = "Function",
  232. Arguments =
  233. {
  234. { Name = "equipmentSetID", Type = "number", Nilable = false },
  235. },
  236. Returns =
  237. {
  238. { Name = "setWasEquipped", Type = "bool", Nilable = false },
  239. },
  240. },
  241. },
  242. Events =
  243. {
  244. {
  245. Name = "EquipmentSetsChanged",
  246. Type = "Event",
  247. LiteralName = "EQUIPMENT_SETS_CHANGED",
  248. },
  249. {
  250. Name = "EquipmentSwapFinished",
  251. Type = "Event",
  252. LiteralName = "EQUIPMENT_SWAP_FINISHED",
  253. Payload =
  254. {
  255. { Name = "result", Type = "bool", Nilable = false },
  256. { Name = "setID", Type = "number", Nilable = true },
  257. },
  258. },
  259. {
  260. Name = "EquipmentSwapPending",
  261. Type = "Event",
  262. LiteralName = "EQUIPMENT_SWAP_PENDING",
  263. },
  264. {
  265. Name = "TransmogOutfitsChanged",
  266. Type = "Event",
  267. LiteralName = "TRANSMOG_OUTFITS_CHANGED",
  268. },
  269. {
  270. Name = "WearEquipmentSet",
  271. Type = "Event",
  272. LiteralName = "WEAR_EQUIPMENT_SET",
  273. Payload =
  274. {
  275. { Name = "setID", Type = "number", Nilable = false },
  276. },
  277. },
  278. },
  279. Tables =
  280. {
  281. },
  282. };
  283. APIDocumentation:AddDocumentationTable(EquipmentManager);