Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:40:48Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=Button}}
Makes a Button stay pressed after it is clicked.

<pre>
ButtonSetStayDownFlag(buttonName, stayDown)
</pre>

== Arguments ==
;buttonName : <code>string</code> – Name of a Button window.
;stayDown : <code>boolean</code> – <code>true</code> to make the button stay pressed, <code>false</code> for normal behaviour.

== Returns ==
Nothing.

== Details ==
* When a stay-down button is released:
** over the button, it stays pressed;
** away from the button, it stays pressed only if it was already pressed before the click.
* A normal button is released (its pressed flag cleared) when the mouse button goes up.
* Use [[API:ButtonSetPressedFlag|ButtonSetPressedFlag]] to release a stay-down button from Lua.
* Changing the flag does not change the button's current pressed state or appearance.
* <code>stayDown</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 'ButtonSetStayDownFlag': Window %s does not exist</code>
* <code>Error in function call 'ButtonSetStayDownFlag': Window %s is not a Button</code>

== Example ==
From <code>eatemplate_defaultwindowskin/source/defaultbutton.lua</code>:
<pre>
function EA_Window_DefaultLabelToggleCircle.Initialize()
local buttonName = SystemData.ActiveWindow.name.."Button"
ButtonSetStayDownFlag( buttonName, true )
end
</pre>

== See also ==
* [[API:ButtonGetStayDownFlag|ButtonGetStayDownFlag]]
* [[API:ButtonSetCheckButtonFlag|ButtonSetCheckButtonFlag]]
* [[API:ButtonSetPressedFlag|ButtonSetPressedFlag]]

API:ButtonSetStayDownFlag - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)