Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:47:40Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=Pregame}}
Turns the client's mouse handling on the character select screen off or back on.

<pre>
PregameBlockMouseOver(block)
</pre>

== Arguments ==
;block : <code>boolean</code> – <code>true</code> to block mouse-over and click handling, <code>false</code> 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" (<code>interfacecore/source/characterselectwindow.lua</code>).
* While the flag is set, [[API:PregameSetCharacterSelectPage|PregameSetCharacterSelectPage]] does nothing. The stock UI disables its page combo box at the same time for this reason.
* [[API:PregamePlayCinematic|PregamePlayCinematic]] sets the same flag while the cinematic plays, and [[API:PregameStopCinematic|PregameStopCinematic]] puts back the value it had before.
* <code>block</code> must be a real boolean. Passing <code>nil</code> 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 <code>interfacecore/source/characterselectwindow.lua</code>:
<pre>
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
</pre>

== See also ==
* [[API:PregameSetCharacterSelectPage|PregameSetCharacterSelectPage]]
* [[API:PregamePlayCinematic|PregamePlayCinematic]]

API:PregameBlockMouseOver - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)