X1The "interp" Function
Syntax#
| Argument | Type | Description |
|---|---|---|
a | real | The starting value to interpolate from |
b | real | The target value to interpolate to |
amount | real | The amount, or percentage to interpolate between values (variable recommended) |
ease | integer/macro | Sets the easing method for the interpolation (see options below) |
[bx1] | real | Optional: X percentage for left control point of a cubic bezier curve (0-1) |
[by1] | real | Optional: Y percentage for left control point of a cubic bezier curve (0-1) |
[bx2] | real | Optional: X percentage for right control point of a cubic bezier curve (0-1) |
[by2] | real | Optional: Y percentage for right control point of a cubic bezier curve (0-1) |
[curve] | curve | Optional: Animation curve asset to use if ease is set to ease_curve |
Description#
Returns a value interpolated between the two input values with optional easing methods to create a smooth start and/or end to animations.
The first input value should equal the original state of the value and the second input the target state of the value. For example, to move an object from x = 0 to x = 50, 0 and 50 would be the two input values here.
The third input value can be thought of as a percentage of completion. Using the same example, an input amount of 0.5 would return x = 25.
In order to create animations with this script, the interpolation amount must be input as a variable which is incremented externally.
The fourth and final value is an integer specifying the easing method used during interpolation. Simple true or false values can be used here for sine or linear interpolation, respectively, but in addition to these basic modes there are 30 different easing techniques, plus other custom techniques, featured below. Built-in easing techniques are ordered from shallowest to deepest curve.
tip
See the included interactive demo for a visual example of this function!
For memorability, it is recommended to use an easing macro from the list below in place of an integer value:
| Easing Macro | Value | Easing Macro | Value | |
|---|---|---|---|---|
ease_none | -4 | ease_expo_in | 17 | |
ease_sin | 1 | ease_expo_out | 18 | |
ease_sin_in | 2 | ease_circ | 19 | |
ease_sin_out | 3 | ease_circ_in | 20 | |
ease_quad | 4 | ease_circ_out | 21 | |
ease_quad_in | 5 | ease_rubber | 22 | |
ease_quad_out | 6 | ease_rubber_in | 23 | |
ease_cubic | 7 | ease_rubber_out | 24 | |
ease_cubic_in | 8 | ease_elastic | 25 | |
ease_cubic_out | 9 | ease_elastic_in | 26 | |
ease_quart | 10 | ease_elastic_out | 27 | |
ease_quart_in | 11 | ease_bounce | 28 | |
ease_quart_out | 12 | ease_bounce_in | 29 | |
ease_quint | 13 | ease_bounce_out | 30 | |
ease_quint_in | 14 | ease_bezier | 31 | |
ease_quint_out | 15 | ease_curve | 32 | |
ease_expo | 16 |
If the bezier ease mode is selected, four more arguments can be supplied to act as control points for a custom interpolation curve. These values range from 0-1, but Y values can be less or greater to create a rubber-banding effect. See cubic-bezier.com for an interactive visual example.
Other types of curves can be created visually in GameMaker 2.3 and newer. To use these curves with interp, specify ease_curve as the mode and then supply an additional argument pointing to the animation curve asset desired. Note that only the first channel in an animation curve asset will be used.
important
Only a custom bezier curve or a custom curve asset can be input. Both cannot be input at the same time.