new Input(game)
Phaser.Input is the Input Manager for all types of Input across Phaser, including mouse, keyboard, touch and MSPointer. The Input manager is updated automatically by the core game loop.
Parameters:
| Name | Type | Description |
|---|---|---|
game |
Phaser.Game | Current game instance. |
- Source:
Members
-
<static, constant> MOUSE_OVERRIDES_TOUCH :number
-
Type:
- number
- Source:
-
<static, constant> MOUSE_TOUCH_COMBINE :number
-
Type:
- number
- Source:
-
<static, constant> TOUCH_OVERRIDES_MOUSE :number
-
Type:
- number
- Source:
-
activePointer
-
The most recently active Pointer object. When you've limited max pointers to 1 this will accurately be either the first finger touched or mouse.
- Source:
Properties:
Name Type Description activePointerPhaser.Pointer -
circle
-
A Circle object centered on the x/y screen coordinates of the Input. Default size of 44px (Apples recommended "finger tip" size) but can be changed to anything.
- Source:
Properties:
Name Type Description circlePhaser.Circle -
currentPointers
-
- Default Value:
- 0
- Source:
Properties:
Name Type Description currentPointersnumber The current number of active Pointers.
-
disabled
-
You can disable all Input by setting Input.disabled = true. While set all new input related events will be ignored. If you need to disable just one type of input; for example mouse; use Input.mouse.disabled = true instead
- Default Value:
- false
- Source:
Properties:
Name Type Description disabledboolean -
doubleTapRate
-
- Default Value:
- 300
- Source:
Properties:
Name Type Description doubleTapRatenumber The number of milliseconds between taps of the same Pointer for it to be considered a double tap / click.
-
game
-
- Source:
Properties:
Name Type Description gamePhaser.Game A reference to the currently running game.
-
gamepad
-
- Source:
Properties:
Name Type Description gamepadPhaser.Gamepad The Gamepad Input manager.
-
hitCanvas
-
- Default Value:
- null
- Source:
Properties:
Name Type Description hitCanvasHTMLCanvasElement The canvas to which single pixels are drawn in order to perform pixel-perfect hit detection.
-
hitContext
-
- Default Value:
- null
- Source:
Properties:
Name Type Description hitContextCanvasRenderingContext2D The context of the pixel perfect hit canvas.
-
holdRate
-
- Default Value:
- 2000
- Source:
Properties:
Name Type Description holdRatenumber The number of milliseconds that the Pointer has to be pressed down for it to fire a onHold event.
-
interactiveItems
-
A list of interactive objects. The InputHandler components add and remove themselves from this list.
- Source:
Properties:
Name Type Description interactiveItemsPhaser.ArrayList -
justPressedRate
-
- Default Value:
- 200
- Source:
Properties:
Name Type Description justPressedRatenumber The number of milliseconds below which the Pointer is considered justPressed.
-
justReleasedRate
-
- Default Value:
- 200
- Source:
Properties:
Name Type Description justReleasedRatenumber The number of milliseconds below which the Pointer is considered justReleased .
-
keyboard
-
- Source:
Properties:
Name Type Description keyboardPhaser.Keyboard The Keyboard Input manager.
-
maxPointers
-
- Default Value:
- 10
- Source:
Properties:
Name Type Description maxPointersnumber The maximum number of Pointers allowed to be active at any one time. For lots of games it's useful to set this to 1.
-
minPriorityID
-
- Default Value:
- 0
- Source:
Properties:
Name Type Description minPriorityIDnumber You can tell all Pointers to ignore any object with a priorityID lower than the minPriorityID. Useful when stacking UI layers. Set to zero to disable.
-
mouse
-
- Source:
Properties:
Name Type Description mousePhaser.Mouse The Mouse Input manager.
-
mousePointer
-
- Source:
Properties:
Name Type Description mousePointerPointer The mouse has its own unique Phaser.Pointer object which you can use if making a desktop specific game.
-
moveCallback
-
- Source:
Properties:
Name Type Description moveCallbackfunction An optional callback that will be fired every time the activePointer receives a move event from the DOM. Set to null to disable.
-
moveCallbackContext
-
- Source:
Properties:
Name Type Description moveCallbackContextobject The context in which the moveCallback will be sent. Defaults to Phaser.Input but can be set to any valid JS object.
-
moveCallbacks
-
- Source:
Properties:
Name Type Description moveCallbacksarray An array of callbacks that will be fired every time the activePointer receives a move event from the DOM.
-
mspointer
-
- Source:
Properties:
Name Type Description mspointerPhaser.MSPointer The MSPointer Input manager.
-
multiInputOverride
-
- Source:
Properties:
Name Type Description multiInputOverridenumber Controls the expected behaviour when using a mouse and touch together on a multi-input device.
-
onDown
-
- Source:
Properties:
Name Type Description onDownPhaser.Signal A Signal that is dispatched each time a pointer is pressed down.
-
onHold
-
- Source:
Properties:
Name Type Description onHoldPhaser.Signal A Signal that is dispatched each time a pointer is held down.
-
onTap
-
- Source:
Properties:
Name Type Description onTapPhaser.Signal A Signal that is dispatched each time a pointer is tapped.
-
onUp
-
- Source:
Properties:
Name Type Description onUpPhaser.Signal A Signal that is dispatched each time a pointer is released.
-
pointer1
-
- Source:
Properties:
Name Type Description pointer1Phaser.Pointer A Pointer object.
-
pointer2
-
- Source:
Properties:
Name Type Description pointer2Phaser.Pointer A Pointer object.
-
pointer3
-
- Source:
Properties:
Name Type Description pointer3Phaser.Pointer A Pointer object.
-
pointer4
-
- Source:
Properties:
Name Type Description pointer4Phaser.Pointer A Pointer object.
-
pointer5
-
- Source:
Properties:
Name Type Description pointer5Phaser.Pointer A Pointer object.
-
pointer6
-
- Source:
Properties:
Name Type Description pointer6Phaser.Pointer A Pointer object.
-
pointer7
-
- Source:
Properties:
Name Type Description pointer7Phaser.Pointer A Pointer object.
-
pointer8
-
- Source:
Properties:
Name Type Description pointer8Phaser.Pointer A Pointer object.
-
pointer9
-
- Source:
Properties:
Name Type Description pointer9Phaser.Pointer A Pointer object.
-
pointer10
-
- Source:
Properties:
Name Type Description pointer10Phaser.Pointer A Pointer object.
-
<readonly> pollLocked
-
- Source:
Properties:
Name Type Description pollLockedboolean True if the Input is currently poll rate locked.
-
pollRate
-
- Default Value:
- 0
- Source:
Properties:
Name Type Description pollRatenumber How often should the input pointers be checked for updates? A value of 0 means every single frame (60fps); a value of 1 means every other frame (30fps) and so on.
-
position
-
- Default Value:
- null
- Source:
Properties:
Name Type Description positionPhaser.Point A point object representing the current position of the Pointer.
-
recordLimit
-
The total number of entries that can be recorded into the Pointer objects tracking history. If the Pointer is tracking one event every 100ms; then a trackLimit of 100 would store the last 10 seconds worth of history.
- Default Value:
- 100
- Source:
Properties:
Name Type Description recordLimitnumber -
recordPointerHistory
-
Sets if the Pointer objects should record a history of x/y coordinates they have passed through. The history is cleared each time the Pointer is pressed down. The history is updated at the rate specified in Input.pollRate
- Default Value:
- false
- Source:
Properties:
Name Type Description recordPointerHistoryboolean -
recordRate
-
- Default Value:
- 100
- Source:
Properties:
Name Type Description recordRatenumber The rate in milliseconds at which the Pointer objects should update their tracking history.
-
resetLocked
-
- Default Value:
- false
- Source:
Properties:
Name Type Description resetLockedboolean If the Input Manager has been reset locked then all calls made to InputManager.reset, such as from a State change, are ignored.
-
scale
-
- Source:
Properties:
Name Type Description scalePhaser.Point The scale by which all input coordinates are multiplied; calculated by the ScaleManager. In an un-scaled game the values will be x = 1 and y = 1.
-
speed
-
- Source:
Properties:
Name Type Description speedPhaser.Point A point object representing the speed of the Pointer. Only really useful in single Pointer games; otherwise see the Pointer objects directly.
-
tapRate
-
- Default Value:
- 200
- Source:
Properties:
Name Type Description tapRatenumber The number of milliseconds that the Pointer has to be pressed down and then released to be considered a tap or click.
-
<readonly> totalActivePointers
-
The total number of active Pointers
- Source:
Properties:
Name Type Description totalActivePointersnumber The total number of active Pointers.
-
<readonly> totalInactivePointers
-
The total number of inactive Pointers
- Source:
Properties:
Name Type Description totalInactivePointersnumber The total number of inactive Pointers.
-
touch
-
- Source:
Properties:
Name Type Description touchPhaser.Touch the Touch Input manager.
-
worldX
-
The world X coordinate of the most recently active pointer.
- Source:
Properties:
Name Type Description worldXnumber The world X coordinate of the most recently active pointer.
-
worldY
-
The world Y coordinate of the most recently active pointer.
- Source:
Properties:
Name Type Description worldYnumber The world Y coordinate of the most recently active pointer.
-
x
-
The X coordinate of the most recently active pointer. This value takes game scaling into account automatically. See Pointer.screenX/clientX for source values.
- Source:
Properties:
Name Type Description xnumber The X coordinate of the most recently active pointer.
-
y
-
The Y coordinate of the most recently active pointer. This value takes game scaling into account automatically. See Pointer.screenY/clientY for source values.
- Source:
Properties:
Name Type Description ynumber The Y coordinate of the most recently active pointer.
Methods
-
addMoveCallback(callback, callbackContext) → {number}
-
Adds a callback that is fired every time the activePointer receives a DOM move event such as a mousemove or touchmove. It will be called every time the activePointer moves, which in a multi-touch game can be a lot of times, so this is best to only use if you've limited input to a single pointer (i.e. mouse or touch). The callback is added to the Phaser.Input.moveCallbacks array and should be removed with Phaser.Input.deleteMoveCallback.
Parameters:
Name Type Description callbackfunction The callback that will be called each time the activePointer receives a DOM move event.
callbackContextobject The context in which the callback will be called.
- Source:
Returns:
The index of the callback entry. Use this index when calling Input.deleteMoveCallback.
- Type
- number
-
addPointer() → {Phaser.Pointer}
-
Add a new Pointer object to the Input Manager. By default Input creates 3 pointer objects: mousePointer, pointer1 and pointer2. If you need more then use this to create a new one, up to a maximum of 10.
- Source:
Returns:
A reference to the new Pointer object that was created.
- Type
- Phaser.Pointer
-
<protected> boot()
-
Starts the Input Manager running.
- Source:
-
deleteMoveCallback(index)
-
Removes the callback at the defined index from the Phaser.Input.moveCallbacks array
Parameters:
Name Type Description indexnumber The index of the callback to remove.
- Source:
-
destroy()
-
Stops all of the Input Managers from running.
- Source:
-
getLocalPosition(displayObject, pointer) → {Phaser.Point}
-
This will return the local coordinates of the specified displayObject based on the given Pointer.
Parameters:
Name Type Description displayObjectPhaser.Sprite | Phaser.Image The DisplayObject to get the local coordinates for.
pointerPhaser.Pointer The Pointer to use in the check against the displayObject.
- Source:
Returns:
A point containing the coordinates of the Pointer position relative to the DisplayObject.
- Type
- Phaser.Point
-
getPointer(state) → {Phaser.Pointer}
-
Get the next Pointer object whos active property matches the given state
Parameters:
Name Type Description stateboolean The state the Pointer should be in (false for inactive, true for active).
- Source:
Returns:
A Pointer object or null if no Pointer object matches the requested state.
- Type
- Phaser.Pointer
-
getPointerFromId(pointerId) → {Phaser.Pointer}
-
Get the Pointer object whos
pointerIdproperty matches the given value. The pointerId property is not set until the Pointer has been used at least once, as its populated by the DOM event. Also it can change every time you press the pointer down if the browser recycles it.Parameters:
Name Type Description pointerIdnumber The Pointer.pointerId value to search for.
- Source:
Returns:
A Pointer object or null if no Pointer object matches the requested identifier.
- Type
- Phaser.Pointer
-
getPointerFromIdentifier(identifier) → {Phaser.Pointer}
-
Get the Pointer object whos
identifierproperty matches the given identifier value. The identifier property is not set until the Pointer has been used at least once, as its populated by the DOM event. Also it can change every time you press the pointer down, and is not fixed once set. Note: Not all browsers set the identifier property and it's not part of the W3C spec, so you may need getPointerFromId instead.Parameters:
Name Type Description identifiernumber The Pointer.identifier value to search for.
- Source:
Returns:
A Pointer object or null if no Pointer object matches the requested identifier.
- Type
- Phaser.Pointer
-
hitTest(displayObject, pointer, localPoint)
-
Tests if the pointer hits the given object.
Parameters:
Name Type Description displayObjectDisplayObject The displayObject to test for a hit.
pointerPhaser.Pointer The pointer to use for the test.
localPointPhaser.Point The local translated point.
- Source:
-
reset(hard)
-
Reset all of the Pointers and Input states. The optional
hardparameter will reset any events or callbacks that may be bound. Input.reset is called automatically during a State change or if a game loses focus / visibility. If you wish to control the reset directly yourself then set InputManager.resetLocked totrue.Parameters:
Name Type Argument Default Description hardboolean <optional>
false A soft reset won't reset any events or callbacks that are bound. A hard reset will.
- Source:
-
resetSpeed(x, y)
-
Resets the speed and old position properties.
Parameters:
Name Type Description xnumber Sets the oldPosition.x value.
ynumber Sets the oldPosition.y value.
- Source:
-
setMoveCallback(callback, callbackContext)
-
DEPRECATED: This method will be removed in a future major point release. Please use Input.addMoveCallback instead.
Sets a callback that is fired every time the activePointer receives a DOM move event such as a mousemove or touchmove. It will be called every time the activePointer moves, which in a multi-touch game can be a lot of times, so this is best to only use if you've limited input to a single pointer (i.e. mouse or touch)
Parameters:
Name Type Description callbackfunction The callback that will be called each time the activePointer receives a DOM move event.
callbackContextobject The context in which the callback will be called.
- Source:
-
startPointer(event) → {Phaser.Pointer}
-
Find the first free Pointer object and start it, passing in the event data. This is called automatically by Phaser.Touch and Phaser.MSPointer.
Parameters:
Name Type Description eventAny The event data from the Touch event.
- Source:
Returns:
The Pointer object that was started or null if no Pointer object is available.
- Type
- Phaser.Pointer
-
stopPointer(event) → {Phaser.Pointer}
-
Stops the matching Pointer object, passing in the event data.
Parameters:
Name Type Description eventAny The event data from the Touch event.
- Source:
Returns:
The Pointer object that was stopped or null if no Pointer object is available.
- Type
- Phaser.Pointer
-
<protected> update()
-
Updates the Input Manager. Called by the core Game loop.
- Source:
-
updatePointer(event) → {Phaser.Pointer}
-
Updates the matching Pointer object, passing in the event data. This is called automatically and should not normally need to be invoked.
Parameters:
Name Type Description eventAny The event data from the Touch event.
- Source:
Returns:
The Pointer object that was updated or null if no Pointer object is available.
- Type
- Phaser.Pointer