API:GetAdvisorFlag
From RoR Wiki
UI Lua API · Interface functions
Version: WAR 1.4.8
Returns the player's "advisor" preference as the client currently holds it.
isAdvisor = GetAdvisorFlag()
Arguments
None.
Returns
- isAdvisor
boolean–trueif the advisor flag is set.
Details
- The value is read from data the client keeps in memory; no request is sent.
- SetAdvisorFlag only sends the new preference to the server and does not change this value directly.
- Arguments are not checked; anything passed is ignored.
Errors
None.
Example
Showing the current setting on a check box, from ea_socialwindow/source/socialwindowtaboptions.lua:
-- Set the Advisor Flag ButtonSetPressedFlag( "SocialWindowTabOptionsAdvisorPreference", GetAdvisorFlag() )