Blizzard_APIDocumentation/PartyInfoDocumentation.lua

Blizzard_APIDocumentation/PartyInfoDocumentation.lua (9.0.5.38556; unchanged since 9.0.2.36665)
  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 = "IsPartyInJailersTower",
  160. Type = "Function",
  161. Returns =
  162. {
  163. { Name = "isPartyInJailersTower", Type = "bool", Nilable = false },
  164. },
  165. },
  166. {
  167. Name = "LeaveParty",
  168. Type = "Function",
  169. 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" },
  170. Arguments =
  171. {
  172. { Name = "category", Type = "number", Nilable = true },
  173. },
  174. },
  175. {
  176. Name = "RequestInviteFromUnit",
  177. Type = "Function",
  178. Documentation = { "Attempt to request an invite into the target party, requires confirmation in some cases (e.g. there is a party sync in progress)." },
  179. Arguments =
  180. {
  181. { Name = "targetName", Type = "string", Nilable = false },
  182. { Name = "tank", Type = "bool", Nilable = true },
  183. { Name = "healer", Type = "bool", Nilable = true },
  184. { Name = "dps", Type = "bool", Nilable = true },
  185. },
  186. },
  187. },
  188. Events =
  189. {
  190. {
  191. Name = "BnetRequestInviteConfirmation",
  192. Type = "Event",
  193. LiteralName = "BNET_REQUEST_INVITE_CONFIRMATION",
  194. Payload =
  195. {
  196. { Name = "gameAccountID", Type = "number", Nilable = false },
  197. { Name = "questSessionActive", Type = "bool", Nilable = false },
  198. { Name = "tank", Type = "bool", Nilable = false },
  199. { Name = "healer", Type = "bool", Nilable = false },
  200. { Name = "dps", Type = "bool", Nilable = false },
  201. },
  202. },
  203. {
  204. Name = "ConvertToRaidConfirmation",
  205. Type = "Event",
  206. LiteralName = "CONVERT_TO_RAID_CONFIRMATION",
  207. },
  208. {
  209. Name = "EnteredDifferentInstanceFromParty",
  210. Type = "Event",
  211. LiteralName = "ENTERED_DIFFERENT_INSTANCE_FROM_PARTY",
  212. },
  213. {
  214. Name = "GroupFormed",
  215. Type = "Event",
  216. LiteralName = "GROUP_FORMED",
  217. Payload =
  218. {
  219. { Name = "category", Type = "number", Nilable = false },
  220. { Name = "partyGUID", Type = "string", Nilable = false },
  221. },
  222. },
  223. {
  224. Name = "GroupInviteConfirmation",
  225. Type = "Event",
  226. LiteralName = "GROUP_INVITE_CONFIRMATION",
  227. },
  228. {
  229. Name = "GroupJoined",
  230. Type = "Event",
  231. LiteralName = "GROUP_JOINED",
  232. Payload =
  233. {
  234. { Name = "category", Type = "number", Nilable = false },
  235. { Name = "partyGUID", Type = "string", Nilable = false },
  236. },
  237. },
  238. {
  239. Name = "GroupLeft",
  240. Type = "Event",
  241. LiteralName = "GROUP_LEFT",
  242. Payload =
  243. {
  244. { Name = "category", Type = "number", Nilable = false },
  245. { Name = "partyGUID", Type = "string", Nilable = false },
  246. },
  247. },
  248. {
  249. Name = "GroupRosterUpdate",
  250. Type = "Event",
  251. LiteralName = "GROUP_ROSTER_UPDATE",
  252. },
  253. {
  254. Name = "InstanceBootStart",
  255. Type = "Event",
  256. LiteralName = "INSTANCE_BOOT_START",
  257. },
  258. {
  259. Name = "InstanceBootStop",
  260. Type = "Event",
  261. LiteralName = "INSTANCE_BOOT_STOP",
  262. },
  263. {
  264. Name = "InstanceGroupSizeChanged",
  265. Type = "Event",
  266. LiteralName = "INSTANCE_GROUP_SIZE_CHANGED",
  267. },
  268. {
  269. Name = "InviteToPartyConfirmation",
  270. Type = "Event",
  271. LiteralName = "INVITE_TO_PARTY_CONFIRMATION",
  272. Payload =
  273. {
  274. { Name = "targetName", Type = "string", Nilable = false },
  275. { Name = "willConvertToRaid", Type = "bool", Nilable = false },
  276. { Name = "questSessionActive", Type = "bool", Nilable = false },
  277. },
  278. },
  279. {
  280. Name = "InviteTravelPassConfirmation",
  281. Type = "Event",
  282. LiteralName = "INVITE_TRAVEL_PASS_CONFIRMATION",
  283. Payload =
  284. {
  285. { Name = "targetName", Type = "string", Nilable = false },
  286. { Name = "targetGUID", Type = "string", Nilable = false },
  287. { Name = "willConvertToRaid", Type = "bool", Nilable = false },
  288. { Name = "questSessionActive", Type = "bool", Nilable = false },
  289. },
  290. },
  291. {
  292. Name = "LeavePartyConfirmation",
  293. Type = "Event",
  294. LiteralName = "LEAVE_PARTY_CONFIRMATION",
  295. },
  296. {
  297. Name = "PartyInviteCancel",
  298. Type = "Event",
  299. LiteralName = "PARTY_INVITE_CANCEL",
  300. },
  301. {
  302. Name = "PartyInviteRequest",
  303. Type = "Event",
  304. LiteralName = "PARTY_INVITE_REQUEST",
  305. Payload =
  306. {
  307. { Name = "name", Type = "string", Nilable = false },
  308. { Name = "isTank", Type = "bool", Nilable = false },
  309. { Name = "isHealer", Type = "bool", Nilable = false },
  310. { Name = "isDamage", Type = "bool", Nilable = false },
  311. { Name = "isNativeRealm", Type = "bool", Nilable = false },
  312. { Name = "allowMultipleRoles", Type = "bool", Nilable = false },
  313. { Name = "inviterGUID", Type = "string", Nilable = false },
  314. { Name = "questSessionActive", Type = "bool", Nilable = false },
  315. },
  316. },
  317. {
  318. Name = "PartyLeaderChanged",
  319. Type = "Event",
  320. LiteralName = "PARTY_LEADER_CHANGED",
  321. },
  322. {
  323. Name = "PartyLfgRestricted",
  324. Type = "Event",
  325. LiteralName = "PARTY_LFG_RESTRICTED",
  326. },
  327. {
  328. Name = "PartyLootMethodChanged",
  329. Type = "Event",
  330. LiteralName = "PARTY_LOOT_METHOD_CHANGED",
  331. },
  332. {
  333. Name = "PartyMemberDisable",
  334. Type = "Event",
  335. LiteralName = "PARTY_MEMBER_DISABLE",
  336. Payload =
  337. {
  338. { Name = "unitTarget", Type = "string", Nilable = false },
  339. },
  340. },
  341. {
  342. Name = "PartyMemberEnable",
  343. Type = "Event",
  344. LiteralName = "PARTY_MEMBER_ENABLE",
  345. Payload =
  346. {
  347. { Name = "unitTarget", Type = "string", Nilable = false },
  348. },
  349. },
  350. {
  351. Name = "PlayerDifficultyChanged",
  352. Type = "Event",
  353. LiteralName = "PLAYER_DIFFICULTY_CHANGED",
  354. },
  355. {
  356. Name = "PlayerRolesAssigned",
  357. Type = "Event",
  358. LiteralName = "PLAYER_ROLES_ASSIGNED",
  359. },
  360. {
  361. Name = "RaidRosterUpdate",
  362. Type = "Event",
  363. LiteralName = "RAID_ROSTER_UPDATE",
  364. },
  365. {
  366. Name = "ReadyCheck",
  367. Type = "Event",
  368. LiteralName = "READY_CHECK",
  369. Payload =
  370. {
  371. { Name = "initiatorName", Type = "string", Nilable = false },
  372. { Name = "readyCheckTimeLeft", Type = "number", Nilable = false },
  373. },
  374. },
  375. {
  376. Name = "ReadyCheckConfirm",
  377. Type = "Event",
  378. LiteralName = "READY_CHECK_CONFIRM",
  379. Payload =
  380. {
  381. { Name = "unitTarget", Type = "string", Nilable = false },
  382. { Name = "isReady", Type = "bool", Nilable = false },
  383. },
  384. },
  385. {
  386. Name = "ReadyCheckFinished",
  387. Type = "Event",
  388. LiteralName = "READY_CHECK_FINISHED",
  389. Payload =
  390. {
  391. { Name = "preempted", Type = "bool", Nilable = false },
  392. },
  393. },
  394. {
  395. Name = "RequestInviteConfirmation",
  396. Type = "Event",
  397. LiteralName = "REQUEST_INVITE_CONFIRMATION",
  398. Payload =
  399. {
  400. { Name = "targetName", Type = "string", Nilable = false },
  401. { Name = "partyLevelLink", Type = "number", Nilable = false },
  402. { Name = "questSessionActive", Type = "bool", Nilable = false },
  403. { Name = "tank", Type = "bool", Nilable = true },
  404. { Name = "healer", Type = "bool", Nilable = true },
  405. { Name = "dps", Type = "bool", Nilable = true },
  406. },
  407. },
  408. {
  409. Name = "RoleChangedInform",
  410. Type = "Event",
  411. LiteralName = "ROLE_CHANGED_INFORM",
  412. Payload =
  413. {
  414. { Name = "changedName", Type = "string", Nilable = false },
  415. { Name = "fromName", Type = "string", Nilable = false },
  416. { Name = "oldRole", Type = "string", Nilable = false },
  417. { Name = "newRole", Type = "string", Nilable = false },
  418. },
  419. },
  420. {
  421. Name = "RolePollBegin",
  422. Type = "Event",
  423. LiteralName = "ROLE_POLL_BEGIN",
  424. Payload =
  425. {
  426. { Name = "fromName", Type = "string", Nilable = false },
  427. },
  428. },
  429. {
  430. Name = "VoteKickReasonNeeded",
  431. Type = "Event",
  432. LiteralName = "VOTE_KICK_REASON_NEEDED",
  433. Payload =
  434. {
  435. { Name = "name", Type = "string", Nilable = false },
  436. { Name = "resultGUID", Type = "string", Nilable = false },
  437. },
  438. },
  439. },
  440. Tables =
  441. {
  442. {
  443. Name = "PartyRequestJoinRelation",
  444. Type = "Enumeration",
  445. NumValues = 5,
  446. MinValue = 0,
  447. MaxValue = 4,
  448. Fields =
  449. {
  450. { Name = "None", Type = "PartyRequestJoinRelation", EnumValue = 0 },
  451. { Name = "Friend", Type = "PartyRequestJoinRelation", EnumValue = 1 },
  452. { Name = "Guild", Type = "PartyRequestJoinRelation", EnumValue = 2 },
  453. { Name = "Club", Type = "PartyRequestJoinRelation", EnumValue = 3 },
  454. { Name = "NumPartyRequestJoinRelations", Type = "PartyRequestJoinRelation", EnumValue = 4 },
  455. },
  456. },
  457. },
  458. };
  459. APIDocumentation:AddDocumentationTable(PartyInfo);