WoW:API GetMapInfo: Difference between revisions
Jump to navigation
Jump to search
m (clear unnecessary dash) |
mNo edit summary |
||
| Line 1: | Line 1: | ||
{{wowapi}} __NOTOC__ | {{wowapi}} __NOTOC__ | ||
mapFileName, textureHeight, textureWidth = GetMapInfo(); | mapFileName, textureHeight, textureWidth, isMicrodungeon, microDungeonMapName = GetMapInfo(); | ||
Return the map information about the current world map texture. | Return the map information about the current world map texture. | ||
| Line 17: | Line 17: | ||
:;textureHeight : Number - The height of the specified texture (0 if no texture) | :;textureHeight : Number - The height of the specified texture (0 if no texture) | ||
:;textureWidth : Number - The width of the specified texture (0 if no texture) (<small>This is a guess, it's not used in the UI</small>) | :;textureWidth : Number - The width of the specified texture (0 if no texture) (<small>This is a guess, it's not used in the UI</small>) | ||
:;isMicroDungeon : Boolean - True if the current map is a MicroDungeon, False otherwise. | |||
:;microDungeonMapName : String - The name of the map for the current MicroDungeon, if applicable. (ex. ShrineofSevenStars) | |||
---- | ---- | ||
Revision as of 15:55, 19 May 2013
← WoW API < GetMapInfo
mapFileName, textureHeight, textureWidth, isMicrodungeon, microDungeonMapName = GetMapInfo();
Return the map information about the current world map texture.
- Arguments
- none
- Returns
- mapFileName, textureHeight, textureWidth
- mapFileName
- String - The name of the file containing the textures for the current world map (nil for the whole world, BUT the official API catches this with a comment of Temporary Hack and uses the value "World" instead!)
- textureHeight
- Number - The height of the specified texture (0 if no texture)
- textureWidth
- Number - The width of the specified texture (0 if no texture) (This is a guess, it's not used in the UI)
- isMicroDungeon
- Boolean - True if the current map is a MicroDungeon, False otherwise.
- microDungeonMapName
- String - The name of the map for the current MicroDungeon, if applicable. (ex. ShrineofSevenStars)
- DetailsP
Note that the width and height aren't in a consistent order with most of the other API functions. Neither of the values are used by the UI so it's impossible to tell whether this is a deliberate inconsistency or a typo! The return values would appear to imply they are, however, reversed from the usual width, height convention.