Mirrors/phaser
2
0
Fork 0
mirror of https://github.com/photonstorm/phaser synced 2025-02-16 14:08:28 +00:00
Code Issues Projects Releases Packages Wiki Activity

* InputPlugin.forceDownState is a new method that will force the given Game Object into the 'down' input state, regardless of what state it is currently in. This will emit the relevant events accordingly. * InputPlugin.forceUpState is a new method that will force the given Game Object into the 'up' input state, regardless of what state it is currently in. This will emit the relevant events accordingly. * InputPlugin.forceOverState is a new method that will force the given Game Object into the 'over' input state, regardless of what state it is currently in. This will emit the relevant events accordingly. * InputPlugin.forceOutState is a new method that will force the given Game Object into the 'out' input state, regardless of what state it is currently in. This will emit the relevant events accordingly. * InputPlugin.forceState is a new internal method that forces a Game Object into the given state.

Browse source
This commit is contained in:
Richard Davey 2024-08-07 19:45:44 +01:00
parent 043e90c87c
commit a77976bff2
1 changed files with 127 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

127
src/input/InputPlugin.js
View file

@ -2077,6 +2077,133 @@ var InputPlugin = new Class({
return currentlyOver.length;
},
/**
* This method will force the given Game Object into the 'down' input state.
*
* This will check to see if the Game Object is enabled for input, and if so,
* it will emit the `GAMEOBJECT_POINTER_DOWN` event for it. If that doesn't change
* the input state, it will then emit the `GAMEOBJECT_DOWN` event.
*
* The Game Object is not checked against the Pointer to see if it can enter this state,
* that is up to you to do before calling this method.
*
* @method Phaser.Input.InputPlugin#forceDownState
* @fires Phaser.Input.Events#GAMEOBJECT_POINTER_DOWN
* @fires Phaser.Input.Events#GAMEOBJECT_DOWN
* @since 3.85.0
*
* @param {Phaser.Input.Pointer} pointer - The pointer to use when setting the state.
* @param {Phaser.GameObjects.GameObject} gameObject - The Game Object to have its state set.
*/
forceDownState: function (pointer, gameObject)
{
this.forceState(pointer, gameObject, Events.GAMEOBJECT_POINTER_DOWN, Events.GAMEOBJECT_DOWN, false);
},
/**
* This method will force the given Game Object into the 'up' input state.
*
* This will check to see if the Game Object is enabled for input, and if so,
* it will emit the `GAMEOBJECT_POINTER_UP` event for it. If that doesn't change
* the input state, it will then emit the `GAMEOBJECT_UP` event.
*
* The Game Object is not checked against the Pointer to see if it can enter this state,
* that is up to you to do before calling this method.
*
* @method Phaser.Input.InputPlugin#forceUpState
* @fires Phaser.Input.Events#GAMEOBJECT_POINTER_UP
* @fires Phaser.Input.Events#GAMEOBJECT_UP
* @since 3.85.0
*
* @param {Phaser.Input.Pointer} pointer - The pointer to use when setting the state.
* @param {Phaser.GameObjects.GameObject} gameObject - The Game Object to have its state set.
*/
forceUpState: function (pointer, gameObject)
{
this.forceState(pointer, gameObject, Events.GAMEOBJECT_POINTER_UP, Events.GAMEOBJECT_UP, false);
},
/**
* This method will force the given Game Object into the 'over' input state.
*
* This will check to see if the Game Object is enabled for input, and if so,
* it will emit the `GAMEOBJECT_POINTER_OVER` event for it. If that doesn't change
* the input state, it will then emit the `GAMEOBJECT_OVER` event.
*
* The Game Object is not checked against the Pointer to see if it can enter this state,
* that is up to you to do before calling this method.
*
* @method Phaser.Input.InputPlugin#forceDownState
* @fires Phaser.Input.Events#GAMEOBJECT_POINTER_OVER
* @fires Phaser.Input.Events#GAMEOBJECT_OVER
* @since 3.85.0
*
* @param {Phaser.Input.Pointer} pointer - The pointer to use when setting the state.
* @param {Phaser.GameObjects.GameObject} gameObject - The Game Object to have its state set.
*/
forceOverState: function (pointer, gameObject)
{
this.forceState(pointer, gameObject, Events.GAMEOBJECT_POINTER_OVER, Events.GAMEOBJECT_OVER, true);
},
/**
* This method will force the given Game Object into the 'out' input state.
*
* This will check to see if the Game Object is enabled for input, and if so,
* it will emit the `GAMEOBJECT_POINTER_OUT` event for it. If that doesn't change
* the input state, it will then emit the `GAMEOBJECT_OUT` event.
*
* The Game Object is not checked against the Pointer to see if it can enter this state,
* that is up to you to do before calling this method.
*
* @method Phaser.Input.InputPlugin#forceDownState
* @fires Phaser.Input.Events#GAMEOBJECT_POINTER_OUT
* @fires Phaser.Input.Events#GAMEOBJECT_OUT
* @since 3.85.0
*
* @param {Phaser.Input.Pointer} pointer - The pointer to use when setting the state.
* @param {Phaser.GameObjects.GameObject} gameObject - The Game Object to have its state set.
*/
forceOutState: function (pointer, gameObject)
{
this.forceState(pointer, gameObject, Events.GAMEOBJECT_POINTER_OUT, Events.GAMEOBJECT_OUT, false);
},
/**
* This method will force the given Game Object into the given input state.
*
* @method Phaser.Input.InputPlugin#forceState
* @since 3.85.0
*
* @param {Phaser.Input.Pointer} pointer - The pointer to use when setting the state.
* @param {Phaser.GameObjects.GameObject} gameObject - The Game Object to have its state set.
* @param {string} gameObjectEvent - The event to emit on the Game Object.
* @param {string} inputPluginEvent - The event to emit on the Input Plugin.
* @param {boolean} [setCursor=false] - Should the cursor be set to the Game Object's cursor?
*/
forceState: function (pointer, gameObject, gameObjectEvent, inputPluginEvent, setCursor)
{
var _eventData = this._eventData;
var _eventContainer = this._eventContainer;
_eventData.cancelled = false;
if (gameObject.input && gameObject.input.enabled)
{
gameObject.emit(gameObjectEvent, pointer, gameObject.input.localX, gameObject.input.localY, _eventContainer);
if (setCursor)
{
this.setCursor(gameObject.input);
}
if (!_eventData.cancelled && this.isActive() && gameObject.input && gameObject.input.enabled)
{
this.emit(inputPluginEvent, pointer, gameObject, _eventContainer);
}
}
},
/**
* Queues a Game Object for insertion into this Input Plugin on the next update.
*