Math

Inherits: LibTSMModule

Functions

Bound

function Lua.Math.Bound(value, minValue, maxValue)
  -> number

Bounds a number between a min and max value.

Parameters:

Name	Type	Description
value	number	The number to be bounded
minValue	number	The min value
maxValue	number	The max value

Returns:

Type	Description
number

Ceil

function Lua.Math.Ceil(value, sig)
  -> number

Rounds a value up to a specified significant value.

Parameters:

Name	Type	Description
value	number	The number to be rounded
sig	number	The value to round up to the nearest multiple of (defaults to 1)

Returns:

Type	Description
number

Floor

function Lua.Math.Floor(value, sig)
  -> number

Rounds a value down to a specified significant value.

Parameters:

Name	Type	Description
value	number	The number to be rounded
sig	number	The value to round down to the nearest multiple of (defaults to 1)

Returns:

Type	Description
number

GetNan

function Lua.Math.GetNan()
  -> number

Returns NAN.

Returns:

Type	Description
number

IsNan

function Lua.Math.IsNan(value)
  -> boolean

Checks if a value is NAN.

Parameters:

Name	Type	Description
value	number	The number to check

Returns:

Type	Description
boolean

Round

function Lua.Math.Round(value, sig)
  -> number

Rounds a value to a specified significant value.

Parameters:

Name	Type	Description
value	number	The number to be rounded
sig	number	The value to round to the nearest multiple of (defaults to 1)

Returns:

Type	Description
number

Scale

function Lua.Math.Scale(value, fromStart, fromEnd, toStart, toEnd)
  -> number

Scales a value from one range to another.

Parameters:

Name	Type	Description
value	number	The number to be scaled
fromStart	number	The start value of the range to scale from
fromEnd	number	The end value of the range to scale from (can be less than fromStart)
toStart	number	The start value of the range to scale to
toEnd	number	The end value of the range to scale to (can be less than toStart)

Returns:

Type	Description
number