Phaser API Documentation

  Version: 

Member of: Phaser.Actions

<static> SmoothStep(items, property, min, max, [inc])

Description:

Smoothstep is a sigmoid-like interpolation and clamping function.

The function depends on three parameters, the input x, the "left edge" and the "right edge", with the left edge being assumed smaller than the right edge. The function receives a real 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. The slope of the smoothstep function is zero at both edges. This is convenient for creating a sequence of transitions using smoothstep to interpolate each segment as an alternative to using more sophisticated or expensive interpolation techniques.

Parameters:

name type arguments Default description
items array | Array.<Phaser.GameObjects.GameObject>

An array of Game Objects. The contents of this array are updated by this Action.

property string

The property of the Game Object to interpolate.

min number

The minimum interpolation value.

max number

The maximum interpolation value.

inc boolean <optional> false

Should the values be incremented? true or set (false)

Returns:
Description:

The array of Game Objects that was passed to this Action.

Type:
Examples:
Since: 3.0.0
Source: src/actions/SmoothStep.js (Line 9)