Average

staticAverage(values)

Description:

Calculate the mean average of the given values.

Parameters:

Returns: number - The average value.

Source: src/math/Average.js#L7
Since: 3.0.0

Bernstein

staticBernstein(n, i)

Description:

Calculates the Bernstein basis from the three factorial coefficients.

Parameters:

Returns: number - The Bernstein basis of Factorial(n) / Factorial(i) / Factorial(n - i)

Source: src/math/Bernstein.js#L9
Since: 3.0.0

Between

staticBetween(min, max)

Description:

Compute a random integer between the min and max values, inclusive.

Parameters:

Returns: number - The random integer.

Source: src/math/Between.js#L7
Since: 3.0.0

CatmullRom

staticCatmullRom(t, p0, p1, p2, p3)

Description:

Calculates a Catmull-Rom value from the given points, based on an alpha of 0.5.

Parameters:

Returns: number - The Catmull-Rom value.

Source: src/math/CatmullRom.js#L7
Since: 3.0.0

CeilTo

staticCeilTo(value, [place], [base])

Description:

Ceils to some place comparative to a base, default is 10 for decimal place.

The place is represented by the power applied to base to get that place.

Parameters:

Returns: number - The rounded value.

Source: src/math/CeilTo.js#L7
Since: 3.0.0

Clamp

staticClamp(value, min, max)

Description:

Force a value within the boundaries by clamping it to the range min, max.

Parameters:

Returns: number - The clamped value.

Source: src/math/Clamp.js#L7
Since: 3.0.0

DegToRad

staticDegToRad(degrees)

Description:

Convert the given angle from degrees, to the equivalent angle in radians.

Parameters:

Returns: number - The given angle converted to radians.

Source: src/math/DegToRad.js#L9
Since: 3.0.0

Difference

staticDifference(a, b)

Description:

Calculates the positive difference of two given numbers.

Parameters:

Returns: number - The positive difference of the two given numbers.

Source: src/math/Difference.js#L7
Since: 3.0.0

Factorial

staticFactorial(value)

Description:

Calculates the factorial of a given number for integer values greater than 0.

Parameters:

Returns: number - The factorial of the given number.

Source: src/math/Factorial.js#L7
Since: 3.0.0

FloatBetween

staticFloatBetween(min, max)

Description:

Generate a random floating point number between the two given bounds, minimum inclusive, maximum exclusive.

Parameters:

Returns: number - A random float within the given range.

Source: src/math/FloatBetween.js#L7
Since: 3.0.0

FloorTo

staticFloorTo(value, [place], [base])

Description:

Floors to some place comparative to a base, default is 10 for decimal place.

The place is represented by the power applied to base to get that place.

Parameters:

Returns: number - The rounded value.

Source: src/math/FloorTo.js#L7
Since: 3.0.0

FromPercent

staticFromPercent(percent, min, [max])

Description:

Return a value based on the range between min and max and the percentage given.

Parameters:

Returns: number - The value that is percent percent between min and max.

Source: src/math/FromPercent.js#L9
Since: 3.0.0

GetSpeed

staticGetSpeed(distance, time)

Description:

Calculate a per-ms speed from a distance and time (given in seconds).

Parameters:

Returns: number - The speed, in distance per ms.

Source: src/math/GetSpeed.js#L7
Since: 3.0.0

IsEven

staticIsEven(value)

Description:

Check if a given value is an even number.

Parameters:

Returns: boolean - Whether the number is even or not.

Source: src/math/IsEven.js#L7
Since: 3.0.0

IsEvenStrict

staticIsEvenStrict(value)

Description:

Check if a given value is an even number using a strict type check.

Parameters:

Returns: boolean - Whether the number is even or not.

Source: src/math/IsEvenStrict.js#L7
Since: 3.0.0

Linear

staticLinear(p0, p1, t)

Description:

Calculates a linear (interpolation) value over t.

Parameters:

Returns: number - The step t% of the way between p0 and p1.

Source: src/math/Linear.js#L7
Since: 3.0.0

LinearXY

staticLinearXY(vector1, vector2, [t])

Description:

Interpolates two given Vectors and returns a new Vector between them.

Does not modify either of the passed Vectors.

Parameters:

Returns: Phaser.Math.Vector2 - The step t% of the way between vector1 and vector2.

Source: src/math/LinearXY.js#L7
Since: 3.60.0

MaxAdd

staticMaxAdd(value, amount, max)

