new Input(game)
Constructor for Phaser Input.
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.
- Default Value:
- null
- 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.
- Default Value:
- null
- Source:
Properties:
Name Type Description circlePhaser.Circle -
currentPointers
-
The current number of active Pointers.
- Default Value:
- 0
- Source:
Properties:
Name Type Description currentPointersnumber -
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
-
The number of milliseconds between taps of the same Pointer for it to be considered a double tap / click
- Default Value:
- 300
- Source:
Properties:
Name Type Description doubleTapRatenumber -
game
-
- Source:
Properties:
Name Type Description gamePhaser.Game A reference to the currently running game.
-
game
-
- Source:
Properties:
Name Type Description gamePhaser.Game -
hitCanvas
-
- Default Value:
- null
- Source:
Properties:
Name Type Description hitCanvasDescription Description.
-
hitContext
-
- Default Value:
- null
- Source:
Properties:
Name Type Description hitContextDescription Description.
-
holdRate
-
The number of milliseconds that the Pointer has to be pressed down for it to fire a onHold event
- Default Value:
- 2000
- Source:
Properties:
Name Type Description holdRatenumber -
interactiveItems
-
A linked list of interactive objects, the InputHandler components (belonging to Sprites) register themselves with this.
- Source:
Properties:
Name Type Description interactiveItemsPhaser.LinkedList -
justPressedRate
-
The number of milliseconds below which the Pointer is considered justPressed
- Default Value:
- 200
- Source:
Properties:
Name Type Description justPressedRatenumber -
justReleasedRate
-
The number of milliseconds below which the Pointer is considered justReleased
- Default Value:
- 200
- Source:
Properties:
Name Type Description justReleasedRatenumber -
keyboard
-
The Keyboard Input manager.
- Default Value:
- null
- Source:
Properties:
Name Type Description keyboardPhaser.Keyboard The Keyboard Input manager.
-
maxPointers
-
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.
- Default Value:
- 10
- Source:
Properties:
Name Type Description maxPointersnumber -
mouse
-
The Mouse Input manager.
- Default Value:
- null
- Source:
Properties:
Name Type Description mousePhaser.Mouse The Mouse Input manager.
-
mousePointer
-
The mouse has its own unique Phaser.Pointer object which you can use if making a desktop specific game.
- Default Value:
- null
- Source:
Properties:
Name Type Description mousePointerPointer -
mspointer
-
The MSPointer Input manager.
- Default Value:
- null
- Source:
Properties:
Name Type Description mspointerPhaser.MSPointer The MSPointer Input manager.
-
multiInputOverride
-
Controls the expected behaviour when using a mouse and touch together on a multi-input device.
- Source:
Properties:
Name Type Description multiInputOverrideDescription -
onDown
-
A Signal that is dispatched each time a pointer is pressed down.
- Default Value:
- null
- Source:
Properties:
Name Type Description onDownPhaser.Signal -
onHold
-
A Signal that is dispatched each time a pointer is held down.
- Default Value:
- null
- Source:
Properties:
Name Type Description onHoldPhaser.Signal -
onTap
-
A Signal that is dispatched each time a pointer is tapped.
- Default Value:
- null
- Source:
Properties:
Name Type Description onTapPhaser.Signal -
onUp
-
A Signal that is dispatched each time a pointer is released.
- Default Value:
- null
- Source:
Properties:
Name Type Description onUpPhaser.Signal -
pointer1
-
A Pointer object
- Source:
Properties:
Name Type Description pointer1Phaser.Pointer -
pointer2
-
A Pointer object
- Source:
Properties:
Name Type Description pointer2Phaser.Pointer -
pointer3
-
A Pointer object
- Source:
Properties:
Name Type Description pointer3Phaser.Pointer -
pointer4
-
A Pointer object
- Source:
Properties:
Name Type Description pointer4Phaser.Pointer -
pointer5
-
A Pointer object
- Source:
Properties:
Name Type Description pointer5Phaser.Pointer -
pointer6
-
A Pointer object
- Source:
Properties:
Name Type Description pointer6Phaser.Pointer -
pointer7
-
A Pointer object
- Source:
Properties:
Name Type Description pointer7Phaser.Pointer -
pointer8
-
A Pointer object
- Source:
Properties:
Name Type Description pointer8Phaser.Pointer -
pointer9
-
A Pointer object
- Source:
Properties:
Name Type Description pointer9Phaser.Pointer -
pointer10
-
A Pointer object.
- Source:
Properties:
Name Type Description pointer10Phaser.Pointer -
<readonly> pollLocked
-
- Source:
Properties:
Name Type Description pollLockedboolean True if the Input is currently poll rate locked.
-
pollRate
-
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.
- Default Value:
- 0
- Source:
Properties:
Name Type Description pollRatenumber -
position
-
A vector object representing the current position of the Pointer.
- Default Value:
- null
- Source:
Properties:
Name Type Description positionPhaser.Point -
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
-
The rate in milliseconds at which the Pointer objects should update their tracking history
- Default Value:
- 100
- Source:
Properties:
Name Type Description recordRatenumber -
scale
-
The scale by which all input coordinates are multiplied, calculated by the StageScaleMode. In an un-scaled game the values will be x: 1 and y: 1.
- Default Value:
- null
- Source:
Properties:
Name Type Description scalePhaser.Point -
speed
-
A vector object representing the speed of the Pointer. Only really useful in single Pointer games, otherwise see the Pointer objects directly.
- Default Value:
- null
- Source:
Properties:
Name Type Description speedPhaser.Point -
tapRate
-
The number of milliseconds that the Pointer has to be pressed down and then released to be considered a tap or clicke
- Default Value:
- 200
- Source:
Properties:
Name Type Description tapRatenumber -
<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
-
The Touch Input manager.
- Default Value:
- null
- 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
-
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:
-
getAngle(pointer1, pointer2) → {Description}
-
Get the angle between two Pointer objects.
Parameters:
Name Type Description pointer1Pointer pointer2Pointer - Source:
Returns:
Description.
- Type
- Description
-
getDistance(pointer1, pointer2) → {Description}
-
Get the distance between two Pointer objects.
Parameters:
Name Type Description pointer1Pointer pointer2Pointer - Source:
Returns:
Description.
- Type
- Description
-
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
-
getPointerFromIdentifier(identifier) → {Phaser.Pointer}
-
Get the Pointer object whos identified property matches the given identifier value.
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
-
reset(hard)
-
Reset all of the Pointers and Input states
Parameters:
Name Type Description hardboolean A soft reset (hard = false) won't reset any Signals that might be 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:
-
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