Back

Array

_{src/main/java/bt7s7k7/treeburst/runtime/Realm.java:167
src/main/java/bt7s7k7/treeburst/standard/ArrayPrototype.java:35
src/main/java/bt7s7k7/treeburst/runtime/Realm.java:226}

Allows the storage of an ordered list of elements, each indexed by a number starting from 0.

Array.prototype.@foreach

_{src/main/java/bt7s7k7/treeburst/standard/ArrayPrototype.java:485}

Overloads:

• @foreach(this: Expression, function: Expression.FunctionDeclaration)

Equivalent to the Array.prototype.foreach function, except this macro inlines the function, allowing you to share the scope and use control flow functions like return and goto.

Array.prototype.append

_{src/main/java/bt7s7k7/treeburst/standard/ArrayPrototype.java:322}

Overloads:

• append(this: Array, elements: Array)

Appends the provided elements to the end of the array. Returns the current array.

Array.prototype.clear

_{src/main/java/bt7s7k7/treeburst/standard/ArrayPrototype.java:229}

Overloads:

• clear(this: Array)

Removes all elements in the array.

Array.prototype.clone

_{src/main/java/bt7s7k7/treeburst/standard/ArrayPrototype.java:223}

Overloads:

• clone(this: Array)

Creates a copy of the array.

Array.prototype.filter

_{src/main/java/bt7s7k7/treeburst/standard/ArrayPrototype.java:458}

Overloads:

• filter(this: Array, function: Function)

Creates a new array with only the elements for which function returned true. The function is called with value of the element, the index of the element and a reference to this array.

Array.prototype.foreach

_{src/main/java/bt7s7k7/treeburst/standard/ArrayPrototype.java:441}

Overloads:

• foreach(this: Array, function: Function)

Calls a function for every element of this array. The function is called with value of the element, the index of the element and a reference to this array. Returns this array.

Array.prototype.join

_{src/main/java/bt7s7k7/treeburst/standard/ArrayPrototype.java:516}

Overloads:

• join(this: Array, separator: String)

Creates a String as that is a concatenation of all elements of the array. Elements that are not strings are converted to strings using their k_string method.

Array.prototype.k_add

_{src/main/java/bt7s7k7/treeburst/standard/ArrayPrototype.java:542}

Overloads:

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

• k_add(this: Array, right: Array)

Creates a new array that is a concatenation of the two input arrays.

Array.prototype.k_at

_{src/main/java/bt7s7k7/treeburst/standard/ArrayPrototype.java:101}

Overloads:

• k_at(this: Array, index: Number)

• k_at(this: Array, index: Number, value: any)

Gets or sets an element at the requested index. If an index outside the array is specified, an exception is generated. As always, the index may be negative to index from the end of the array, where -1 is the last element and so on.

Array.prototype.k_dump

_{src/main/java/bt7s7k7/treeburst/standard/ArrayPrototype.java:396}

Overloads:

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

Formats the array into a textual form.

Array.prototype.k_mul

_{src/main/java/bt7s7k7/treeburst/standard/ArrayPrototype.java:557}

Overloads:

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

• k_mul(this: Array, right: Number)

Creates a new array that is the input array repeated n times.

Array.prototype.map

_{src/main/java/bt7s7k7/treeburst/standard/ArrayPrototype.java:415}

Overloads:

• map(this: Array, function: Function)

Creates a new array with the results of calling function on every element. The function is called with value of the element, the index of the element and a reference to this array. If function returns void, the element is discarded and the resulting array is shorter.

Array.prototype.pop

_{src/main/java/bt7s7k7/treeburst/standard/ArrayPrototype.java:338}

Overloads:

• pop(this: Array)

Removes the last element of the array and returns it. If the array is empty returns void.

Array.prototype.prepend

_{src/main/java/bt7s7k7/treeburst/standard/ArrayPrototype.java:330}

Overloads:

• prepend(this: Array, elements: Array)

Prepends the provided elements before the start of the array. Returns the current array.

Array.prototype.push

_{src/main/java/bt7s7k7/treeburst/standard/ArrayPrototype.java:360}

Overloads:

• push(this: Array)

Adds an element after the end of the array. Returns the last added value.

Array.prototype.shift

_{src/main/java/bt7s7k7/treeburst/standard/ArrayPrototype.java:349}

Overloads:

• shift(this: Array)

Removes the first element of the array and returns it. If the array is empty returns void.

Array.prototype.slice

_{src/main/java/bt7s7k7/treeburst/standard/ArrayPrototype.java:236}

Overloads:

• slice(this: Array, from: Number)

• slice(this: Array, from: Number, to: Number)

Creates a copy of a section of the array starting at from and ending at to (or the end of the array if not provided). As always, the index may be negative to index from the end of the array, where -1 is the last element and so on.

Array.prototype.splice

_{src/main/java/bt7s7k7/treeburst/standard/ArrayPrototype.java:286}

Overloads:

• splice(this: Array, index: Number, delete: Number)

• splice(this: Array, index: Number, delete: Number, insert: Array)

Removes a section of the array at index of length delete. Optionally replacing this section with the elements of insert. If the delete argument is 0, this function is equivalent to an insertion function; in this case the index may point to just after the end of the array. As always, the index may be negative to index from the end of the array, where -1 is the last element and so on.

Array.prototype.truncate

_{src/main/java/bt7s7k7/treeburst/standard/ArrayPrototype.java:197}

Overloads:

• truncate(this: Array, length: Number)

Sets the length of the array to the provided value. If the new length is shorter, elements at the end are discarded. If the length is longer, new elements are filled with null. Returns a reference to this array.

Array.prototype.tryAt

_{src/main/java/bt7s7k7/treeburst/standard/ArrayPrototype.java:141}

Overloads:

• tryAt(this: Array, index: Number)

• tryAt(this: Array, index: Number, value: any)

Gets or sets an element at the requested index. If an index outside the array is specified, it returns void when reading or the length of array is extended on writing (all added elements are filled with null). As always, the index may be negative to index from the end of the array, where -1 is the last element and so on.

Array.prototype.unshift

_{src/main/java/bt7s7k7/treeburst/standard/ArrayPrototype.java:378}

Overloads:

• unshift(this: Array)

Adds an element before the start of the array. Returns the last added value.

Array.prototype.view

_{src/main/java/bt7s7k7/treeburst/standard/ArrayPrototype.java:261}

Overloads:

• view(this: Array, from: Number)

• view(this: Array, from: Number, to: Number)

Creates a view of a section of the array starting at from and ending at to (or the end of the array if not provided). As always, the index may be negative to index from the end of the array, where -1 is the last element and so on.

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.

Table.prototype.k_string

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

Inherited from: Table

Overloads:

• k_string(this: any)

Formats the value into a textual form, using its k_dump implementation