Copyright © 2025-2026 Candy ArtsMouse
The Mouse command sets the mouse mode, which controls whether the cursor is visible and whether it is confined to the window.
Keys
Every key also accepts a ¢ expression instead of a fixed value, unless its description says otherwise. See CandyRef Expressions.
Mouse_Mode
Description:
The mouse mode to apply. The value is case-insensitive. Unlike choice menus, the Locked alias isn't accepted.
Values:
• visible: The cursor is visible and free.
• hidden: The cursor is hidden but free.
• captured: The cursor is hidden and locked to the window.
• confined: The cursor is visible and confined to the window.
• confined_hidden: The cursor is hidden and confined to the window.
• dialogue_start: The Engine's mouse_mode_start.
• dialogue_end: The Engine's mouse_mode_end.
• choice: The Engine's mouse_mode_choice.
• Empty, or any other value: No change.