API:WindowSetPopable

UI Lua API · Window functions
Version: WAR 1.4.8

Sets whether a window is popable, that is, raised above its siblings when shown or clicked.

WindowSetPopable(windowName, popable)

Arguments

windowName

string – Name of the window.

popable

boolean – true to make the window popable.

Returns

Nothing.

Details

• A popable window is moved to the front of its siblings on the same layer:
  • when it is shown with WindowSetShowing (unless it is on the background layer), and
  • when the client finds it under the mouse while handling a mouse button event.
• Windows are only ordered against their siblings (windows with the same parent) and only within their layer. See WindowSetLayer.
• popable must be a real boolean. Passing nil or a number raises an Invalid Parameters error.
• The function needs at least two arguments and only reads the last two.
• The stock UI never calls WindowSetPopable.

Errors

• Error in function call 'WindowSetPopable': Window %s does not exist
• Error in function call 'WindowSetPopable': Window %s is currently locked and may not be modified from lua. ...
  This check never triggers in the current client. See WindowSetShowing.

Example

A minimal example built from the signature above:

-- Keep this window from jumping in front of its siblings when clicked
WindowSetPopable( "MyWindow", false )

See also

• WindowGetPopable
• WindowSetLayer
• WindowSetShowing