https://wiki.returnofreckoning.com/index.php?action=history&feed=atom&title=API%3AGetDyeTintMasksAPI:GetDyeTintMasks - Revision history2026-10-17T08:50:11ZRevision history for this page on the wikiMediaWiki 1.43.11https://wiki.returnofreckoning.com/index.php?title=API:GetDyeTintMasks&diff=30379&oldid=prevMaintenance script: UI Lua API import (WAR 1.4.8)2026-10-16T19:43:37Z<p>UI Lua API import (WAR 1.4.8)</p>
<p><b>New page</b></p><div>{{LuaApi|group=Dye}}<br />
Returns which dye colours (primary, secondary) an item's model can take.<br />
<br />
<pre><br />
tintMask = GetDyeTintMasks(itemId)<br />
</pre><br />
<br />
== Arguments ==<br />
;itemId : <code>number</code> – Item id (the <code>id</code> field of an [[API:GetInventoryItemData#Item data table|item data table]]).<br />
<br />
== Returns ==<br />
;tintMask : <code>number</code> – Bit mask: 1 = primary colour, 2 = secondary colour, 3 = both, 0 = none. These match the stock UI's <code>GameData.TintMasks.A</code>, <code>B</code>, <code>BOTH</code> and <code>NONE</code> checks.<br />
<br />
== Details ==<br />
* The mask comes from the item's model data. It does not look at the <code>EITEMFLAG_DYE_ABLE</code> flag; the stock UI checks both.<br />
* If the argument check fails, nothing is returned.<br />
* Exactly one argument must be passed.<br />
<br />
== Errors ==<br />
None besides the generic ''Invalid Parameters'' message when the argument is missing or not a number.<br />
<br />
== Example ==<br />
From <code>default/ea_modifyitem/source/useitemtargeting.lua</code>:<br />
<pre><br />
function UseItemTargeting.ItemIsDyable(itemData)<br />
local tintMasks = GetDyeTintMasks( itemData.id )<br />
return( itemData.flags[GameData.Item.EITEMFLAG_DYE_ABLE] == true and tintMasks ~= GameData.TintMasks.NONE and not itemData.broken )<br />
end<br />
</pre><br />
<br />
== See also ==<br />
* [[API:DyePreview|DyePreview]]<br />
* [[API:DyeMerchantPreview|DyeMerchantPreview]]<br />
* [[API:CanUseDyeItem|CanUseDyeItem]]</div>Maintenance script