Description:

Add an amount to a value, limiting the maximum result to max.

Parameters:

Returns: number - The resulting value.

Source: src/math/MaxAdd.js#L7
Since: 3.0.0

Median

staticMedian(values)

Description:

Calculate the median of the given values. The values are sorted and the middle value is returned.

In case of an even number of values, the average of the two middle values is returned.

Parameters:

Returns: number - The median value.

Source: src/math/Median.js#L7
Since: 3.54.0

MinSub

staticMinSub(value, amount, min)

Description:

Subtract an amount from value, limiting the minimum result to min.

Parameters:

Returns: number - The resulting value.

Source: src/math/MinSub.js#L7
Since: 3.0.0

Percent

staticPercent(value, min, [max], [upperMax])

Description:

Work out what percentage value is of the range between min and max.

If max isn't given then it will return the percentage of value to min.

You can optionally specify an upperMax value, which is a mid-way point in the range that represents 100%, after which the % starts to go down to zero again.

Parameters:

Returns: number - A value between 0 and 1 representing the percentage.

Source: src/math/Percent.js#L7
Since: 3.0.0

RadToDeg

staticRadToDeg(radians)

Description:

Convert the given angle in radians, to the equivalent angle in degrees.

Parameters:

Returns: number - The given angle converted to degrees.

Source: src/math/RadToDeg.js#L9
Since: 3.0.0

RandomXY

staticRandomXY(vector, [scale])

Description:

Compute a random unit vector.

Computes random values for the given vector between -1 and 1 that can be used to represent a direction.

Optionally accepts a scale value to scale the resulting vector by.

Parameters:

Returns: Phaser.Math.Vector2 - The given Vector.

Source: src/math/RandomXY.js#L7
Since: 3.0.0

RandomXYZ

staticRandomXYZ(vec3, [radius])

Description:

Compute a random position vector in a spherical area, optionally defined by the given radius.

Parameters:

Returns: Phaser.Math.Vector3 - The given Vector.

Source: src/math/RandomXYZ.js#L7
Since: 3.0.0

RandomXYZW

staticRandomXYZW(vec4, [scale])

Description:

Compute a random four-dimensional vector.

Parameters:

Returns: Phaser.Math.Vector4 - The given Vector.

Source: src/math/RandomXYZW.js#L7
Since: 3.0.0

Rotate

staticRotate(point, angle)

Description:

Rotate a given point by a given angle around the origin (0, 0), in an anti-clockwise direction.

Parameters:

Returns: Phaser.Geom.Point - The given point, rotated by the given angle in an anticlockwise direction.

Source: src/math/Rotate.js#L7
Since: 3.0.0

RotateAround

staticRotateAround(point, x, y, angle)

Description:

Rotate a point around x and y to the given angle, at the same distance.

In polar notation, this maps a point from (r, t) to (r, angle), vs. the origin (x, y).

Tags:

• generic

Parameters:

Returns: Phaser.Types.Math.Vector2Like - The given point.

Source: src/math/RotateAround.js#L7
Since: 3.0.0

RotateAroundDistance

staticRotateAroundDistance(point, x, y, angle, distance)

Description:

Rotate a point around x and y by the given angle and distance.

In polar notation, this maps a point from (r, t) to (distance, t + angle), vs. the origin (x, y).

Tags:

• generic

Parameters:

Returns: Phaser.Types.Math.Vector2Like - The given point.

Source: src/math/RotateAroundDistance.js#L7
Since: 3.0.0

RotateTo

staticRotateTo(point, x, y, angle, distance)

Description:

Position a point at the given angle and distance to (x, y).

Tags:

• generic

Parameters:

Returns: Phaser.Types.Math.Vector2Like - The given point.

Source: src/math/RotateTo.js#L7
Since: 3.24.0

RotateVec3

staticRotateVec3(vec, axis, radians)

Description:

Rotates a vector in place by axis angle.

This is the same as transforming a point by an

axis-angle quaternion, but it has higher precision.

Parameters:

Returns: Phaser.Math.Vector3 - The given vector.

Source: src/math/RotateVec3.js#L15
Since: 3.0.0

RoundAwayFromZero

staticRoundAwayFromZero(value)

Description:

Round a given number so it is further away from zero. That is, positive numbers are rounded up, and negative numbers are rounded down.

Parameters:

Returns: number - The rounded number, rounded away from zero.

Source: src/math/RoundAwayFromZero.js#L7
Since: 3.0.0

