API:ButtonGetStayDownFlag

UI Lua API · Button functions
Version: WAR 1.4.8

Returns whether a Button stays pressed after it is clicked.

stayDown = ButtonGetStayDownFlag(buttonName)

Arguments

buttonName

string – Name of a Button window.

Returns

stayDown

boolean – true if the button's stay-down flag is set.

Details

• The flag is set with ButtonSetStayDownFlag. See that page for its effect.

Errors

• Error in function call 'ButtonGetStayDownFlag': Window %s does not exist
• Error in function call 'ButtonGetStayDownFlag': Window %s is not a Button

Example

From ea_interactionwindow/source/interactionflightmaster.lua:

if( ButtonGetDisabledFlag( SystemData.ActiveWindow.name ) or ButtonGetStayDownFlag( SystemData.ActiveWindow.name ) ) then

See also

• ButtonSetStayDownFlag
• ButtonGetCheckButtonFlag