WoW:API GetRealZoneText: Difference between revisions

← Older edit

WoW:API GetRealZoneText (source)

Revision as of 04:46, 15 August 2023

413 bytes added , 15 August 2023

m

Move page script moved page API GetRealZoneText to WoW:API GetRealZoneText without leaving a redirect

Anonymous user

Move page script

@@ Line 1: / Line 1: @@
-<center>'''GetRealZoneText'''</center>
+{{wowapi}} __NOTOC__
   ZoneName = GetRealZoneText();
-Returns the real name of the Zone, e.g. Loch Modan or Elwynn Forest.
+When in an instance, returns the real name of the instance, not the name in the Minimap. (e.g. returns "The Stockade" whereas GetZoneText() returns "Stormwind Stockade"). Otherwise is identical to [[API_GetZoneText|GetZoneText]].
-----
+As of 4.? something this is no longer accurate. These appear to return the same thing. For example: GetInstanceInfo, GetRealZoneText, GetZoneText all return "Stormwind Stockade", however [[API GetMapNameByID|GetMapNameByID(]][[API GetCurrentMapAreaID|GetCurrentMapAreaID())]] now returns "The Stockade". As of 5.3, GetRealZoneText/GetZoneText do *not* always match GetMapNameByID or GetInstanceInfo.
-;''Arguments''
+==Parameters==
+===Arguments===
 :none
-----
+===Returns===
-;''Returns''
+:;ZoneName : String - The real name of an instance or the zone name
-:;ZoneName : String - Returns the real name of the Zone, e.g. Loch Modan or Elwynn Forest.
-----
-;''Example''
-<!-- If it helps, include an example here, though it's not required if the usage is self-explanatory -->
-  ZoneName = GetRealZoneName();
-  message("Zone:"..ZoneName);
-;''Result''
+==Example==
-:An error popup appears that could show the following text: "Zone: Loch Modan"
+  local zoneName = GetRealZoneText();
+  message("Zone: "..zoneName);
-----
+:An error popup appears that could show the following text: "Zone: Stormwind Stockade"