Math

All functions are added directly to the Lua math global. Accessible via math.* or lib.math.*.

#math.round

Rounds a number to the specified decimal places.

math.round(3.14159, 2) -- 3.14
math.round(1567)       -- 1567

#math.clamp

Clamps a value between lower and upper bounds. Auto-swaps boundaries if inverted.

math.clamp(15, 0, 10) -- 10

#math.interp

Simple linear interpolation between two values.

math.interp(0, 100, 0.5) -- 50.0

#math.lerp

Returns an iterator that yields interpolated values each frame over a duration.

for value, step in math.lerp(0.0, 100.0, 1000) do
    print(value, step) -- step goes 0 → 1
end

The final iteration yields (finish, 1), then nil.

#math.groupdigits

Formats a number with digit grouping.

math.groupdigits(1000000) -- "1,000,000"
math.groupdigits(1000000, '.') -- "1.000.000"

#math.toscalars

Parses numeric scalars from a string.

local x, y, z = math.toscalars("1.0, 2.5, 3.0")

#math.tovector

Converts a string or table to a vector type.

math.tovector("1.0, 2.5, 3.0") -- vector3(1.0, 2.5, 3.0)
math.tovector({x = 1, y = 2})  -- vector2(1, 2)

Returns vector2, vector3, vector4, or number depending on the number of components.

#math.normaltorotation

Converts a surface normal vector to a rotation vector.

local rot = math.normaltorotation(surfaceNormal) -- vector3(pitch, yaw, 0)

#math.torgba

Converts a string or table to an RGBA vector4.

local rgba = math.torgba("255, 128, 0, 0.5") -- vector4(255, 128, 0, 0.5)

RGB values are 0–255, alpha is 0–1.

#math.hextorgb

Converts a hex colour string to RGB components.

local r, g, b = math.hextorgb("#FF00AA")

#math.tohex

Converts a number to a hex string.

math.tohex(255)       -- "0xff"
math.tohex(255, true) -- "0xFF"