Skip to main content
Version: Phaser v4.0.0

Phaser.Physics.Arcade.ProcessY

Scope: static

Source: src/physics/arcade/ProcessY.js#L406

Static functions

BlockCheck

<static> BlockCheck()

Description:

Blocked Direction checks, because it doesn't matter if an object can be pushed or not, blocked is blocked.

Returns: number - The BlockCheck result. 0 = not blocked. 1 = Body 1 blocked. 2 = Body 2 blocked.

Source: src/physics/arcade/ProcessY.js#L71
Since: 3.50.0


Check

<static> Check()

Description:

The main check function. Runs through one of the four possible tests and returns the results.

Returns: boolean - true if a check passed, otherwise false.

Source: src/physics/arcade/ProcessY.js#L118
Since: 3.50.0


Run

<static> Run(side)

Description:

Executes the vertical separation and velocity exchange for the two bodies, based on the collision side determined by the Check function. Handles all combinations of pushable and non-pushable bodies, distributing overlap and recalculating post-collision velocities accordingly.

Parameters:

nametypeoptionaldescription
sidenumberNoThe side to test. As passed in by the Check function.

Returns: boolean - Always returns true.

Source: src/physics/arcade/ProcessY.js#L169
Since: 3.50.0


RunImmovableBody1

<static> RunImmovableBody1(blockedState)

Description:

This function is run when Body1 is Immovable and Body2 is not.

Parameters:

nametypeoptionaldescription
blockedStatenumberNoThe block state value.

Source: src/physics/arcade/ProcessY.js#L334
Since: 3.50.0


RunImmovableBody2

<static> RunImmovableBody2(blockedState)

Description:

This function is run when Body2 is Immovable and Body1 is not.

Parameters:

nametypeoptionaldescription
blockedStatenumberNoThe block state value.

Source: src/physics/arcade/ProcessY.js#L370
Since: 3.50.0


Set

<static> Set(b1, b2, ov)

Description:

Sets all of the local processing values and calculates the velocity exchanges.

Then runs BlockCheck and returns the value from it.

This method is called by Phaser.Physics.Arcade.SeparateY and should not be called directly.

Parameters:

nametypeoptionaldescription
b1Phaser.Physics.Arcade.BodyNoThe first Body to separate.
b2Phaser.Physics.Arcade.BodyNoThe second Body to separate.
ovnumberNoThe overlap value.

Returns: number - The BlockCheck result. 0 = not blocked. 1 = Body 1 blocked. 2 = Body 2 blocked.

Source: src/physics/arcade/ProcessY.js#L25
Since: 3.50.0