API Docs for:
Show:

Mouse Class

Defined in: src/mouse.js:4

Helper for handling user mouse input.

Constructor

Mouse

(
  • onClick
  • onHover
)

Defined in src/mouse.js:4

Parameters:

  • onClick Function
    • A function to handle mouse click events. function(x, y){}
  • onHover Function
    • A function to handle mouse hover events. function(x, y){}

Methods

handleEvent

(
  • e
)

Defined in src/mouse.js:43

Hander for mouse events

Parameters:

  • e Event
    • mouse event

mouseMove

(
  • e
)

Defined in src/mouse.js:63

Hander for mouse move events

Parameters:

  • e Event
    • mouse event

onClick

(
  • x
  • y
)

Defined in src/mouse.js:19

A function to handle tile mouse click events.

Parameters:

  • x Number
    • Mouse x coord relative to window.
  • y Number
    • Mouse y coord relative to window.

onHover

(
  • x
  • y
)

Defined in src/mouse.js:27

A function to handle tile mouse hover events

Parameters:

  • x Number
    • Mouse x coord relative to window.
  • y Number
    • Mouse y coord relative to window.

startListening

(
  • element
)

Defined in src/mouse.js:75

Binds event listener for mouse events.

Parameters:

  • element HTMLElement
    • The dom element being rendered to.

stopListening

()

Defined in src/mouse.js:93

Unbinds event listener for mouse events.

Properties

_boundElement

HTMLElement protected

Defined in src/mouse.js:35

The dom element being rendered to and listened to for mouse events.