WoW:API SetMapZoom: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
No edit summary
 
m (Recategorized)
Line 1: Line 1:
  <center>'''SetMapZoom''' ''-Documentation by [[user:Meog|Meog]]-''</center>
  <center>'''SetMapZoom''' ''-Documentation by [[user:Meog|Meog]]-''</center>


Sets the zoom to a specific zone
Sets what is displayed by the current world map to a specific continent and zone.


  SetMapZoom(continent, zone)
  SetMapZoom(continentIndex [,zoneIndex])


----
----
;''Arguments''
;''Arguments''


:Number continent, Number zone
:(continentIndex [,zoneIndex])
:;continent : number specifies the continent corresponding to the numbers of [[API_GetCurrentMapContinent|GetCurrentMapContinent]]
:;continentIndex : Number - Specifies the continent corresponding to the numbers of [[API_GetMapContinents|GetMapContinents()]], or 0 for whole world.
:;zone : number specifies the zone corresponding to the numbers of [[API_GetCurrentMapZone|GetCurrentMapZone]]
:;zoneIndex : Number - Specifies the zone corresponding to the numbers of [[API_GetMapZones|GetMapZones(continentIndex)]], omit for whole continent.
 
----
;''Returns''
 
:;nil


----
----
Line 21: Line 16:
  SetMapZoom(2, 10); -- 1.
  SetMapZoom(2, 10); -- 1.
  SetMapZoom(2, nil); -- 2.
  SetMapZoom(2, nil); -- 2.
  SetMapZoom(0, nil); -- 3.
SetMapZoom(2); -- 2.
  SetMapZoom(0); -- 3.


;''Result''
;''Result''
Line 28: Line 24:
  3. Shows both continents
  3. Shows both continents


----
;''Description''
: Sets the zoom to a specific zone.
----
----
{{Template:WoW API}}
{{Template:WoW API}}
[[Category:API World Map Functions|SetMapZoom]]

Revision as of 19:22, 28 December 2004

SetMapZoom -Documentation by Meog-

Sets what is displayed by the current world map to a specific continent and zone.

SetMapZoom(continentIndex [,zoneIndex])

Arguments
(continentIndex [,zoneIndex])
continentIndex
Number - Specifies the continent corresponding to the numbers of GetMapContinents(), or 0 for whole world.
zoneIndex
Number - Specifies the zone corresponding to the numbers of GetMapZones(continentIndex), omit for whole continent.

Example
SetMapZoom(2, 10); -- 1.
SetMapZoom(2, nil); -- 2.
SetMapZoom(2); -- 2.
SetMapZoom(0); -- 3.
Result
1. Set the current map zoom of the world map to Elvynn Forrest.
2. Shows the Eastern Kingdoms
3. Shows both continents

Template:WoW API