RoundTo

staticRoundTo(value, [place], [base])

Description:

Round a value to the given precision.

For example:

RoundTo(123.456, 0) = 123

RoundTo(123.456, 1) = 120

RoundTo(123.456, 2) = 100

To round the decimal, i.e. to round to precision, pass in a negative place:

RoundTo(123.456789, 0) = 123

RoundTo(123.456789, -1) = 123.5

RoundTo(123.456789, -2) = 123.46

RoundTo(123.456789, -3) = 123.457

Parameters:

Returns: number - The rounded value.

Source: src/math/RoundTo.js#L7
Since: 3.0.0

SinCosTableGenerator

staticSinCosTableGenerator(length, [sinAmp], [cosAmp], [frequency])

Description:

Generate a series of sine and cosine values.

Parameters:

Returns: Phaser.Types.Math.SinCosTable - The generated values.

Source: src/math/SinCosTableGenerator.js#L7
Since: 3.0.0

SmoothStep

staticSmoothStep(x, min, max)

Description:

Calculate a smooth interpolation percentage of x between min and max.

The function receives the number x as an argument and returns 0 if x is less than or equal to the left edge,

1 if x is greater than or equal to the right edge, and smoothly interpolates, using a Hermite polynomial,

between 0 and 1 otherwise.

Parameters:

Returns: number - The percentage of interpolation, between 0 and 1.

Source: src/math/SmoothStep.js#L7
Since: 3.0.0

SmootherStep

staticSmootherStep(x, min, max)

Description:

Calculate a smoother interpolation percentage of x between min and max.

The function receives the number x as an argument and returns 0 if x is less than or equal to the left edge,

1 if x is greater than or equal to the right edge, and smoothly interpolates, using a Hermite polynomial,

between 0 and 1 otherwise.

Produces an even smoother interpolation than Phaser.Math.SmoothStep.

Parameters:

Returns: number - The percentage of interpolation, between 0 and 1.

Source: src/math/SmootherStep.js#L7
Since: 3.0.0

ToXY

staticToXY(index, width, height, [out])

Description:

Returns a Vector2 containing the x and y position of the given index in a width x height sized grid.

For example, in a 6 x 4 grid, index 16 would equal x: 4 y: 2.

If the given index is out of range an empty Vector2 is returned.

Parameters:

Returns: Phaser.Math.Vector2 - A Vector2 where the x and y properties contain the given grid index.

Source: src/math/ToXY.js#L9
Since: 3.19.0

TransformXY

staticTransformXY(x, y, positionX, positionY, rotation, scaleX, scaleY, [output])

Description:

Takes the x and y coordinates and transforms them into the same space as

defined by the position, rotation and scale values.

Parameters:

Returns: Phaser.Math.Vector2, Phaser.Geom.Point, object - The translated point.

Source: src/math/TransformXY.js#L9
Since: 3.0.0

Within

staticWithin(a, b, tolerance)

Description:

Checks if the two values are within the given tolerance of each other.

Parameters:

Returns: boolean - Returns true if a is less than or equal to the tolerance of b.

Source: src/math/Within.js#L7
Since: 3.0.0

Wrap

staticWrap(value, min, max)

Description:

Wrap the given value between min and max.

Parameters:

Returns: number - The wrapped value.

Source: src/math/Wrap.js#L7
Since: 3.0.0

Phaser.Math.Angle

Between

staticBetween(x1, y1, x2, y2)

Description:

Find the angle of a segment from (x1, y1) -> (x2, y2).

Parameters:

Returns: number - The angle in radians.

Source: src/math/angle/Between.js#L7
Since: 3.0.0

BetweenPoints

staticBetweenPoints(point1, point2)

Description:

Find the angle of a segment from (point1.x, point1.y) -> (point2.x, point2.y).

Calculates the angle of the vector from the first point to the second point.

Parameters:

Returns: number - The angle in radians.

Source: src/math/angle/BetweenPoints.js#L7
Since: 3.0.0

BetweenPointsY

staticBetweenPointsY(point1, point2)

Description:

Find the angle of a segment from (point1.x, point1.y) -> (point2.x, point2.y).

The difference between this method and Phaser.Math.Angle.BetweenPoints is that this assumes the y coordinate

travels down the screen.

Parameters:

Returns: number - The angle in radians.

Source: src/math/angle/BetweenPointsY.js#L7
Since: 3.0.0

BetweenY

