util.math.floor

Shared

Rounds a number down to the nearest integer


Syntax

local result = util.math.floor(
    value
)

Parameters

TypeNameDescription
floatvalueNumber to round down

Returns

TypeNameDescription
intresultLargest integer less than or equal to value

Examples

Floor a positive float
local result = util.math.floor(4.9)

core.engine.print("info", result) -- 4
Floor a negative float
local result = util.math.floor(-4.2)

core.engine.print("info", result) -- -5
Floor an exact integer returns itself
local result = util.math.floor(3.0)

core.engine.print("info", result) -- 3
Truncate a float to integer
local result = util.math.floor(9.99)

core.engine.print("info", result) -- 9
Compute integer division
local result = util.math.floor(17/5)

core.engine.print("info", result) -- 3
Snap position to grid
local pos_x = 137.6
local grid_size = 32
local snapped = util.math.floor(pos_x/grid_size)*grid_size

core.engine.print("info", snapped) -- 128
Convert seconds to whole minutes
local seconds = 185
local minutes = util.math.floor(seconds/60)

core.engine.print("info", minutes) -- 3

On this page