Mathf

Subset of the JavaScript Math object and Unity Mathf static functions. Uses the Unity Mathf implementations.

Constructor

new Mathf()

Methods

abs(value) → {number}

Parameters:
NameTypeDescription
valuenumber
Returns:
Type: 
number

acos(value) → {number}

Parameters:
NameTypeDescription
valuenumber
Returns:
Type: 
number

asin(value) → {number}

Parameters:
NameTypeDescription
valuenumber
Returns:
Type: 
number

atan(value) → {number}

Parameters:
NameTypeDescription
valuenumber
Returns:
Type: 
number

atan2(y, x) → {number}

Parameters:
NameTypeDescription
ynumber
xnumber
Returns:
Type: 
number

ceil(value) → {number}

Parameters:
NameTypeDescription
valuenumber
Returns:
Type: 
number

clamp(value, min, max) → {number}

Clamps the given value between the given minimum float and maximum float values. Returns the given value if it is within the minimum and maximum range.

Parameters:
NameTypeDescription
valuenumber
minnumber
maxnumber
Returns:
Type: 
number

clamp01(value) → {number}

Clamps the given value between 0 and 1. Returns the given value if it is between 0 and 1.

Parameters:
NameTypeDescription
valuenumber
Returns:
Type: 
number

cos(value) → {number}

Parameters:
NameTypeDescription
valuenumber
Returns:
Type: 
number

exp(value) → {number}

Parameters:
NameTypeDescription
valuenumber
Returns:
Type: 
number

floor(value) → {number}

Parameters:
NameTypeDescription
valuenumber
Returns:
Type: 
number

inverseLerp(value, a, b) → {number}

Calculates the linear parameter t that produces the interpolant value within the range [a, b], see https://docs.unity3d.com/2018.1/Documentation/ScriptReference/Mathf.InverseLerp.html

Parameters:
NameTypeDescription
valuenumber
anumber
bnumber
Returns:

t

Type: 
number

lerp(a, b, t) → {number}

Linearly interpolates between a and b by t.

Parameters:
NameTypeDescription
anumber
bnumber
tnumber
Returns:
Type: 
number

lerpAngle(a, b, t) → {number}

Same as Lerp but makes sure the values interpolate correctly when they wrap around 360 degrees.

Parameters:
NameTypeDescription
anumber
bnumber
tnumber
Returns:
Type: 
number

lerpUnclamped(a, b, t) → {number}

Linearly interpolates between a and b by t with no limit to t.

Parameters:
NameTypeDescription
anumber
bnumber
tnumber
Returns:
Type: 
number

log(value) → {number}

Parameters:
NameTypeDescription
valuenumber
Returns:
Type: 
number

log10(value) → {number}

Parameters:
NameTypeDescription
valuenumber
Returns:
Type: 
number

max(…values) → {number}

Parameters:
NameTypeAttributesDescription
valuesArray.<number><repeatable>
Returns:
Type: 
number

min(…values) → {number}

Parameters:
NameTypeAttributesDescription
valuesArray.<number><repeatable>
Returns:
Type: 
number

pingPong(t, length) → {number}

PingPongs the value t, so that it is never larger than length and never smaller than 0.

Parameters:
NameTypeDescription
tnumber
lengthnumber
Returns:
Type: 
number

pow(x, y) → {number}

Parameters:
NameTypeDescription
xnumber
ynumber
Returns:
Type: 
number

random() → {number}

Returns a random number between 0 and 1. Uses the Unity Random.value implementation.

Returns:
Type: 
number

round(value) → {number}

Parameters:
NameTypeDescription
valuenumber
Returns:
Type: 
number

sign(value) → {number}

Parameters:
NameTypeDescription
valuenumber
Returns:
Type: 
number

sin(value) → {number}

Parameters:
NameTypeDescription
valuenumber
Returns:
Type: 
number

smoothStep(min, max, t) → {number}

Interpolates between min and max with smoothing at the limits.

Parameters:
NameTypeDescription
minnumber
maxnumber
tnumber
Returns:
Type: 
number

sqrt(value) → {number}

Parameters:
NameTypeDescription
valuenumber
Returns:
Type: 
number

tan(value) → {number}

Parameters:
NameTypeDescription
valuenumber
Returns:
Type: 
number