Blizzard_APIDocumentation/MapDocumentation.lua

Blizzard_APIDocumentation/MapDocumentation.lua (9.1.5.40906; unchanged since 9.0.5.37864)
  1. local Map =
  2. {
  3. Name = "MapUI",
  4. Type = "System",
  5. Namespace = "C_Map",
  6. Functions =
  7. {
  8. {
  9. Name = "CanSetUserWaypointOnMap",
  10. Type = "Function",
  11. Arguments =
  12. {
  13. { Name = "uiMapID", Type = "number", Nilable = false },
  14. },
  15. Returns =
  16. {
  17. { Name = "canSet", Type = "bool", Nilable = false },
  18. },
  19. },
  20. {
  21. Name = "ClearUserWaypoint",
  22. Type = "Function",
  23. },
  24. {
  25. Name = "CloseWorldMapInteraction",
  26. Type = "Function",
  27. },
  28. {
  29. Name = "GetAreaInfo",
  30. Type = "Function",
  31. Arguments =
  32. {
  33. { Name = "areaID", Type = "number", Nilable = false },
  34. },
  35. Returns =
  36. {
  37. { Name = "name", Type = "string", Nilable = false },
  38. },
  39. },
  40. {
  41. Name = "GetBestMapForUnit",
  42. Type = "Function",
  43. Documentation = { "Only works for the player and party members." },
  44. Arguments =
  45. {
  46. { Name = "unitToken", Type = "string", Nilable = false },
  47. },
  48. Returns =
  49. {
  50. { Name = "uiMapID", Type = "number", Nilable = true },
  51. },
  52. },
  53. {
  54. Name = "GetBountySetMaps",
  55. Type = "Function",
  56. Arguments =
  57. {
  58. { Name = "bountySetID", Type = "number", Nilable = false },
  59. },
  60. Returns =
  61. {
  62. { Name = "mapIDs", Type = "table", InnerType = "number", Nilable = false },
  63. },
  64. },
  65. {
  66. Name = "GetFallbackWorldMapID",
  67. Type = "Function",
  68. Returns =
  69. {
  70. { Name = "uiMapID", Type = "number", Nilable = false },
  71. },
  72. },
  73. {
  74. Name = "GetMapArtBackgroundAtlas",
  75. Type = "Function",
  76. Arguments =
  77. {
  78. { Name = "uiMapID", Type = "number", Nilable = false },
  79. },
  80. Returns =
  81. {
  82. { Name = "atlasName", Type = "string", Nilable = false },
  83. },
  84. },
  85. {
  86. Name = "GetMapArtHelpTextPosition",
  87. Type = "Function",
  88. Arguments =
  89. {
  90. { Name = "uiMapID", Type = "number", Nilable = false },
  91. },
  92. Returns =
  93. {
  94. { Name = "position", Type = "MapCanvasPosition", Nilable = false },
  95. },
  96. },
  97. {
  98. Name = "GetMapArtID",
  99. Type = "Function",
  100. Arguments =
  101. {
  102. { Name = "uiMapID", Type = "number", Nilable = false },
  103. },
  104. Returns =
  105. {
  106. { Name = "uiMapArtID", Type = "number", Nilable = false },
  107. },
  108. },
  109. {
  110. Name = "GetMapArtLayerTextures",
  111. Type = "Function",
  112. Arguments =
  113. {
  114. { Name = "uiMapID", Type = "number", Nilable = false },
  115. { Name = "layerIndex", Type = "number", Nilable = false },
  116. },
  117. Returns =
  118. {
  119. { Name = "textures", Type = "table", InnerType = "number", Nilable = false },
  120. },
  121. },
  122. {
  123. Name = "GetMapArtLayers",
  124. Type = "Function",
  125. Arguments =
  126. {
  127. { Name = "uiMapID", Type = "number", Nilable = false },
  128. },
  129. Returns =
  130. {
  131. { Name = "layerInfo", Type = "table", InnerType = "UiMapLayerInfo", Nilable = false },
  132. },
  133. },
  134. {
  135. Name = "GetMapBannersForMap",
  136. Type = "Function",
  137. Arguments =
  138. {
  139. { Name = "uiMapID", Type = "number", Nilable = false },
  140. },
  141. Returns =
  142. {
  143. { Name = "mapBanners", Type = "table", InnerType = "MapBannerInfo", Nilable = false },
  144. },
  145. },
  146. {
  147. Name = "GetMapChildrenInfo",
  148. Type = "Function",
  149. Arguments =
  150. {
  151. { Name = "uiMapID", Type = "number", Nilable = false },
  152. { Name = "mapType", Type = "UIMapType", Nilable = true },
  153. { Name = "allDescendants", Type = "bool", Nilable = true },
  154. },
  155. Returns =
  156. {
  157. { Name = "info", Type = "table", InnerType = "UiMapDetails", Nilable = false },
  158. },
  159. },
  160. {
  161. Name = "GetMapDisplayInfo",
  162. Type = "Function",
  163. Arguments =
  164. {
  165. { Name = "uiMapID", Type = "number", Nilable = false },
  166. },
  167. Returns =
  168. {
  169. { Name = "hideIcons", Type = "bool", Nilable = false },
  170. },
  171. },
  172. {
  173. Name = "GetMapGroupID",
  174. Type = "Function",
  175. Arguments =
  176. {
  177. { Name = "uiMapID", Type = "number", Nilable = false },
  178. },
  179. Returns =
  180. {
  181. { Name = "uiMapGroupID", Type = "number", Nilable = false },
  182. },
  183. },
  184. {
  185. Name = "GetMapGroupMembersInfo",
  186. Type = "Function",
  187. Arguments =
  188. {
  189. { Name = "uiMapGroupID", Type = "number", Nilable = false },
  190. },
  191. Returns =
  192. {
  193. { Name = "info", Type = "table", InnerType = "UiMapGroupMemberInfo", Nilable = false },
  194. },
  195. },
  196. {
  197. Name = "GetMapHighlightInfoAtPosition",
  198. Type = "Function",
  199. Arguments =
  200. {
  201. { Name = "uiMapID", Type = "number", Nilable = false },
  202. { Name = "x", Type = "number", Nilable = false },
  203. { Name = "y", Type = "number", Nilable = false },
  204. },
  205. Returns =
  206. {
  207. { Name = "fileDataID", Type = "number", Nilable = false },
  208. { Name = "atlasID", Type = "string", Nilable = false },
  209. { Name = "texturePercentageX", Type = "number", Nilable = false },
  210. { Name = "texturePercentageY", Type = "number", Nilable = false },
  211. { Name = "textureX", Type = "number", Nilable = false },
  212. { Name = "textureY", Type = "number", Nilable = false },
  213. { Name = "scrollChildX", Type = "number", Nilable = false },
  214. { Name = "scrollChildY", Type = "number", Nilable = false },
  215. },
  216. },
  217. {
  218. Name = "GetMapInfo",
  219. Type = "Function",
  220. Arguments =
  221. {
  222. { Name = "uiMapID", Type = "number", Nilable = false },
  223. },
  224. Returns =
  225. {
  226. { Name = "info", Type = "UiMapDetails", Nilable = false },
  227. },
  228. },
  229. {
  230. Name = "GetMapInfoAtPosition",
  231. Type = "Function",
  232. Arguments =
  233. {
  234. { Name = "uiMapID", Type = "number", Nilable = false },
  235. { Name = "x", Type = "number", Nilable = false },
  236. { Name = "y", Type = "number", Nilable = false },
  237. },
  238. Returns =
  239. {
  240. { Name = "info", Type = "UiMapDetails", Nilable = false },
  241. },
  242. },
  243. {
  244. Name = "GetMapLevels",
  245. Type = "Function",
  246. Arguments =
  247. {
  248. { Name = "uiMapID", Type = "number", Nilable = false },
  249. },
  250. Returns =
  251. {
  252. { Name = "playerMinLevel", Type = "number", Nilable = false },
  253. { Name = "playerMaxLevel", Type = "number", Nilable = false },
  254. { Name = "petMinLevel", Type = "number", Nilable = false, Default = 0 },
  255. { Name = "petMaxLevel", Type = "number", Nilable = false, Default = 0 },
  256. },
  257. },
  258. {
  259. Name = "GetMapLinksForMap",
  260. Type = "Function",
  261. Arguments =
  262. {
  263. { Name = "uiMapID", Type = "number", Nilable = false },
  264. },
  265. Returns =
  266. {
  267. { Name = "mapLinks", Type = "table", InnerType = "MapLinkInfo", Nilable = false },
  268. },
  269. },
  270. {
  271. Name = "GetMapPosFromWorldPos",
  272. Type = "Function",
  273. Arguments =
  274. {
  275. { Name = "continentID", Type = "number", Nilable = false },
  276. { Name = "worldPosition", Type = "table", Mixin = "Vector2DMixin", Nilable = false },
  277. { Name = "overrideUiMapID", Type = "number", Nilable = true },
  278. },
  279. Returns =
  280. {
  281. { Name = "uiMapID", Type = "number", Nilable = false },
  282. { Name = "mapPosition", Type = "table", Mixin = "Vector2DMixin", Nilable = false },
  283. },
  284. },
  285. {
  286. Name = "GetMapRectOnMap",
  287. Type = "Function",
  288. Arguments =
  289. {
  290. { Name = "uiMapID", Type = "number", Nilable = false },
  291. { Name = "topUiMapID", Type = "number", Nilable = false },
  292. },
  293. Returns =
  294. {
  295. { Name = "minX", Type = "number", Nilable = false },
  296. { Name = "maxX", Type = "number", Nilable = false },
  297. { Name = "minY", Type = "number", Nilable = false },
  298. { Name = "maxY", Type = "number", Nilable = false },
  299. },
  300. },
  301. {
  302. Name = "GetMapWorldSize",
  303. Type = "Function",
  304. Documentation = { "Returns the size in yards of the area represented by the map." },
  305. Arguments =
  306. {
  307. { Name = "uiMapID", Type = "number", Nilable = false },
  308. },
  309. Returns =
  310. {
  311. { Name = "width", Type = "number", Nilable = false },
  312. { Name = "height", Type = "number", Nilable = false },
  313. },
  314. },
  315. {
  316. Name = "GetPlayerMapPosition",
  317. Type = "Function",
  318. Documentation = { "Only works for the player and party members." },
  319. Arguments =
  320. {
  321. { Name = "uiMapID", Type = "number", Nilable = false },
  322. { Name = "unitToken", Type = "string", Nilable = false },
  323. },
  324. Returns =
  325. {
  326. { Name = "position", Type = "table", Mixin = "Vector2DMixin", Nilable = true },
  327. },
  328. },
  329. {
  330. Name = "GetUserWaypoint",
  331. Type = "Function",
  332. Returns =
  333. {
  334. { Name = "point", Type = "table", Nilable = false },
  335. },
  336. },
  337. {
  338. Name = "GetUserWaypointFromHyperlink",
  339. Type = "Function",
  340. Arguments =
  341. {
  342. { Name = "hyperlink", Type = "string", Nilable = false },
  343. },
  344. Returns =
  345. {
  346. { Name = "point", Type = "table", Nilable = false },
  347. },
  348. },
  349. {
  350. Name = "GetUserWaypointHyperlink",
  351. Type = "Function",
  352. Returns =
  353. {
  354. { Name = "hyperlink", Type = "string", Nilable = false },
  355. },
  356. },
  357. {
  358. Name = "GetUserWaypointPositionForMap",
  359. Type = "Function",
  360. Arguments =
  361. {
  362. { Name = "uiMapID", Type = "number", Nilable = false },
  363. },
  364. Returns =
  365. {
  366. { Name = "mapPosition", Type = "table", Mixin = "Vector2DMixin", Nilable = false },
  367. },
  368. },
  369. {
  370. Name = "GetWorldPosFromMapPos",
  371. Type = "Function",
  372. Arguments =
  373. {
  374. { Name = "uiMapID", Type = "number", Nilable = false },
  375. { Name = "mapPosition", Type = "table", Mixin = "Vector2DMixin", Nilable = false },
  376. },
  377. Returns =
  378. {
  379. { Name = "continentID", Type = "number", Nilable = false },
  380. { Name = "worldPosition", Type = "table", Mixin = "Vector2DMixin", Nilable = false },
  381. },
  382. },
  383. {
  384. Name = "HasUserWaypoint",
  385. Type = "Function",
  386. Returns =
  387. {
  388. { Name = "hasUserWaypoint", Type = "bool", Nilable = false },
  389. },
  390. },
  391. {
  392. Name = "IsMapValidForNavBarDropDown",
  393. Type = "Function",
  394. Arguments =
  395. {
  396. { Name = "uiMapID", Type = "number", Nilable = false },
  397. },
  398. Returns =
  399. {
  400. { Name = "isValid", Type = "bool", Nilable = false },
  401. },
  402. },
  403. {
  404. Name = "MapHasArt",
  405. Type = "Function",
  406. Arguments =
  407. {
  408. { Name = "uiMapID", Type = "number", Nilable = false },
  409. },
  410. Returns =
  411. {
  412. { Name = "hasArt", Type = "bool", Nilable = false },
  413. },
  414. },
  415. {
  416. Name = "RequestPreloadMap",
  417. Type = "Function",
  418. Arguments =
  419. {
  420. { Name = "uiMapID", Type = "number", Nilable = false },
  421. },
  422. },
  423. {
  424. Name = "SetUserWaypoint",
  425. Type = "Function",
  426. Arguments =
  427. {
  428. { Name = "point", Type = "table", Nilable = false },
  429. },
  430. },
  431. },
  432. Events =
  433. {
  434. {
  435. Name = "NewWmoChunk",
  436. Type = "Event",
  437. LiteralName = "NEW_WMO_CHUNK",
  438. },
  439. {
  440. Name = "UserWaypointUpdated",
  441. Type = "Event",
  442. LiteralName = "USER_WAYPOINT_UPDATED",
  443. },
  444. {
  445. Name = "WorldMapClose",
  446. Type = "Event",
  447. LiteralName = "WORLD_MAP_CLOSE",
  448. },
  449. {
  450. Name = "WorldMapOpen",
  451. Type = "Event",
  452. LiteralName = "WORLD_MAP_OPEN",
  453. Payload =
  454. {
  455. { Name = "uiMapID", Type = "number", Nilable = false },
  456. },
  457. },
  458. {
  459. Name = "ZoneChanged",
  460. Type = "Event",
  461. LiteralName = "ZONE_CHANGED",
  462. },
  463. {
  464. Name = "ZoneChangedIndoors",
  465. Type = "Event",
  466. LiteralName = "ZONE_CHANGED_INDOORS",
  467. },
  468. {
  469. Name = "ZoneChangedNewArea",
  470. Type = "Event",
  471. LiteralName = "ZONE_CHANGED_NEW_AREA",
  472. },
  473. },
  474. Tables =
  475. {
  476. {
  477. Name = "MapCanvasPosition",
  478. Type = "Enumeration",
  479. NumValues = 5,
  480. MinValue = 0,
  481. MaxValue = 4,
  482. Fields =
  483. {
  484. { Name = "None", Type = "MapCanvasPosition", EnumValue = 0 },
  485. { Name = "BottomLeft", Type = "MapCanvasPosition", EnumValue = 1 },
  486. { Name = "BottomRight", Type = "MapCanvasPosition", EnumValue = 2 },
  487. { Name = "TopLeft", Type = "MapCanvasPosition", EnumValue = 3 },
  488. { Name = "TopRight", Type = "MapCanvasPosition", EnumValue = 4 },
  489. },
  490. },
  491. {
  492. Name = "UIMapFlag",
  493. Type = "Enumeration",
  494. NumValues = 17,
  495. MinValue = 1,
  496. MaxValue = 65536,
  497. Fields =
  498. {
  499. { Name = "NoHighlight", Type = "UIMapFlag", EnumValue = 1 },
  500. { Name = "ShowOverlays", Type = "UIMapFlag", EnumValue = 2 },
  501. { Name = "ShowTaxiNodes", Type = "UIMapFlag", EnumValue = 4 },
  502. { Name = "GarrisonMap", Type = "UIMapFlag", EnumValue = 8 },
  503. { Name = "FallbackToParentMap", Type = "UIMapFlag", EnumValue = 16 },
  504. { Name = "NoHighlightTexture", Type = "UIMapFlag", EnumValue = 32 },
  505. { Name = "ShowTaskObjectives", Type = "UIMapFlag", EnumValue = 64 },
  506. { Name = "NoWorldPositions", Type = "UIMapFlag", EnumValue = 128 },
  507. { Name = "HideArchaeologyDigs", Type = "UIMapFlag", EnumValue = 256 },
  508. { Name = "Deprecated", Type = "UIMapFlag", EnumValue = 512 },
  509. { Name = "HideIcons", Type = "UIMapFlag", EnumValue = 1024 },
  510. { Name = "HideVignettes", Type = "UIMapFlag", EnumValue = 2048 },
  511. { Name = "ForceAllOverlayExplored", Type = "UIMapFlag", EnumValue = 4096 },
  512. { Name = "FlightMapShowZoomOut", Type = "UIMapFlag", EnumValue = 8192 },
  513. { Name = "FlightMapAutoZoom", Type = "UIMapFlag", EnumValue = 16384 },
  514. { Name = "ForceOnNavbar", Type = "UIMapFlag", EnumValue = 32768 },
  515. { Name = "AlwaysAllowUserWaypoints", Type = "UIMapFlag", EnumValue = 65536 },
  516. },
  517. },
  518. {
  519. Name = "UIMapSystem",
  520. Type = "Enumeration",
  521. NumValues = 4,
  522. MinValue = 0,
  523. MaxValue = 3,
  524. Fields =
  525. {
  526. { Name = "World", Type = "UIMapSystem", EnumValue = 0 },
  527. { Name = "Taxi", Type = "UIMapSystem", EnumValue = 1 },
  528. { Name = "Adventure", Type = "UIMapSystem", EnumValue = 2 },
  529. { Name = "Minimap", Type = "UIMapSystem", EnumValue = 3 },
  530. },
  531. },
  532. {
  533. Name = "UIMapType",
  534. Type = "Enumeration",
  535. NumValues = 7,
  536. MinValue = 0,
  537. MaxValue = 6,
  538. Fields =
  539. {
  540. { Name = "Cosmic", Type = "UIMapType", EnumValue = 0 },
  541. { Name = "World", Type = "UIMapType", EnumValue = 1 },
  542. { Name = "Continent", Type = "UIMapType", EnumValue = 2 },
  543. { Name = "Zone", Type = "UIMapType", EnumValue = 3 },
  544. { Name = "Dungeon", Type = "UIMapType", EnumValue = 4 },
  545. { Name = "Micro", Type = "UIMapType", EnumValue = 5 },
  546. { Name = "Orphan", Type = "UIMapType", EnumValue = 6 },
  547. },
  548. },
  549. {
  550. Name = "MapBannerInfo",
  551. Type = "Structure",
  552. Fields =
  553. {
  554. { Name = "areaPoiID", Type = "number", Nilable = false },
  555. { Name = "name", Type = "string", Nilable = false },
  556. { Name = "atlasName", Type = "string", Nilable = false },
  557. { Name = "uiTextureKit", Type = "string", Nilable = true },
  558. },
  559. },
  560. {
  561. Name = "MapLinkInfo",
  562. Type = "Structure",
  563. Fields =
  564. {
  565. { Name = "areaPoiID", Type = "number", Nilable = false },
  566. { Name = "position", Type = "table", Mixin = "Vector2DMixin", Nilable = false },
  567. { Name = "name", Type = "string", Nilable = false },
  568. { Name = "atlasName", Type = "string", Nilable = false },
  569. { Name = "linkedUiMapID", Type = "number", Nilable = false },
  570. },
  571. },
  572. {
  573. Name = "UiMapDetails",
  574. Type = "Structure",
  575. Fields =
  576. {
  577. { Name = "mapID", Type = "number", Nilable = false },
  578. { Name = "name", Type = "string", Nilable = false },
  579. { Name = "mapType", Type = "UIMapType", Nilable = false },
  580. { Name = "parentMapID", Type = "number", Nilable = false },
  581. { Name = "flags", Type = "number", Nilable = false },
  582. },
  583. },
  584. {
  585. Name = "UiMapGroupMemberInfo",
  586. Type = "Structure",
  587. Fields =
  588. {
  589. { Name = "mapID", Type = "number", Nilable = false },
  590. { Name = "relativeHeightIndex", Type = "number", Nilable = false },
  591. { Name = "name", Type = "string", Nilable = false },
  592. },
  593. },
  594. {
  595. Name = "UiMapLayerInfo",
  596. Type = "Structure",
  597. Fields =
  598. {
  599. { Name = "layerWidth", Type = "number", Nilable = false },
  600. { Name = "layerHeight", Type = "number", Nilable = false },
  601. { Name = "tileWidth", Type = "number", Nilable = false },
  602. { Name = "tileHeight", Type = "number", Nilable = false },
  603. { Name = "minScale", Type = "number", Nilable = false },
  604. { Name = "maxScale", Type = "number", Nilable = false },
  605. { Name = "additionalZoomSteps", Type = "number", Nilable = false },
  606. },
  607. },
  608. },
  609. };
  610. APIDocumentation:AddDocumentationTable(Map);