Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:48:50Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=Interface}}
Sends the player's "advisor" preference to the server.

<pre>
SetAdvisorFlag(isAdvisor)
</pre>

== Arguments ==
;isAdvisor : <code>boolean</code> – <code>true</code> to turn the advisor preference on, <code>false</code> to turn it off.

== Returns ==
Nothing.

== Details ==
* The client sends a social-network request with the new value to the server. Nothing is sent if the client's network connection is not ready.
* The value returned by [[API:GetAdvisorFlag|GetAdvisorFlag]] is not changed by this call itself; the function only sends the request.
* <code>isAdvisor</code> must be a real boolean. Passing <code>nil</code> or a number raises an ''Invalid Parameters'' error.
* The function needs at least one argument and only reads the last one.
* The stock UI calls it from the "advisor" check box on the Options tab of the social window.

== Errors ==
None besides the ''Invalid Parameters'' argument check.

== Example ==
From <code>ea_socialwindow/source/socialwindowtaboptions.lua</code>:
<pre>
function SocialWindowTabOptions.OnPressAdvisorButton()
local buttonState = ButtonGetPressedFlag( "SocialWindowTabOptionsAdvisorPreference" )
SetAdvisorFlag(buttonState)
end
</pre>

== See also ==
* [[API:GetAdvisorFlag|GetAdvisorFlag]]
* [[API:ButtonGetPressedFlag|ButtonGetPressedFlag]]

API:SetAdvisorFlag - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)