Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:48:21Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=Dye}}
Removes a dye preview from one equipped item, showing its real colours again.

<pre>
RevertDyePreview(location, slot)
</pre>

== Arguments ==
;location : <code>number</code> – Must be <code>GameData.ItemLocs.EQUIPPED</code>.
;slot : <code>number</code> – Equipment slot of the item.

== Returns ==
Nothing.

== Details ==
* For any other <code>location</code>, or an empty slot, nothing happens.
* The item's appearance is set back to the dye colours the client has stored for the item. A channel without a dye shows the item's own colour. It undoes both [[API:DyePreview|DyePreview]] and [[API:DyeMerchantPreview|DyeMerchantPreview]].
* If there is no player object, nothing happens.
* 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 ==
Reverting the previously selected slot in the dye merchant view, from <code>default/ea_characterwindow/source/characterwindow.lua</code>:
<pre>
-- revert the stuff we had selected
RevertDyePreview( GameData.ItemLocs.EQUIPPED, WindowGetId( oldSelectedSlotName ) )
</pre>

Before using a dye for real, from <code>default/ea_modifyitem/source/useitemtargeting.lua</code>:
<pre>
RevertDyePreview( UseItemTargeting.TargetData.TargetLoc, UseItemTargeting.TargetData.TargetSlot )
UseItemTargeting.SendingUseTargetItem( tintMask )
</pre>

== See also ==
* [[API:DyePreview|DyePreview]]
* [[API:DyeMerchantPreview|DyeMerchantPreview]]
* [[API:RevertAllDyePreview|RevertAllDyePreview]]

API:RevertDyePreview - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)