mouse

manages input from the mouse

virtuosity.inputManager.mouse

Objects

Methods

Properties


Objects

add

add mouse events

virtuosity.inputManager.mouse.add

delete

delete mouse events

virtuosity.inputManager.mouse.delete


Methods

clearDeltas

clear mouse deltas

virtuosity.inputManager.mouse.clearDeltas();

pointerLock

hide the cursor for infinite movement (like in an FPS game)

virtuosity.inputManager.mouse.pointerLock();

releasePointerLock

unhide the cursor that was hidden from pointerLock

virtuosity.inputManager.mouse.releasePointerLock();


Properties

x

Int

current mouse x position

virtuosity.inputManager.mouse.x

dx

Int

change in mouse x position

virtuosity.inputManager.mouse.dx

screenX

Int

current relative mouse x position

virtuosity.inputManager.mouse.screenX

y

Int

current mouse y position

virtuosity.inputManager.mouse.y

dy

Int

change in mouse y position

virtuosity.inputManager.mouse.dy

screenY

current relative mouse y position

virtuosity.inputManager.mouse.screenY

left

Boolean

left mouse button currently down

virtuosity.inputManager.mouse.left

middle

Boolean

middle mouse button currently down

virtuosity.inputManager.mouse.middle

Boolean

right mouse button currently down

virtuosity.inputManager.mouse.right

back

Boolean

back mouse button currently down

virtuosity.inputManager.mouse.back

forward

Boolean

forward mouse button currently down

virtuosity.inputManager.mouse.forward

offsetX

Number

mouse x offset

virtuosity.inputManager.mouse.offsetX

offsetY

Number

mouse y offset

virtuosity.inputManager.mouse.offsetY

pointerLocked

Boolean

if the pointer is currently locked

virtuosity.inputManager.mouse.pointerLocked