e2 docs number - wiremod/wire GitHub Wiki

Jump to table of contents

Number

Number = min(Number A, Number B)

Returns the lowest value Argument (1 ops)

Number = min(Number A, Number B, Number C)

Returns the lowest value Argument (1 ops)

Number = min(Number A, Number B, Number C, Number D)

Returns the lowest value Argument (1 ops)

Number = max(Number A, Number B)

Returns the highest value Argument (1 ops)

Number = max(Number A, Number B, Number C)

Returns the highest value Argument (1 ops)

Number = max(Number A, Number B, Number C, Number D)

Returns the highest value Argument (1 ops)

Number = isfinite(Number Value)

(2 ops)

Number = isinf(Number Value)

Returns 1 if given value is a positive infinity or -1 if given value is a negative infinity; otherwise 0. (2 ops)

Number = isnan(Number Value)

Returns 1 if given value is not a number (NaN); otherwise 0. (2 ops)

Number = remap(Number Value, Number In_min, Number In_max, Number Out_min, Number Out_max)

Remaps an input value with an input minimum value and an input maximum value to an output minimum and output maximum. (2 ops)

Number = abs(Number N)

Returns the Magnitude of the Argument (2 ops)

Number = ceil(Number N)

Rounds the Argument up to the nearest Integer (2 ops)

Number = ceil(Number Value, Number Decimals)

Rounds Argument 1 up to Argument 2's decimal precision (2 ops)

Number = floor(Number N)

Rounds the Argument down to the nearest Integer (2 ops)

Number = floor(Number Value, Number Decimals)

Rounds Argument 1 down to Argument 2's decimal precision (2 ops)

Number = round(Number N)

Rounds the Argument to the nearest Integer (2 ops)

Number = round(Number Value, Number Decimals)

Rounds Argument 1 to Argument 2's decimal precision (2 ops)

Number = int(Number N)

Returns the Integer part of the Argument (always rounds towards zero) (2 ops)

Number = frac(Number N)

Returns the Fractional part (decimal places) of the Argument (2 ops)

Number = mod(Number Lhs, Number Rhs)

Modulo, returns the Remainder after Argument 1 has been divided by Argument 2. Note "mod(-1, 3) = -1" (2 ops)

Number = wrap(Number Lhs, Number Rhs)

Performs (n1 + n2) % (n2 * 2) - n2 (2 ops)

Number = clamp(Number N, Number Low, Number High)

If Arg1 = Arg3 (max) returns Arg3; otherwise returns Arg1 (2 ops)

Number = inrange(Number Value, Number Min, Number Max)

Returns 1 if N is in the interval [N2; N3], 0 otherwise. This means it is equivalent to ((N2 <= N) & (N <= N3)) (2 ops)

Number = lerp(Number From, Number To, Number Fraction)

Performs linear interpolation. Returns a new value between 'from' and 'to', based on a 0-1 percentage ('fraction') (2 ops)

Number = sign(Number N)

Returns the sign of argument (-1,0,1) [sign(N) = N / abs(N) ] (2 ops)

Number = random()

Returns a random floating-point number between 0 and 1 [0 <= x < 1 ] (2 ops)

Number = random(Number N)

Returns a random floating-point number between 0 and the specified value [0 <= x < a ] (2 ops)

Number = random(Number Low, Number High)

Returns a random floating-point number between the specified interval [a <= x < b ] (2 ops)

Number = randint(Number N)

Returns a random integer from 1 to the specified value [1 <= x <= a ] (2 ops)

Number = randint(Number A, Number B)

Returns a random integer in the specified interval [a <= x <= b ] (2 ops)

Number = factorial(Number N)

Returns the Factorial of the Argument (10 ops)

Number = sqrt(Number N)

Returns the Square Root of the Argument (2 ops)

Number = cbrt(Number N)

Returns the Cube Root of the Argument (2 ops)

Number = root(Number N, Number Pow)

Returns the Nth Root of the first Argument (2 ops)

Number = e()

Returns Euler's Constant (2 ops)

Number = exp(Number N)

Returns e to the power of the Argument (same as e()^N but shorter and faster this way) (2 ops)

Vector2 = frexp(Number N)

