math.ease
The math easing functions.
Functions
math.ease.backIn | Eases in by reversing the direction of the ease slightly before returning. |
math.ease.backInOut | Eases in and out by reversing the direction of the ease slightly before returning on both ends. |
math.ease.backOut | Eases out by reversing the direction of the ease slightly before finishing. |
math.ease.bounceIn | Eases in like a bouncy ball. |
math.ease.bounceInOut | Eases in and out like a bouncy ball. |
math.ease.bounceOut | Eases out like a bouncy ball. |
math.ease.circIn | Eases in using a circular function. |
math.ease.circInOut | Eases in and out using a circular function. |
math.ease.circOut | Eases out using a circular function. |
math.ease.cubicIn | Eases in by cubing the fraction. |
math.ease.cubicInOut | Eases in and out by cubing the fraction. |
math.ease.cubicOut | Eases out by cubing the fraction. |
math.ease.elasticIn | Eases in like a rubber band. |
math.ease.elasticInOut | Eases in and out like a rubber band. |
math.ease.elasticOut | Eases out like a rubber band. |
math.ease.expoIn | Eases in using an exponential equation with a base of 2 and where the fraction is used in the exponent. |
math.ease.expoInOut | Eases in and out using an exponential equation with a base of 2 and where the fraction is used in the exponent. |
math.ease.expoOut | Eases out using an exponential equation with a base of 2 and where the fraction is used in the exponent. |
math.ease.quadIn | Eases in by squaring the fraction. |
math.ease.quadInOut | Eases in and out by squaring the fraction. |
math.ease.quadOut | Eases out by squaring the fraction. |
math.ease.quartIn | Eases in by raising the fraction to the power of 4. |
math.ease.quartInOut | Eases in and out by raising the fraction to the power of 4. |
math.ease.quartOut | Eases out by raising the fraction to the power of 4. |
math.ease.quintIn | Eases in by raising the fraction to the power of 5. |
math.ease.quintInOut | Eases in and out by raising the fraction to the power of 5. |
math.ease.quintOut | Eases out by raising the fraction to the power of 5. |
math.ease.sineIn | Eases in using math.sin. |
math.ease.sineInOut | Eases in and out using math.sin. |
math.ease.sineOut | Eases out using math.sin. |
#math.ease.backIn
function math.ease.backIn(fraction: number): numberEases in by reversing the direction of the ease slightly before returning.
Parameters
| Name | Type | Description |
|---|---|---|
fraction | number | Fraction of the progress to ease, from 0 to 1. |
Returns
| Type | Name | Description |
|---|---|---|
number | eased | The eased number. |
#math.ease.backInOut
function math.ease.backInOut(fraction: number): numberEases in and out by reversing the direction of the ease slightly before returning on both ends.
Parameters
| Name | Type | Description |
|---|---|---|
fraction | number | Fraction of the progress to ease, from 0 to 1. |
Returns
| Type | Name | Description |
|---|---|---|
number | eased | The eased number. |
#math.ease.backOut
function math.ease.backOut(fraction: number): numberEases out by reversing the direction of the ease slightly before finishing.
Parameters
| Name | Type | Description |
|---|---|---|
fraction | number | Fraction of the progress to ease, from 0 to 1. |
Returns
| Type | Name | Description |
|---|---|---|
number | eased | The eased number. |
#math.ease.bounceIn
function math.ease.bounceIn(fraction: number): numberEases in like a bouncy ball.
Parameters
| Name | Type | Description |
|---|---|---|
fraction | number | Fraction of the progress to ease, from 0 to 1. |
Returns
| Type | Name | Description |
|---|---|---|
number | eased | The eased number. |
#math.ease.bounceInOut
function math.ease.bounceInOut(fraction: number): numberEases in and out like a bouncy ball.
Parameters
| Name | Type | Description |
|---|---|---|
fraction | number | Fraction of the progress to ease, from 0 to 1. |
Returns
| Type | Name | Description |
|---|---|---|
number | eased | The eased number. |
#math.ease.bounceOut
function math.ease.bounceOut(fraction: number): numberEases out like a bouncy ball.
Parameters
| Name | Type | Description |
|---|---|---|
fraction | number | Fraction of the progress to ease, from 0 to 1. |
Returns
| Type | Name | Description |
|---|---|---|
number | eased | The eased number. |
#math.ease.circIn
function math.ease.circIn(fraction: number): numberEases in using a circular function.
Parameters
| Name | Type | Description |
|---|---|---|
fraction | number | Fraction of the progress to ease, from 0 to 1. |
Returns
| Type | Name | Description |
|---|---|---|
number | eased | The eased number. |
#math.ease.circInOut
function math.ease.circInOut(fraction: number): numberEases in and out using a circular function.
Parameters
| Name | Type | Description |
|---|---|---|
fraction | number | Fraction of the progress to ease, from 0 to 1. |
Returns
| Type | Name | Description |
|---|---|---|
number | eased | The eased number. |
#math.ease.circOut
function math.ease.circOut(fraction: number): numberEases out using a circular function.
Parameters
| Name | Type | Description |
|---|---|---|
fraction | number | Fraction of the progress to ease, from 0 to 1. |
Returns
| Type | Name | Description |
|---|---|---|
number | eased | The eased number. |
#math.ease.cubicIn
function math.ease.cubicIn(fraction: number): numberEases in by cubing the fraction.
Parameters
| Name | Type | Description |
|---|---|---|
fraction | number | Fraction of the progress to ease, from 0 to 1. |
Returns
| Type | Name | Description |
|---|---|---|
number | eased | The eased number. |
#math.ease.cubicInOut
function math.ease.cubicInOut(fraction: number): numberEases in and out by cubing the fraction.
Parameters
| Name | Type | Description |
|---|---|---|
fraction | number | Fraction of the progress to ease, from 0 to 1. |
Returns
| Type | Name | Description |
|---|---|---|
number | eased | The eased number. |
#math.ease.cubicOut
function math.ease.cubicOut(fraction: number): numberEases out by cubing the fraction.
Parameters
| Name | Type | Description |
|---|---|---|
fraction | number | Fraction of the progress to ease, from 0 to 1. |
Returns
| Type | Name | Description |
|---|---|---|
number | eased | The eased number. |
#math.ease.elasticIn
function math.ease.elasticIn(fraction: number): numberEases in like a rubber band.
Parameters
| Name | Type | Description |
|---|---|---|
fraction | number | Fraction of the progress to ease, from 0 to 1. |
Returns
| Type | Name | Description |
|---|---|---|
number | eased | The eased number. |
#math.ease.elasticInOut
function math.ease.elasticInOut(fraction: number): numberEases in and out like a rubber band.
Parameters
| Name | Type | Description |
|---|---|---|
fraction | number | Fraction of the progress to ease, from 0 to 1. |
Returns
| Type | Name | Description |
|---|---|---|
number | eased | The eased number. |
#math.ease.elasticOut
function math.ease.elasticOut(fraction: number): numberEases out like a rubber band.
Parameters
| Name | Type | Description |
|---|---|---|
fraction | number | Fraction of the progress to ease, from 0 to 1. |
Returns
| Type | Name | Description |
|---|---|---|
number | eased | The eased number. |
#math.ease.expoIn
function math.ease.expoIn(fraction: number): numberEases in using an exponential equation with a base of 2 and where the fraction is used in the exponent.
Parameters
| Name | Type | Description |
|---|---|---|
fraction | number | Fraction of the progress to ease, from 0 to 1. |
Returns
| Type | Name | Description |
|---|---|---|
number | eased | The eased number. |
#math.ease.expoInOut
function math.ease.expoInOut(fraction: number): numberEases in and out using an exponential equation with a base of 2 and where the fraction is used in the exponent.
Parameters
| Name | Type | Description |
|---|---|---|
fraction | number | Fraction of the progress to ease, from 0 to 1. |
Returns
| Type | Name | Description |
|---|---|---|
number | eased | The eased number. |
#math.ease.expoOut
function math.ease.expoOut(fraction: number): numberEases out using an exponential equation with a base of 2 and where the fraction is used in the exponent.
Parameters
| Name | Type | Description |
|---|---|---|
fraction | number | Fraction of the progress to ease, from 0 to 1. |
Returns
| Type | Name | Description |
|---|---|---|
number | eased | The eased number. |
#math.ease.quadIn
function math.ease.quadIn(fraction: number): numberEases in by squaring the fraction.
Parameters
| Name | Type | Description |
|---|---|---|
fraction | number | Fraction of the progress to ease, from 0 to 1. |
Returns
| Type | Name | Description |
|---|---|---|
number | eased | The eased number. |
#math.ease.quadInOut
function math.ease.quadInOut(fraction: number): numberEases in and out by squaring the fraction.
Parameters
| Name | Type | Description |
|---|---|---|
fraction | number | Fraction of the progress to ease, from 0 to 1. |
Returns
| Type | Name | Description |
|---|---|---|
number | eased | The eased number. |
#math.ease.quadOut
function math.ease.quadOut(fraction: number): numberEases out by squaring the fraction.
Parameters
| Name | Type | Description |
|---|---|---|
fraction | number | Fraction of the progress to ease, from 0 to 1. |
Returns
| Type | Name | Description |
|---|---|---|
number | eased | The eased number. |
#math.ease.quartIn
function math.ease.quartIn(fraction: number): numberEases in by raising the fraction to the power of 4.
Parameters
| Name | Type | Description |
|---|---|---|
fraction | number | Fraction of the progress to ease, from 0 to 1. |
Returns
| Type | Name | Description |
|---|---|---|
number | eased | The eased number. |
#math.ease.quartInOut
function math.ease.quartInOut(fraction: number): numberEases in and out by raising the fraction to the power of 4.
Parameters
| Name | Type | Description |
|---|---|---|
fraction | number | Fraction of the progress to ease, from 0 to 1. |
Returns
| Type | Name | Description |
|---|---|---|
number | eased | The eased number. |
#math.ease.quartOut
function math.ease.quartOut(fraction: number): numberEases out by raising the fraction to the power of 4.
Parameters
| Name | Type | Description |
|---|---|---|
fraction | number | Fraction of the progress to ease, from 0 to 1. |
Returns
| Type | Name | Description |
|---|---|---|
number | eased | The eased number. |
#math.ease.quintIn
function math.ease.quintIn(fraction: number): numberEases in by raising the fraction to the power of 5.
Parameters
| Name | Type | Description |
|---|---|---|
fraction | number | Fraction of the progress to ease, from 0 to 1. |
Returns
| Type | Name | Description |
|---|---|---|
number | eased | The eased number. |
#math.ease.quintInOut
function math.ease.quintInOut(fraction: number): numberEases in and out by raising the fraction to the power of 5.
Parameters
| Name | Type | Description |
|---|---|---|
fraction | number | Fraction of the progress to ease, from 0 to 1. |
Returns
| Type | Name | Description |
|---|---|---|
number | eased | The eased number. |
#math.ease.quintOut
function math.ease.quintOut(fraction: number): numberEases out by raising the fraction to the power of 5.
Parameters
| Name | Type | Description |
|---|---|---|
fraction | number | Fraction of the progress to ease, from 0 to 1. |
Returns
| Type | Name | Description |
|---|---|---|
number | eased | The eased number. |
#math.ease.sineIn
function math.ease.sineIn(fraction: number): numberEases in using math.sin.
Parameters
| Name | Type | Description |
|---|---|---|
fraction | number | Fraction of the progress to ease, from 0 to 1. |
Returns
| Type | Name | Description |
|---|---|---|
number | eased | The eased number. |
#math.ease.sineInOut
function math.ease.sineInOut(fraction: number): numberEases in and out using math.sin.
Parameters
| Name | Type | Description |
|---|---|---|
fraction | number | Fraction of the progress to ease, from 0 to 1. |
Returns
| Type | Name | Description |
|---|---|---|
number | eased | The eased number. |
#math.ease.sineOut
function math.ease.sineOut(fraction: number): numberEases out using math.sin.
Parameters
| Name | Type | Description |
|---|---|---|
fraction | number | Fraction of the progress to ease, from 0 to 1. |
Returns
| Type | Name | Description |
|---|---|---|
number | eased | The eased number. |