WoW:API UpdateMapHighlight: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
(Best guess version of first pass documentation)
 
m (Move page script moved page API UpdateMapHighlight to API UpdateMapHighlight without leaving a redirect)
 
(3 intermediate revisions by 3 users not shown)
Line 1: Line 1:
<center>'''UpdateMapHighlight''' ''-Documentation by [[user:Flickering|Flickering]]-''</center>
{{wowapi}} __NOTOC__
 
  name, fileName, texPctX, texPctY, texX, texY, scrollX, scrollY = UpdateMapHighlight(x, y);
  name, fileName, texPctX, texPctY, texX, texY, scrollX, scrollY = UpdateMapHighlight(x, y);
Provides rollover region detection for the map frame.
Provides rollover region detection for the map frame.


----
==Parameters==
;''Arguments''
===Arguments===
 
:(x, y)
:;x : Number - X position of the click (A proportion between 0 and 1, relative to WorldMapDetailFrame)
:;x : Number - X position of the click (A proportion between 0 and 1, relative to WorldMapDetailFrame)
:;y : Number - Y position of the click (A proportion between 0 and 1, relative to WorldMapDetailFrame)
:;y : Number - Y position of the click (A proportion between 0 and 1, relative to WorldMapDetailFrame)
 
===Returns===
----
;''Returns''
 
:name, fileName, texPctX, texPctY, texX, texY, scrollX, scrollY
:;name : String - The name of the area which is being pointed at.
:;name : String - The name of the area which is being pointed at.
:;fileName : String - The filename of the highlight texture to use, or <tt>nil</tt> if none.
:;fileName : String - The filename of the highlight texture to use, or <tt>nil</tt> if none.
Line 24: Line 16:
:;scrollX : Number - The X location of the start of the highlight texture as a proportion of the map's width (between 0 and 1)
:;scrollX : Number - The X location of the start of the highlight texture as a proportion of the map's width (between 0 and 1)
:;scrollY : Number - The Y location of the start of the highlight texture as a proportion of the map's height (between 0 and 1)
:;scrollY : Number - The Y location of the start of the highlight texture as a proportion of the map's height (between 0 and 1)
----
{{Template:WoW API}}
[[Category:API World Map Functions|UpdateMapHighlight]]

Latest revision as of 04:47, 15 August 2023

← WoW API < UpdateMapHighlight 

name, fileName, texPctX, texPctY, texX, texY, scrollX, scrollY = UpdateMapHighlight(x, y);

Provides rollover region detection for the map frame.

Parameters[edit]

Arguments[edit]

x
Number - X position of the click (A proportion between 0 and 1, relative to WorldMapDetailFrame)
y
Number - Y position of the click (A proportion between 0 and 1, relative to WorldMapDetailFrame)

Returns[edit]

name
String - The name of the area which is being pointed at.
fileName
String - The filename of the highlight texture to use, or nil if none.
texPctX
Number - Proportion of the highlight texture's full width to use (proportion from 0 to 1) this is a guess
texPctY
Number - Proportion of the highlight texture's full height to use (proportion from 0 to 1) this is a guess
texX
Number - The width of the highlight texture as a proportion of the map's width (between 0 and 1)
texY
Number - The height of the highlight texture as a proportion of the map's height (between 0 and 1)
scrollX
Number - The X location of the start of the highlight texture as a proportion of the map's width (between 0 and 1)
scrollY
Number - The Y location of the start of the highlight texture as a proportion of the map's height (between 0 and 1)
Retrieved from "https://addonstudio.org/mw/index.php?title=WoW:API_UpdateMapHighlight&oldid=20113"