Back

Map

_{src/main/java/bt7s7k7/treeburst/runtime/Realm.java:170
src/main/java/bt7s7k7/treeburst/standard/MapPrototype.java:20
src/main/java/bt7s7k7/treeburst/runtime/Realm.java:227}

Allows the storage of an unordered set of entries, indexed by a key, which may be any type of value.

Map.prototype.clear

_{src/main/java/bt7s7k7/treeburst/standard/MapPrototype.java:73}

Overloads:

• clear(this: Map)

Removes all entries in the map.

Map.prototype.clone

_{src/main/java/bt7s7k7/treeburst/standard/MapPrototype.java:67}

Overloads:

• clone(this: Map)

Creates a copy of the map.

Map.prototype.entries

_{src/main/java/bt7s7k7/treeburst/standard/MapPrototype.java:92}

Overloads:

• entries(this: Map)

Returns an Array, containing all the entries in the map.

Map.prototype.k_at

_{src/main/java/bt7s7k7/treeburst/standard/MapPrototype.java:29}

Overloads:

• k_at(this: Map, index: any)

• k_at(this: Map, index: any, value: any)

Gets or sets an entry in the map. When writing, if the value is void, the selected entry is deleted. When reading, if the selected entry does not exist, a void is returned.

Map.prototype.k_dump

_{src/main/java/bt7s7k7/treeburst/standard/MapPrototype.java:105}

Overloads:

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

Formats the map into a textual form.

Map.prototype.keys

_{src/main/java/bt7s7k7/treeburst/standard/MapPrototype.java:80}

Overloads:

• keys(this: Map)

Returns an Array, containing keys of all the entries in the map.

Map.prototype.values

_{src/main/java/bt7s7k7/treeburst/standard/MapPrototype.java:86}

Overloads:

• values(this: Map)

Returns an Array, containing values of all the entries in the map.

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