WoW:Getting the current interface number: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
(Wrong build number)
m (Move page script moved page Getting the current interface number to Getting the current interface number without leaving a redirect)
 
(2 intermediate revisions by one other user not shown)
Line 1: Line 1:
{{UIHowTo}}
{{wow/uihowto}}
When loading the interface, the WoW client skips over any [[AddOn]]s whose interface version does not match its own. This is an effort to keep the client's behavior free of errors due to changes in the API. Each AddOn specifies (in its [[TOC format|.toc file]]) the interface version with which it complies. So an AddOn's .toc file most likely contains a line similar to:
The WoW 'interface number' is important for WoW [[AddOn]]s and can be difficult to find.
## Interface: 70000
 
Here, 70000 would mean that the AddOn is designed against the Patch 7.0.0 client (which doesn't technically exist, [[Patch 7.0.3]] is the pre-patch release). If the interface was only compatible with a specific release like Patch 7.0.3 it most likely contains a line similar to:
== Interface number basics ==
The WoW 'interface number' is the current version for the actual UI in WoW. AddOns use this number in their own [[TOC file]] to denote the WoW user interface they were created for.
 
By default the WoW client skips over any AddOns whose interface version does not match its own. This is an effort to keep the client's behavior free of errors due to changes in the API.
 
In the AddOn TOC file:
 
  ## Interface: 70000
  ## Interface: 70000


== Reference ==
Interface number 70000 would mean that the AddOn is compatible with WoW Patch 7.0.3. The same interface number can be used for a series of WoW patches, usually until the next 'minor' release version. For example for with WoW Patch 7.1.0, 70100 would likely be the new interface version number.
 
== Editions, patches and PTRs ==
With the addition of WoW Classic and now having two different WoWs, there are now multiple TOC interface version numbers "live" at the same time. WoW 'Classic' uses the older versions similar to the versions of the original game, starting with 1.X, and has differently numbered versions from 'Retail' which is the name for regular WoW.
 
The truth is that there are were always multiple versions of WoW, as far as PTRs, betas and so forth. But each version now has its own distinct folder under the World of Warcraft install folder, like '_retail_', '_classic_', '_ptr_'. Each of those folders has a its own set of 'WTF', 'Interface/AddOns', and other files and folders. Keep this in mind when using the following ways below.
 
=== Two versions ===
If an addon is released for both classic and retail, and wanted matching numbers for each to load without the out-of-date warning, there need to be two copies. There would need to be a retail release with the retail TOC version, and classic release with the classic TOC version.
 
== Finding the number ==
There are a number of ways to get the current interface version:
There are a number of ways to get the current interface version:
* See the latest '[[Patch 5.4.0|patch notes]]' and look for the 'Interface' number in the Patch box.
:: This is the most authoritative source on the Wiki.


* The '''current''' number probably is '{{API LatestInterface}}', from our WoWWIki 'Interface Version' template {{t|API LatestInterface}}
==== 1. Wiki patch notes ====
:: But this number is [[Template:API LatestInterface|maintained manualy]], so it ''might'' be out of date.
: See the latest 'patch notes' and look for the 'Interface' number in the Patch box.
: This is the most authoritative source on the Wiki.
 
==== 2. 'API LatestInterface' wiki template ====
: The WoWWiki 'Interface Version' template {{t|API LatestInterface}}
: But this number is [[Template:API LatestInterface|maintained manualy]], so it ''might'' be out of date.
 
==== 3. WoW major minor version ====
: The interface number is usually derived exactly from WoW 'major.minor' version. Sometimes is derived from 'major.minor.release'.
 
: In 2.4.0, where 2 is the major version number, and .4 is the minor version number, is 20400. 5.4.0 is 50400 and, 5.4.1 (.1 being the 'sub-minor' or 'release' version) would likely be 50401. However, [[Blizzard]] doesn't often distinguish on the sub-minor version level, so you would still use 50400. However with patch 8.2.5, for example, the interface number is actually 80205.
 
==== 4. <s>WoW FrameXML.toc</s> ====
: Extract and check FrameXML.toc (no longer works, interface number is no longer in the FrameXML.toc). See [[Extracting WoW user interface files]].
: or ''DEPRECATED, not updated since Oct. 2010'' You can download Blizzard's  User Interface Customization tool], use it to extract interface data, and peek at 'World of Warcraft\Blizzard Interface Data (usUS)\FrameXML\FrameXML.toc'. See [[Interface AddOn Kit]] for history of the tool kit.


* Its usually derrived exactly from 'major.minor' version
==== 5. From another AddOn ====
:: 2.4.0 (i.e. 2 being the major version number and .4 being the minor version number) is 20400, 5.4.0 is 50400 and, 5.4.1 (.1 being the sub-minor version) would likely be 50401 (however, [[Blizz]]ard doesn't appear to distinguish on the sub-minor version level, so you would still use 50400).
: Steal it from another AddOn
: Recently updated AddOns, which are not listed as "out of date" by the client contain the latest Interface version in their toc tag.


* Extract FrameXML and check FrameXML.toc
==== 6. 'lastAddonVersion' in Config.wtf ====
:: See [[Extracting interface files]]
: Find the 'WTF/Config.wtf' file in your 'World of Warcraft/_retail_' or 'World of Warcraft/_classic_' folder, then the 'lastAddonVersion' [[CVar]]
:: or ''DEPRECATED, not updated since Oct. 2010'' You can download Blizzard's [https://us.battle.net/support/en/article/33747 User Interface Customization tool], use it to extract interface data, and peek at <code>World of Warcraft\Blizzard Interface Data (usUS)\FrameXML\FrameXML.toc</code>
: This is the most authoritative source for the interface number.


* Steal it from another AddOn
: Must run WoW at least once after install or patch for this to show up.
:: Recently updated AddOns, which are not listed as "out of date" by the client contain the latest Interface version in their toc tag.


* Use {{api|GetBuildInfo}}
==== 7. The Wow API GetBuildInfo ====
:: In particular, <code>/run print((select(4, GetBuildInfo())));</code> should output the correct version to your chat frame.
: Use {{api|GetBuildInfo}} to verify the 'major.minor' version number.
: <pre>/run print((select(4, GetBuildInfo())))</pre>
: Above should output the WoW build version to your chat frame.


* View FrameXML.toc online
==== 8. <s>WoW FrameXML.toc on the Web</s> ====
:: For instance at {{tlylink|FrameXML.toc}}<!--{{wdnlink|FrameXML/FrameXML.toc}}-->.
: View FrameXML.toc online (no longer works, interface number is no longer in the FrameXML.toc) For example: {{WoW/reslink|FrameXML.toc}}.<!--{{tlylink|FrameXML.toc}} {{wdnlink|FrameXML/FrameXML.toc}}-->


== Notes ==
== Notes ==
* In the past Extract FrameXML and check FrameXML.toc
* In the past Extract FrameXML and check FrameXML.toc - ''DEPRECATED, not updated since Oct. 2010''
:: ''DEPRECATED, not updated since Oct. 2010''
* In the past you could also download Blizzard's [https://us.battle.net/support/en/article/33747 User Interface Customization tool], use it to extract interface data, and peek at <code>World of Warcraft\Blizzard Interface Data (usUS)\FrameXML\FrameXML.toc</code>
:: You can download Blizzard's [https://us.battle.net/support/en/article/33747 User Interface Customization tool], use it to extract interface data, and peek at <code>World of Warcraft\Blizzard Interface Data (usUS)\FrameXML\FrameXML.toc</code>
[[Category:World of Warcraft API]]
[[Category:World of Warcraft API]]

Latest revision as of 04:48, 15 August 2023

HOWTOs

The WoW 'interface number' is important for WoW AddOns and can be difficult to find.

Interface number basics[edit]

The WoW 'interface number' is the current version for the actual UI in WoW. AddOns use this number in their own TOC file to denote the WoW user interface they were created for.

By default the WoW client skips over any AddOns whose interface version does not match its own. This is an effort to keep the client's behavior free of errors due to changes in the API.

In the AddOn TOC file:

## Interface: 70000

Interface number 70000 would mean that the AddOn is compatible with WoW Patch 7.0.3. The same interface number can be used for a series of WoW patches, usually until the next 'minor' release version. For example for with WoW Patch 7.1.0, 70100 would likely be the new interface version number.

Editions, patches and PTRs[edit]

With the addition of WoW Classic and now having two different WoWs, there are now multiple TOC interface version numbers "live" at the same time. WoW 'Classic' uses the older versions similar to the versions of the original game, starting with 1.X, and has differently numbered versions from 'Retail' which is the name for regular WoW.

The truth is that there are were always multiple versions of WoW, as far as PTRs, betas and so forth. But each version now has its own distinct folder under the World of Warcraft install folder, like '_retail_', '_classic_', '_ptr_'. Each of those folders has a its own set of 'WTF', 'Interface/AddOns', and other files and folders. Keep this in mind when using the following ways below.

Two versions[edit]

If an addon is released for both classic and retail, and wanted matching numbers for each to load without the out-of-date warning, there need to be two copies. There would need to be a retail release with the retail TOC version, and classic release with the classic TOC version.

Finding the number[edit]

There are a number of ways to get the current interface version:

1. Wiki patch notes[edit]

See the latest 'patch notes' and look for the 'Interface' number in the Patch box.
This is the most authoritative source on the Wiki.

2. 'API LatestInterface' wiki template[edit]

The WoWWiki 'Interface Version' template {{API LatestInterface}}
But this number is maintained manualy, so it might be out of date.

3. WoW major minor version[edit]

The interface number is usually derived exactly from WoW 'major.minor' version. Sometimes is derived from 'major.minor.release'.
In 2.4.0, where 2 is the major version number, and .4 is the minor version number, is 20400. 5.4.0 is 50400 and, 5.4.1 (.1 being the 'sub-minor' or 'release' version) would likely be 50401. However, Blizzard doesn't often distinguish on the sub-minor version level, so you would still use 50400. However with patch 8.2.5, for example, the interface number is actually 80205.

4. WoW FrameXML.toc[edit]

Extract and check FrameXML.toc (no longer works, interface number is no longer in the FrameXML.toc). See Extracting WoW user interface files.
or DEPRECATED, not updated since Oct. 2010 You can download Blizzard's User Interface Customization tool], use it to extract interface data, and peek at 'World of Warcraft\Blizzard Interface Data (usUS)\FrameXML\FrameXML.toc'. See Interface AddOn Kit for history of the tool kit.

5. From another AddOn[edit]

Steal it from another AddOn
Recently updated AddOns, which are not listed as "out of date" by the client contain the latest Interface version in their toc tag.

6. 'lastAddonVersion' in Config.wtf[edit]

Find the 'WTF/Config.wtf' file in your 'World of Warcraft/_retail_' or 'World of Warcraft/_classic_' folder, then the 'lastAddonVersion' CVar
This is the most authoritative source for the interface number.
Must run WoW at least once after install or patch for this to show up.

7. The Wow API GetBuildInfo[edit]

Use GetBuildInfo to verify the 'major.minor' version number.
/run print((select(4, GetBuildInfo())))
Above should output the WoW build version to your chat frame.

8. WoW FrameXML.toc on the Web[edit]

View FrameXML.toc online (no longer works, interface number is no longer in the FrameXML.toc) For example: FrameXML.toc [tly].

Notes[edit]

  • In the past Extract FrameXML and check FrameXML.toc - DEPRECATED, not updated since Oct. 2010
  • In the past you could also download Blizzard's User Interface Customization tool, use it to extract interface data, and peek at World of Warcraft\Blizzard Interface Data (usUS)\FrameXML\FrameXML.toc