Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:40:47Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=Button}}
Sets or clears the pressed state of a Button.

<pre>
ButtonSetPressedFlag(buttonName, pressed)
</pre>

== Arguments ==
;buttonName : <code>string</code> – Name of a Button window.
;pressed : <code>boolean</code> – <code>true</code> to show the button pressed, <code>false</code> to release it.

== Returns ==
Nothing.

== Details ==
* This is how the stock UI checks and unchecks check boxes and shows toggle buttons as active.
* The button's text colour changes to the colour set for its new state (see [[API:ButtonSetTextColor|ButtonSetTextColor]]).
* The client also changes the flag when the button is clicked (see [[API:ButtonGetPressedFlag|ButtonGetPressedFlag]]).
* <code>pressed</code> must be a real boolean. Passing <code>nil</code> or a number raises an ''Invalid Parameters'' error.
* The function needs at least two arguments and only reads the last two.

== Errors ==
* <code>Error in function call 'ButtonSetPressedFlag': Window %s does not exist</code>
* <code>Error in function call 'ButtonSetPressedFlag': Window %s is not a Button</code>

== Example ==
Showing a window's toolbar button as pressed while the window is open, from <code>easystem_windowutils/source/windowutils.lua</code>:
<pre>
for index, buttonName in ipairs( WindowUtils.stateButtons[ windowName ] ) do
ButtonSetPressedFlag( buttonName, true )
end
</pre>

== See also ==
* [[API:ButtonGetPressedFlag|ButtonGetPressedFlag]]
* [[API:ButtonSetCheckButtonFlag|ButtonSetCheckButtonFlag]]
* [[API:ButtonSetStayDownFlag|ButtonSetStayDownFlag]]

API:ButtonSetPressedFlag - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)