WoW:API GetMapInfo: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
m (Remove singature made using ~ in main namespace)
m (clear unnecessary dash)
Line 21: Line 21:
;''Details''P
;''Details''P


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. --
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.

Revision as of 06:18, 10 February 2007

WoW API < GetMapInfo

mapFileName, textureHeight, textureWidth = 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)

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.