util.math.cos

Shared

Returns the cosine of an angle given in radians


Syntax

local result = util.math.cos(
    angle
)

Parameters

TypeNameDescription
floatangleAngle in radians

Returns

TypeNameDescription
floatresultCosine of angle, in the range [-1, 1]

Examples

Cosine of 0 is 1
local result = util.math.cos(0)

core.engine.print("info", result) -- 1.0
Cosine of pi is -1
local result = util.math.cos(util.math.pi)

core.engine.print("info", result) -- -1.0
Cosine of a 60 degree angle
local result = util.math.cos(util.math.rad(60))

core.engine.print("info", result) -- 0.5
Cosine of a 90 degree angle
local result = util.math.cos(util.math.rad(90))

core.engine.print("info", result) -- 0.0
Generate a point on a unit circle
local angle = util.math.rad(45)
local pos_x = util.math.cos(angle)
local pos_y = util.math.sin(angle)

core.engine.print("info", pos_x, pos_y) -- 0.70711  0.70711
Oscillate a value back and forth
local elapsed = 1.0
local value = util.math.cos(elapsed*util.math.pi)

core.engine.print("info", value) -- -1.0
Compute cosine for each cardinal angle
for _, deg in ipairs({0, 90, 180, 270, 360}) do
    core.engine.print("info", deg, util.math.cos(util.math.rad(deg)))
end

On this page