Phaser Class: Arcade

new Arcade(game)

Arcade Physics constructor.

Parameters:

Name	Type	Description
`game`	Phaser.Game	reference to the current game instance.

Source:

physics/arcade/ArcadePhysics.js, line 20

Members

maxLevels :number

Used by the QuadTree to set the maximum number of levels

Type:

number

Source:

physics/arcade/ArcadePhysics.js, line 37

maxObjects :number

Used by the QuadTree to set the maximum number of objects

Type:

number

Source:

physics/arcade/ArcadePhysics.js, line 31

Methods

accelerateToObject(displayObject, destination, speed, xSpeedMax, ySpeedMax) → {number}

Sets the acceleration.x/y property on the display object so it will move towards the target at the given speed (in pixels per second sq.) You must give a maximum speed value, beyond which the display object won't go any faster. Note: The display object does not continuously track the target. If the target changes location during transit the display object will not modify its course. Note: The display object doesn't stop moving once it reaches the destination coordinates.

Parameters:

Name	Type	Argument	Default	Description
`displayObject`	any			The display object to move.
`destination`	any			The display object to move towards. Can be any object but must have visible x/y properties.
`speed`	number	<optional>	60	The speed it will accelerate in pixels per second.
`xSpeedMax`	number	<optional>	500	The maximum x velocity the display object can reach.
`ySpeedMax`	number	<optional>	500	The maximum y velocity the display object can reach.

Source:

physics/arcade/ArcadePhysics.js, line 1072

Returns:

The angle (in radians) that the object should be visually set to in order to match its new trajectory.

Type: number

accelerateToPointer(displayObject, pointer, speed, xSpeedMax, ySpeedMax) → {number}

Parameters:

Name	Type	Argument	Default	Description
`displayObject`	any			The display object to move.
`pointer`	Phaser.Pointer	<optional>		The pointer to move towards. Defaults to Phaser.Input.activePointer.
`speed`	number	<optional>	60	The speed it will accelerate in pixels per second.
`xSpeedMax`	number	<optional>	500	The maximum x velocity the display object can reach.
`ySpeedMax`	number	<optional>	500	The maximum y velocity the display object can reach.

Source:

physics/arcade/ArcadePhysics.js, line 1101

Returns:

The angle (in radians) that the object should be visually set to in order to match its new trajectory.

Type: number

accelerateToXY(displayObject, x, y, speed, xSpeedMax, ySpeedMax) → {number}

Sets the acceleration.x/y property on the display object so it will move towards the x/y coordinates at the given speed (in pixels per second sq.) You must give a maximum speed value, beyond which the display object won't go any faster. Note: The display object does not continuously track the target. If the target changes location during transit the display object will not modify its course. Note: The display object doesn't stop moving once it reaches the destination coordinates.

Parameters:

Name	Type	Argument	Default	Description
`displayObject`	any			The display object to move.
`x`	number			The x coordinate to accelerate towards.
`y`	number			The y coordinate to accelerate towards.
`speed`	number	<optional>	60	The speed it will accelerate in pixels per second.
`xSpeedMax`	number	<optional>	500	The maximum x velocity the display object can reach.
`ySpeedMax`	number	<optional>	500	The maximum y velocity the display object can reach.

Source:

physics/arcade/ArcadePhysics.js, line 1131

Returns:

The angle (in radians) that the object should be visually set to in order to match its new trajectory.

Type: number

accelerationFromRotation(rotation, speed, point) → {Phaser.Point}

Given the rotation (in radians) and speed calculate the acceleration and return it as a Point object, or set it to the given point object. One way to use this is: velocityFromRotation(rotation, 200, sprite.velocity) which will set the values directly to the sprites velocity and not create a new Point object.

Parameters:

Name	Type	Argument	Default	Description
`rotation`	number			The angle in radians.
`speed`	number	<optional>	60	The speed it will move, in pixels per second sq.
`point`	Phaser.Point \| object	<optional>		The Point object in which the x and y properties will be set to the calculated acceleration.

Source:

physics/arcade/ArcadePhysics.js, line 1053

Returns:

A Point where point.x contains the acceleration x value and point.y contains the acceleration y value.

Type: Phaser.Point

angleBetween(source, target) → {number}

Find the angle in radians between two display objects (like Sprites).

Parameters:

Name	Type	Description
`source`	any	The Display Object to test from.
`target`	any	The Display Object to test to.

Source:

physics/arcade/ArcadePhysics.js, line 1219

Returns:

The angle in radians between the source and target display objects.

Type: number