staticBetweenY(x1, y1, x2, y2)

Description:

Find the angle of a segment from (x1, y1) -> (x2, y2).

The difference between this method and Phaser.Math.Angle.Between is that this assumes the y coordinate

travels down the screen.

Parameters:

Returns: number - The angle in radians.

Source: src/math/angle/BetweenY.js#L7
Since: 3.0.0

CounterClockwise

staticCounterClockwise(angle)

Description:

Takes an angle in Phasers default clockwise format and converts it so that

0 is North, 90 is West, 180 is South and 270 is East,

therefore running counter-clockwise instead of clockwise.

You can pass in the angle from a Game Object using:

var converted = CounterClockwise(gameobject.rotation);

All values for this function are in radians.

Parameters:

Returns: number - The converted angle, in radians.

Source: src/math/angle/CounterClockwise.js#L9
Since: 3.16.0

Normalize

staticNormalize(angle)

Description:

Normalize an angle to the [0, 2pi] range.

Parameters:

Returns: number - The normalized angle, in radians.

Source: src/math/angle/Normalize.js#L7
Since: 3.0.0

Random

staticRandom()

Description:

Returns a random angle in the range [-pi, pi].

Returns: number - The angle, in radians.

Source: src/math/angle/Random.js#L10
Since: 3.23.0

RandomDegrees

staticRandomDegrees()

Description:

Returns a random angle in the range [-180, 180].

Returns: number - The angle, in degrees.

Source: src/math/angle/RandomDegrees.js#L10
Since: 3.23.0

Reverse

staticReverse(angle)

Description:

Reverse the given angle.

Parameters:

Returns: number - The reversed angle, in radians.

Source: src/math/angle/Reverse.js#L9
Since: 3.0.0

RotateTo

staticRotateTo(currentAngle, targetAngle, [lerp])

Description:

Rotates currentAngle towards targetAngle, taking the shortest rotation distance. The lerp argument is the amount to rotate by in this call.

Parameters:

Returns: number - The adjusted angle.

Source: src/math/angle/RotateTo.js#L9
Since: 3.0.0

ShortestBetween

staticShortestBetween(angle1, angle2)

Description:

Gets the shortest angle between angle1 and angle2.

Both angles must be in the range -180 to 180, which is the same clamped

range that sprite.angle uses, so you can pass in two sprite angles to

this method and get the shortest angle back between the two of them.

The angle returned will be in the same range. If the returned angle is

greater than 0 then it's a counter-clockwise rotation, if < 0 then it's

a clockwise rotation.

Parameters:

Returns: number - The shortest angle, in degrees. If greater than zero it's a counter-clockwise rotation.

Source: src/math/angle/ShortestBetween.js#L7
Since: 3.0.0

Wrap

staticWrap(angle)

Description:

Wrap an angle.

Wraps the angle to a value in the range of -PI to PI.

Parameters:

Returns: number - The wrapped angle, in radians.

Source: src/math/angle/Wrap.js#L9
Since: 3.0.0

WrapDegrees

staticWrapDegrees(angle)

Description:

Wrap an angle in degrees.

Wraps the angle to a value in the range of -180 to 180.

Parameters:

Returns: number - The wrapped angle, in degrees.

Source: src/math/angle/WrapDegrees.js#L9
Since: 3.0.0

Phaser.Math.Distance

Between

staticBetween(x1, y1, x2, y2)

Description:

Calculate the distance between two sets of coordinates (points).

Parameters:

Returns: number - The distance between each point.

Source: src/math/distance/DistanceBetween.js#L7
Since: 3.0.0

BetweenPoints

staticBetweenPoints(a, b)

Description:

Calculate the distance between two points.

Parameters:

Returns: number - The distance between the points.

Source: src/math/distance/DistanceBetweenPoints.js#L7
Since: 3.22.0

BetweenPointsSquared

staticBetweenPointsSquared(a, b)

Description:

Calculate the squared distance between two points.

Parameters:

Returns: number - The squared distance between the points.

Source: src/math/distance/DistanceBetweenPointsSquared.js#L7
Since: 3.22.0

Chebyshev

staticChebyshev(x1, y1, x2, y2)

Description:

Calculate the Chebyshev distance between two sets of coordinates (points).

Chebyshev distance (or chessboard distance) is the maximum of the horizontal and vertical distances.

It's the effective distance when movement can be horizontal, vertical, or diagonal.

Parameters:

Returns: number - The distance between each point.

