Documentation

Math - Open Dev Kit Documentation

Open Dev Kit Documentation :: General :: Math

Root.Math
Collection of various mathematical operations for calculations and manipulations

Functions

Addition ( Value Variant, Add Variant ) Variant
Adds to a value
Subtract ( Value Variant, Subtract Variant ) Variant
Subtracts from a value
Multiply ( Value Variant, Multiply Variant ) Variant
Multiplies a value
Division ( Value Float, Divide Float ) Float
Divides a value
Integer Division ( Value Integer, Divide Integer ) Integer
Divides a value to the nearest whole number
Modulus ( Value Float, Divide Float ) Float
Returns the remainder of two numbers divided
Integer Modulus ( Value Integer, Divide Integer ) Integer
Returns the remainder of two numbers divided (as whole numbers)
Absolute Number ( Value Variant ) Variant
Returns the value as a positive number
Power of ( Value Double, Power Double ) Double
Multiplies a value by itself a set number of times
Square Root ( Value Double ) Double
Returns the square root of a value
Round ( Value Double, Unit Double ) Double
Rounds down or up to the nearest number
Round Down ( Value Double, Unit Double ) Double
Rounds down a value to the nearest number
Round Up ( Value Double, Unit Double ) Double
Rounds up a value to the nearest number
Round Int ( Value Double, Unit Integer ) Integer
Rounds down or up to the nearest number
Round Down Int ( Value Double, Unit Integer ) Integer
Rounds down a value to the nearest whole number
Round Up Int ( Value Double, Unit Integer ) Integer
Rounds up a value to the nearest whole number
Round Int Int ( Value Integer, Unit Integer ) Integer
Rounds down or up to the nearest number
Round Down Int Int ( Value Integer, Unit Integer ) Integer
Rounds down a integer value to the nearest number
Round Up Int Int ( Value Integer, Unit Integer ) Integer
Rounds up an integer value to the nearest number
Round Up to Power of 2 ( Value Integer ) Integer
Rounds up a value to the nearest power of 2
Clamp Number ( Value Variant, Minimum Variant, Maximum Variant ) Variant
Returns a number that is limited from being lower or higher than the certain values
Minimum Number ( Value 1 Variant, Value 2 Variant ) Variant
Returns the lower of the two numbers
Maximum Number ( Value 1 Variant, Value 2 Variant ) Variant
Returns the higher of the two numbers
Linear Interpolate ( Value 1 Double, Value 2 Double, Factor Double ) Double
Returns Value 1 if Factor is 0, Value 2 if Factor is 1 and the average of Value 1 and 2 if Factor is 0.5, with everything in between using linear interpolation
Linear Interpolate within Range ( Value Double, Minimum Source Double, Maximum Source Double, Minimum Target Double, Maximum Target Double ) Double
Returns a value mapped from the original range to the target range
Deviate Value Exponentially ( Value Double, Factor Double ) Double
Increases or decreased a value on an exponential scale
Greatest Common Divisor ( Value 1 Double, Value 2 Double, Epsilon Double ) Double
Returns the largest number that both values can be divided by
Lowest Common Multiple ( Value 1 Double, Value 2 Double, Epsilon Double ) Double
Returns the least common multiple of the two values
Cosine ( Value Double ) Double
Returns the cosine of a direction
Sine ( Value Double ) Double
Returns the sine of a direction
Tangent ( Value Double ) Double
Returns the tangent of a direction
Arctangent ( Value Double ) Double
Returns the arctangent of a direction
Random Integer ( Minimum Integer, Maximum Integer ) Integer
Returns a random integer inclusive of the specified range
Random Long ( Minimum Long, Maximum Long ) Long
Returns a random integer inclusive of the specified range
Random Float ( Minimum Float, Maximum Float ) Float
Returns a random floating-point number inclusive of the specified range
Random Double ( Minimum Double, Maximum Double ) Double
Returns a random floating-point number inclusive of the specified range
Bitwise And ( Value 1 Integer, Value 2 Integer ) Integer
Returns bitwise AND operation on two integers
Bitwise Or ( Value 1 Integer, Value 2 Integer ) Integer
Returns bitwise AND operation on two integers
Bitwise Xor ( Value 1 Integer, Value 2 Integer ) Integer
Returns bitwise XOR operation on two integers
Bitwise Not ( Value Integer ) Integer
Returns bitwise NOT operation on an integer
Is Numeric ( Value String ) Boolean
Returns true if the string value can be converted to an integer or floating-point number
Is Integer ( Value String ) Boolean
Returns true if the string value can be converted to am integer number
To Radians ( Degrees Float ) Float
Returns the radians of the specified number of degrees
To Degrees ( Radians Float ) Float
Returns the degrees of the specified number of radians

Properties

Pi Float
value of the constant pi

If you think anything is missing, please feel free to: submit documentation feedback on this page