WoW:API GetSubZoneText: Difference between revisions

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


  GetSubZoneText();
  GetSubZoneText();
Line 14: Line 13:


:String subzone
:String subzone
:;subzone : string, contains the subzone name, is empty (not nil) when player is not in a subzone
:;subzone : string, subzone name or an empty string (if not in a subzone).


----
----
;''Example''
;''Example''
  local subzone = GetSubZoneText();
  local subzone = GetSubZoneText();
   
  message(subzone);


;''Result''
;''Result''
  "Goldshire"
  Message box appears with current subzone text.


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


: Returns the subzone text, if the player is a subzone. The event <tt>"ZONE_CHANGED"</tt> is triggered, when the text changes. See also the related functions [[API_GetMinimapZoneText|GetMinimapZoneText]] and [[API_GetZoneText|GetZoneText]].
: Returns the subzone text, if the player is a subzone. The event '"ZONE_CHANGED"' is triggered when the text changes. See also the related functions [[API_GetMinimapZoneText|GetMinimapZoneText]] and [[API_GetZoneText|GetZoneText]].
 
: Additional note: Blizzard also registers the event '''ZONE_CHANGED_INDOORS'''. If you know what this event is used for, please edit the 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:38, 18 June 2006

WoW API < GetSubZoneText

Returns the subzone name.

GetSubZoneText();

Arguments
none

Returns
String subzone
subzone
string, subzone name or an empty string (if not in a subzone).

Example
local subzone = GetSubZoneText();
message(subzone);
Result
Message box appears with current subzone text.

Description
Returns the subzone text, if the player is a subzone. The event '"ZONE_CHANGED"' is triggered when the text changes. See also the related functions GetMinimapZoneText and GetZoneText.
Additional note: Blizzard also registers the event ZONE_CHANGED_INDOORS. If you know what this event is used for, please edit the page.