Class MouseHandler

Represents a global mouse. Will likely only create one per app.

You can bind/switch MouseContexts to the MouseHandler to change input 'modes'.

Hierarchy

MouseHandler

Index

Constructors

constructor

Methods

Constructors

constructor

new MouseHandler(): MouseHandler

- Defined in input/mouse.ts:25
Creates a new Mouse Handler

Returns MouseHandler

Methods

clearContext

clearContext(): this

- Defined in input/mouse.ts:105
Clears the active mouse context

Returns this

this

getPos

getPos(): Vector2

- Defined in input/mouse.ts:84
Gets the current position of the mouse

Returns Vector2

Vector2

isMouseDown

isMouseDown(mouseButton?: number): boolean

- Defined in input/mouse.ts:76
Returns true if the given mouse button is down.

Parameters
- Default value mouseButton: number = 0
  
  number - Default 0 for left click.
Returns boolean

setContext

setContext(context: MouseContext): this

- Defined in input/mouse.ts:96
Sets the active mouse context

Parameters
- context: MouseContext
  
  MouseContext
Returns this

this

Generated using TypeDoc