API:WindowSetDrawWhenInterfaceHidden

UI Lua API · Window functions
Version: WAR 1.4.8

Sets whether a window is still drawn when the player hides the interface.

WindowSetDrawWhenInterfaceHidden(windowName, draw)

Arguments

windowName

string – Name of the window.

draw

boolean – true to keep drawing the window while the interface is hidden.

Returns

Nothing.

Details

• The client keeps a list of windows for this purpose. true adds the window to the list (once; adding it again has no effect) and false removes it.
• If the window does not exist, the call does nothing. No error is raised.
• draw 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.

Errors

None. A missing window is ignored.

Example

Keeping the siege weapon windows visible in fire mode, from ea_siegeweaponwindow/source/siegeweapongeneralfirewindow.lua:

for index, data in ipairs( windowList) do
    WindowSetDrawWhenInterfaceHidden( data.windowName, inFireMode )

    if( data.shouldSetShowing ) then
        WindowSetShowing( data.windowName, inFireMode )
    end
    -- ...
end

See also

• WindowSetShowing