five-on-it / apps/client/src/renderer/mouse / Mouse

Interface: Mouse

Defined in: apps/client/src/renderer/mouse.ts:16

The mouse state the game loop samples each tick.

Properties

expose

readonly expose: boolean

Defined in: apps/client/src/renderer/mouse.ts:24

Popped up out of cover: flipped by every right click.

---

fire

readonly fire: boolean

Defined in: apps/client/src/renderer/mouse.ts:22

The left button is held.

---

seen

readonly seen: boolean

Defined in: apps/client/src/renderer/mouse.ts:28

The pointer has moved over the canvas at least once.

---

wheelSteps

readonly wheelSteps: number

Defined in: apps/client/src/renderer/mouse.ts:26

Net wheel steps so far (down is positive); the game loop wraps it over the targets.

---

x

readonly x: number

Defined in: apps/client/src/renderer/mouse.ts:18

Pointer x in canvas pixels.

---

y

readonly y: number

Defined in: apps/client/src/renderer/mouse.ts:20

Pointer y in canvas pixels.

Methods

dispose()

dispose(): void

Defined in: apps/client/src/renderer/mouse.ts:32

Removes the listeners.

Returns

void

---

hide()

hide(): void

Defined in: apps/client/src/renderer/mouse.ts:30

Back to hidden (on taking or leaving cover).

Returns

void