Quantcast Mythic Plus API Documented - WoWInterface
Thread Tools Display Modes
07-26-18, 06:31 PM   #1
thomasjohnshannon
A Theradrim Guardian
 
thomasjohnshannon's Avatar
AddOn Author - Click to view addons
Join Date: Sep 2009
Posts: 65
Mythic Plus API Documented

The patch that just went out to the beta and ptr (8.0.1.27178) includes documentation for the mythic plus api. This isn't all new but having more information on how something works is always better.

Lua Code:
  1. local MythicPlusInfo =
  2. {
  3.     Name = "MythicPlusInfo",
  4.     Type = "System",
  5.     Namespace = "C_MythicPlus",
  6.  
  7.     Functions =
  8.     {
  9.         {
  10.             Name = "GetCurrentAffixes",
  11.             Type = "Function",
  12.  
  13.             Returns =
  14.             {
  15.                 { Name = "affixIDs", Type = "table", InnerType = "number", Nilable = false },
  16.             },
  17.         },
  18.         {
  19.             Name = "GetLastWeeklyBestInformation",
  20.             Type = "Function",
  21.  
  22.             Returns =
  23.             {
  24.                 { Name = "challengeMapId", Type = "number", Nilable = false },
  25.                 { Name = "level", Type = "number", Nilable = false },
  26.             },
  27.         },
  28.         {
  29.             Name = "GetOwnedKeystoneChallengeMapID",
  30.             Type = "Function",
  31.  
  32.             Returns =
  33.             {
  34.                 { Name = "challengeMapID", Type = "number", Nilable = false },
  35.             },
  36.         },
  37.         {
  38.             Name = "GetOwnedKeystoneLevel",
  39.             Type = "Function",
  40.  
  41.             Returns =
  42.             {
  43.                 { Name = "keyStoneLevel", Type = "number", Nilable = false },
  44.             },
  45.         },
  46.         {
  47.             Name = "GetRewardLevelForDifficultyLevel",
  48.             Type = "Function",
  49.  
  50.             Arguments =
  51.             {
  52.                 { Name = "difficultyLevel", Type = "number", Nilable = false },
  53.             },
  54.  
  55.             Returns =
  56.             {
  57.                 { Name = "weeklyRewardLevel", Type = "number", Nilable = false },
  58.                 { Name = "endOfRunRewardLevel", Type = "number", Nilable = false },
  59.             },
  60.         },
  61.         {
  62.             Name = "GetRewardLevelFromKeystoneLevel",
  63.             Type = "Function",
  64.  
  65.             Arguments =
  66.             {
  67.                 { Name = "keystoneLevel", Type = "number", Nilable = false },
  68.             },
  69.  
  70.             Returns =
  71.             {
  72.                 { Name = "rewardLevel", Type = "number", Nilable = true },
  73.             },
  74.         },
  75.         {
  76.             Name = "GetSeasonBestForMap",
  77.             Type = "Function",
  78.  
  79.             Arguments =
  80.             {
  81.                 { Name = "mapChallengeModeID", Type = "number", Nilable = false },
  82.             },
  83.  
  84.             Returns =
  85.             {
  86.                 { Name = "durationSec", Type = "number", Nilable = false },
  87.                 { Name = "level", Type = "number", Nilable = false },
  88.                 { Name = "completionDate", Type = "MythicPlusDate", Nilable = false },
  89.                 { Name = "affixIDs", Type = "table", InnerType = "number", Nilable = false },
  90.                 { Name = "members", Type = "table", InnerType = "MythicPlusMember", Nilable = false },
  91.             },
  92.         },
  93.         {
  94.             Name = "GetWeeklyBestForMap",
  95.             Type = "Function",
  96.  
  97.             Arguments =
  98.             {
  99.                 { Name = "mapChallengeModeID", Type = "number", Nilable = false },
  100.             },
  101.  
  102.             Returns =
  103.             {
  104.                 { Name = "durationSec", Type = "number", Nilable = false },
  105.                 { Name = "level", Type = "number", Nilable = false },
  106.                 { Name = "completionDate", Type = "MythicPlusDate", Nilable = false },
  107.                 { Name = "affixIDs", Type = "table", InnerType = "number", Nilable = false },
  108.                 { Name = "members", Type = "table", InnerType = "MythicPlusMember", Nilable = false },
  109.             },
  110.         },
  111.         {
  112.             Name = "GetWeeklyChestRewardLevel",
  113.             Type = "Function",
  114.  
  115.             Returns =
  116.             {
  117.                 { Name = "currentWeekBestLevel", Type = "number", Nilable = false },
  118.                 { Name = "weeklyRewardLevel", Type = "number", Nilable = false },
  119.                 { Name = "nextDifficultyWeeklyRewardLevel", Type = "number", Nilable = false },
  120.             },
  121.         },
  122.         {
  123.             Name = "IsMythicPlusActive",
  124.             Type = "Function",
  125.  
  126.             Returns =
  127.             {
  128.                 { Name = "isMythicPlusActive", Type = "bool", Nilable = false },
  129.             },
  130.         },
  131.         {
  132.             Name = "IsWeeklyRewardAvailable",
  133.             Type = "Function",
  134.  
  135.             Returns =
  136.             {
  137.                 { Name = "weeklyRewardAvailable", Type = "bool", Nilable = false },
  138.             },
  139.         },
  140.         {
  141.             Name = "RequestCurrentAffixes",
  142.             Type = "Function",
  143.         },
  144.         {
  145.             Name = "RequestMapInfo",
  146.             Type = "Function",
  147.         },
  148.         {
  149.             Name = "RequestRewards",
  150.             Type = "Function",
  151.         },
  152.     },
  153.  
  154.     Events =
  155.     {
  156.         {
  157.             Name = "MythicPlusCurrentAffixUpdate",
  158.             Type = "Event",
  159.             LiteralName = "MYTHIC_PLUS_CURRENT_AFFIX_UPDATE",
  160.         },
  161.         {
  162.             Name = "MythicPlusNewSeasonRecord",
  163.             Type = "Event",
  164.             LiteralName = "MYTHIC_PLUS_NEW_SEASON_RECORD",
  165.             Payload =
  166.             {
  167.                 { Name = "mapChallengeModeID", Type = "number", Nilable = false },
  168.                 { Name = "completionMilliseconds", Type = "number", Nilable = false },
  169.                 { Name = "level", Type = "number", Nilable = false },
  170.             },
  171.         },
  172.         {
  173.             Name = "MythicPlusNewWeeklyRecord",
  174.             Type = "Event",
  175.             LiteralName = "MYTHIC_PLUS_NEW_WEEKLY_RECORD",
  176.             Payload =
  177.             {
  178.                 { Name = "mapChallengeModeID", Type = "number", Nilable = false },
  179.                 { Name = "completionMilliseconds", Type = "number", Nilable = false },
  180.                 { Name = "level", Type = "number", Nilable = false },
  181.             },
  182.         },
  183.     },
  184.  
  185.     Tables =
  186.     {
  187.         {
  188.             Name = "MythicPlusDate",
  189.             Type = "Structure",
  190.             Fields =
  191.             {
  192.                 { Name = "year", Type = "number", Nilable = false },
  193.                 { Name = "month", Type = "number", Nilable = false },
  194.                 { Name = "day", Type = "number", Nilable = false },
  195.                 { Name = "hour", Type = "number", Nilable = false },
  196.                 { Name = "minute", Type = "number", Nilable = false },
  197.             },
  198.         },
  199.         {
  200.             Name = "MythicPlusMember",
  201.             Type = "Structure",
  202.             Fields =
  203.             {
  204.                 { Name = "name", Type = "string", Nilable = true },
  205.                 { Name = "specID", Type = "number", Nilable = false },
  206.                 { Name = "classID", Type = "number", Nilable = false },
  207.             },
  208.         },
  209.     },
  210. };
  211.  
  212. APIDocumentation:AddDocumentationTable(MythicPlusInfo);
__________________
Thomas aka Urnn
  Reply With Quote

WoWInterface » PTR » PTR API and Graphics Changes » Mythic Plus API Documented

Thread Tools
Display Modes

Posting Rules
You may not post new threads
You may not post replies
You may not post attachments
You may not edit your posts

vB code is On
Smilies are On
[IMG] code is On
HTML code is Off