https://wiki.returnofreckoning.com/index.php?action=history&feed=atom&title=API%3ALootRollOptOutAPI:LootRollOptOut - Revision history2026-10-18T06:58:45ZRevision history for this page on the wikiMediaWiki 1.43.11https://wiki.returnofreckoning.com/index.php?title=API:LootRollOptOut&diff=30596&oldid=prevMaintenance script: UI Lua API import (WAR 1.4.8)2026-10-16T19:47:06Z<p>UI Lua API import (WAR 1.4.8)</p>
<p><b>New page</b></p><div>{{LuaApi|group=Loot}}<br />
Tells the server which loot the player wants to opt out of for a public quest or other objective.<br />
<br />
<pre><br />
LootRollOptOut(objectiveId, optOutType)<br />
</pre><br />
<br />
== Arguments ==<br />
;objectiveId : <code>number</code> – Id of the objective, as in the <code>id</code> field of the objective data used by the stock trackers.<br />
;optOutType : <code>number</code> – Opt-out choice. The stock UI uses <code>0</code> (no opt-out), <code>1</code> (opt out of all objective loot) and <code>2</code> (opt out of gold bags only), defined as <code>TrackerUtils.OPT_OUT_OPTION_NONE</code>, <code>_ALL</code> and <code>_GOLD</code>.<br />
<br />
== Returns ==<br />
Nothing.<br />
<br />
== Details ==<br />
* The client sends the objective id and the opt-out value to the server and does nothing else. It does not check that the objective exists. Only the low byte of <code>optOutType</code> is sent.<br />
* Nothing is sent if the connection is not ready.<br />
* The stock UI updates its check boxes when the server answers with <code>SystemData.Events.PUBLIC_QUEST_OPTOUT</code> (see <code>EA_Window_CityTracker.OnQuestOptOut</code> in <code>ea_objectivetrackers/source/citytrackerwindow.lua</code>).<br />
* The function needs at least two arguments and only reads the last two.<br />
<br />
== Errors ==<br />
None besides the generic ''Invalid Parameters'' message when an argument is missing or not a number.<br />
<br />
== Example ==<br />
From <code>default/ea_objectivetrackers/source/trackerutils.lua</code>:<br />
<pre><br />
function TrackerUtils.SetOptOutOption( windowName, index, optOutValue)<br />
local checkBoxName = windowName.."CheckBox"<br />
if(ButtonGetPressedFlag(checkBoxName) == false) then<br />
local objectiveId = DataUtils.activeObjectivesData[index].id<br />
LootRollOptOut(objectiveId, optOutValue) <br />
end<br />
EA_Window_ContextMenu.HideAll() <br />
end<br />
</pre><br />
<br />
== See also ==<br />
* [[API:GetActiveObjectivesData|GetActiveObjectivesData]]<br />
* [[API:GetLootRollData|GetLootRollData]]</div>Maintenance script