API Docs for: 1.4.0
Show:

Kiwi.Input.InputManager Class

Defined in: src\input\InputManager.ts:11
Module: Input
Parent Module: Kiwi

Handles the initialization and management of the various ways a user can interact with the device/game, whether this is through a Keyboard and Mouse or by a Touch. Also contains some of the general callbacks that are 'global' between both Desktop and Mobile based devices.

Constructor

Kiwi.Input.InputManager

(
  • game
)
Kiwi.Input.InputManager

Defined in src\input\InputManager.ts:11

Parameters:

  • game Kiwi.Game

    The game that this object belongs to.

Returns:

Kiwi.Input.InputManager:

This object.

Methods

_onDownEvent

(
  • x
  • y
  • timeDown
  • timeUp
  • duration
  • pointer
)
private

Defined in src\input\InputManager.ts:143

A private method that gets dispatched when either the mouse or touch manager dispatches a down event

Parameters:

  • x Number

    The x coordinate of the pointer

  • y Number

    The y coordinate of the pointer

  • timeDown Number

    The time that the pointer has been down for.

  • timeUp Number

    The Time that the pointer has been up form

  • duration Number
  • pointer Kiwi.Input.Pointer

    The pointer that was used.

_onUpEvent

(
  • x
  • y
  • timeDown
  • timeUp
  • duration
  • pointer
)
private

Defined in src\input\InputManager.ts:159

A private method that gets dispatched when either the mouse or touch manager dispatches a up event

Parameters:

  • x Number

    The x coordinate of the pointer

  • y Number

    The y coordinate of the pointer

  • timeDown Number

    The time that the pointer has been down for.

  • timeUp Number

    The Time that the pointer has been up form

  • duration Number
  • pointer Kiwi.Input.Pointer

    The pointer that was used.

boot

() public

Defined in src\input\InputManager.ts:106

This method is executed when the DOM has loaded and the manager is ready to load.

objType

() String public

Defined in src\input\InputManager.ts:29

The type of object this is.

Returns:

String:

"InputManager"

reset

()

Defined in src\input\InputManager.ts:216

Runs the reset method on the managers.

update

() public

Defined in src\input\InputManager.ts:194

The update loop that gets executed every frame.

Properties

_pointers

Array private

Defined in src\input\InputManager.ts:87

An array containing all of the pointers that are active on the stage.

game

Game public

Defined in src\input\InputManager.ts:55

The game that this manager belongs to.

isDown

Boolean public

Defined in src\input\InputManager.ts:235

If an input (either touch or the mouse cursor) is currently down. Not an accurate representation, should use the individual managers.

keyboard

Keyboard public

Defined in src\input\InputManager.ts:71

The keyboard manager

mouse

Mouse public

Defined in src\input\InputManager.ts:63

A reference to the mouse manager.

onDown

Signal public

Defined in src\input\InputManager.ts:39

A Signal that dispatches a event when any Pointer is pressed from the game.

onReleased

Signal public

Defined in src\input\InputManager.ts:184

An alias for the onRelease signal that goes straight to the onUp

onUp

Signal public

Defined in src\input\InputManager.ts:47

A Signal that dispatches a event when any Pointer is released from the game.

pointers

Array public

Defined in src\input\InputManager.ts:96

Returns all of the pointers that can be used on the Input Manager. This is READ only.

position

Kiwi.Geom.Point public

Defined in src\input\InputManager.ts:227

The position of the last pointer that was/is active on the stage.

touch

Touch public

Defined in src\input\InputManager.ts:79

The touch manager.

x

Number public

Defined in src\input\InputManager.ts:243

Populated x coordinate based on the most recent click/touch event

y

Number public

Defined in src\input\InputManager.ts:254

Populated y coordinate based on the most recent click/touch event