Source: src/math/distance/DistanceChebyshev.js#L7
Since: 3.22.0

Power

staticPower(x1, y1, x2, y2, pow)

Description:

Calculate the distance between two sets of coordinates (points) to the power of pow.

Parameters:

Returns: number - The distance between each point.

Source: src/math/distance/DistancePower.js#L7
Since: 3.0.0

Snake

staticSnake(x1, y1, x2, y2)

Description:

Calculate the snake distance between two sets of coordinates (points).

Snake distance (rectilinear distance, Manhattan distance) is the sum of the horizontal and vertical distances.

It's the effective distance when movement is allowed only horizontally or vertically (but not both).

Parameters:

Returns: number - The distance between each point.

Source: src/math/distance/DistanceSnake.js#L7
Since: 3.22.0

Squared

staticSquared(x1, y1, x2, y2)

Description:

Calculate the distance between two sets of coordinates (points), squared.

Parameters:

Returns: number - The distance between each point, squared.

Source: src/math/distance/DistanceSquared.js#L7
Since: 3.0.0

Phaser.Math.Easing.Back

In

staticIn(v, [overshoot])

Description:

Back ease-in.

Parameters:

Returns: number - The tweened value.

Source: src/math/easing/back/In.js#L7
Since: 3.0.0

InOut

staticInOut(v, [overshoot])

Description:

Back ease-in/out.

Parameters:

Returns: number - The tweened value.

Source: src/math/easing/back/InOut.js#L7
Since: 3.0.0

Out

staticOut(v, [overshoot])

Description:

Back ease-out.

Parameters:

Returns: number - The tweened value.

Source: src/math/easing/back/Out.js#L7
Since: 3.0.0

Phaser.Math.Easing.Bounce

In

staticIn(v)

Description:

Bounce ease-in.

Parameters:

Returns: number - The tweened value.

Source: src/math/easing/bounce/In.js#L7
Since: 3.0.0

InOut

staticInOut(v)

Description:

Bounce ease-in/out.

Parameters:

Returns: number - The tweened value.

Source: src/math/easing/bounce/InOut.js#L7
Since: 3.0.0

Out

staticOut(v)

Description:

Bounce ease-out.

Parameters:

Returns: number - The tweened value.

Source: src/math/easing/bounce/Out.js#L7
Since: 3.0.0

Phaser.Math.Easing.Circular

In

staticIn(v)

Description:

Circular ease-in.

Parameters:

Returns: number - The tweened value.

Source: src/math/easing/circular/In.js#L7
Since: 3.0.0

InOut

staticInOut(v)

Description:

Circular ease-in/out.

Parameters:

Returns: number - The tweened value.

Source: src/math/easing/circular/InOut.js#L7
Since: 3.0.0

Out

staticOut(v)

Description:

Circular ease-out.

Parameters:

Returns: number - The tweened value.

Source: src/math/easing/circular/Out.js#L7
Since: 3.0.0

Phaser.Math.Easing.Cubic

In

staticIn(v)

Description:

Cubic ease-in.

Parameters:

Returns: number - The tweened value.

Source: src/math/easing/cubic/In.js#L7
Since: 3.0.0

InOut

staticInOut(v)

Description:

Cubic ease-in/out.

Parameters:

Returns: number - The tweened value.

Source: src/math/easing/cubic/InOut.js#L7
Since: 3.0.0

Out

staticOut(v)

Description:

Cubic ease-out.

Parameters:

Returns: number - The tweened value.

Source: src/math/easing/cubic/Out.js#L7
Since: 3.0.0

Phaser.Math.Easing.Elastic

In

staticIn(v, [amplitude], [period])

Description:

Elastic ease-in.

Parameters:

Returns: number - The tweened value.

Source: src/math/easing/elastic/In.js#L7
Since: 3.0.0

InOut

staticInOut(v, [amplitude], [period])

Description:

Elastic ease-in/out.

Parameters:

Returns: number - The tweened value.

Source: src/math/easing/elastic/InOut.js#L7
Since: 3.0.0

Out

staticOut(v, [amplitude], [period])

Description:

Elastic ease-out.

Parameters:

Returns: number - The tweened value.

Source: src/math/easing/elastic/Out.js#L7
Since: 3.0.0

Phaser.Math.Easing.Expo

In

staticIn(v)

Description:

Exponential ease-in.

Parameters:

Returns: number - The tweened value.

