Blizzard_APIDocumentation/PvpInfoDocumentation.lua

Blizzard_APIDocumentation/PvpInfoDocumentation.lua (9.1.0.39617; unchanged since 9.1.0.39229)
  1. local PvpInfo =
  2. {
  3. Name = "PvpInfo",
  4. Type = "System",
  5. Namespace = "C_PvP",
  6. Functions =
  7. {
  8. {
  9. Name = "CanDisplayDeaths",
  10. Type = "Function",
  11. Returns =
  12. {
  13. { Name = "canDisplay", Type = "bool", Nilable = false },
  14. },
  15. },
  16. {
  17. Name = "CanDisplayHonorableKills",
  18. Type = "Function",
  19. Returns =
  20. {
  21. { Name = "canDisplay", Type = "bool", Nilable = false },
  22. },
  23. },
  24. {
  25. Name = "CanPlayerUseRatedPVPUI",
  26. Type = "Function",
  27. Returns =
  28. {
  29. { Name = "canUse", Type = "bool", Nilable = false },
  30. { Name = "failureReason", Type = "string", Nilable = false },
  31. },
  32. },
  33. {
  34. Name = "CanToggleWarMode",
  35. Type = "Function",
  36. Arguments =
  37. {
  38. { Name = "toggle", Type = "bool", Nilable = false },
  39. },
  40. Returns =
  41. {
  42. { Name = "canTogglePvP", Type = "bool", Nilable = false },
  43. },
  44. },
  45. {
  46. Name = "CanToggleWarModeInArea",
  47. Type = "Function",
  48. Returns =
  49. {
  50. { Name = "canTogglePvPInArea", Type = "bool", Nilable = false },
  51. },
  52. },
  53. {
  54. Name = "DoesMatchOutcomeAffectRating",
  55. Type = "Function",
  56. Returns =
  57. {
  58. { Name = "doesAffect", Type = "bool", Nilable = false },
  59. },
  60. },
  61. {
  62. Name = "GetActiveBrawlInfo",
  63. Type = "Function",
  64. Returns =
  65. {
  66. { Name = "brawlInfo", Type = "PvpBrawlInfo", Nilable = true },
  67. },
  68. },
  69. {
  70. Name = "GetActiveMatchBracket",
  71. Type = "Function",
  72. Returns =
  73. {
  74. { Name = "bracket", Type = "number", Nilable = false },
  75. },
  76. },
  77. {
  78. Name = "GetActiveMatchDuration",
  79. Type = "Function",
  80. Returns =
  81. {
  82. { Name = "seconds", Type = "number", Nilable = false },
  83. },
  84. },
  85. {
  86. Name = "GetActiveMatchState",
  87. Type = "Function",
  88. Returns =
  89. {
  90. { Name = "state", Type = "PvPMatchState", Nilable = false },
  91. },
  92. },
  93. {
  94. Name = "GetActiveMatchWinner",
  95. Type = "Function",
  96. Returns =
  97. {
  98. { Name = "winner", Type = "number", Nilable = false },
  99. },
  100. },
  101. {
  102. Name = "GetArenaCrowdControlInfo",
  103. Type = "Function",
  104. Arguments =
  105. {
  106. { Name = "playerToken", Type = "string", Nilable = false },
  107. },
  108. Returns =
  109. {
  110. { Name = "spellID", Type = "number", Nilable = false },
  111. { Name = "startTime", Type = "number", Nilable = false },
  112. { Name = "duration", Type = "number", Nilable = false },
  113. },
  114. },
  115. {
  116. Name = "GetArenaRewards",
  117. Type = "Function",
  118. Arguments =
  119. {
  120. { Name = "teamSize", Type = "number", Nilable = false },
  121. },
  122. Returns =
  123. {
  124. { Name = "honor", Type = "number", Nilable = false },
  125. { Name = "experience", Type = "number", Nilable = false },
  126. { Name = "itemRewards", Type = "table", InnerType = "BattlefieldItemReward", Nilable = true },
  127. { Name = "currencyRewards", Type = "table", InnerType = "BattlefieldCurrencyReward", Nilable = true },
  128. },
  129. },
  130. {
  131. Name = "GetArenaSkirmishRewards",
  132. Type = "Function",
  133. Returns =
  134. {
  135. { Name = "honor", Type = "number", Nilable = false },
  136. { Name = "experience", Type = "number", Nilable = false },
  137. { Name = "itemRewards", Type = "table", InnerType = "BattlefieldItemReward", Nilable = true },
  138. { Name = "currencyRewards", Type = "table", InnerType = "BattlefieldCurrencyReward", Nilable = true },
  139. },
  140. },
  141. {
  142. Name = "GetAvailableBrawlInfo",
  143. Type = "Function",
  144. Documentation = { "If nil is returned, PVP_BRAWL_INFO_UPDATED event will be sent when the data is ready." },
  145. Returns =
  146. {
  147. { Name = "brawlInfo", Type = "PvpBrawlInfo", Nilable = true },
  148. },
  149. },
  150. {
  151. Name = "GetBattlefieldVehicleInfo",
  152. Type = "Function",
  153. Arguments =
  154. {
  155. { Name = "vehicleIndex", Type = "number", Nilable = false },
  156. { Name = "uiMapID", Type = "number", Nilable = false },
  157. },
  158. Returns =
  159. {
  160. { Name = "info", Type = "BattlefieldVehicleInfo", Nilable = false },
  161. },
  162. },
  163. {
  164. Name = "GetBattlefieldVehicles",
  165. Type = "Function",
  166. Arguments =
  167. {
  168. { Name = "uiMapID", Type = "number", Nilable = false },
  169. },
  170. Returns =
  171. {
  172. { Name = "vehicles", Type = "table", InnerType = "BattlefieldVehicleInfo", Nilable = false },
  173. },
  174. },
  175. {
  176. Name = "GetBrawlRewards",
  177. Type = "Function",
  178. Arguments =
  179. {
  180. { Name = "brawlType", Type = "BrawlType", Nilable = false },
  181. },
  182. Returns =
  183. {
  184. { Name = "honor", Type = "number", Nilable = false },
  185. { Name = "experience", Type = "number", Nilable = false },
  186. { Name = "itemRewards", Type = "table", InnerType = "BattlefieldItemReward", Nilable = true },
  187. { Name = "currencyRewards", Type = "table", InnerType = "BattlefieldCurrencyReward", Nilable = true },
  188. { Name = "hasWon", Type = "bool", Nilable = false },
  189. },
  190. },
  191. {
  192. Name = "GetGlobalPvpScalingInfoForSpecID",
  193. Type = "Function",
  194. Arguments =
  195. {
  196. { Name = "specializationID", Type = "number", Nilable = false },
  197. },
  198. Returns =
  199. {
  200. { Name = "pvpScalingData", Type = "table", InnerType = "PvpScalingData", Nilable = false },
  201. },
  202. },
  203. {
  204. Name = "GetHonorRewardInfo",
  205. Type = "Function",
  206. Arguments =
  207. {
  208. { Name = "honorLevel", Type = "number", Nilable = false },
  209. },
  210. Returns =
  211. {
  212. { Name = "info", Type = "HonorRewardInfo", Nilable = true },
  213. },
  214. },
  215. {
  216. Name = "GetLevelUpBattlegrounds",
  217. Type = "Function",
  218. Arguments =
  219. {
  220. { Name = "level", Type = "number", Nilable = false },
  221. },
  222. Returns =
  223. {
  224. { Name = "battlefields", Type = "table", InnerType = "LevelUpBattlegroundInfo", Nilable = false },
  225. },
  226. },
  227. {
  228. Name = "GetMatchPVPStatColumn",
  229. Type = "Function",
  230. Arguments =
  231. {
  232. { Name = "pvpStatID", Type = "number", Nilable = false },
  233. },
  234. Returns =
  235. {
  236. { Name = "info", Type = "MatchPVPStatColumn", Nilable = true },
  237. },
  238. },
  239. {
  240. Name = "GetMatchPVPStatColumns",
  241. Type = "Function",
  242. Returns =
  243. {
  244. { Name = "columns", Type = "table", InnerType = "MatchPVPStatColumn", Nilable = false },
  245. },
  246. },
  247. {
  248. Name = "GetNextHonorLevelForReward",
  249. Type = "Function",
  250. Arguments =
  251. {
  252. { Name = "honorLevel", Type = "number", Nilable = false },
  253. },
  254. Returns =
  255. {
  256. { Name = "nextHonorLevelWithReward", Type = "number", Nilable = true },
  257. },
  258. },
  259. {
  260. Name = "GetOutdoorPvPWaitTime",
  261. Type = "Function",
  262. Arguments =
  263. {
  264. { Name = "uiMapID", Type = "number", Nilable = false },
  265. },
  266. Returns =
  267. {
  268. { Name = "pvpWaitTime", Type = "number", Nilable = false },
  269. },
  270. },
  271. {
  272. Name = "GetPVPActiveMatchPersonalRatedInfo",
  273. Type = "Function",
  274. Returns =
  275. {
  276. { Name = "info", Type = "PVPPersonalRatedInfo", Nilable = true },
  277. },
  278. },
  279. {
  280. Name = "GetPostMatchCurrencyRewards",
  281. Type = "Function",
  282. Returns =
  283. {
  284. { Name = "rewards", Type = "table", InnerType = "PVPPostMatchCurrencyReward", Nilable = false },
  285. },
  286. },
  287. {
  288. Name = "GetPostMatchItemRewards",
  289. Type = "Function",
  290. Returns =
  291. {
  292. { Name = "rewards", Type = "table", InnerType = "PVPPostMatchItemReward", Nilable = false },
  293. },
  294. },
  295. {
  296. Name = "GetPvpTierID",
  297. Type = "Function",
  298. Arguments =
  299. {
  300. { Name = "tierEnum", Type = "number", Nilable = false },
  301. { Name = "bracketEnum", Type = "number", Nilable = false },
  302. },
  303. Returns =
  304. {
  305. { Name = "id", Type = "number", Nilable = true },
  306. },
  307. },
  308. {
  309. Name = "GetPvpTierInfo",
  310. Type = "Function",
  311. Arguments =
  312. {
  313. { Name = "tierID", Type = "number", Nilable = false },
  314. },
  315. Returns =
  316. {
  317. { Name = "pvpTierInfo", Type = "PvpTierInfo", Nilable = true },
  318. },
  319. },
  320. {
  321. Name = "GetRandomBGInfo",
  322. Type = "Function",
  323. Returns =
  324. {
  325. { Name = "info", Type = "RandomBGInfo", Nilable = false },
  326. },
  327. },
  328. {
  329. Name = "GetRandomBGRewards",
  330. Type = "Function",
  331. Returns =
  332. {
  333. { Name = "honor", Type = "number", Nilable = false },
  334. { Name = "experience", Type = "number", Nilable = false },
  335. { Name = "itemRewards", Type = "table", InnerType = "BattlefieldItemReward", Nilable = true },
  336. { Name = "currencyRewards", Type = "table", InnerType = "BattlefieldCurrencyReward", Nilable = true },
  337. },
  338. },
  339. {
  340. Name = "GetRandomEpicBGInfo",
  341. Type = "Function",
  342. Returns =
  343. {
  344. { Name = "info", Type = "RandomBGInfo", Nilable = false },
  345. },
  346. },
  347. {
  348. Name = "GetRandomEpicBGRewards",
  349. Type = "Function",
  350. Returns =
  351. {
  352. { Name = "honor", Type = "number", Nilable = false },
  353. { Name = "experience", Type = "number", Nilable = false },
  354. { Name = "itemRewards", Type = "table", InnerType = "BattlefieldItemReward", Nilable = true },
  355. { Name = "currencyRewards", Type = "table", InnerType = "BattlefieldCurrencyReward", Nilable = true },
  356. },
  357. },
  358. {
  359. Name = "GetRatedBGRewards",
  360. Type = "Function",
  361. Returns =
  362. {
  363. { Name = "honor", Type = "number", Nilable = false },
  364. { Name = "experience", Type = "number", Nilable = false },
  365. { Name = "itemRewards", Type = "table", InnerType = "BattlefieldItemReward", Nilable = true },
  366. { Name = "currencyRewards", Type = "table", InnerType = "BattlefieldCurrencyReward", Nilable = true },
  367. },
  368. },
  369. {
  370. Name = "GetRewardItemLevelsByTierEnum",
  371. Type = "Function",
  372. Arguments =
  373. {
  374. { Name = "pvpTierEnum", Type = "number", Nilable = false },
  375. },
  376. Returns =
  377. {
  378. { Name = "activityItemLevel", Type = "number", Nilable = false },
  379. { Name = "weeklyItemLevel", Type = "number", Nilable = false },
  380. },
  381. },
  382. {
  383. Name = "GetScoreInfo",
  384. Type = "Function",
  385. Arguments =
  386. {
  387. { Name = "offsetIndex", Type = "number", Nilable = false },
  388. },
  389. Returns =
  390. {
  391. { Name = "info", Type = "PVPScoreInfo", Nilable = true },
  392. },
  393. },
  394. {
  395. Name = "GetScoreInfoByPlayerGuid",
  396. Type = "Function",
  397. Arguments =
  398. {
  399. { Name = "guid", Type = "string", Nilable = false },
  400. },
  401. Returns =
  402. {
  403. { Name = "info", Type = "PVPScoreInfo", Nilable = true },
  404. },
  405. },
  406. {
  407. Name = "GetSeasonBestInfo",
  408. Type = "Function",
  409. Returns =
  410. {
  411. { Name = "tierID", Type = "number", Nilable = false },
  412. { Name = "nextTierID", Type = "number", Nilable = true },
  413. },
  414. },
  415. {
  416. Name = "GetSkirmishInfo",
  417. Type = "Function",
  418. Arguments =
  419. {
  420. { Name = "pvpBracket", Type = "number", Nilable = false },
  421. },
  422. Returns =
  423. {
  424. { Name = "battlemasterListInfo", Type = "BattlemasterListInfo", Nilable = false },
  425. },
  426. },
  427. {
  428. Name = "GetSpecialEventDetails",
  429. Type = "Function",
  430. Returns =
  431. {
  432. { Name = "info", Type = "SpecialEventDetails", Nilable = true },
  433. },
  434. },
  435. {
  436. Name = "GetSpecialEventInfo",
  437. Type = "Function",
  438. Returns =
  439. {
  440. { Name = "info", Type = "RandomBGInfo", Nilable = false },
  441. },
  442. },
  443. {
  444. Name = "GetTeamInfo",
  445. Type = "Function",
  446. Arguments =
  447. {
  448. { Name = "factionIndex", Type = "number", Nilable = false },
  449. },
  450. Returns =
  451. {
  452. { Name = "info", Type = "PVPTeamInfo", Nilable = true },
  453. },
  454. },
  455. {
  456. Name = "GetWarModeRewardBonus",
  457. Type = "Function",
  458. Returns =
  459. {
  460. { Name = "rewardBonus", Type = "number", Nilable = false },
  461. },
  462. },
  463. {
  464. Name = "GetWarModeRewardBonusDefault",
  465. Type = "Function",
  466. Returns =
  467. {
  468. { Name = "defaultBonus", Type = "number", Nilable = false },
  469. },
  470. },
  471. {
  472. Name = "GetWeeklyChestInfo",
  473. Type = "Function",
  474. Returns =
  475. {
  476. { Name = "rewardAchieved", Type = "bool", Nilable = false },
  477. { Name = "lastWeekRewardAchieved", Type = "bool", Nilable = false },
  478. { Name = "lastWeekRewardClaimed", Type = "bool", Nilable = false },
  479. { Name = "pvpTierMaxFromWins", Type = "number", Nilable = false },
  480. },
  481. },
  482. {
  483. Name = "HasArenaSkirmishWinToday",
  484. Type = "Function",
  485. Returns =
  486. {
  487. { Name = "hasArenaSkirmishWinToday", Type = "bool", Nilable = false },
  488. },
  489. },
  490. {
  491. Name = "IsActiveBattlefield",
  492. Type = "Function",
  493. Returns =
  494. {
  495. { Name = "isActiveBattlefield", Type = "bool", Nilable = false },
  496. },
  497. },
  498. {
  499. Name = "IsActiveMatchRegistered",
  500. Type = "Function",
  501. Returns =
  502. {
  503. { Name = "registered", Type = "bool", Nilable = false },
  504. },
  505. },
  506. {
  507. Name = "IsArena",
  508. Type = "Function",
  509. Returns =
  510. {
  511. { Name = "isArena", Type = "bool", Nilable = false },
  512. },
  513. },
  514. {
  515. Name = "IsBattleground",
  516. Type = "Function",
  517. Returns =
  518. {
  519. { Name = "isBattleground", Type = "bool", Nilable = false },
  520. },
  521. },
  522. {
  523. Name = "IsBattlegroundEnlistmentBonusActive",
  524. Type = "Function",
  525. Returns =
  526. {
  527. { Name = "battlegroundActive", Type = "bool", Nilable = false },
  528. { Name = "brawlActive", Type = "bool", Nilable = false },
  529. },
  530. },
  531. {
  532. Name = "IsInBrawl",
  533. Type = "Function",
  534. Returns =
  535. {
  536. { Name = "isInBrawl", Type = "bool", Nilable = false },
  537. },
  538. },
  539. {
  540. Name = "IsMatchConsideredArena",
  541. Type = "Function",
  542. Returns =
  543. {
  544. { Name = "asArena", Type = "bool", Nilable = false },
  545. },
  546. },
  547. {
  548. Name = "IsMatchFactional",
  549. Type = "Function",
  550. Returns =
  551. {
  552. { Name = "isFactional", Type = "bool", Nilable = false },
  553. },
  554. },
  555. {
  556. Name = "IsPVPMap",
  557. Type = "Function",
  558. Returns =
  559. {
  560. { Name = "isPVPMap", Type = "bool", Nilable = false },
  561. },
  562. },
  563. {
  564. Name = "IsRatedArena",
  565. Type = "Function",
  566. Returns =
  567. {
  568. { Name = "isRatedArena", Type = "bool", Nilable = false },
  569. },
  570. },
  571. {
  572. Name = "IsRatedBattleground",
  573. Type = "Function",
  574. Returns =
  575. {
  576. { Name = "isRatedBattleground", Type = "bool", Nilable = false },
  577. },
  578. },
  579. {
  580. Name = "IsRatedMap",
  581. Type = "Function",
  582. Returns =
  583. {
  584. { Name = "isRatedMap", Type = "bool", Nilable = false },
  585. },
  586. },
  587. {
  588. Name = "IsWarModeActive",
  589. Type = "Function",
  590. Returns =
  591. {
  592. { Name = "warModeActive", Type = "bool", Nilable = false },
  593. },
  594. },
  595. {
  596. Name = "IsWarModeDesired",
  597. Type = "Function",
  598. Returns =
  599. {
  600. { Name = "warModeDesired", Type = "bool", Nilable = false },
  601. },
  602. },
  603. {
  604. Name = "IsWarModeFeatureEnabled",
  605. Type = "Function",
  606. Returns =
  607. {
  608. { Name = "warModeEnabled", Type = "bool", Nilable = false },
  609. },
  610. },
  611. {
  612. Name = "JoinBrawl",
  613. Type = "Function",
  614. },
  615. {
  616. Name = "RequestCrowdControlSpell",
  617. Type = "Function",
  618. Arguments =
  619. {
  620. { Name = "playerToken", Type = "string", Nilable = false },
  621. },
  622. },
  623. {
  624. Name = "SetWarModeDesired",
  625. Type = "Function",
  626. Arguments =
  627. {
  628. { Name = "warModeDesired", Type = "bool", Nilable = false },
  629. },
  630. },
  631. {
  632. Name = "ToggleWarMode",
  633. Type = "Function",
  634. },
  635. },
  636. Events =
  637. {
  638. {
  639. Name = "ArenaOpponentUpdate",
  640. Type = "Event",
  641. LiteralName = "ARENA_OPPONENT_UPDATE",
  642. Payload =
  643. {
  644. { Name = "unitToken", Type = "string", Nilable = false },
  645. { Name = "updateReason", Type = "string", Nilable = false },
  646. },
  647. },
  648. {
  649. Name = "ArenaPrepOpponentSpecializations",
  650. Type = "Event",
  651. LiteralName = "ARENA_PREP_OPPONENT_SPECIALIZATIONS",
  652. },
  653. {
  654. Name = "ArenaSeasonWorldState",
  655. Type = "Event",
  656. LiteralName = "ARENA_SEASON_WORLD_STATE",
  657. },
  658. {
  659. Name = "BattlefieldQueueTimeout",
  660. Type = "Event",
  661. LiteralName = "BATTLEFIELD_QUEUE_TIMEOUT",
  662. },
  663. {
  664. Name = "BattlefieldsClosed",
  665. Type = "Event",
  666. LiteralName = "BATTLEFIELDS_CLOSED",
  667. },
  668. {
  669. Name = "BattlefieldsShow",
  670. Type = "Event",
  671. LiteralName = "BATTLEFIELDS_SHOW",
  672. Payload =
  673. {
  674. { Name = "isArena", Type = "bool", Nilable = true },
  675. { Name = "battleMasterListID", Type = "number", Nilable = true },
  676. },
  677. },
  678. {
  679. Name = "BattlegroundObjectivesUpdate",
  680. Type = "Event",
  681. LiteralName = "BATTLEGROUND_OBJECTIVES_UPDATE",
  682. },
  683. {
  684. Name = "BattlegroundPointsUpdate",
  685. Type = "Event",
  686. LiteralName = "BATTLEGROUND_POINTS_UPDATE",
  687. },
  688. {
  689. Name = "GdfSimComplete",
  690. Type = "Event",
  691. LiteralName = "GDF_SIM_COMPLETE",
  692. },
  693. {
  694. Name = "HonorLevelUpdate",
  695. Type = "Event",
  696. LiteralName = "HONOR_LEVEL_UPDATE",
  697. Payload =
  698. {
  699. { Name = "isHigherLevel", Type = "bool", Nilable = false },
  700. },
  701. },
  702. {
  703. Name = "NotifyPvpAfkResult",
  704. Type = "Event",
  705. LiteralName = "NOTIFY_PVP_AFK_RESULT",
  706. Payload =
  707. {
  708. { Name = "offender", Type = "string", Nilable = false },
  709. { Name = "numBlackMarksOnOffender", Type = "number", Nilable = false },
  710. { Name = "numPlayersIHaveReported", Type = "number", Nilable = false },
  711. },
  712. },
  713. {
  714. Name = "PlayerEnteringBattleground",
  715. Type = "Event",
  716. LiteralName = "PLAYER_ENTERING_BATTLEGROUND",
  717. },
  718. {
  719. Name = "PostMatchCurrencyRewardUpdate",
  720. Type = "Event",
  721. LiteralName = "POST_MATCH_CURRENCY_REWARD_UPDATE",
  722. Payload =
  723. {
  724. { Name = "reward", Type = "PVPPostMatchCurrencyReward", Nilable = false },
  725. },
  726. },
  727. {
  728. Name = "PostMatchItemRewardUpdate",
  729. Type = "Event",
  730. LiteralName = "POST_MATCH_ITEM_REWARD_UPDATE",
  731. },
  732. {
  733. Name = "PvpBrawlInfoUpdated",
  734. Type = "Event",
  735. LiteralName = "PVP_BRAWL_INFO_UPDATED",
  736. },
  737. {
  738. Name = "PvpMatchActive",
  739. Type = "Event",
  740. LiteralName = "PVP_MATCH_ACTIVE",
  741. },
  742. {
  743. Name = "PvpMatchComplete",
  744. Type = "Event",
  745. LiteralName = "PVP_MATCH_COMPLETE",
  746. Payload =
  747. {
  748. { Name = "winner", Type = "number", Nilable = false },
  749. { Name = "duration", Type = "number", Nilable = false },
  750. },
  751. },
  752. {
  753. Name = "PvpMatchInactive",
  754. Type = "Event",
  755. LiteralName = "PVP_MATCH_INACTIVE",
  756. },
  757. {
  758. Name = "PvpRatedStatsUpdate",
  759. Type = "Event",
  760. LiteralName = "PVP_RATED_STATS_UPDATE",
  761. },
  762. {
  763. Name = "PvpRewardsUpdate",
  764. Type = "Event",
  765. LiteralName = "PVP_REWARDS_UPDATE",
  766. },
  767. {
  768. Name = "PvpRoleUpdate",
  769. Type = "Event",
  770. LiteralName = "PVP_ROLE_UPDATE",
  771. },
  772. {
  773. Name = "PvpSpecialEventInfoUpdated",
  774. Type = "Event",
  775. LiteralName = "PVP_SPECIAL_EVENT_INFO_UPDATED",
  776. },
  777. {
  778. Name = "PvpTypesEnabled",
  779. Type = "Event",
  780. LiteralName = "PVP_TYPES_ENABLED",
  781. Payload =
  782. {
  783. { Name = "wargameBattlegrounds", Type = "bool", Nilable = false },
  784. { Name = "ratedBattlegrounds", Type = "bool", Nilable = false },
  785. { Name = "ratedArenas", Type = "bool", Nilable = false },
  786. },
  787. },
  788. {
  789. Name = "PvpVehicleInfoUpdated",
  790. Type = "Event",
  791. LiteralName = "PVP_VEHICLE_INFO_UPDATED",
  792. },
  793. {
  794. Name = "PvpWorldstateUpdate",
  795. Type = "Event",
  796. LiteralName = "PVP_WORLDSTATE_UPDATE",
  797. },
  798. {
  799. Name = "PvpqueueAnywhereShow",
  800. Type = "Event",
  801. LiteralName = "PVPQUEUE_ANYWHERE_SHOW",
  802. },
  803. {
  804. Name = "PvpqueueAnywhereUpdateAvailable",
  805. Type = "Event",
  806. LiteralName = "PVPQUEUE_ANYWHERE_UPDATE_AVAILABLE",
  807. },
  808. {
  809. Name = "UpdateActiveBattlefield",
  810. Type = "Event",
  811. LiteralName = "UPDATE_ACTIVE_BATTLEFIELD",
  812. },
  813. {
  814. Name = "UpdateBattlefieldScore",
  815. Type = "Event",
  816. LiteralName = "UPDATE_BATTLEFIELD_SCORE",
  817. },
  818. {
  819. Name = "UpdateBattlefieldStatus",
  820. Type = "Event",
  821. LiteralName = "UPDATE_BATTLEFIELD_STATUS",
  822. Payload =
  823. {
  824. { Name = "battleFieldIndex", Type = "number", Nilable = false },
  825. },
  826. },
  827. {
  828. Name = "WarModeStatusUpdate",
  829. Type = "Event",
  830. LiteralName = "WAR_MODE_STATUS_UPDATE",
  831. Payload =
  832. {
  833. { Name = "warModeEnabled", Type = "bool", Nilable = false },
  834. },
  835. },
  836. {
  837. Name = "WargameRequested",
  838. Type = "Event",
  839. LiteralName = "WARGAME_REQUESTED",
  840. Payload =
  841. {
  842. { Name = "opposingPartyMemberName", Type = "string", Nilable = false },
  843. { Name = "battlegroundName", Type = "string", Nilable = false },
  844. { Name = "timeoutSeconds", Type = "number", Nilable = false },
  845. { Name = "tournamentRules", Type = "bool", Nilable = false },
  846. },
  847. },
  848. },
  849. Tables =
  850. {
  851. {
  852. Name = "BrawlType",
  853. Type = "Enumeration",
  854. NumValues = 4,
  855. MinValue = 0,
  856. MaxValue = 3,
  857. Fields =
  858. {
  859. { Name = "None", Type = "BrawlType", EnumValue = 0 },
  860. { Name = "Battleground", Type = "BrawlType", EnumValue = 1 },
  861. { Name = "Arena", Type = "BrawlType", EnumValue = 2 },
  862. { Name = "Lfg", Type = "BrawlType", EnumValue = 3 },
  863. },
  864. },
  865. {
  866. Name = "PvPMatchState",
  867. Type = "Enumeration",
  868. NumValues = 3,
  869. MinValue = 0,
  870. MaxValue = 2,
  871. Fields =
  872. {
  873. { Name = "Inactive", Type = "PvPMatchState", EnumValue = 0 },
  874. { Name = "Active", Type = "PvPMatchState", EnumValue = 1 },
  875. { Name = "Complete", Type = "PvPMatchState", EnumValue = 2 },
  876. },
  877. },
  878. {
  879. Name = "BattlefieldCurrencyReward",
  880. Type = "Structure",
  881. Fields =
  882. {
  883. { Name = "id", Type = "number", Nilable = false },
  884. { Name = "quantity", Type = "number", Nilable = false },
  885. },
  886. },
  887. {
  888. Name = "BattlefieldItemReward",
  889. Type = "Structure",
  890. Fields =
  891. {
  892. { Name = "id", Type = "number", Nilable = false },
  893. { Name = "name", Type = "string", Nilable = false },
  894. { Name = "texture", Type = "number", Nilable = false },
  895. { Name = "quantity", Type = "number", Nilable = false },
  896. },
  897. },
  898. {
  899. Name = "BattlefieldVehicleInfo",
  900. Type = "Structure",
  901. Fields =
  902. {
  903. { Name = "x", Type = "number", Nilable = false },
  904. { Name = "y", Type = "number", Nilable = false },
  905. { Name = "name", Type = "string", Nilable = false },
  906. { Name = "isOccupied", Type = "bool", Nilable = false },
  907. { Name = "atlas", Type = "string", Nilable = false },
  908. { Name = "textureWidth", Type = "number", Nilable = false },
  909. { Name = "textureHeight", Type = "number", Nilable = false },
  910. { Name = "facing", Type = "number", Nilable = false },
  911. { Name = "isPlayer", Type = "bool", Nilable = false },
  912. { Name = "isAlive", Type = "bool", Nilable = false },
  913. { Name = "shouldDrawBelowPlayerBlips", Type = "bool", Nilable = false },
  914. },
  915. },
  916. {
  917. Name = "BattlemasterListInfo",
  918. Type = "Structure",
  919. Fields =
  920. {
  921. { Name = "name", Type = "string", Nilable = false },
  922. { Name = "instanceType", Type = "number", Nilable = false },
  923. { Name = "minPlayers", Type = "number", Nilable = false },
  924. { Name = "maxPlayers", Type = "number", Nilable = false },
  925. { Name = "icon", Type = "number", Nilable = false },
  926. { Name = "longDescription", Type = "string", Nilable = false },
  927. { Name = "shortDescription", Type = "string", Nilable = false },
  928. },
  929. },
  930. {
  931. Name = "HonorRewardInfo",
  932. Type = "Structure",
  933. Fields =
  934. {
  935. { Name = "honorLevelName", Type = "string", Nilable = false },
  936. { Name = "badgeFileDataID", Type = "number", Nilable = false },
  937. { Name = "achievementRewardedID", Type = "number", Nilable = false },
  938. },
  939. },
  940. {
  941. Name = "LevelUpBattlegroundInfo",
  942. Type = "Structure",
  943. Fields =
  944. {
  945. { Name = "id", Type = "number", Nilable = false },
  946. { Name = "icon", Type = "number", Nilable = false },
  947. { Name = "name", Type = "string", Nilable = false },
  948. { Name = "isEpic", Type = "bool", Nilable = false },
  949. },
  950. },
  951. {
  952. Name = "MatchPVPStatColumn",
  953. Type = "Structure",
  954. Fields =
  955. {
  956. { Name = "pvpStatID", Type = "number", Nilable = false },
  957. { Name = "columnHeaderID", Type = "number", Nilable = false },
  958. { Name = "orderIndex", Type = "number", Nilable = false },
  959. { Name = "name", Type = "string", Nilable = false },
  960. { Name = "tooltip", Type = "string", Nilable = false },
  961. },
  962. },
  963. {
  964. Name = "PvpBrawlInfo",
  965. Type = "Structure",
  966. Fields =
  967. {
  968. { Name = "name", Type = "string", Nilable = false },
  969. { Name = "shortDescription", Type = "string", Nilable = false },
  970. { Name = "longDescription", Type = "string", Nilable = false },
  971. { Name = "canQueue", Type = "bool", Nilable = false },
  972. { Name = "timeLeftUntilNextChange", Type = "number", Nilable = false },
  973. { Name = "brawlType", Type = "BrawlType", Nilable = false },
  974. { Name = "mapNames", Type = "table", InnerType = "string", Nilable = false },
  975. },
  976. },
  977. {
  978. Name = "PVPPersonalRatedInfo",
  979. Type = "Structure",
  980. Fields =
  981. {
  982. { Name = "personalRating", Type = "number", Nilable = false },
  983. { Name = "bestSeasonRating", Type = "number", Nilable = false },
  984. { Name = "bestWeeklyRating", Type = "number", Nilable = false },
  985. { Name = "seasonPlayed", Type = "number", Nilable = false },
  986. { Name = "seasonWon", Type = "number", Nilable = false },
  987. { Name = "weeklyPlayed", Type = "number", Nilable = false },
  988. { Name = "weeklyWon", Type = "number", Nilable = false },
  989. { Name = "lastWeeksBestRating", Type = "number", Nilable = false },
  990. { Name = "hasWonBracketToday", Type = "bool", Nilable = false },
  991. { Name = "tier", Type = "number", Nilable = false },
  992. { Name = "ranking", Type = "number", Nilable = true },
  993. },
  994. },
  995. {
  996. Name = "PVPPostMatchCurrencyReward",
  997. Type = "Structure",
  998. Fields =
  999. {
  1000. { Name = "currencyType", Type = "number", Nilable = false },
  1001. { Name = "quantityChanged", Type = "number", Nilable = false },
  1002. },
  1003. },
  1004. {
  1005. Name = "PVPPostMatchItemReward",
  1006. Type = "Structure",
  1007. Fields =
  1008. {
  1009. { Name = "type", Type = "string", Nilable = false },
  1010. { Name = "link", Type = "string", Nilable = false },
  1011. { Name = "quantity", Type = "number", Nilable = false },
  1012. { Name = "specID", Type = "number", Nilable = false },
  1013. { Name = "sex", Type = "number", Nilable = false },
  1014. { Name = "isUpgraded", Type = "bool", Nilable = false },
  1015. },
  1016. },
  1017. {
  1018. Name = "PvpScalingData",
  1019. Type = "Structure",
  1020. Fields =
  1021. {
  1022. { Name = "scalingDataID", Type = "number", Nilable = false },
  1023. { Name = "specializationID", Type = "number", Nilable = false },
  1024. { Name = "name", Type = "string", Nilable = false },
  1025. { Name = "value", Type = "number", Nilable = false },
  1026. },
  1027. },
  1028. {
  1029. Name = "PVPScoreInfo",
  1030. Type = "Structure",
  1031. Fields =
  1032. {
  1033. { Name = "name", Type = "string", Nilable = false },
  1034. { Name = "guid", Type = "string", Nilable = false },
  1035. { Name = "killingBlows", Type = "number", Nilable = false },
  1036. { Name = "honorableKills", Type = "number", Nilable = false },
  1037. { Name = "deaths", Type = "number", Nilable = false },
  1038. { Name = "honorGained", Type = "number", Nilable = false },
  1039. { Name = "faction", Type = "number", Nilable = false },
  1040. { Name = "raceName", Type = "string", Nilable = false },
  1041. { Name = "className", Type = "string", Nilable = false },
  1042. { Name = "classToken", Type = "string", Nilable = false },
  1043. { Name = "damageDone", Type = "number", Nilable = false },
  1044. { Name = "healingDone", Type = "number", Nilable = false },
  1045. { Name = "rating", Type = "number", Nilable = false },
  1046. { Name = "ratingChange", Type = "number", Nilable = false },
  1047. { Name = "prematchMMR", Type = "number", Nilable = false },
  1048. { Name = "mmrChange", Type = "number", Nilable = false },
  1049. { Name = "talentSpec", Type = "string", Nilable = false },
  1050. { Name = "honorLevel", Type = "number", Nilable = false },
  1051. { Name = "stats", Type = "table", InnerType = "PVPStatInfo", Nilable = false },
  1052. },
  1053. },
  1054. {
  1055. Name = "PVPStatInfo",
  1056. Type = "Structure",
  1057. Fields =
  1058. {
  1059. { Name = "pvpStatID", Type = "number", Nilable = false },
  1060. { Name = "pvpStatValue", Type = "number", Nilable = false },
  1061. { Name = "orderIndex", Type = "number", Nilable = false },
  1062. { Name = "name", Type = "string", Nilable = false },
  1063. { Name = "tooltip", Type = "string", Nilable = false },
  1064. { Name = "iconName", Type = "string", Nilable = false },
  1065. },
  1066. },
  1067. {
  1068. Name = "PVPTeamInfo",
  1069. Type = "Structure",
  1070. Fields =
  1071. {
  1072. { Name = "name", Type = "string", Nilable = false },
  1073. { Name = "size", Type = "number", Nilable = false },
  1074. { Name = "rating", Type = "number", Nilable = false },
  1075. { Name = "ratingNew", Type = "number", Nilable = false },
  1076. { Name = "ratingMMR", Type = "number", Nilable = false },
  1077. },
  1078. },
  1079. {
  1080. Name = "PvpTierInfo",
  1081. Type = "Structure",
  1082. Fields =
  1083. {
  1084. { Name = "name", Type = "string", Nilable = false },
  1085. { Name = "descendRating", Type = "number", Nilable = false },
  1086. { Name = "ascendRating", Type = "number", Nilable = false },
  1087. { Name = "descendTier", Type = "number", Nilable = false },
  1088. { Name = "ascendTier", Type = "number", Nilable = false },
  1089. { Name = "pvpTierEnum", Type = "number", Nilable = false },
  1090. { Name = "tierIconID", Type = "number", Nilable = false },
  1091. },
  1092. },
  1093. {
  1094. Name = "RandomBGInfo",
  1095. Type = "Structure",
  1096. Fields =
  1097. {
  1098. { Name = "canQueue", Type = "bool", Nilable = false },
  1099. { Name = "bgID", Type = "number", Nilable = false },
  1100. { Name = "hasRandomWinToday", Type = "bool", Nilable = false },
  1101. { Name = "minLevel", Type = "number", Nilable = false },
  1102. { Name = "maxLevel", Type = "number", Nilable = false },
  1103. },
  1104. },
  1105. {
  1106. Name = "SpecialEventDetails",
  1107. Type = "Structure",
  1108. Fields =
  1109. {
  1110. { Name = "name", Type = "string", Nilable = false },
  1111. { Name = "shortDescription", Type = "string", Nilable = false },
  1112. { Name = "longDescription", Type = "string", Nilable = false },
  1113. { Name = "questID", Type = "number", Nilable = true },
  1114. { Name = "isActive", Type = "bool", Nilable = false },
  1115. },
  1116. },
  1117. },
  1118. };
  1119. APIDocumentation:AddDocumentationTable(PvpInfo);