Interface

MouseButtons

input/mouse.types.ts:10

Held-state booleans for the three standard mouse buttons, exposed as a named bag on MouseSnapshot (and MouseState) so they're a) addressable as a group (if (state.buttons.left)) and b) easy to extend with extra buttons (back, forward) without flattening the top-level shape further.

Properties

readonly #

left: boolean

true while the primary (left) mouse button is held.

readonly #

middle: boolean

true while the middle (wheel) mouse button is held.

readonly #

right: boolean

true while the secondary (right) mouse button is held. The engine does not suppress the browser's native context menu on right-click — applications that want to use the right button as a game input should add their own contextmenu listener and call event.preventDefault().