Source: src/math/easing/expo/In.js#L7
Since: 3.0.0

InOut

staticInOut(v)

Description:

Exponential ease-in/out.

Parameters:

Returns: number - The tweened value.

Source: src/math/easing/expo/InOut.js#L7
Since: 3.0.0

Out

staticOut(v)

Description:

Exponential ease-out.

Parameters:

Returns: number - The tweened value.

Source: src/math/easing/expo/Out.js#L7
Since: 3.0.0

Phaser.Math.Easing

Linear

staticLinear(v)

Description:

Linear easing (no variation).

Parameters:

Returns: number - The tweened value.

Source: src/math/easing/linear/Linear.js#L7
Since: 3.0.0

Stepped

staticStepped(v, [steps])

Description:

Stepped easing.

Parameters:

Returns: number - The tweened value.

Source: src/math/easing/stepped/Stepped.js#L7
Since: 3.0.0

Phaser.Math.Easing.Quadratic

In

staticIn(v)

Description:

Quadratic ease-in.

Parameters:

Returns: number - The tweened value.

Source: src/math/easing/quadratic/In.js#L7
Since: 3.0.0

InOut

staticInOut(v)

Description:

Quadratic ease-in/out.

Parameters:

Returns: number - The tweened value.

Source: src/math/easing/quadratic/InOut.js#L7
Since: 3.0.0

Out

staticOut(v)

Description:

Quadratic ease-out.

Parameters:

Returns: number - The tweened value.

Source: src/math/easing/quadratic/Out.js#L7
Since: 3.0.0

Phaser.Math.Easing.Quartic

In

staticIn(v)

Description:

Quartic ease-in.

Parameters:

Returns: number - The tweened value.

Source: src/math/easing/quartic/In.js#L7
Since: 3.0.0

InOut

staticInOut(v)

Description:

Quartic ease-in/out.

Parameters:

Returns: number - The tweened value.

Source: src/math/easing/quartic/InOut.js#L7
Since: 3.0.0

Out

staticOut(v)

Description:

Quartic ease-out.

Parameters:

Returns: number - The tweened value.

Source: src/math/easing/quartic/Out.js#L7
Since: 3.0.0

Phaser.Math.Easing.Quintic

In

staticIn(v)

Description:

Quintic ease-in.

Parameters:

Returns: number - The tweened value.

Source: src/math/easing/quintic/In.js#L7
Since: 3.0.0

InOut

staticInOut(v)

Description:

Quintic ease-in/out.

Parameters:

Returns: number - The tweened value.

Source: src/math/easing/quintic/InOut.js#L7
Since: 3.0.0

Out

staticOut(v)

Description:

Quintic ease-out.

Parameters:

Returns: number - The tweened value.

Source: src/math/easing/quintic/Out.js#L7
Since: 3.0.0

Phaser.Math.Easing.Sine

In

staticIn(v)

Description:

Sinusoidal ease-in.

Parameters:

Returns: number - The tweened value.

Source: src/math/easing/sine/In.js#L7
Since: 3.0.0

InOut

staticInOut(v)

Description:

Sinusoidal ease-in/out.

Parameters:

Returns: number - The tweened value.

Source: src/math/easing/sine/InOut.js#L7
Since: 3.0.0

Out

staticOut(v)

Description:

Sinusoidal ease-out.

Parameters:

Returns: number - The tweened value.

Source: src/math/easing/sine/Out.js#L7
Since: 3.0.0

Phaser.Math.Fuzzy

Ceil

staticCeil(value, [epsilon])

Description:

Calculate the fuzzy ceiling of the given value.

Parameters:

Returns: number - The fuzzy ceiling of the value.

Source: src/math/fuzzy/Ceil.js#L7
Since: 3.0.0

Equal

staticEqual(a, b, [epsilon])

Description:

Check whether the given values are fuzzily equal.

Two numbers are fuzzily equal if their difference is less than epsilon.

Parameters:

Returns: boolean - true if the values are fuzzily equal, otherwise false.

Source: src/math/fuzzy/Equal.js#L7
Since: 3.0.0

Floor

staticFloor(value, [epsilon])

Description:

Calculate the fuzzy floor of the given value.

Parameters:

Returns: number - The floor of the value.

Source: src/math/fuzzy/Floor.js#L7
Since: 3.0.0

GreaterThan

staticGreaterThan(a, b, [epsilon])

Description:

Check whether a is fuzzily greater than b.

