Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:48:57Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=Item}}
Shows or hides the player's helm or cloak.

<pre>
SetEquippedItemVisible(slotNumber, visible)
</pre>

== Arguments ==
;slotNumber : <code>number</code> – <code>GameData.EquipSlots.HELM</code> or <code>GameData.EquipSlots.BACK</code>.
;visible : <code>boolean</code> – <code>true</code> to show the item, <code>false</code> to hide it.

== Returns ==
Nothing.

== Details ==
* Only <code>HELM</code> and <code>BACK</code> do anything. Any other slot is ignored.
* If the requested state is already the current one, nothing is sent. Otherwise the client issues its helm or cloak toggle command.
* If there is no player object, or the client has no appearance data for the player, nothing happens.
* <code>visible</code> must be a real boolean. Passing <code>nil</code> or a number raises an ''Invalid Parameters'' error.
* The function needs at least two arguments and only reads the last two.

== Errors ==
None besides the generic ''Invalid Parameters'' message when an argument has the wrong type.

== Example ==
From <code>default/ea_characterwindow/source/characterwindow.lua</code>:
<pre>
function CharacterWindow.ShowHelm()
local showHelm = ButtonGetPressedFlag("CharacterWindowContentsEquipmentShowHelm")
SetEquippedItemVisible(GameData.EquipSlots.HELM, showHelm)
end
</pre>

<pre>
function CharacterWindow.ShowCloak()
local showCloak = ButtonGetPressedFlag("CharacterWindowContentsEquipmentShowCloak")
SetEquippedItemVisible(GameData.EquipSlots.BACK, showCloak)
</pre>

== See also ==
* [[API:GetEquippedItemVisible|GetEquippedItemVisible]]

API:SetEquippedItemVisible - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)