Blizzard_APIDocumentation/PartyInfoDocumentation.lua

Blizzard_APIDocumentation/PartyInfoDocumentation.lua (8.3.0.34963; unchanged since 8.3.0.33062)
  1. local PartyInfo =
  2. {
  3. Name = "PartyInfo",
  4. Type = "System",
  5. Namespace = "C_PartyInfo",
  6. Functions =
  7. {
  8. {
  9. Name = "AllowedToDoPartyConversion",
  10. Type = "Function",
  11. Arguments =
  12. {
  13. { Name = "toRaid", Type = "bool", Nilable = false },
  14. },
  15. Returns =
  16. {
  17. { Name = "allowed", Type = "bool", Nilable = false },
  18. },
  19. },
  20. {
  21. Name = "CanInvite",
  22. Type = "Function",
  23. Returns =
  24. {
  25. { Name = "allowedToInvite", Type = "bool", Nilable = false },
  26. },
  27. },
  28. {
  29. Name = "ConfirmConvertToRaid",
  30. Type = "Function",
  31. Documentation = { "Immediately convert to raid with no regard for potentially destructive actions." },
  32. },
  33. {
  34. Name = "ConfirmInviteTravelPass",
  35. Type = "Function",
  36. Arguments =
  37. {
  38. { Name = "targetName", Type = "string", Nilable = false },
  39. { Name = "targetGUID", Type = "string", Nilable = false },
  40. },
  41. },
  42. {
  43. Name = "ConfirmInviteUnit",
  44. Type = "Function",
  45. Documentation = { "Immediately invites the named unit to a party, with no regard for potentially destructive actions." },
  46. Arguments =
  47. {
  48. { Name = "targetName", Type = "string", Nilable = false },
  49. },
  50. },
  51. {
  52. Name = "ConfirmLeaveParty",
  53. Type = "Function",
  54. Documentation = { "Immediately leave the party with no regard for potentially destructive actions" },
  55. Arguments =
  56. {
  57. { Name = "category", Type = "number", Nilable = true },
  58. },
  59. },
  60. {
  61. Name = "ConfirmRequestInviteFromUnit",
  62. Type = "Function",
  63. Documentation = { "Immediately request an invite into the target party, this is the confirmation function to call after RequestInviteFromUnit, or if you would like to skip the confirmation process." },
  64. Arguments =
  65. {
  66. { Name = "targetName", Type = "string", Nilable = false },
  67. { Name = "tank", Type = "bool", Nilable = true },
  68. { Name = "healer", Type = "bool", Nilable = true },
  69. { Name = "dps", Type = "bool", Nilable = true },
  70. },
  71. },
  72. {
  73. Name = "ConvertToParty",
  74. Type = "Function",
  75. },
  76. {
  77. Name = "ConvertToRaid",
  78. Type = "Function",
  79. Documentation = { "Usually this will convert to raid immediately. In some cases (e.g. PartySync) the user will be prompted to confirm converting to raid, because it's potentially destructive." },
  80. },
  81. {
  82. Name = "GetActiveCategories",
  83. Type = "Function",
  84. Returns =
  85. {
  86. { Name = "categories", Type = "table", InnerType = "number", Nilable = false },
  87. },
  88. },
  89. {
  90. Name = "GetInviteConfirmationInvalidQueues",
  91. Type = "Function",
  92. Arguments =
  93. {
  94. { Name = "inviteGUID", Type = "string", Nilable = false },
  95. },
  96. Returns =
  97. {
  98. { Name = "invalidQueues", Type = "table", InnerType = "QueueSpecificInfo", Nilable = false },
  99. },
  100. },
  101. {
  102. Name = "GetInviteReferralInfo",
  103. Type = "Function",
  104. Arguments =
  105. {
  106. { Name = "inviteGUID", Type = "string", Nilable = false },
  107. },
  108. Returns =
  109. {
  110. { Name = "outReferredByGuid", Type = "string", Nilable = false },
  111. { Name = "outReferredByName", Type = "string", Nilable = false },
  112. { Name = "outRelationType", Type = "PartyRequestJoinRelation", Nilable = false },
  113. { Name = "outIsQuickJoin", Type = "bool", Nilable = false },
  114. { Name = "outClubId", Type = "string", Nilable = false },
  115. },
  116. },
  117. {
  118. Name = "GetMinLevel",
  119. Type = "Function",
  120. Arguments =
  121. {
  122. { Name = "category", Type = "number", Nilable = true, Documentation = { "If not provided, the active party is used" } },
  123. },
  124. Returns =
  125. {
  126. { Name = "minLevel", Type = "number", Nilable = false },
  127. },
  128. },
  129. {
  130. Name = "InviteUnit",
  131. Type = "Function",
  132. Documentation = { "Attempt to invite the named unit to a party, requires confirmation in some cases (e.g. the party will convert to a raid, or if there is a party sync in progress)." },
  133. Arguments =
  134. {
  135. { Name = "targetName", Type = "string", Nilable = false },
  136. },
  137. },
  138. {
  139. Name = "IsPartyFull",
  140. Type = "Function",
  141. Arguments =
  142. {
  143. { Name = "category", Type = "number", Nilable = true, Documentation = { "If not provided, the active party is used" } },
  144. },
  145. Returns =
  146. {
  147. { Name = "isFull", Type = "bool", Nilable = false },
  148. },
  149. },
  150. {
  151. Name = "LeaveParty",
  152. Type = "Function",
  153. Documentation = { "Usually this will leave the party immediately. In some cases (e.g. PartySync) the user will be prompted to confirm leaving the party, because it's potentially destructive" },
  154. Arguments =
  155. {
  156. { Name = "category", Type = "number", Nilable = true },
  157. },
  158. },
  159. {
  160. Name = "RequestInviteFromUnit",
  161. Type = "Function",
  162. Documentation = { "Attempt to request an invite into the target party, requires confirmation in some cases (e.g. there is a party sync in progress)." },
  163. Arguments =
  164. {
  165. { Name = "targetName", Type = "string", Nilable = false },
  166. { Name = "tank", Type = "bool", Nilable = true },
  167. { Name = "healer", Type = "bool", Nilable = true },
  168. { Name = "dps", Type = "bool", Nilable = true },
  169. },
  170. },
  171. },
  172. Events =
  173. {
  174. {
  175. Name = "BnetRequestInviteConfirmation",
  176. Type = "Event",
  177. LiteralName = "BNET_REQUEST_INVITE_CONFIRMATION",
  178. Payload =
  179. {
  180. { Name = "gameAccountID", Type = "number", Nilable = false },
  181. { Name = "questSessionActive", Type = "bool", Nilable = false },
  182. { Name = "tank", Type = "bool", Nilable = false },
  183. { Name = "healer", Type = "bool", Nilable = false },
  184. { Name = "dps", Type = "bool", Nilable = false },
  185. },
  186. },
  187. {
  188. Name = "ConvertToRaidConfirmation",
  189. Type = "Event",
  190. LiteralName = "CONVERT_TO_RAID_CONFIRMATION",
  191. },
  192. {
  193. Name = "EnteredDifferentInstanceFromParty",
  194. Type = "Event",
  195. LiteralName = "ENTERED_DIFFERENT_INSTANCE_FROM_PARTY",
  196. },
  197. {
  198. Name = "GroupFormed",
  199. Type = "Event",
  200. LiteralName = "GROUP_FORMED",
  201. Payload =
  202. {
  203. { Name = "category", Type = "number", Nilable = false },
  204. { Name = "partyGUID", Type = "string", Nilable = false },
  205. },
  206. },
  207. {
  208. Name = "GroupInviteConfirmation",
  209. Type = "Event",
  210. LiteralName = "GROUP_INVITE_CONFIRMATION",
  211. },
  212. {
  213. Name = "GroupJoined",
  214. Type = "Event",
  215. LiteralName = "GROUP_JOINED",
  216. Payload =
  217. {
  218. { Name = "category", Type = "number", Nilable = false },
  219. { Name = "partyGUID", Type = "string", Nilable = false },
  220. },
  221. },
  222. {
  223. Name = "GroupLeft",
  224. Type = "Event",
  225. LiteralName = "GROUP_LEFT",
  226. Payload =
  227. {
  228. { Name = "category", Type = "number", Nilable = false },
  229. { Name = "partyGUID", Type = "string", Nilable = false },
  230. },
  231. },
  232. {
  233. Name = "GroupRosterUpdate",
  234. Type = "Event",
  235. LiteralName = "GROUP_ROSTER_UPDATE",
  236. },
  237. {
  238. Name = "InstanceBootStart",
  239. Type = "Event",
  240. LiteralName = "INSTANCE_BOOT_START",
  241. },
  242. {
  243. Name = "InstanceBootStop",
  244. Type = "Event",
  245. LiteralName = "INSTANCE_BOOT_STOP",
  246. },
  247. {
  248. Name = "InstanceGroupSizeChanged",
  249. Type = "Event",
  250. LiteralName = "INSTANCE_GROUP_SIZE_CHANGED",
  251. },
  252. {
  253. Name = "InviteToPartyConfirmation",
  254. Type = "Event",
  255. LiteralName = "INVITE_TO_PARTY_CONFIRMATION",
  256. Payload =
  257. {
  258. { Name = "targetName", Type = "string", Nilable = false },
  259. { Name = "willConvertToRaid", Type = "bool", Nilable = false },
  260. { Name = "questSessionActive", Type = "bool", Nilable = false },
  261. },
  262. },
  263. {
  264. Name = "InviteTravelPassConfirmation",
  265. Type = "Event",
  266. LiteralName = "INVITE_TRAVEL_PASS_CONFIRMATION",
  267. Payload =
  268. {
  269. { Name = "targetName", Type = "string", Nilable = false },
  270. { Name = "targetGUID", Type = "string", Nilable = false },
  271. { Name = "willConvertToRaid", Type = "bool", Nilable = false },
  272. { Name = "questSessionActive", Type = "bool", Nilable = false },
  273. },
  274. },
  275. {
  276. Name = "LeavePartyConfirmation",
  277. Type = "Event",
  278. LiteralName = "LEAVE_PARTY_CONFIRMATION",
  279. },
  280. {
  281. Name = "PartyInviteCancel",
  282. Type = "Event",
  283. LiteralName = "PARTY_INVITE_CANCEL",
  284. },
  285. {
  286. Name = "PartyInviteRequest",
  287. Type = "Event",
  288. LiteralName = "PARTY_INVITE_REQUEST",
  289. Payload =
  290. {
  291. { Name = "name", Type = "string", Nilable = false },
  292. { Name = "isTank", Type = "bool", Nilable = false },
  293. { Name = "isHealer", Type = "bool", Nilable = false },
  294. { Name = "isDamage", Type = "bool", Nilable = false },
  295. { Name = "isNativeRealm", Type = "bool", Nilable = false },
  296. { Name = "allowMultipleRoles", Type = "bool", Nilable = false },
  297. { Name = "inviterGUID", Type = "string", Nilable = false },
  298. { Name = "questSessionActive", Type = "bool", Nilable = false },
  299. },
  300. },
  301. {
  302. Name = "PartyLeaderChanged",
  303. Type = "Event",
  304. LiteralName = "PARTY_LEADER_CHANGED",
  305. },
  306. {
  307. Name = "PartyLfgRestricted",
  308. Type = "Event",
  309. LiteralName = "PARTY_LFG_RESTRICTED",
  310. },
  311. {
  312. Name = "PartyLootMethodChanged",
  313. Type = "Event",
  314. LiteralName = "PARTY_LOOT_METHOD_CHANGED",
  315. },
  316. {
  317. Name = "PartyMemberDisable",
  318. Type = "Event",
  319. LiteralName = "PARTY_MEMBER_DISABLE",
  320. Payload =
  321. {
  322. { Name = "unitTarget", Type = "string", Nilable = false },
  323. },
  324. },
  325. {
  326. Name = "PartyMemberEnable",
  327. Type = "Event",
  328. LiteralName = "PARTY_MEMBER_ENABLE",
  329. Payload =
  330. {
  331. { Name = "unitTarget", Type = "string", Nilable = false },
  332. },
  333. },
  334. {
  335. Name = "PlayerDifficultyChanged",
  336. Type = "Event",
  337. LiteralName = "PLAYER_DIFFICULTY_CHANGED",
  338. },
  339. {
  340. Name = "PlayerRolesAssigned",
  341. Type = "Event",
  342. LiteralName = "PLAYER_ROLES_ASSIGNED",
  343. },
  344. {
  345. Name = "RaidRosterUpdate",
  346. Type = "Event",
  347. LiteralName = "RAID_ROSTER_UPDATE",
  348. },
  349. {
  350. Name = "ReadyCheck",
  351. Type = "Event",
  352. LiteralName = "READY_CHECK",
  353. Payload =
  354. {
  355. { Name = "initiatorName", Type = "string", Nilable = false },
  356. { Name = "readyCheckTimeLeft", Type = "number", Nilable = false },
  357. },
  358. },
  359. {
  360. Name = "ReadyCheckConfirm",
  361. Type = "Event",
  362. LiteralName = "READY_CHECK_CONFIRM",
  363. Payload =
  364. {
  365. { Name = "unitTarget", Type = "string", Nilable = false },
  366. { Name = "isReady", Type = "bool", Nilable = false },
  367. },
  368. },
  369. {
  370. Name = "ReadyCheckFinished",
  371. Type = "Event",
  372. LiteralName = "READY_CHECK_FINISHED",
  373. Payload =
  374. {
  375. { Name = "preempted", Type = "bool", Nilable = false },
  376. },
  377. },
  378. {
  379. Name = "RequestInviteConfirmation",
  380. Type = "Event",
  381. LiteralName = "REQUEST_INVITE_CONFIRMATION",
  382. Payload =
  383. {
  384. { Name = "targetName", Type = "string", Nilable = false },
  385. { Name = "partyLevelLink", Type = "number", Nilable = false },
  386. { Name = "questSessionActive", Type = "bool", Nilable = false },
  387. { Name = "tank", Type = "bool", Nilable = true },
  388. { Name = "healer", Type = "bool", Nilable = true },
  389. { Name = "dps", Type = "bool", Nilable = true },
  390. },
  391. },
  392. {
  393. Name = "RoleChangedInform",
  394. Type = "Event",
  395. LiteralName = "ROLE_CHANGED_INFORM",
  396. Payload =
  397. {
  398. { Name = "changedName", Type = "string", Nilable = false },
  399. { Name = "fromName", Type = "string", Nilable = false },
  400. { Name = "oldRole", Type = "string", Nilable = false },
  401. { Name = "newRole", Type = "string", Nilable = false },
  402. },
  403. },
  404. {
  405. Name = "RolePollBegin",
  406. Type = "Event",
  407. LiteralName = "ROLE_POLL_BEGIN",
  408. Payload =
  409. {
  410. { Name = "fromName", Type = "string", Nilable = false },
  411. },
  412. },
  413. {
  414. Name = "VoteKickReasonNeeded",
  415. Type = "Event",
  416. LiteralName = "VOTE_KICK_REASON_NEEDED",
  417. Payload =
  418. {
  419. { Name = "name", Type = "string", Nilable = false },
  420. { Name = "resultGUID", Type = "string", Nilable = false },
  421. },
  422. },
  423. },
  424. Tables =
  425. {
  426. {
  427. Name = "PartyRequestJoinRelation",
  428. Type = "Enumeration",
  429. NumValues = 5,
  430. MinValue = 0,
  431. MaxValue = 4,
  432. Fields =
  433. {
  434. { Name = "None", Type = "PartyRequestJoinRelation", EnumValue = 0 },
  435. { Name = "Friend", Type = "PartyRequestJoinRelation", EnumValue = 1 },
  436. { Name = "Guild", Type = "PartyRequestJoinRelation", EnumValue = 2 },
  437. { Name = "Club", Type = "PartyRequestJoinRelation", EnumValue = 3 },
  438. { Name = "NumPartyRequestJoinRelations", Type = "PartyRequestJoinRelation", EnumValue = 4 },
  439. },
  440. },
  441. },
  442. };
  443. APIDocumentation:AddDocumentationTable(PartyInfo);