math.angle_to_cardinal

Converts an angle into the closest cardinal directions (including intercardinals).

Usage

math.angle_to_cardinal(angle)

Arguments

Name Type Description
angle number Angle in radians.

Returns

Name Type Description
x number X component of the closest cardinal direction: -1, 0, or 1.
y number Y component of the closest cardinal direction: -1, 0, or 1.

Examples

local x, y = math.angle_to_cardinal(math.pi / 4);
print(x, y); -- Prints "1, -1"
local x, y = math.angle_to_cardinal(math.pi);
print(x, y); -- Prints "-1, 0"

This site uses Just the Docs, a documentation theme for Jekyll.