Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:40:41Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=Button}}
Returns whether a Button is pressed.

<pre>
pressed = ButtonGetPressedFlag(buttonName)
</pre>

== Arguments ==
;buttonName : <code>string</code> – Name of a Button window.

== Returns ==
;pressed : <code>boolean</code> – <code>true</code> if the button is in the pressed state.

== Details ==
* The pressed flag is set by [[API:ButtonSetPressedFlag|ButtonSetPressedFlag]] and by the client when the button is clicked:
** A left-button press on the button sets it. On a check button (see [[API:ButtonSetCheckButtonFlag|ButtonSetCheckButtonFlag]]) that is already pressed, the press clears it instead, so each click toggles it.
** On release it is cleared again. Check buttons keep it, and stay-down buttons keep it in the cases described on [[API:ButtonSetStayDownFlag|ButtonSetStayDownFlag]].
** While the button is disabled, clicks do not change it.
* The stock UI reads it to get the state of check boxes and toggle buttons.

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

== Example ==
Reading filter toggle buttons, from <code>ea_backpackwindow/source/backpacklistview.lua</code>:
<pre>
local shouldShowOnlyUsable = ButtonGetPressedFlag( "EA_Window_BackpackListViewFilterByUsableButton" )
local shouldShowArmor = ButtonGetPressedFlag( "EA_Window_BackpackListViewFilterArmorButton" )
</pre>

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

API:ButtonGetPressedFlag - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)