API:PregameBlockMouseOver

UI Lua API · Pregame functions
Version: WAR 1.4.8

Turns the client's mouse handling on the character select screen off or back on.

PregameBlockMouseOver(block)

Arguments

block: boolean – true to block mouse-over and click handling, false to allow it again.

Returns

Nothing.

Details

The call only has an effect in the pregame state while the character select screen is set up. At any other time it does nothing.
The stock UI describes the flag as "start/stop handling mouse over & mouse button clicks on the C side" (interfacecore/source/characterselectwindow.lua).
While the flag is set, PregameSetCharacterSelectPage does nothing. The stock UI disables its page combo box at the same time for this reason.
PregamePlayCinematic sets the same flag while the cinematic plays, and PregameStopCinematic puts back the value it had before.
block must be a real boolean. Passing nil or a number raises an Invalid Parameters error.

Errors

None besides the generic Invalid Parameters message when the argument is not a boolean.

Example

From interfacecore/source/characterselectwindow.lua:

function CharacterSelectWindow.BlockMouseOver(bBlock)
    -- start/stop handling mouse over & mouse button clicks on the C side
    PregameBlockMouseOver(bBlock)

    -- when mouse-over is blocked, character pages cannot be changed, so don't let the user interact with the page change combo box
    ComboBoxSetDisabledFlag("CharacterSelectPageChangeComboBox", bBlock)
end

Return of Reckoning