phaser
Version:
A fast, free and fun HTML5 Game Framework for Desktop and Mobile web browsers.
1,518 lines (1,266 loc) • 93.1 kB
JavaScript
/**
* @author Richard Davey <rich@photonstorm.com>
* @copyright 2019 Photon Storm Ltd.
* @license {@link https://opensource.org/licenses/MIT|MIT License}
*/
var Circle = require('../geom/circle/Circle');
var CircleContains = require('../geom/circle/Contains');
var Class = require('../utils/Class');
var CreateInteractiveObject = require('./CreateInteractiveObject');
var CreatePixelPerfectHandler = require('./CreatePixelPerfectHandler');
var DistanceBetween = require('../math/distance/DistanceBetween');
var Ellipse = require('../geom/ellipse/Ellipse');
var EllipseContains = require('../geom/ellipse/Contains');
var Events = require('./events');
var EventEmitter = require('eventemitter3');
var GetFastValue = require('../utils/object/GetFastValue');
var InputPluginCache = require('./InputPluginCache');
var IsPlainObject = require('../utils/object/IsPlainObject');
var PluginCache = require('../plugins/PluginCache');
var Rectangle = require('../geom/rectangle/Rectangle');
var RectangleContains = require('../geom/rectangle/Contains');
var SceneEvents = require('../scene/events');
var Triangle = require('../geom/triangle/Triangle');
var TriangleContains = require('../geom/triangle/Contains');
/**
* @classdesc
* The Input Plugin belongs to a Scene and handles all input related events and operations for it.
*
* You can access it from within a Scene using `this.input`.
*
* It emits events directly. For example, you can do:
*
* ```javascript
* this.input.on('pointerdown', callback, context);
* ```
*
* To listen for a pointer down event anywhere on the game canvas.
*
* Game Objects can be enabled for input by calling their `setInteractive` method. After which they
* will directly emit input events:
*
* ```javascript
* var sprite = this.add.sprite(x, y, texture);
* sprite.setInteractive();
* sprite.on('pointerdown', callback, context);
* ```
*
* Please see the Input examples and tutorials for more information.
*
* @class InputPlugin
* @extends Phaser.Events.EventEmitter
* @memberof Phaser.Input
* @constructor
* @since 3.0.0
*
* @param {Phaser.Scene} scene - A reference to the Scene that this Input Plugin is responsible for.
*/
var InputPlugin = new Class({
Extends: EventEmitter,
initialize:
function InputPlugin (scene)
{
EventEmitter.call(this);
/**
* A reference to the Scene that this Input Plugin is responsible for.
*
* @name Phaser.Input.InputPlugin#scene
* @type {Phaser.Scene}
* @since 3.0.0
*/
this.scene = scene;
/**
* A reference to the Scene Systems class.
*
* @name Phaser.Input.InputPlugin#systems
* @type {Phaser.Scenes.Systems}
* @since 3.0.0
*/
this.systems = scene.sys;
/**
* A reference to the Scene Systems Settings.
*
* @name Phaser.Input.InputPlugin#settings
* @type {Phaser.Types.Scenes.SettingsObject}
* @since 3.5.0
*/
this.settings = scene.sys.settings;
/**
* A reference to the Game Input Manager.
*
* @name Phaser.Input.InputPlugin#manager
* @type {Phaser.Input.InputManager}
* @since 3.0.0
*/
this.manager = scene.sys.game.input;
/**
* Internal event queue used for plugins only.
*
* @name Phaser.Input.InputPlugin#pluginEvents
* @type {Phaser.Events.EventEmitter}
* @private
* @since 3.10.0
*/
this.pluginEvents = new EventEmitter();
/**
* If set, the Input Plugin will run its update loop every frame.
*
* @name Phaser.Input.InputPlugin#enabled
* @type {boolean}
* @default true
* @since 3.5.0
*/
this.enabled = true;
/**
* A reference to the Scene Display List. This property is set during the `boot` method.
*
* @name Phaser.Input.InputPlugin#displayList
* @type {Phaser.GameObjects.DisplayList}
* @since 3.0.0
*/
this.displayList;
/**
* A reference to the Scene Cameras Manager. This property is set during the `boot` method.
*
* @name Phaser.Input.InputPlugin#cameras
* @type {Phaser.Cameras.Scene2D.CameraManager}
* @since 3.0.0
*/
this.cameras;
// Inject the available input plugins into this class
InputPluginCache.install(this);
/**
* A reference to the Mouse Manager.
*
* This property is only set if Mouse support has been enabled in your Game Configuration file.
*
* If you just wish to get access to the mouse pointer, use the `mousePointer` property instead.
*
* @name Phaser.Input.InputPlugin#mouse
* @type {?Phaser.Input.Mouse.MouseManager}
* @since 3.0.0
*/
this.mouse = this.manager.mouse;
/**
* When set to `true` (the default) the Input Plugin will emulate DOM behavior by only emitting events from
* the top-most Game Objects in the Display List.
*
* If set to `false` it will emit events from all Game Objects below a Pointer, not just the top one.
*
* @name Phaser.Input.InputPlugin#topOnly
* @type {boolean}
* @default true
* @since 3.0.0
*/
this.topOnly = true;
/**
* How often should the Pointers be checked?
*
* The value is a time, given in ms, and is the time that must have elapsed between game steps before
* the Pointers will be polled again. When a pointer is polled it runs a hit test to see which Game
* Objects are currently below it, or being interacted with it.
*
* Pointers will *always* be checked if they have been moved by the user, or press or released.
*
* This property only controls how often they will be polled if they have not been updated.
* You should set this if you want to have Game Objects constantly check against the pointers, even
* if the pointer didn't move itself.
*
* Set to 0 to poll constantly. Set to -1 to only poll on user movement.
*
* @name Phaser.Input.InputPlugin#pollRate
* @type {integer}
* @default -1
* @since 3.0.0
*/
this.pollRate = -1;
/**
* Internal poll timer value.
*
* @name Phaser.Input.InputPlugin#_pollTimer
* @type {number}
* @private
* @default 0
* @since 3.0.0
*/
this._pollTimer = 0;
var _eventData = { cancelled: false };
/**
* Internal event propagation callback container.
*
* @name Phaser.Input.InputPlugin#_eventContainer
* @type {Phaser.Types.Input.EventData}
* @private
* @since 3.13.0
*/
this._eventContainer = {
stopPropagation: function ()
{
_eventData.cancelled = true;
}
};
/**
* Internal event propagation data object.
*
* @name Phaser.Input.InputPlugin#_eventData
* @type {object}
* @private
* @since 3.13.0
*/
this._eventData = _eventData;
/**
* The distance, in pixels, a pointer has to move while being held down, before it thinks it is being dragged.
*
* @name Phaser.Input.InputPlugin#dragDistanceThreshold
* @type {number}
* @default 0
* @since 3.0.0
*/
this.dragDistanceThreshold = 0;
/**
* The amount of time, in ms, a pointer has to be held down before it thinks it is dragging.
*
* @name Phaser.Input.InputPlugin#dragTimeThreshold
* @type {number}
* @default 0
* @since 3.0.0
*/
this.dragTimeThreshold = 0;
/**
* Used to temporarily store the results of the Hit Test
*
* @name Phaser.Input.InputPlugin#_temp
* @type {array}
* @private
* @default []
* @since 3.0.0
*/
this._temp = [];
/**
* Used to temporarily store the results of the Hit Test dropZones
*
* @name Phaser.Input.InputPlugin#_tempZones
* @type {array}
* @private
* @default []
* @since 3.0.0
*/
this._tempZones = [];
/**
* A list of all Game Objects that have been set to be interactive in the Scene this Input Plugin is managing.
*
* @name Phaser.Input.InputPlugin#_list
* @type {Phaser.GameObjects.GameObject[]}
* @private
* @default []
* @since 3.0.0
*/
this._list = [];
/**
* Objects waiting to be inserted to the list on the next call to 'begin'.
*
* @name Phaser.Input.InputPlugin#_pendingInsertion
* @type {Phaser.GameObjects.GameObject[]}
* @private
* @default []
* @since 3.0.0
*/
this._pendingInsertion = [];
/**
* Objects waiting to be removed from the list on the next call to 'begin'.
*
* @name Phaser.Input.InputPlugin#_pendingRemoval
* @type {Phaser.GameObjects.GameObject[]}
* @private
* @default []
* @since 3.0.0
*/
this._pendingRemoval = [];
/**
* A list of all Game Objects that have been enabled for dragging.
*
* @name Phaser.Input.InputPlugin#_draggable
* @type {Phaser.GameObjects.GameObject[]}
* @private
* @default []
* @since 3.0.0
*/
this._draggable = [];
/**
* A list of all Interactive Objects currently considered as being 'draggable' by any pointer, indexed by pointer ID.
*
* @name Phaser.Input.InputPlugin#_drag
* @type {{0:Array,2:Array,3:Array,4:Array,5:Array,6:Array,7:Array,8:Array,9:Array}}
* @private
* @since 3.0.0
*/
this._drag = { 0: [], 1: [], 2: [], 3: [], 4: [], 5: [], 6: [], 7: [], 8: [], 9: [], 10: [] };
/**
* A array containing the dragStates, for this Scene, index by the Pointer ID.
*
* @name Phaser.Input.InputPlugin#_dragState
* @type {integer[]}
* @private
* @since 3.16.0
*/
this._dragState = [];
/**
* A list of all Interactive Objects currently considered as being 'over' by any pointer, indexed by pointer ID.
*
* @name Phaser.Input.InputPlugin#_over
* @type {{0:Array,2:Array,3:Array,4:Array,5:Array,6:Array,7:Array,8:Array,9:Array}}
* @private
* @since 3.0.0
*/
this._over = { 0: [], 1: [], 2: [], 3: [], 4: [], 5: [], 6: [], 7: [], 8: [], 9: [], 10: [] };
/**
* A list of valid DOM event types.
*
* @name Phaser.Input.InputPlugin#_validTypes
* @type {string[]}
* @private
* @since 3.0.0
*/
this._validTypes = [ 'onDown', 'onUp', 'onOver', 'onOut', 'onMove', 'onDragStart', 'onDrag', 'onDragEnd', 'onDragEnter', 'onDragLeave', 'onDragOver', 'onDrop' ];
scene.sys.events.once(SceneEvents.BOOT, this.boot, this);
scene.sys.events.on(SceneEvents.START, this.start, this);
},
/**
* This method is called automatically, only once, when the Scene is first created.
* Do not invoke it directly.
*
* @method Phaser.Input.InputPlugin#boot
* @fires Phaser.Input.Events#BOOT
* @private
* @since 3.5.1
*/
boot: function ()
{
this.cameras = this.systems.cameras;
this.displayList = this.systems.displayList;
this.systems.events.once(SceneEvents.DESTROY, this.destroy, this);
// Registered input plugins listen for this
this.pluginEvents.emit(Events.BOOT);
},
/**
* This method is called automatically by the Scene when it is starting up.
* It is responsible for creating local systems, properties and listening for Scene events.
* Do not invoke it directly.
*
* @method Phaser.Input.InputPlugin#start
* @fires Phaser.Input.Events#START
* @private
* @since 3.5.0
*/
start: function ()
{
var eventEmitter = this.systems.events;
eventEmitter.on(SceneEvents.TRANSITION_START, this.transitionIn, this);
eventEmitter.on(SceneEvents.TRANSITION_OUT, this.transitionOut, this);
eventEmitter.on(SceneEvents.TRANSITION_COMPLETE, this.transitionComplete, this);
eventEmitter.on(SceneEvents.PRE_UPDATE, this.preUpdate, this);
if (this.manager.useQueue)
{
eventEmitter.on(SceneEvents.UPDATE, this.update, this);
}
else
{
eventEmitter.on(SceneEvents.UPDATE, this.pluginUpdate, this);
}
eventEmitter.once(SceneEvents.SHUTDOWN, this.shutdown, this);
this.manager.events.on(Events.GAME_OUT, this.onGameOut, this);
this.manager.events.on(Events.GAME_OVER, this.onGameOver, this);
this.enabled = true;
// Populate the pointer drag states
this._dragState = [ 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 ];
// Registered input plugins listen for this
this.pluginEvents.emit(Events.START);
},
/**
* Game Over handler.
*
* @method Phaser.Input.InputPlugin#onGameOver
* @fires Phaser.Input.Events#GAME_OVER
* @private
* @since 3.16.2
*/
onGameOver: function (event)
{
if (this.isActive())
{
this.emit(Events.GAME_OVER, event.timeStamp, event);
}
},
/**
* Game Out handler.
*
* @method Phaser.Input.InputPlugin#onGameOut
* @fires Phaser.Input.Events#GAME_OUT
* @private
* @since 3.16.2
*/
onGameOut: function (event)
{
if (this.isActive())
{
this.emit(Events.GAME_OUT, event.timeStamp, event);
}
},
/**
* The pre-update handler is responsible for checking the pending removal and insertion lists and
* deleting old Game Objects.
*
* @method Phaser.Input.InputPlugin#preUpdate
* @fires Phaser.Input.Events#PRE_UPDATE
* @private
* @since 3.0.0
*/
preUpdate: function ()
{
// Registered input plugins listen for this
this.pluginEvents.emit(Events.PRE_UPDATE);
var removeList = this._pendingRemoval;
var insertList = this._pendingInsertion;
var toRemove = removeList.length;
var toInsert = insertList.length;
if (toRemove === 0 && toInsert === 0)
{
// Quick bail
return;
}
var current = this._list;
// Delete old gameObjects
for (var i = 0; i < toRemove; i++)
{
var gameObject = removeList[i];
var index = current.indexOf(gameObject);
if (index > -1)
{
current.splice(index, 1);
this.clear(gameObject, true);
}
}
// Clear the removal list
removeList.length = 0;
this._pendingRemoval.length = 0;
// Move pendingInsertion to list (also clears pendingInsertion at the same time)
this._list = current.concat(insertList.splice(0));
},
/**
* Checks to see if both this plugin and the Scene to which it belongs is active.
*
* @method Phaser.Input.InputPlugin#isActive
* @since 3.10.0
*
* @return {boolean} `true` if the plugin and the Scene it belongs to is active.
*/
isActive: function ()
{
return (this.enabled && this.scene.sys.isActive());
},
/**
* The internal update loop for the plugins belong to this Input class.
* Called automatically by the Scene Systems step and only used if `useQueue` is false.
*
* @method Phaser.Input.InputPlugin#pluginUpdate
* @private
* @since 3.17.0
*
* @param {number} time - The time value from the most recent Game step. Typically a high-resolution timer value, or Date.now().
* @param {number} delta - The delta value since the last frame. This is smoothed to avoid delta spikes by the TimeStep class.
*/
pluginUpdate: function (time, delta)
{
if (this.pollRate > -1)
{
this.update(time, delta);
}
else
{
if (!this.isActive())
{
return;
}
this.pluginEvents.emit(Events.UPDATE, time, delta);
}
},
/**
* The internal update loop for the Input Plugin.
* Called automatically by the Scene Systems step.
*
* @method Phaser.Input.InputPlugin#update
* @fires Phaser.Input.Events#UPDATE
* @private
* @since 3.0.0
*
* @param {number} time - The time value from the most recent Game step. Typically a high-resolution timer value, or Date.now().
* @param {number} delta - The delta value since the last frame. This is smoothed to avoid delta spikes by the TimeStep class.
*/
update: function (time, delta)
{
if (!this.isActive())
{
return;
}
var manager = this.manager;
this.pluginEvents.emit(Events.UPDATE, time, delta);
// Another Scene above this one has already consumed the input events, or we're in transition
if (manager.globalTopOnly && manager.ignoreEvents)
{
return;
}
var runUpdate = (manager.dirty || this.pollRate === 0);
if (this.pollRate > 0)
{
this._pollTimer -= delta;
if (this._pollTimer < 0)
{
runUpdate = true;
// Discard timer diff
this._pollTimer = this.pollRate;
}
}
if (!runUpdate)
{
return;
}
var pointers = this.manager.pointers;
var pointersTotal = this.manager.pointersTotal;
for (var i = 0; i < pointersTotal; i++)
{
var pointer = pointers[i];
// Always reset this array
this._tempZones = [];
// _temp contains a hit tested and camera culled list of IO objects
this._temp = this.hitTestPointer(pointer);
this.sortGameObjects(this._temp);
this.sortGameObjects(this._tempZones);
if (this.topOnly)
{
// Only the top-most one counts now, so safely ignore the rest
if (this._temp.length)
{
this._temp.splice(1);
}
if (this._tempZones.length)
{
this._tempZones.splice(1);
}
}
var total = this.processDragEvents(pointer, time);
// TODO: Enable for touch - the method needs recoding to take ALL pointers at once
// and process them all together, in the same batch, otherwise the justOut and stillOver
// arrays will get corrupted in multi-touch enabled games. For now, we'll enable it for
// single touch games (which is probably the majority anyway).
if (pointersTotal < 3 || !pointer.wasTouch)
{
total += this.processOverOutEvents(pointer);
}
if (pointer.justDown)
{
total += this.processDownEvents(pointer);
}
if (pointer.justMoved)
{
total += this.processMoveEvents(pointer);
}
if (pointer.justUp)
{
total += this.processUpEvents(pointer);
}
if (total > 0 && manager.globalTopOnly)
{
// We interacted with an event in this Scene, so block any Scenes below us from doing the same this frame
manager.ignoreEvents = true;
}
}
},
/**
* Clears a Game Object so it no longer has an Interactive Object associated with it.
* The Game Object is then queued for removal from the Input Plugin on the next update.
*
* @method Phaser.Input.InputPlugin#clear
* @since 3.0.0
*
* @param {Phaser.GameObjects.GameObject} gameObject - The Game Object that will have its Interactive Object removed.
* @param {boolean} [skipQueue=false] - Skip adding this Game Object into the removal queue?
*
* @return {Phaser.GameObjects.GameObject} The Game Object that had its Interactive Object removed.
*/
clear: function (gameObject, skipQueue)
{
if (skipQueue === undefined) { skipQueue = false; }
var input = gameObject.input;
// If GameObject.input already cleared from higher class
if (!input)
{
return;
}
if (!skipQueue)
{
this.queueForRemoval(gameObject);
}
input.gameObject = undefined;
input.target = undefined;
input.hitArea = undefined;
input.hitAreaCallback = undefined;
input.callbackContext = undefined;
this.manager.resetCursor(input);
gameObject.input = null;
// Clear from _draggable, _drag and _over
var index = this._draggable.indexOf(gameObject);
if (index > -1)
{
this._draggable.splice(index, 1);
}
index = this._drag[0].indexOf(gameObject);
if (index > -1)
{
this._drag[0].splice(index, 1);
}
index = this._over[0].indexOf(gameObject);
if (index > -1)
{
this._over[0].splice(index, 1);
}
return gameObject;
},
/**
* Disables Input on a single Game Object.
*
* An input disabled Game Object still retains its Interactive Object component and can be re-enabled
* at any time, by passing it to `InputPlugin.enable`.
*
* @method Phaser.Input.InputPlugin#disable
* @since 3.0.0
*
* @param {Phaser.GameObjects.GameObject} gameObject - The Game Object to have its input system disabled.
*/
disable: function (gameObject)
{
gameObject.input.enabled = false;
},
/**
* Enable a Game Object for interaction.
*
* If the Game Object already has an Interactive Object component, it is enabled and returned.
*
* Otherwise, a new Interactive Object component is created and assigned to the Game Object's `input` property.
*
* Input works by using hit areas, these are nearly always geometric shapes, such as rectangles or circles, that act as the hit area
* for the Game Object. However, you can provide your own hit area shape and callback, should you wish to handle some more advanced
* input detection.
*
* If no arguments are provided it will try and create a rectangle hit area based on the texture frame the Game Object is using. If
* this isn't a texture-bound object, such as a Graphics or BitmapText object, this will fail, and you'll need to provide a specific
* shape for it to use.
*
* You can also provide an Input Configuration Object as the only argument to this method.
*
* @method Phaser.Input.InputPlugin#enable
* @since 3.0.0
*
* @param {Phaser.GameObjects.GameObject} gameObject - The Game Object to be enabled for input.
* @param {(Phaser.Types.Input.InputConfiguration|any)} [shape] - Either an input configuration object, or a geometric shape that defines the hit area for the Game Object. If not specified a Rectangle will be used.
* @param {Phaser.Types.Input.HitAreaCallback} [callback] - The 'contains' function to invoke to check if the pointer is within the hit area.
* @param {boolean} [dropZone=false] - Is this Game Object a drop zone or not?
*
* @return {Phaser.Input.InputPlugin} This Input Plugin.
*/
enable: function (gameObject, shape, callback, dropZone)
{
if (dropZone === undefined) { dropZone = false; }
if (gameObject.input)
{
// If it is already has an InteractiveObject then just enable it and return
gameObject.input.enabled = true;
}
else
{
// Create an InteractiveObject and enable it
this.setHitArea(gameObject, shape, callback);
}
if (gameObject.input && dropZone && !gameObject.input.dropZone)
{
gameObject.input.dropZone = dropZone;
}
return this;
},
/**
* Takes the given Pointer and performs a hit test against it, to see which interactive Game Objects
* it is currently above.
*
* The hit test is performed against which-ever Camera the Pointer is over. If it is over multiple
* cameras, it starts checking the camera at the top of the camera list, and if nothing is found, iterates down the list.
*
* @method Phaser.Input.InputPlugin#hitTestPointer
* @since 3.0.0
*
* @param {Phaser.Input.Pointer} pointer - The Pointer to check against the Game Objects.
*
* @return {Phaser.GameObjects.GameObject[]} An array of all the interactive Game Objects the Pointer was above.
*/
hitTestPointer: function (pointer)
{
var cameras = this.cameras.getCamerasBelowPointer(pointer);
for (var c = 0; c < cameras.length; c++)
{
var camera = cameras[c];
// Get a list of all objects that can be seen by the camera below the pointer in the scene and store in 'over' array.
// All objects in this array are input enabled, as checked by the hitTest method, so we don't need to check later on as well.
var over = this.manager.hitTest(pointer, this._list, camera);
// Filter out the drop zones
for (var i = 0; i < over.length; i++)
{
var obj = over[i];
if (obj.input.dropZone)
{
this._tempZones.push(obj);
}
}
if (over.length > 0)
{
pointer.camera = camera;
return over;
}
}
// If we got this far then there were no Game Objects below the pointer, but it was still over
// a camera, so set that the top-most one into the pointer
pointer.camera = cameras[0];
return [];
},
/**
* An internal method that handles the Pointer down event.
*
* @method Phaser.Input.InputPlugin#processDownEvents
* @private
* @fires Phaser.Input.Events#GAMEOBJECT_POINTER_DOWN
* @fires Phaser.Input.Events#GAMEOBJECT_DOWN
* @fires Phaser.Input.Events#POINTER_DOWN
* @fires Phaser.Input.Events#POINTER_DOWN_OUTSIDE
* @since 3.0.0
*
* @param {Phaser.Input.Pointer} pointer - The Pointer being tested.
*
* @return {integer} The total number of objects interacted with.
*/
processDownEvents: function (pointer)
{
var total = 0;
var currentlyOver = this._temp;
var _eventData = this._eventData;
var _eventContainer = this._eventContainer;
_eventData.cancelled = false;
var aborted = false;
// Go through all objects the pointer was over and fire their events / callbacks
for (var i = 0; i < currentlyOver.length; i++)
{
var gameObject = currentlyOver[i];
if (!gameObject.input)
{
continue;
}
total++;
gameObject.emit(Events.GAMEOBJECT_POINTER_DOWN, pointer, gameObject.input.localX, gameObject.input.localY, _eventContainer);
if (_eventData.cancelled || !gameObject.input)
{
aborted = true;
break;
}
this.emit(Events.GAMEOBJECT_DOWN, pointer, gameObject, _eventContainer);
if (_eventData.cancelled || !gameObject.input)
{
aborted = true;
break;
}
}
// If they released outside the canvas, but pressed down inside it, we'll still dispatch the event.
if (!aborted)
{
if (pointer.downElement === this.manager.game.canvas)
{
this.emit(Events.POINTER_DOWN, pointer, currentlyOver);
}
else
{
this.emit(Events.POINTER_DOWN_OUTSIDE, pointer);
}
}
return total;
},
/**
* Returns the drag state of the given Pointer for this Input Plugin.
*
* The state will be one of the following:
*
* 0 = Not dragging anything
* 1 = Primary button down and objects below, so collect a draglist
* 2 = Pointer being checked if meets drag criteria
* 3 = Pointer meets criteria, notify the draglist
* 4 = Pointer actively dragging the draglist and has moved
* 5 = Pointer actively dragging but has been released, notify draglist
*
* @method Phaser.Input.InputPlugin#getDragState
* @since 3.16.0
*
* @param {Phaser.Input.Pointer} pointer - The Pointer to get the drag state for.
*
* @return {integer} The drag state of the given Pointer.
*/
getDragState: function (pointer)
{
return this._dragState[pointer.id];
},
/**
* Sets the drag state of the given Pointer for this Input Plugin.
*
* The state must be one of the following values:
*
* 0 = Not dragging anything
* 1 = Primary button down and objects below, so collect a draglist
* 2 = Pointer being checked if meets drag criteria
* 3 = Pointer meets criteria, notify the draglist
* 4 = Pointer actively dragging the draglist and has moved
* 5 = Pointer actively dragging but has been released, notify draglist
*
* @method Phaser.Input.InputPlugin#setDragState
* @since 3.16.0
*
* @param {Phaser.Input.Pointer} pointer - The Pointer to set the drag state for.
* @param {integer} state - The drag state value. An integer between 0 and 5.
*/
setDragState: function (pointer, state)
{
this._dragState[pointer.id] = state;
},
/**
* An internal method that handles the Pointer drag events.
*
* @method Phaser.Input.InputPlugin#processDragEvents
* @private
* @fires Phaser.Input.Events#DRAG_END
* @fires Phaser.Input.Events#DRAG_ENTER
* @fires Phaser.Input.Events#DRAG
* @fires Phaser.Input.Events#DRAG_LEAVE
* @fires Phaser.Input.Events#DRAG_OVER
* @fires Phaser.Input.Events#DRAG_START
* @fires Phaser.Input.Events#DROP
* @fires Phaser.Input.Events#GAMEOBJECT_DOWN
* @fires Phaser.Input.Events#GAMEOBJECT_DRAG_END
* @fires Phaser.Input.Events#GAMEOBJECT_DRAG_ENTER
* @fires Phaser.Input.Events#GAMEOBJECT_DRAG
* @fires Phaser.Input.Events#GAMEOBJECT_DRAG_LEAVE
* @fires Phaser.Input.Events#GAMEOBJECT_DRAG_OVER
* @fires Phaser.Input.Events#GAMEOBJECT_DRAG_START
* @fires Phaser.Input.Events#GAMEOBJECT_DROP
* @since 3.0.0
*
* @param {Phaser.Input.Pointer} pointer - The Pointer to check against the Game Objects.
* @param {number} time - The time stamp of the most recent Game step.
*
* @return {integer} The total number of objects interacted with.
*/
processDragEvents: function (pointer, time)
{
if (this._draggable.length === 0)
{
// There are no draggable items, so let's not even bother going further
return 0;
}
var i;
var gameObject;
var list;
var input;
var currentlyOver = this._temp;
// 0 = Not dragging anything
// 1 = Primary button down and objects below, so collect a draglist
// 2 = Pointer being checked if meets drag criteria
// 3 = Pointer meets criteria, notify the draglist
// 4 = Pointer actively dragging the draglist and has moved
// 5 = Pointer actively dragging but has been released, notify draglist
if (this.getDragState(pointer) === 0 && pointer.primaryDown && pointer.justDown && currentlyOver.length > 0)
{
this.setDragState(pointer, 1);
}
else if (this.getDragState(pointer) > 0 && !pointer.primaryDown && pointer.justUp)
{
this.setDragState(pointer, 5);
}
// Process the various drag states
// 1 = Primary button down and objects below, so collect a draglist
if (this.getDragState(pointer) === 1)
{
// Get draggable objects, sort them, pick the top (or all) and store them somewhere
var draglist = [];
for (i = 0; i < currentlyOver.length; i++)
{
gameObject = currentlyOver[i];
if (gameObject.input.draggable && (gameObject.input.dragState === 0))
{
draglist.push(gameObject);
}
}
if (draglist.length === 0)
{
this.setDragState(pointer, 0);
return 0;
}
else if (draglist.length > 1)
{
this.sortGameObjects(draglist);
if (this.topOnly)
{
draglist.splice(1);
}
}
// draglist now contains all potential candidates for dragging
this._drag[pointer.id] = draglist;
if (this.dragDistanceThreshold === 0 && this.dragTimeThreshold === 0)
{
// No drag criteria, so snap immediately to mode 3
this.setDragState(pointer, 3);
}
else
{
// Check the distance / time
this.setDragState(pointer, 2);
}
}
// 2 = Pointer being checked if meets drag criteria
if (this.getDragState(pointer) === 2)
{
// Has it moved far enough to be considered a drag?
if (this.dragDistanceThreshold > 0 && DistanceBetween(pointer.x, pointer.y, pointer.downX, pointer.downY) >= this.dragDistanceThreshold)
{
// Alrighty, we've got a drag going on ...
this.setDragState(pointer, 3);
}
// Held down long enough to be considered a drag?
if (this.dragTimeThreshold > 0 && (time >= pointer.downTime + this.dragTimeThreshold))
{
// Alrighty, we've got a drag going on ...
this.setDragState(pointer, 3);
}
}
// 3 = Pointer meets criteria and is freshly down, notify the draglist
if (this.getDragState(pointer) === 3)
{
list = this._drag[pointer.id];
for (i = 0; i < list.length; i++)
{
gameObject = list[i];
input = gameObject.input;
input.dragState = 2;
input.dragX = pointer.x - gameObject.x;
input.dragY = pointer.y - gameObject.y;
input.dragStartX = gameObject.x;
input.dragStartY = gameObject.y;
gameObject.emit(Events.GAMEOBJECT_DRAG_START, pointer, input.dragX, input.dragY);
this.emit(Events.DRAG_START, pointer, gameObject);
}
this.setDragState(pointer, 4);
return list.length;
}
var target;
// 4 = Pointer actively dragging the draglist and has moved
if (this.getDragState(pointer) === 4 && pointer.justMoved && !pointer.justUp)
{
var dropZones = this._tempZones;
list = this._drag[pointer.id];
for (i = 0; i < list.length; i++)
{
gameObject = list[i];
input = gameObject.input;
target = input.target;
// If this GO has a target then let's check it
if (target)
{
var index = dropZones.indexOf(target);
// Got a target, are we still over it?
if (index === 0)
{
// We're still over it, and it's still the top of the display list, phew ...
gameObject.emit(Events.GAMEOBJECT_DRAG_OVER, pointer, target);
this.emit(Events.DRAG_OVER, pointer, gameObject, target);
}
else if (index > 0)
{
// Still over it but it's no longer top of the display list (targets must always be at the top)
gameObject.emit(Events.GAMEOBJECT_DRAG_LEAVE, pointer, target);
this.emit(Events.DRAG_LEAVE, pointer, gameObject, target);
input.target = dropZones[0];
target = input.target;
gameObject.emit(Events.GAMEOBJECT_DRAG_ENTER, pointer, target);
this.emit(Events.DRAG_ENTER, pointer, gameObject, target);
}
else
{
// Nope, we've moved on (or the target has!), leave the old target
gameObject.emit(Events.GAMEOBJECT_DRAG_LEAVE, pointer, target);
this.emit(Events.DRAG_LEAVE, pointer, gameObject, target);
// Anything new to replace it?
// Yup!
if (dropZones[0])
{
input.target = dropZones[0];
target = input.target;
gameObject.emit(Events.GAMEOBJECT_DRAG_ENTER, pointer, target);
this.emit(Events.DRAG_ENTER, pointer, gameObject, target);
}
else
{
// Nope
input.target = null;
}
}
}
else if (!target && dropZones[0])
{
input.target = dropZones[0];
target = input.target;
gameObject.emit(Events.GAMEOBJECT_DRAG_ENTER, pointer, target);
this.emit(Events.DRAG_ENTER, pointer, gameObject, target);
}
var dragX = pointer.x - gameObject.input.dragX;
var dragY = pointer.y - gameObject.input.dragY;
gameObject.emit(Events.GAMEOBJECT_DRAG, pointer, dragX, dragY);
this.emit(Events.DRAG, pointer, gameObject, dragX, dragY);
}
return list.length;
}
// 5 = Pointer was actively dragging but has been released, notify draglist
if (this.getDragState(pointer) === 5)
{
list = this._drag[pointer.id];
for (i = 0; i < list.length; i++)
{
gameObject = list[i];
input = gameObject.input;
if (input && input.dragState === 2)
{
input.dragState = 0;
input.dragX = input.localX - gameObject.displayOriginX;
input.dragY = input.localY - gameObject.displayOriginY;
var dropped = false;
target = input.target;
if (target)
{
gameObject.emit(Events.GAMEOBJECT_DROP, pointer, target);
this.emit(Events.DROP, pointer, gameObject, target);
input.target = null;
dropped = true;
}
// And finally the dragend event
if (gameObject.input)
{
gameObject.emit(Events.GAMEOBJECT_DRAG_END, pointer, input.dragX, input.dragY, dropped);
this.emit(Events.DRAG_END, pointer, gameObject, dropped);
}
}
}
this.setDragState(pointer, 0);
list.splice(0);
}
return 0;
},
/**
* An internal method that handles the Pointer movement event.
*
* @method Phaser.Input.InputPlugin#processMoveEvents
* @fires Phaser.Input.Events#GAMEOBJECT_POINTER_MOVE
* @fires Phaser.Input.Events#GAMEOBJECT_MOVE
* @fires Phaser.Input.Events#POINTER_MOVE
* @private
* @since 3.0.0
*
* @param {Phaser.Input.Pointer} pointer - The pointer to check for events against.
*
* @return {integer} The total number of objects interacted with.
*/
processMoveEvents: function (pointer)
{
var total = 0;
var currentlyOver = this._temp;
var _eventData = this._eventData;
var _eventContainer = this._eventContainer;
_eventData.cancelled = false;
var aborted = false;
// Go through all objects the pointer was over and fire their events / callbacks
for (var i = 0; i < currentlyOver.length; i++)
{
var gameObject = currentlyOver[i];
if (!gameObject.input)
{
continue;
}
total++;
gameObject.emit(Events.GAMEOBJECT_POINTER_MOVE, pointer, gameObject.input.localX, gameObject.input.localY, _eventContainer);
if (_eventData.cancelled || !gameObject.input)
{
aborted = true;
break;
}
this.emit(Events.GAMEOBJECT_MOVE, pointer, gameObject, _eventContainer);
if (_eventData.cancelled || !gameObject.input)
{
aborted = true;
break;
}
if (this.topOnly)
{
break;
}
}
if (!aborted)
{
this.emit(Events.POINTER_MOVE, pointer, currentlyOver);
}
return total;
},
/**
* An internal method that handles the Pointer over and out events.
*
* @method Phaser.Input.InputPlugin#processOverOutEvents
* @private
* @fires Phaser.Input.Events#GAMEOBJECT_POINTER_OVER
* @fires Phaser.Input.Events#GAMEOBJECT_OVER
* @fires Phaser.Input.Events#POINTER_OVER
* @fires Phaser.Input.Events#GAMEOBJECT_POINTER_OUT
* @fires Phaser.Input.Events#GAMEOBJECT_OUT
* @fires Phaser.Input.Events#POINTER_OUT
* @since 3.0.0
*
* @param {Phaser.Input.Pointer} pointer - The pointer to check for events against.
*
* @return {integer} The total number of objects interacted with.
*/
processOverOutEvents: function (pointer)
{
var currentlyOver = this._temp;
var i;
var gameObject;
var justOut = [];
var justOver = [];
var stillOver = [];
var previouslyOver = this._over[pointer.id];
var currentlyDragging = this._drag[pointer.id];
var manager = this.manager;
// Go through all objects the pointer was previously over, and see if it still is.
// Splits the previouslyOver array into two parts: justOut and stillOver
for (i = 0; i < previouslyOver.length; i++)
{
gameObject = previouslyOver[i];
if (currentlyOver.indexOf(gameObject) === -1 && currentlyDragging.indexOf(gameObject) === -1)
{
// Not in the currentlyOver array, so must be outside of this object now
justOut.push(gameObject);
}
else
{
// In the currentlyOver array
stillOver.push(gameObject);
}
}
// Go through all objects the pointer is currently over (the hit test results)
// and if not in the previouslyOver array we know it's a new entry, so add to justOver
for (i = 0; i < currentlyOver.length; i++)
{
gameObject = currentlyOver[i];
// Is this newly over?
if (previouslyOver.indexOf(gameObject) === -1)
{
justOver.push(gameObject);
}
}
// By this point the arrays are filled, so now we can process what happened...
// Process the Just Out objects
var total = justOut.length;
var totalInteracted = 0;
var _eventData = this._eventData;
var _eventContainer = this._eventContainer;
_eventData.cancelled = false;
var aborted = false;
if (total > 0)
{
this.sortGameObjects(justOut);
// Call onOut for everything in the justOut array
for (i = 0; i < total; i++)
{
gameObject = justOut[i];
if (!gameObject.input)
{
continue;
}
gameObject.emit(Events.GAMEOBJECT_POINTER_OUT, pointer, _eventContainer);
manager.resetCursor(gameObject.input);
totalInteracted++;
if (_eventData.cancelled || !gameObject.input)
{
aborted = true;
break;
}
this.emit(Events.GAMEOBJECT_OUT, pointer, gameObject, _eventContainer);
if (_eventData.cancelled || !gameObject.input)
{
aborted = true;
break;
}
}
if (!aborted)
{
this.emit(Events.POINTER_OUT, pointer, justOut);
}
}
// Process the Just Over objects
total = justOver.length;
_eventData.cancelled = false;
aborted = false;
if (total > 0)
{
this.sortGameObjects(justOver);
// Call onOver for everything in the justOver array
for (i = 0; i < total; i++)
{
gameObject = justOver[i];
if (!gameObject.input)
{
continue;
}
gameObject.emit(Events.GAMEOBJECT_POINTER_OVER, pointer, gameObject.input.localX, gameObject.input.localY, _eventContainer);
manager.setCursor(gameObject.input);
totalInteracted++;
if (_eventData.cancelled || !gameObject.input)
{
aborted = true;
break;
}
this.emit(Events.GAMEOBJECT_OVER, pointer, gameObject, _eventContainer);
if (_eventData.cancelled || !gameObject.input)
{
aborted = true;
break;
}
}
if (!aborted)
{
this.emit(Events.POINTER_OVER, pointer, justOver);
}
}
// Add the contents of justOver to the previously over array
previouslyOver = stillOver.concat(justOver);
// Then sort it into display list order
this._over[pointer.id] = this.sortGameObjects(previouslyOver);
return totalInteracted;
},
/**
* An internal method that handles the Pointer up events.
*
* @method Phaser.Input.InputPlugin#processUpEvents
* @private
* @fires Phaser.Input.Events#GAMEOBJECT_POINTER_UP
* @fires Phaser.Input.Events#GAMEOBJECT_UP
* @fires Phaser.Input.Events#POINTER_UP
* @fires Phaser.Input.Events#POINTER_UP_OUTSIDE
* @since 3.0.0
*
* @param {Phaser.Input.Pointer} po