Math Extensions

This module contains mathematical utility functions. All functions are registered on the global math table and can be accessed as math.example().

Constants

Name	Description
math.tau	360 degrees in radians (equals `2 * math.pi`)

Functions

Name	Description
math.angle_between	Returns the shortest rotation between two vectors.
math.angle_delta	Returns the shortest rotation between two angles.
math.angle_to_cardinal	Converts an angle into the closest cardinal directions (including intercardinals).
math.clamp	Clamps a number between a minimum and maximum value.
math.cross_product	Computes the length of the cross product between two `(x, y, 0)` 3D vectors.
math.damp	Exponential decay interpolation.
math.distance	Computes the distance between two 2D points.
math.distance_squared	Computes the squared distance between two 2D points.
math.dot_product	Computes the dot product between 2D vectors.
math.index_to_xy	Converts an integer into coordinates into a 2D array.
math.length	Computes the length of a 2D vector.
math.length_squared	Computes the squared length of a 2D vector.
math.lerp	Linear interpolation between two numbers.
math.normalize	Scales a 2D vector to length 1.
math.round	Rounds a number to the nearest integer.

Easing Functions

For a visual reference of easing functions, see https://easings.net/. Note that the bounce easing functions in Crystal have a few more bounces to them than these illustrations.

All easing functions expect a value between 0 and 1, and return a value between 0 and 1 with easing applied.

math.ease_linear
math.ease_in_quadratic
math.ease_out_quadratic
math.ease_in_out_quadratic
math.ease_in_cubic
math.ease_out_cubic
math.ease_in_out_cubic
math.ease_in_quartic
math.ease_out_quartic
math.ease_in_out_quartic
math.ease_in_quintic
math.ease_out_quintic
math.ease_in_out_quintic
math.ease_in_bounce
math.ease_out_bounce
math.ease_in_out_bounce