Blizzard_APIDocumentation/PartyInfoDocumentation.lua

Blizzard_APIDocumentation/PartyInfoDocumentation.lua (9.0.1.36272; unchanged since 9.0.1.36230)
  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 = "DoCountdown",
  83. Type = "Function",
  84. Arguments =
  85. {
  86. { Name = "seconds", Type = "number", Nilable = false },
  87. },
  88. },
  89. {
  90. Name = "GetActiveCategories",
  91. Type = "Function",
  92. Returns =
  93. {
  94. { Name = "categories", Type = "table", InnerType = "number", Nilable = false },
  95. },
  96. },
  97. {
  98. Name = "GetInviteConfirmationInvalidQueues",
  99. Type = "Function",
  100. Arguments =
  101. {
  102. { Name = "inviteGUID", Type = "string", Nilable = false },
  103. },
  104. Returns =
  105. {
  106. { Name = "invalidQueues", Type = "table", InnerType = "QueueSpecificInfo", Nilable = false },
  107. },
  108. },
  109. {
  110. Name = "GetInviteReferralInfo",
  111. Type = "Function",
  112. Arguments =
  113. {
  114. { Name = "inviteGUID", Type = "string", Nilable = false },
  115. },
  116. Returns =
  117. {
  118. { Name = "outReferredByGuid", Type = "string", Nilable = false },
  119. { Name = "outReferredByName", Type = "string", Nilable = false },
  120. { Name = "outRelationType", Type = "PartyRequestJoinRelation", Nilable = false },
  121. { Name = "outIsQuickJoin", Type = "bool", Nilable = false },
  122. { Name = "outClubId", Type = "string", Nilable = false },
  123. },
  124. },
  125. {
  126. Name = "GetMinLevel",
  127. Type = "Function",
  128. Arguments =
  129. {
  130. { Name = "category", Type = "number", Nilable = true, Documentation = { "If not provided, the active party is used" } },
  131. },
  132. Returns =
  133. {
  134. { Name = "minLevel", Type = "number", Nilable = false },
  135. },
  136. },
  137. {
  138. Name = "InviteUnit",
  139. Type = "Function",
  140. 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)." },
  141. Arguments =
  142. {
  143. { Name = "targetName", Type = "string", Nilable = false },
  144. },
  145. },
  146. {
  147. Name = "IsPartyFull",
  148. Type = "Function",
  149. Arguments =
  150. {
  151. { Name = "category", Type = "number", Nilable = true, Documentation = { "If not provided, the active party is used" } },
  152. },
  153. Returns =
  154. {
  155. { Name = "isFull", Type = "bool", Nilable = false },
  156. },
  157. },
  158. {
  159. Name = "LeaveParty",
  160. Type = "Function",
  161. 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" },
  162. Arguments =
  163. {
  164. { Name = "category", Type = "number", Nilable = true },
  165. },
  166. },
  167. {
  168. Name = "RequestInviteFromUnit",
  169. Type = "Function",
  170. Documentation = { "Attempt to request an invite into the target party, requires confirmation in some cases (e.g. there is a party sync in progress)." },
  171. Arguments =
  172. {
  173. { Name = "targetName", Type = "string", Nilable = false },
  174. { Name = "tank", Type = "bool", Nilable = true },
  175. { Name = "healer", Type = "bool", Nilable = true },
  176. { Name = "dps", Type = "bool", Nilable = true },
  177. },
  178. },
  179. },
  180. Events =
  181. {
  182. {
  183. Name = "BnetRequestInviteConfirmation",
  184. Type = "Event",
  185. LiteralName = "BNET_REQUEST_INVITE_CONFIRMATION",
  186. Payload =
  187. {
  188. { Name = "gameAccountID", Type = "number", Nilable = false },
  189. { Name = "questSessionActive", Type = "bool", Nilable = false },
  190. { Name = "tank", Type = "bool", Nilable = false },
  191. { Name = "healer", Type = "bool", Nilable = false },
  192. { Name = "dps", Type = "bool", Nilable = false },
  193. },
  194. },
  195. {
  196. Name = "ConvertToRaidConfirmation",
  197. Type = "Event",
  198. LiteralName = "CONVERT_TO_RAID_CONFIRMATION",
  199. },
  200. {
  201. Name = "EnteredDifferentInstanceFromParty",
  202. Type = "Event",
  203. LiteralName = "ENTERED_DIFFERENT_INSTANCE_FROM_PARTY",
  204. },
  205. {
  206. Name = "GroupFormed",
  207. Type = "Event",
  208. LiteralName = "GROUP_FORMED",
  209. Payload =
  210. {
  211. { Name = "category", Type = "number", Nilable = false },
  212. { Name = "partyGUID", Type = "string", Nilable = false },
  213. },
  214. },
  215. {
  216. Name = "GroupInviteConfirmation",
  217. Type = "Event",
  218. LiteralName = "GROUP_INVITE_CONFIRMATION",
  219. },
  220. {
  221. Name = "GroupJoined",
  222. Type = "Event",
  223. LiteralName = "GROUP_JOINED",
  224. Payload =
  225. {
  226. { Name = "category", Type = "number", Nilable = false },
  227. { Name = "partyGUID", Type = "string", Nilable = false },
  228. },
  229. },
  230. {
  231. Name = "GroupLeft",
  232. Type = "Event",
  233. LiteralName = "GROUP_LEFT",
  234. Payload =
  235. {
  236. { Name = "category", Type = "number", Nilable = false },
  237. { Name = "partyGUID", Type = "string", Nilable = false },
  238. },
  239. },
  240. {
  241. Name = "GroupRosterUpdate",
  242. Type = "Event",
  243. LiteralName = "GROUP_ROSTER_UPDATE",
  244. },
  245. {
  246. Name = "InstanceBootStart",
  247. Type = "Event",
  248. LiteralName = "INSTANCE_BOOT_START",
  249. },
  250. {
  251. Name = "InstanceBootStop",
  252. Type = "Event",
  253. LiteralName = "INSTANCE_BOOT_STOP",
  254. },
  255. {
  256. Name = "InstanceGroupSizeChanged",
  257. Type = "Event",
  258. LiteralName = "INSTANCE_GROUP_SIZE_CHANGED",
  259. },
  260. {
  261. Name = "InviteToPartyConfirmation",
  262. Type = "Event",
  263. LiteralName = "INVITE_TO_PARTY_CONFIRMATION",
  264. Payload =
  265. {
  266. { Name = "targetName", Type = "string", Nilable = false },
  267. { Name = "willConvertToRaid", Type = "bool", Nilable = false },
  268. { Name = "questSessionActive", Type = "bool", Nilable = false },
  269. },
  270. },
  271. {
  272. Name = "InviteTravelPassConfirmation",
  273. Type = "Event",
  274. LiteralName = "INVITE_TRAVEL_PASS_CONFIRMATION",
  275. Payload =
  276. {
  277. { Name = "targetName", Type = "string", Nilable = false },
  278. { Name = "targetGUID", Type = "string", Nilable = false },
  279. { Name = "willConvertToRaid", Type = "bool", Nilable = false },
  280. { Name = "questSessionActive", Type = "bool", Nilable = false },
  281. },
  282. },
  283. {
  284. Name = "LeavePartyConfirmation",
  285. Type = "Event",
  286. LiteralName = "LEAVE_PARTY_CONFIRMATION",
  287. },
  288. {
  289. Name = "PartyInviteCancel",
  290. Type = "Event",
  291. LiteralName = "PARTY_INVITE_CANCEL",
  292. },
  293. {
  294. Name = "PartyInviteRequest",
  295. Type = "Event",
  296. LiteralName = "PARTY_INVITE_REQUEST",
  297. Payload =
  298. {
  299. { Name = "name", Type = "string", Nilable = false },
  300. { Name = "isTank", Type = "bool", Nilable = false },
  301. { Name = "isHealer", Type = "bool", Nilable = false },
  302. { Name = "isDamage", Type = "bool", Nilable = false },
  303. { Name = "isNativeRealm", Type = "bool", Nilable = false },
  304. { Name = "allowMultipleRoles", Type = "bool", Nilable = false },
  305. { Name = "inviterGUID", Type = "string", Nilable = false },
  306. { Name = "questSessionActive", Type = "bool", Nilable = false },
  307. },
  308. },
  309. {
  310. Name = "PartyLeaderChanged",
  311. Type = "Event",
  312. LiteralName = "PARTY_LEADER_CHANGED",
  313. },
  314. {
  315. Name = "PartyLfgRestricted",
  316. Type = "Event",
  317. LiteralName = "PARTY_LFG_RESTRICTED",
  318. },
  319. {
  320. Name = "PartyLootMethodChanged",
  321. Type = "Event",
  322. LiteralName = "PARTY_LOOT_METHOD_CHANGED",
  323. },
  324. {
  325. Name = "PartyMemberDisable",
  326. Type = "Event",
  327. LiteralName = "PARTY_MEMBER_DISABLE",
  328. Payload =
  329. {
  330. { Name = "unitTarget", Type = "string", Nilable = false },
  331. },
  332. },
  333. {
  334. Name = "PartyMemberEnable",
  335. Type = "Event",
  336. LiteralName = "PARTY_MEMBER_ENABLE",
  337. Payload =
  338. {
  339. { Name = "unitTarget", Type = "string", Nilable = false },
  340. },
  341. },
  342. {
  343. Name = "PlayerDifficultyChanged",
  344. Type = "Event",
  345. LiteralName = "PLAYER_DIFFICULTY_CHANGED",
  346. },
  347. {
  348. Name = "PlayerRolesAssigned",
  349. Type = "Event",
  350. LiteralName = "PLAYER_ROLES_ASSIGNED",
  351. },
  352. {
  353. Name = "RaidRosterUpdate",
  354. Type = "Event",
  355. LiteralName = "RAID_ROSTER_UPDATE",
  356. },
  357. {
  358. Name = "ReadyCheck",
  359. Type = "Event",
  360. LiteralName = "READY_CHECK",
  361. Payload =
  362. {
  363. { Name = "initiatorName", Type = "string", Nilable = false },
  364. { Name = "readyCheckTimeLeft", Type = "number", Nilable = false },
  365. },
  366. },
  367. {
  368. Name = "ReadyCheckConfirm",
  369. Type = "Event",
  370. LiteralName = "READY_CHECK_CONFIRM",
  371. Payload =
  372. {
  373. { Name = "unitTarget", Type = "string", Nilable = false },
  374. { Name = "isReady", Type = "bool", Nilable = false },
  375. },
  376. },
  377. {
  378. Name = "ReadyCheckFinished",
  379. Type = "Event",
  380. LiteralName = "READY_CHECK_FINISHED",
  381. Payload =
  382. {
  383. { Name = "preempted", Type = "bool", Nilable = false },
  384. },
  385. },
  386. {
  387. Name = "RequestInviteConfirmation",
  388. Type = "Event",
  389. LiteralName = "REQUEST_INVITE_CONFIRMATION",
  390. Payload =
  391. {
  392. { Name = "targetName", Type = "string", Nilable = false },
  393. { Name = "partyLevelLink", Type = "number", Nilable = false },
  394. { Name = "questSessionActive", Type = "bool", Nilable = false },
  395. { Name = "tank", Type = "bool", Nilable = true },
  396. { Name = "healer", Type = "bool", Nilable = true },
  397. { Name = "dps", Type = "bool", Nilable = true },
  398. },
  399. },
  400. {
  401. Name = "RoleChangedInform",
  402. Type = "Event",
  403. LiteralName = "ROLE_CHANGED_INFORM",
  404. Payload =
  405. {
  406. { Name = "changedName", Type = "string", Nilable = false },
  407. { Name = "fromName", Type = "string", Nilable = false },
  408. { Name = "oldRole", Type = "string", Nilable = false },
  409. { Name = "newRole", Type = "string", Nilable = false },
  410. },
  411. },
  412. {
  413. Name = "RolePollBegin",
  414. Type = "Event",
  415. LiteralName = "ROLE_POLL_BEGIN",
  416. Payload =
  417. {
  418. { Name = "fromName", Type = "string", Nilable = false },
  419. },
  420. },
  421. {
  422. Name = "VoteKickReasonNeeded",
  423. Type = "Event",
  424. LiteralName = "VOTE_KICK_REASON_NEEDED",
  425. Payload =
  426. {
  427. { Name = "name", Type = "string", Nilable = false },
  428. { Name = "resultGUID", Type = "string", Nilable = false },
  429. },
  430. },
  431. },
  432. Tables =
  433. {
  434. {
  435. Name = "PartyRequestJoinRelation",
  436. Type = "Enumeration",
  437. NumValues = 5,
  438. MinValue = 0,
  439. MaxValue = 4,
  440. Fields =
  441. {
  442. { Name = "None", Type = "PartyRequestJoinRelation", EnumValue = 0 },
  443. { Name = "Friend", Type = "PartyRequestJoinRelation", EnumValue = 1 },
  444. { Name = "Guild", Type = "PartyRequestJoinRelation", EnumValue = 2 },
  445. { Name = "Club", Type = "PartyRequestJoinRelation", EnumValue = 3 },
  446. { Name = "NumPartyRequestJoinRelations", Type = "PartyRequestJoinRelation", EnumValue = 4 },
  447. },
  448. },
  449. },
  450. };
  451. APIDocumentation:AddDocumentationTable(PartyInfo);