API:WindowIsGameActionLocked

UI Lua API · Window functions
Version: WAR 1.4.8

Meant to report whether a window is locked against changes from Lua because of a game action. In the current client it always returns false.

locked = WindowIsGameActionLocked(windowName)

Arguments

windowName

string – Name of the window.

Returns

locked

boolean – Always false in the current client.

Details

• The function runs the same test as the is currently locked errors of many window functions (see WindowSetShowing). The test first checks a global lock switch, which is never turned on in the current client, so the answer is always false.
• If the switch were on, a window would count as locked when it or one of its relatives has game action data (see WindowSetGameActionData).
• The error message names the function WindowGetGameActionButton, not WindowIsGameActionLocked.
• The stock UI never calls WindowIsGameActionLocked.

Errors

• Error in function call 'WindowGetGameActionButton': Window %s does not exist

Example

A minimal example built from the signature above:

if not WindowIsGameActionLocked( "MyWindow" ) then
    WindowSetShowing( "MyWindow", false )
end

See also

• WindowSetGameActionData
• WindowSetShowing