angleToPointer(displayObject, pointer) → {number}

Find the angle in radians between a display object (like a Sprite) and a Pointer, taking their x/y and center into account.

Parameters:

Name	Type	Argument	Description
`displayObject`	any		The Display Object to test from.
`pointer`	Phaser.Pointer	<optional>	The Phaser.Pointer to test to. If none is given then Input.activePointer is used.

Source:

physics/arcade/ArcadePhysics.js, line 1254

Returns:

The angle in radians between displayObject.x/y to Pointer.x/y

Type: number

angleToXY(displayObject, x, y) → {number}

Find the angle in radians between a display object (like a Sprite) and the given x/y coordinate.

Parameters:

Name	Type	Description
`displayObject`	any	The Display Object to test from.
`x`	number	The x coordinate to get the angle to.
`y`	number	The y coordinate to get the angle to.

Source:

physics/arcade/ArcadePhysics.js, line 1236

Returns:

The angle in radians between displayObject.x/y to Pointer.x/y

Type: number

collide(object1, object2, collideCallback, processCallback, callbackContext) → {number}

Checks for collision between two game objects. The objects can be Sprites, Groups, Emitters or Tilemaps. You can perform Sprite vs. Sprite, Sprite vs. Group, Group vs. Group, Sprite vs. Tilemap or Group vs. Tilemap collisions. The objects are also automatically separated.

Parameters:

Name	Type	Argument	Default	Description
`object1`	Phaser.Sprite \| Phaser.Group \| Phaser.Particles.Emitter \| Phaser.Tilemap			The first object to check. Can be an instance of Phaser.Sprite, Phaser.Group, Phaser.Particles.Emitter, or Phaser.Tilemap
`object2`	Phaser.Sprite \| Phaser.Group \| Phaser.Particles.Emitter \| Phaser.Tilemap			The second object to check. Can be an instance of Phaser.Sprite, Phaser.Group, Phaser.Particles.Emitter or Phaser.Tilemap
`collideCallback`	function	<optional>	null	An optional callback function that is called if the objects overlap. The two objects will be passed to this function in the same order in which you passed them to Collision.overlap.
`processCallback`	function	<optional>	null	A callback function that lets you perform additional checks against the two objects if they overlap. If this is set then collideCallback will only be called if processCallback returns true.
`callbackContext`	object	<optional>		The context in which to run the callbacks.

Source:

physics/arcade/ArcadePhysics.js, line 207

Returns:

The number of collisions that were processed.

Type: number

computeVelocity(axis, body, velocity, acceleration, drag, mMax) → {number}

A tween-like function that takes a starting velocity and some other factors and returns an altered velocity.

Parameters:

Name	Type	Description
`axis`	number	1 for horizontal, 2 for vertical.
`body`	Phaser.Physics.Arcade.Body	The Body object to be updated.
`velocity`	number	Any component of velocity (e.g. 20).
`acceleration`	number	Rate at which the velocity is changing.
`drag`	number	Really kind of a deceleration, this is how much the velocity changes if Acceleration is not set.
`mMax`	number	An absolute value cap for the velocity.

Source:

physics/arcade/ArcadePhysics.js, line 97

Returns:

The altered Velocity value.

Type: number

distanceBetween(source, target) → {number}

Find the distance between two display objects (like Sprites).

Parameters:

Name	Type	Description
`source`	any	The Display Object to test from.
`target`	any	The Display Object to test to.

Source:

physics/arcade/ArcadePhysics.js, line 1161

Returns:

The distance between the source and target objects.

Type: number

distanceToPointer(displayObject, pointer) → {number}

Find the distance between a display object (like a Sprite) and a Pointer. If no Pointer is given the Input.activePointer is used. The calculation is made from the display objects x/y coordinate. This may be the top-left if its anchor hasn't been changed. If you need to calculate from the center of a display object instead use the method distanceBetweenCenters()

Parameters:

Name	Type	Argument	Description
`displayObject`	any		The Display Object to test from.
`pointer`	Phaser.Pointer	<optional>	The Phaser.Pointer to test to. If none is given then Input.activePointer is used.

Source:

physics/arcade/ArcadePhysics.js, line 1198

Returns:

The distance between the object and the Pointer.

Type: number

distanceToXY(displayObject, x, y) → {number}

Find the distance between a display object (like a Sprite) and the given x/y coordinates. The calculation is made from the display objects x/y coordinate. This may be the top-left if its anchor hasn't been changed. If you need to calculate from the center of a display object instead use the method distanceBetweenCenters()

Parameters:

