Back

Number

_{src/main/java/bt7s7k7/treeburst/runtime/Realm.java:158
src/main/java/bt7s7k7/treeburst/runtime/Realm.java:157
src/main/java/bt7s7k7/treeburst/runtime/Realm.java:223}

Represents a real number.

Number.prototype.k_add

_{src/main/java/bt7s7k7/treeburst/runtime/Realm.java:104}

Overloads:

• k_add(this: any, left: Number, right: Number)

• k_add(this: Number, right: Number)

Adds two numbers together.

Number.prototype.k_bitAnd

_{src/main/java/bt7s7k7/treeburst/runtime/Realm.java:117}

Overloads:

• k_bitAnd(this: any, left: Number, right: Number)

• k_bitAnd(this: Number, right: Number)

Performs a bitwise AND over the two numbers, calculated using 32-bit signed integers.

Number.prototype.k_bitOr

_{src/main/java/bt7s7k7/treeburst/runtime/Realm.java:118}

Overloads:

• k_bitOr(this: any, left: Number, right: Number)

• k_bitOr(this: Number, right: Number)

Performs a bitwise OR over the two numbers, calculated using 32-bit signed integers.

Number.prototype.k_bitShl

_{src/main/java/bt7s7k7/treeburst/runtime/Realm.java:119}

Overloads:

• k_bitShl(this: any, left: Number, right: Number)

• k_bitShl(this: Number, right: Number)

Shifts the bits in the first number left by the value of the second number, calculated using 32-bit signed integers.

Number.prototype.k_bitShr

_{src/main/java/bt7s7k7/treeburst/runtime/Realm.java:120}

Overloads:

• k_bitShr(this: any, left: Number, right: Number)

• k_bitShr(this: Number, right: Number)

Shifts the bits in the first number right by the value of the second number, calculated using 32-bit signed integers.

Number.prototype.k_bitShrUnsigned

_{src/main/java/bt7s7k7/treeburst/runtime/Realm.java:121}

Overloads:

• k_bitShrUnsigned(this: any, left: Number, right: Number)

• k_bitShrUnsigned(this: Number, right: Number)

Shifts the bits in the first number right by the value of the second number, calculated using 32-bit unsigned integers.

Number.prototype.k_bitXor

_{src/main/java/bt7s7k7/treeburst/runtime/Realm.java:116}

Overloads:

• k_bitXor(this: any, left: Number, right: Number)

• k_bitXor(this: Number, right: Number)

Performs a bitwise XOR over the two numbers, calculated using 32-bit signed integers.

Number.prototype.k_div

_{src/main/java/bt7s7k7/treeburst/runtime/Realm.java:107}

Overloads:

• k_div(this: any, left: Number, right: Number)

• k_div(this: Number, right: Number)

Divides the first number by the second one.

Number.prototype.k_dump

_{src/main/java/bt7s7k7/treeburst/runtime/Realm.java:242}

Overloads:

• k_dump(this: Number, depth?: Number)

Formats the number into a textual form.

Number.prototype.k_gt

_{src/main/java/bt7s7k7/treeburst/runtime/Realm.java:112}

Overloads:

• k_gt(this: any, left: Number, right: Number)

• k_gt(this: Number, right: Number)

Returns true if the first number is greater than the second.

Number.prototype.k_gte

_{src/main/java/bt7s7k7/treeburst/runtime/Realm.java:113}

Overloads:

• k_gte(this: any, left: Number, right: Number)

• k_gte(this: Number, right: Number)

Returns true if the first number is greater or equal to the second.

Number.prototype.k_lt

_{src/main/java/bt7s7k7/treeburst/runtime/Realm.java:111}

Overloads:

• k_lt(this: any, left: Number, right: Number)

• k_lt(this: Number, right: Number)

Returns true if the first number is less than the second.

Number.prototype.k_lte

_{src/main/java/bt7s7k7/treeburst/runtime/Realm.java:114}

Overloads:

• k_lte(this: any, left: Number, right: Number)

• k_lte(this: Number, right: Number)

Returns true if the first number is less or equal to the second.

Number.prototype.k_mod

_{src/main/java/bt7s7k7/treeburst/runtime/Realm.java:108}

Overloads:

• k_mod(this: any, left: Number, right: Number)

• k_mod(this: Number, right: Number)

Returns the remainder of the first number when divided by the second.

Number.prototype.k_mul

_{src/main/java/bt7s7k7/treeburst/runtime/Realm.java:106}

Overloads:

• k_mul(this: any, left: Number, right: Number)

• k_mul(this: Number, right: Number)

Multiplies two numbers together.

Number.prototype.k_neg

_{src/main/java/bt7s7k7/treeburst/runtime/Realm.java:237}

Overloads:

• k_neg(this: Number)

Returns a number with an inverted sign.

Number.prototype.k_pow

_{src/main/java/bt7s7k7/treeburst/runtime/Realm.java:109}

Overloads:

• k_pow(this: any, left: Number, right: Number)

• k_pow(this: Number, right: Number)

Puts the first number to the second's power.

Number.prototype.k_string

_{src/main/java/bt7s7k7/treeburst/runtime/Realm.java:254}

Overloads:

• k_string(this: Number, radix?: Number)

Formats the number into a textual form. If the radix parameter is provided, it is used as the base for representing the number value. In this case the number is converted to an integer by rounding down.

Number.prototype.k_sub

_{src/main/java/bt7s7k7/treeburst/runtime/Realm.java:105}

Overloads:

• k_sub(this: any, left: Number, right: Number)

• k_sub(this: Number, right: Number)

Subtracts the second number from the first one.

Inherited Properties

Table.prototype.@k_and

_{src/main/java/bt7s7k7/treeburst/runtime/Realm.java:471}

Inherited from: Table

Overloads:

• @k_and(this: Expression, other: Expression)

This object is converted to a Boolean. If the result is true, the other expression is evaluated and the result retuned, otherwise this object is returned.

Table.prototype.@k_coalesce

_{src/main/java/bt7s7k7/treeburst/runtime/Realm.java:531}

Inherited from: Table

Overloads:

• @k_coalesce(this: Expression, other: Expression)

If this object is not null or void, it is returned, otherwise the other expression is evaluated and the result retuned.

Table.prototype.@k_else

_{src/main/java/bt7s7k7/treeburst/runtime/Realm.java:568}

Inherited from: Table

Overloads:

• @k_else(this: Expression, other: Expression)

If this object is not void, it is returned, otherwise the other expression is evaluated and the result retuned.

Table.prototype.@k_or

_{src/main/java/bt7s7k7/treeburst/runtime/Realm.java:494}

Inherited from: Table

Overloads:

• @k_or(this: Expression, other: Expression)

This object is converted to a Boolean. If the result is true this object is retuned, otherwise the other expression is evaluated and the result retuned.

Table.prototype.k_boolean

_{src/main/java/bt7s7k7/treeburst/runtime/Realm.java:591}

Inherited from: Table

Overloads:

• k_boolean(this: any)

This object is converted to a Boolean.

Table.prototype.k_is

_{src/main/java/bt7s7k7/treeburst/runtime/Realm.java:602}

Inherited from: Table

Overloads:

• k_is(this: any, other: any)

Returns true if this object is equal by reference to the other object. This function returns inconsistent results for objects of type String and Number, and should not be used with them. The intended use is for reference comparisons between compound objects and null or void, without using their overload of the k_eq operator.