https://wiki.returnofreckoning.com/index.php?action=history&feed=atom&title=API%3ADyePreviewAPI:DyePreview - Revision history2026-10-17T18:49:24ZRevision history for this page on the wikiMediaWiki 1.43.11https://wiki.returnofreckoning.com/index.php?title=API:DyePreview&diff=30281&oldid=prevMaintenance script: UI Lua API import (WAR 1.4.8)2026-10-16T19:42:05Z<p>UI Lua API import (WAR 1.4.8)</p>
<p><b>New page</b></p><div>{{LuaApi|group=Dye}}<br />
Shows on the character how an equipped item would look with a dye from the player's inventory.<br />
<br />
<pre><br />
DyePreview(dyeLocation, dyeSlot, tintMask, targetLocation, targetSlot)<br />
</pre><br />
<br />
== Arguments ==<br />
;dyeLocation : <code>number</code> – Where the dye item is, as a <code>GameData.ItemLocs</code> value.<br />
;dyeSlot : <code>number</code> – Slot of the dye item, starting at 1.<br />
;tintMask : <code>number</code> – Which colour of the target to change: 1 = primary, 2 = secondary, 3 = both (<code>GameData.TintMasks</code> values; the stock UI passes the result of [[API:GetDyeTintMasks|GetDyeTintMasks]] or the tint picked in its dye window).<br />
;targetLocation : <code>number</code> – Must be <code>GameData.ItemLocs.EQUIPPED</code>.<br />
;targetSlot : <code>number</code> – Equipment slot of the item to preview on.<br />
<br />
== Returns ==<br />
Nothing.<br />
<br />
== Details ==<br />
* Nothing happens unless:<br />
** <code>targetLocation</code> is <code>EQUIPPED</code> and <code>tintMask</code> is not 0;<br />
** the dye slot holds an item of type <code>GameData.ItemTypes.DYE</code>.<br />
* The target starts from its current dye colours. The colour(s) selected by <code>tintMask</code> are replaced by the dye's colour. Any other <code>tintMask</code> value leaves the colours as they are.<br />
* A colour is only applied to a channel the item's model supports (see [[API:GetDyeTintMasks|GetDyeTintMasks]]). Only armour slots take a preview.<br />
* This is a preview in the client. It does not use up the dye. The stock UI calls [[API:RevertDyePreview|RevertDyePreview]] before it sends the real use request with [[API:SendUseItem|SendUseItem]].<br />
* <code>GameData.ItemLocs.BANK</code> is not supported for the dye's location.<br />
* If there is no player object, nothing happens.<br />
* The function needs at least five arguments and only reads the last five.<br />
<br />
== Errors ==<br />
None besides the generic ''Invalid Parameters'' message when an argument is not a number.<br />
<br />
== Example ==<br />
From <code>default/ea_modifyitem/source/useitemtargeting.lua</code>:<br />
<pre><br />
function UseItemTargeting.PreviewDye( tintMask )<br />
...<br />
local sourceSlot = UseItemTargeting.TargetData.SourceSlot<br />
local sourceLoc = UseItemTargeting.TargetData.Source<br />
local targetLoc = UseItemTargeting.TargetData.TargetLoc<br />
local targetSlot = UseItemTargeting.TargetData.TargetSlot<br />
<br />
DyePreview( sourceLoc, sourceSlot, tintMask, targetLoc, targetSlot )<br />
end<br />
</pre><br />
<br />
== See also ==<br />
* [[API:RevertDyePreview|RevertDyePreview]]<br />
* [[API:DyeMerchantPreview|DyeMerchantPreview]]<br />
* [[API:GetDyeTintMasks|GetDyeTintMasks]]<br />
* [[API:CanUseDyeItem|CanUseDyeItem]]</div>Maintenance script