Returns the mantissa and exponent of the given floating-point number as a vector2 (X component holds a mantissa, and Y component holds an exponent) (2 ops)

Number = ln(Number N)

Returns the logarithm to base e of the Argument (2 ops)

Number = log2(Number N)

Returns the logarithm to base 2 of the Argument (2 ops)

Number = log10(Number N)

Returns the logarithm to base 10 of the Argument (2 ops)

Number = log(Number A, Number B)

Returns the logarithm to base Argument 2 of Argument 1 (2 ops)

Number = inf()

Returns a huge constant (infinity) (1 ops)

Number = pi()

Returns the constant PI (1 ops)

Number = toRad(Number N)

Converts Degree angles to Radian angles (1 ops)

Number = toDeg(Number N)

Converts Radian angles to Degree angles (1 ops)

Number = acos(Number N)

Returns the inverse cosine of the argument, in degrees (2 ops)

Number = asin(Number N)

Returns the inverse sine of the argument, in degrees (2 ops)

Number = atan(Number N)

Returns the inverse tangent of the argument, in degrees (2 ops)

Number = atan(Number X, Number Y)

Returns the inverse tangent of the arguments (arg1 / arg2), in degrees. This function accounts for positive/negative arguments, and arguments at or close to 0 (2 ops)

Number = atan2(Number X, Number Y)

(2 ops)

Number = cos(Number N)

Returns the cosine of N degrees (2 ops)

Number = sec(Number N)

Returns the secant of N degrees (2 ops)

Number = sin(Number N)

Returns the sine of N degrees (2 ops)

Number = csc(Number N)

Returns the cosecant of N degrees (2 ops)

Number = tan(Number N)

Returns the tangent of N degrees (2 ops)

Number = cot(Number N)

Returns the cotangent of N degrees (2 ops)

Number = cosh(Number N)

Returns the hyperbolic cosine of N degrees (1.5 ops)

Number = sech(Number N)

Returns the hyperbolic secant of N degrees (1.5 ops)

Number = sinh(Number N)

Returns the hyperbolic sine of N degrees (1.5 ops)

Number = csch(Number N)

Returns the hyperbolic cosecant of N degrees (1.5 ops)

Number = tanh(Number N)

Returns the hyperbolic tangent of N degrees (1.5 ops)

Number = coth(Number N)

Returns the hyperbolic cotangent of N degrees (1.5 ops)

Number = acosr(Number N)

Returns the inverse cosine of the argument, in radians (1.5 ops)

Number = asinr(Number N)

Returns the inverse sine of the argument, in radians (1.5 ops)

Number = atanr(Number N)

Returns the inverse tangent of the argument, in radians (1.5 ops)

Number = cosr(Number N)

Returns the cosine of N radians (1.5 ops)

Number = secr(Number N)

Returns the secant of N radians (1.5 ops)

Number = sinr(Number N)

Returns the sine of N radians (1.5 ops)

Number = cscr(Number N)

Returns the cosecant of N radians (1.5 ops)

Number = tanr(Number N)

Returns the tangent of N radians (1.5 ops)

Number = cotr(Number N)

Returns the cotangent of N radians (1.5 ops)

Number = coshr(Number N)

Returns the hyperbolic cosine of N radians (1.5 ops)

Number = sechr(Number N)

Returns the hyperbolic secant of N radians (1.5 ops)

Number = sinhr(Number N)

Returns the hyperbolic sine of N radians (1.5 ops)

Number = cschr(Number N)

Returns the hyperbolic cosecant of N radians (1.5 ops)

Number = tanhr(Number N)

Returns the hyperbolic tangent of N radians (1.5 ops)

Number = cothr(Number N)

Returns the hyperbolic cotangent of N radians (1.5 ops)

String = toString(Number Number)

Formats a number as a string. (Numbers may be concatenated into a string without using this function) (5 ops)

String = Number:toString()

Formats a number as a string. (Numbers may be concatenated into a string without using this function) (5 ops)

String = toString(Number Number, Number Base)

Formats a number as a string, using argument 2 as the base. i.e. using 16 for base would convert the number to hex (10 ops)

String = Number:toString(Number Base)

Formats a number as a string, using argument 2 as the base. i.e. using 16 for base would convert the number to hex (10 ops)