WoW:API GetZoneText: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
mNo edit summary
m ({{wowapi}}, formatting / grammar)
Line 1: Line 1:
<center>'''GetZoneText''' ''-Documentation by [[user:Meog|Meog]]-''</center>
{{wowapi}}
 
Returns the zone text.
Returns the zone text


  GetZoneText();
  GetZoneText();
Line 13: Line 12:
;''Returns''
;''Returns''


:String zonetext
:
:;zonetext : string, contains the zone name (localized, the client doesn't have an non-localized name)
:;zonetext : String - zone name (localized).


----
----
;''Example''
;''Example''
  local zonetext = GetZoneText();
  local zonetext = GetZoneText();
   
  message(zonetext);


;''Result''
;''Result''
"Elwynn Forest"
: Message box appears displaying your current zone.


----
----
;''Description''
;''Description''


: Returns the zone text, in which the player currently is. The event <tt>"ZONE_CHANGED_NEW_AREA"</tt> is triggered, when the text changes. See also the related functions [[API_GetSubZoneText|GetSubZoneText]] and [[API_GetMinimapZoneText|GetMinimapZoneText]].
: Returns the zone text, in which the player currently is. The event '''ZONE_CHANGED_NEW_AREA''' is triggered when the text changes. See also the related functions [[API_GetSubZoneText|GetSubZoneText]] and [[API_GetMinimapZoneText|GetMinimapZoneText]].
 
: Additional note: Blizzard also registers the event '''ZONE_CHANGED_INDOORS'''. If you know what this event is used for, please edit this page.
<small>Additional note: Blizzard also registers the event <tt>"ZONE_CHANGED_INDOORS"</tt>, please edit the page, if you know, for what it is.</small>
----
{{Template:WoW API}}

Revision as of 12:35, 18 June 2006

← WoW API < GetZoneText

Returns the zone text. 

GetZoneText();
Arguments
none
Returns
zonetext
String - zone name (localized).
Example
local zonetext = GetZoneText();
message(zonetext);
Result
Message box appears displaying your current zone.
Description
Returns the zone text, in which the player currently is. The event ZONE_CHANGED_NEW_AREA is triggered when the text changes. See also the related functions GetSubZoneText and GetMinimapZoneText.
Additional note: Blizzard also registers the event ZONE_CHANGED_INDOORS. If you know what this event is used for, please edit this page.
Retrieved from "https://addonstudio.org/mw/index.php?title=WoW:API_GetZoneText&oldid=4935"