Name	Type	Description
`displayObject`	any	The Display Object to test from.
`x`	number	The x coordinate to move towards.
`y`	number	The y coordinate to move towards.

Source:

physics/arcade/ArcadePhysics.js, line 1178

Returns:

The distance between the object and the x/y coordinates.

Type: number

moveToObject(displayObject, destination, speed, maxTime) → {number}

Move the given display object towards the destination object at a steady velocity. If you specify a maxTime then it will adjust the speed (over-writing what you set) so it arrives at the destination in that number of seconds. Timings are approximate due to the way browser timers work. Allow for a variance of +- 50ms. Note: The display object does not continuously track the target. If the target changes location during transit the display object will not modify its course. Note: The display object doesn't stop moving once it reaches the destination coordinates. Note: Doesn't take into account acceleration, maxVelocity or drag (if you've set drag or acceleration too high this object may not move at all)

Parameters:

Name	Type	Argument	Default	Description
`displayObject`	any			The display object to move.
`destination`	any			The display object to move towards. Can be any object but must have visible x/y properties.
`speed`	number	<optional>	60	The speed it will move, in pixels per second (default is 60 pixels/sec)
`maxTime`	number	<optional>	0	Time given in milliseconds (1000 = 1 sec). If set the speed is adjusted so the object will arrive at destination in the given number of ms.

Source:

physics/arcade/ArcadePhysics.js, line 909

Returns:

The angle (in radians) that the object should be visually set to in order to match its new velocity.

Type: number

moveToPointer(displayObject, speed, pointer, maxTime) → {number}

Move the given display object towards the pointer at a steady velocity. If no pointer is given it will use Phaser.Input.activePointer. If you specify a maxTime then it will adjust the speed (over-writing what you set) so it arrives at the destination in that number of seconds. Timings are approximate due to the way browser timers work. Allow for a variance of +- 50ms. Note: The display object does not continuously track the target. If the target changes location during transit the display object will not modify its course. Note: The display object doesn't stop moving once it reaches the destination coordinates.

Parameters:

Name	Type	Argument	Default	Description
`displayObject`	any			The display object to move.
`speed`	number	<optional>	60	The speed it will move, in pixels per second (default is 60 pixels/sec)
`pointer`	Phaser.Pointer	<optional>		The pointer to move towards. Defaults to Phaser.Input.activePointer.
`maxTime`	number	<optional>	0	Time given in milliseconds (1000 = 1 sec). If set the speed is adjusted so the object will arrive at destination in the given number of ms.

Source:

physics/arcade/ArcadePhysics.js, line 944

Returns:

The angle (in radians) that the object should be visually set to in order to match its new velocity.

Type: number

moveToXY(displayObject, x, y, speed, maxTime) → {number}

Move the given display object towards the x/y coordinates at a steady velocity. If you specify a maxTime then it will adjust the speed (over-writing what you set) so it arrives at the destination in that number of seconds. Timings are approximate due to the way browser timers work. Allow for a variance of +- 50ms. Note: The display object does not continuously track the target. If the target changes location during transit the display object will not modify its course. Note: The display object doesn't stop moving once it reaches the destination coordinates. Note: Doesn't take into account acceleration, maxVelocity or drag (if you've set drag or acceleration too high this object may not move at all)

Parameters:

Name	Type	Argument	Default	Description
`displayObject`	any			The display object to move.
`x`	number			The x coordinate to move towards.
`y`	number			The y coordinate to move towards.
`speed`	number	<optional>	60	The speed it will move, in pixels per second (default is 60 pixels/sec)
`maxTime`	number	<optional>	0	Time given in milliseconds (1000 = 1 sec). If set the speed is adjusted so the object will arrive at destination in the given number of ms.

Source:

physics/arcade/ArcadePhysics.js, line 979

Returns:

The angle (in radians) that the object should be visually set to in order to match its new velocity.

Type: number

overlap(object1, object2) → {boolean}

Checks if two Sprite objects overlap.

Parameters:

Name	Type	Description
`object1`	Phaser.Sprite	The first object to check. Can be an instance of Phaser.Sprite or anything that extends it.
`object2`	Phaser.Sprite	The second object to check. Can be an instance of Phaser.Sprite or anything that extends it.

Source:

physics/arcade/ArcadePhysics.js, line 187

Returns:

true if the two objects overlap.

Type: boolean

<protected> postUpdate()

Called automatically by the core game loop.

Source:

physics/arcade/ArcadePhysics.js, line 174

<protected> preUpdate()

Called automatically by the core game loop.

Source:

physics/arcade/ArcadePhysics.js, line 157

separate(body1, body2) → {boolean}

The core separation function to separate two physics bodies.

Parameters:

Name	Type	Description
`body1`	Phaser.Physics.Arcade.Body	The Body object to separate.
`body2`	Phaser.Physics.Arcade.Body	The Body object to separate.

Source:

physics/arcade/ArcadePhysics.js, line 486

Returns:

Returns true if the bodies were separated, otherwise false.

Type: boolean

separateTile(body1, tile) → {boolean}

The core separation function to separate a physics body and a tile.

Parameters:

Name	Type	Description
`body1`	Phaser.Physics.Arcade.Body	The Body object to separate.
`tile`	Phaser.Tile	The tile to collide against.

Source:

physics/arcade/ArcadePhysics.js, line 728

Returns:

Returns true if the bodies were separated, otherwise false.

Type: boolean

separateTileX(body1, tile) → {boolean}

The core separation function to separate a physics body and a tile on the x axis.

Parameters:

Name	Type	Description
`body1`	Phaser.Physics.Arcade.Body	The Body object to separate.
`tile`	Phaser.Tile	The tile to collide against.

Source:

physics/arcade/ArcadePhysics.js, line 741

Returns:

Returns true if the bodies were separated, otherwise false.

Type: boolean

separateTileY(body1, tile) → {boolean}

The core separation function to separate a physics body and a tile on the x axis.

Parameters:

Name	Type	Description
`body1`	Phaser.Physics.Arcade.Body	The Body object to separate.
`tile`	Phaser.Tile	The tile to collide against.

Source:

physics/arcade/ArcadePhysics.js, line 825

Returns:

Returns true if the bodies were separated, otherwise false.

Type: boolean

separateX(body1, body2) → {boolean}

The core separation function to separate two physics bodies on the x axis.

Parameters:

Name	Type	Description
`body1`	Phaser.Physics.Arcade.Body	The Body object to separate.
`body2`	Phaser.Physics.Arcade.Body	The Body object to separate.

Source:

physics/arcade/ArcadePhysics.js, line 499

Returns:

Returns true if the bodies were separated, otherwise false.

Type: boolean

separateY(body1, body2) → {boolean}

The core separation function to separate two physics bodies on the y axis.

Parameters:

Name	Type	Description
`body1`	Phaser.Physics.Arcade.Body	The Body object to separate.
`body2`	Phaser.Physics.Arcade.Body	The Body object to separate.

Source:

physics/arcade/ArcadePhysics.js, line 607

Returns:

Returns true if the bodies were separated, otherwise false.

Type: boolean

updateMotion(The)

Called automatically by a Physics body, it updates all motion related values on the Body.

Parameters:

Name	Type	Description
`The`	Phaser.Physics.Arcade.Body	Body object to be updated.

Source:

physics/arcade/ArcadePhysics.js, line 67

velocityFromAngle(angle, speed, point) → {Phaser.Point}

Given the angle (in degrees) and speed calculate the velocity and return it as a Point object, or set it to the given point object. One way to use this is: velocityFromAngle(angle, 200, sprite.velocity) which will set the values directly to the sprites velocity and not create a new Point object.

Parameters:

Name	Type	Argument	Default	Description
`angle`	number			The angle in degrees calculated in clockwise positive direction (down = 90 degrees positive, right = 0 degrees positive, up = 90 degrees negative)
`speed`	number	<optional>	60	The speed it will move, in pixels per second sq.
`point`	Phaser.Point \| object	<optional>		The Point object in which the x and y properties will be set to the calculated velocity.

Source:

physics/arcade/ArcadePhysics.js, line 1015

Returns:

A Point where point.x contains the velocity x value and point.y contains the velocity y value.

Type: Phaser.Point

velocityFromRotation(rotation, speed, point) → {Phaser.Point}

Given the rotation (in radians) and speed calculate the velocity and return it as a Point object, or set it to the given point object. One way to use this is: velocityFromRotation(rotation, 200, sprite.velocity) which will set the values directly to the sprites velocity and not create a new Point object.

Parameters:

Name	Type	Argument	Default	Description
`rotation`	number			The angle in radians.
`speed`	number	<optional>	60	The speed it will move, in pixels per second sq.
`point`	Phaser.Point \| object	<optional>		The Point object in which the x and y properties will be set to the calculated velocity.

Source:

physics/arcade/ArcadePhysics.js, line 1034

Returns:

A Point where point.x contains the velocity x value and point.y contains the velocity y value.

Type: Phaser.Point