https://wiki.returnofreckoning.com/index.php?action=history&feed=atom&title=API%3AGetEquippedItemVisibleAPI:GetEquippedItemVisible - Revision history2026-10-18T13:12:02ZRevision history for this page on the wikiMediaWiki 1.43.11https://wiki.returnofreckoning.com/index.php?title=API:GetEquippedItemVisible&diff=30382&oldid=prevMaintenance script: UI Lua API import (WAR 1.4.8)2026-10-16T19:43:40Z<p>UI Lua API import (WAR 1.4.8)</p>
<p><b>New page</b></p><div>{{LuaApi|group=Item}}<br />
Meant to return whether the player's helm or cloak is shown. In the current client the slot numbers it checks are off by one. See [[#Details|Details]].<br />
<br />
<pre><br />
visible = GetEquippedItemVisible(slotNumber)<br />
</pre><br />
<br />
== Arguments ==<br />
;slotNumber : <code>number</code> – Slot number. See Details for the values that actually work.<br />
<br />
== Returns ==<br />
;visible : <code>boolean</code> – <code>true</code> if the item is shown.<br />
<br />
== Details ==<br />
* The function only knows two values:<br />
** 8 returns the helm visibility setting;<br />
** 12 returns the cloak visibility setting.<br />
: Any other value returns <code>true</code>.<br />
* <code>GameData.EquipSlots.HELM</code> is 9 and <code>GameData.EquipSlots.BACK</code> is 13, so calling it with those constants (as the stock UI does) always returns <code>true</code>. Pass <code>GameData.EquipSlots.HELM - 1</code> or <code>GameData.EquipSlots.BACK - 1</code> to read the real setting. [[API:SetEquippedItemVisible|SetEquippedItemVisible]] subtracts 1 itself and works with the constants.<br />
* If there is no player object, or the client has no appearance data for the player, the function returns <code>true</code>.<br />
* If the argument check fails, the ''Invalid Parameters'' message names <code>SetEquippedItemVisible</code>, not this function. The function still returns <code>true</code> in that case.<br />
* The function needs at least one argument and only reads the last one.<br />
<br />
== Errors ==<br />
None besides the generic ''Invalid Parameters'' message when the argument is missing or not a number.<br />
<br />
== Example ==<br />
The stock call, from <code>default/ea_characterwindow/source/characterwindow.lua</code> (both values are always <code>true</code> here, see Details):<br />
<pre><br />
local showHelm = GetEquippedItemVisible( GameData.EquipSlots.HELM )<br />
local showCloak = GetEquippedItemVisible( GameData.EquipSlots.BACK )<br />
</pre><br />
<br />
Reading the real helm setting:<br />
<pre><br />
local showHelm = GetEquippedItemVisible( GameData.EquipSlots.HELM - 1 )<br />
</pre><br />
<br />
== See also ==<br />
* [[API:SetEquippedItemVisible|SetEquippedItemVisible]]<br />
* [[API:GetEquipmentData|GetEquipmentData]]</div>Maintenance script