WoW:API GetSubZoneText: Difference between revisions

Latest revision as of 04:46, 15 August 2023

Reference e
AddOns WoW API Widget API XML UI Event API WoW Lua Macro API CVars Battle.net HOWTOs Snippets UI tech Categories

Returns the subzone name.

subzone = GetSubZoneText();

One or more of the following fire when the player enters a new zone:

@@ Line 1: / Line 1: @@
 {{wowapi}}
 Returns the subzone name.
+ subzone = GetSubZoneText();
- GetSubZoneText();
+== Returns ==
+;subzone : String - subzone name or an empty string (if not in a subzone).
-----
+== Related events ==
-;''Arguments''
+One or more of the following fire when the player enters a new zone:
+* {{api|t=e|ZONE_CHANGED}}
+* {{api|t=e|ZONE_CHANGED_INDOORS}}
+* {{api|t=e|ZONE_CHANGED_NEW_AREA}}
-:''none''
+== See also ==
+* {{api|GetZoneText}}
-----
+* {{api|GetMinimapZoneText}}
-;''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 [[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.