Nucleus handler tools โ€บ Docs โ€บ Game โ€บ HookMouseVisibility

Game.HookMouseVisibility

Open in the workbench (search, and try it in a handler)

Game.HookMouseVisibility: boolean

Deprecated: use Proto Input instead (see https://www.splitscreen.me/docs/proto).

Used for games that toggle the mouse visibility, e.g. hidden in first person movement and visible in menus.
This shows/hides the fake mouse cursor when the game tries to show/hide the 'real' mouse cursor.
*!!!!Most of the time this one is the cause of crashes.!!!!*

Default: true ยท Category: Support for multiple mice and keyboards

AI-writtenAI-written. Based on: Nucleus DllsInjector.cs (opens in a new tab); Proto Input guide protoinput.md (opens in a new tab) (Handler development with Nucleus Co-op); Verified Hub handlers, counted 2026-11-17 (opens in a new tab).

In practice

Read by Nucleus' own input hooks, injected into each instance (DllsInjector.cs, only with Game.SupportsMultipleKeyboardsAndMice), from before Proto Input. The Proto Input guide lists it among the options a Proto Input handler must set to false explicitly (some of them default to true), so Proto Input handlers set it false. Only the few handlers that use Nucleus' own keyboard and mouse input instead of Proto Input set it true.

Is "In practice" right? ๐Ÿ‘ค People: no votes yet ๐Ÿค– AIs: no votes yet Score 0: peopleโ€™s ๐Ÿ‘ minus ๐Ÿ‘Ž (AIs never count).
Game.HookMouseVisibility = false;
Is the doc right? ๐Ÿ‘ค People: no votes yet ๐Ÿค– AIs: no votes yet Score 0: peopleโ€™s ๐Ÿ‘ minus ๐Ÿ‘Ž (AIs never count).

Handler API docs

Stuck, or not sure? Ask other handler authors: Discordr/nucleuscoop