a is fuzzily greater than b if it is more than b - epsilon.

Parameters:

Returns: boolean - true if a is fuzzily greater than than b, otherwise false.

Source: src/math/fuzzy/GreaterThan.js#L7
Since: 3.0.0

LessThan

staticLessThan(a, b, [epsilon])

Description:

Check whether a is fuzzily less than b.

a is fuzzily less than b if it is less than b + epsilon.

Parameters:

Returns: boolean - true if a is fuzzily less than b, otherwise false.

Source: src/math/fuzzy/LessThan.js#L7
Since: 3.0.0

Phaser.Math.Interpolation

Bezier

staticBezier(v, k)

Description:

A bezier interpolation method.

Parameters:

Returns: number - The interpolated value.

Source: src/math/interpolation/BezierInterpolation.js#L9
Since: 3.0.0

CatmullRom

staticCatmullRom(v, k)

Description:

A Catmull-Rom interpolation method.

Parameters:

Returns: number - The interpolated value.

Source: src/math/interpolation/CatmullRomInterpolation.js#L9
Since: 3.0.0

CubicBezier

staticCubicBezier(t, p0, p1, p2, p3)

Description:

A cubic bezier interpolation method.

https://medium.com/@adrian_cooney/bezier-interpolation-13b68563313a

Parameters:

Returns: number - The interpolated value.

Source: src/math/interpolation/CubicBezierInterpolation.js#L43
Since: 3.0.0

Linear

staticLinear(v, k)

Description:

A linear interpolation method.

Parameters:

Returns: number - The interpolated value.

Source: src/math/interpolation/LinearInterpolation.js#L9
Since: 3.0.0

QuadraticBezier

staticQuadraticBezier(t, p0, p1, p2)

Description:

A quadratic bezier interpolation method.

Parameters:

Returns: number - The interpolated value.

Source: src/math/interpolation/QuadraticBezierInterpolation.js#L35
Since: 3.2.0

SmoothStep

staticSmoothStep(t, min, max)

Description:

A Smooth Step interpolation method.

Parameters:

Returns: number - The interpolated value.

Source: src/math/interpolation/SmoothStepInterpolation.js#L9
Since: 3.9.0

SmootherStep

staticSmootherStep(t, min, max)

Description:

A Smoother Step interpolation method.

Parameters:

Returns: number - The interpolated value.

Source: src/math/interpolation/SmootherStepInterpolation.js#L9
Since: 3.9.0

Phaser.Math.Pow2

GetNext

staticGetNext(value)

Description:

Returns the nearest power of 2 to the given value.

Parameters:

Returns: number - The nearest power of 2 to value.

Source: src/math/pow2/GetPowerOfTwo.js#L7
Since: 3.0.0

IsSize

staticIsSize(width, height)

Description:

Checks if the given width and height are a power of two.

Useful for checking texture dimensions.

Parameters:

Returns: boolean - true if width and height are a power of two, otherwise false.

Source: src/math/pow2/IsSizePowerOfTwo.js#L7
Since: 3.0.0

IsValue

staticIsValue(value)

Description:

Tests the value and returns true if it is a power of two.

Parameters:

Returns: boolean - Returns true if value is a power of two, otherwise false.

Source: src/math/pow2/IsValuePowerOfTwo.js#L7
Since: 3.0.0

Phaser.Math.Snap

Ceil

staticCeil(value, gap, [start], [divide])

Description:

Snap a value to nearest grid slice, using ceil.

Example: if you have an interval gap of 5 and a position of 12... you will snap to 15.

As will 14 snap to 15... but 16 will snap to 20.

Parameters:

Returns: number - The snapped value.

Source: src/math/snap/SnapCeil.js#L7
Since: 3.0.0

Floor

staticFloor(value, gap, [start], [divide])

Description:

Snap a value to nearest grid slice, using floor.

Example: if you have an interval gap of 5 and a position of 12... you will snap to 10.

As will 14 snap to 10... but 16 will snap to 15.

Parameters:

Returns: number - The snapped value.

Source: src/math/snap/SnapFloor.js#L7
Since: 3.0.0

To

staticTo(value, gap, [start], [divide])

Description:

Snap a value to nearest grid slice, using rounding.

Example: if you have an interval gap of 5 and a position of 12... you will snap to 10 whereas 14 will snap to 15.

Parameters:

Returns: number - The snapped value.

Source: src/math/snap/SnapTo.js#L7
Since: 3.0.0