Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:40:59Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=Dye}}
Returns whether the player's rank is high enough to use an item, such as a dye.

<pre>
canUse = CanUseDyeItem(location, slot)
</pre>

== Arguments ==
;location : <code>number</code> – Where the item is, as a <code>GameData.ItemLocs</code> value.
;slot : <code>number</code> – Slot of the item in <code>location</code>, starting at 1.

== Returns ==
;canUse : <code>boolean</code> – <code>true</code> if the player's rank is at least the item's required level.

== Details ==
* Only the level requirement is compared. The client does not check that the item is a dye or that the slot holds an item.
* <code>GameData.ItemLocs.BANK</code> is not supported by the slot conversion this function uses.
* If there is no player object, the Lua state is not available or the argument check fails, the function returns <code>false</code>.
* The function needs at least two arguments and only reads the last two.

== Errors ==
None besides the generic ''Invalid Parameters'' message when an argument is not a number.

== Example ==
From <code>default/ea_modifyitem/source/useitemtargeting.lua</code>:
<pre>
function UseItemTargeting.CanUseDyeItem(sourceLocation, dyeSlot)
local canUseDye = false
-- Check to see if player is able to use the dye Item first
canUseDye = CanUseDyeItem(sourceLocation, dyeSlot)

--Display a one dialog box with text saying "Your rank is too low to use this dye!"
--if they can't use the dye because of their rank
if(canUseDye == false) then
...
return false
end

return true
end
</pre>

== See also ==
* [[API:DyePreview|DyePreview]]
* [[API:GetDyeTintMasks|GetDyeTintMasks]]
* [[API:SendUseItem|SendUseItem]]

API:CanUseDyeItem - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)