Difference between revisions of "SHIP:Sail:round"

From Serious Documentation
Jump to: navigation, search
(Created page with "__NOTOC__ {{SailFuncTableStart|}}<onlyinclude> |{{SailFunc|round}}||{{DataType|Integer}}||1||Gets the nearest integer to a number</onlyinclude> |} == See Also: == *[[SHIP:Sail...")
 
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
 
{{SailFuncTableStart|}}<onlyinclude>
 
{{SailFuncTableStart|}}<onlyinclude>
|{{SailFunc|round}}||{{DataType|Integer}}||1||Gets the nearest integer to a number</onlyinclude>
+
|{{SailFunc|round}}||{{DataType|Integer}}||1||Gets the nearest integer to a number (v5)</onlyinclude>
 
|}
 
|}
 +
This function was introduced in SHIP Version 5.0.
 
== See Also: ==
 
== See Also: ==
 
*[[SHIP:Sail|SHIP Sail Home]]
 
*[[SHIP:Sail|SHIP Sail Home]]

Revision as of 06:45, 22 June 2014

Function Returns Introduced Description
round Integer 1 Gets the nearest integer to a number (v5)

This function was introduced in SHIP Version 5.0.

See Also:

Prototype

Integer round(Float n);

Parameters/Return Value

Parameter Data Type Description
n Float the number to find the rounded value of
Return Integer the rounded value of the supplied number

Detailed Description

The round() function returns the nearest integer to a number.

Examples

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