SHIP:Sail:floor

Function	Returns	Introduced	Description
floor	Integer	1	Gets the largest integer less than or equal to a number (v5)

This function was introduced in SHIP Version 5.0.

See Also

• SHIP Sail Home
• SHIP Sail Function Home
• abs, ceil, floor, ftoi, itof, max, min, round

Prototype

Integer floor(Float n);

Parameters/Return Value

Parameter	Data Type	Description
n	Float	the number to find the floor value of
Return	Integer	the floor (lower) of the supplied number

Detailed Description

The floor() function returns the returns the largest integer less than or equal to a number. If you visualize a number line, floor() goes to the integer to the left.

Examples

Example	Result	Notes
floor(-5.1f);	-6
floor(5.2f);	5