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: @@
-  <center>'''GetSubZoneText''' ''-Documentation by [[user:Meog|Meog]]-''</center>
+{{wowapi}}
+Returns the subzone name.
+  subzone = GetSubZoneText();
-Returns the subzone text
+== Returns ==
+;subzone : String - subzone name or an empty string (if not in a subzone).
- GetSubZoneText();
+== Related events ==
+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}}
-----
+== See also ==
-;''Arguments''
+* {{api|GetZoneText}}
+* {{api|GetMinimapZoneText}}
-:''none''
-----
-;''Returns''
-:String subzone
-:;subzone : string, contains the subzone name, is empty (not nil) when player is not in a subzone
-----
-;''Example''
- local subzone = GetSubZoneText();
-;''Result''
- "Goldshire"
-----
-;''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]].
-<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}}