String

_{src/main/java/bt7s7k7/treeburst/runtime/Realm.java:161
src/main/java/bt7s7k7/treeburst/runtime/Realm.java:160
src/main/java/bt7s7k7/treeburst/runtime/Realm.java:224}

Represents a string of characters.

Static Properties

`String.fromCharCode`

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

Overloads:

fromCharCode(code: Number)

Returns a string containing a character with the provided character code. The codepage is implementation dependent, but it's probably UTF-16.

Instance Properties

`String.prototype.endsWith`

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

Overloads:

endsWith(this: String, substring: String)

Tests if the string ends with the substring.

`String.prototype.getCharCode`

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

Overloads:

getCharCode(this: String, index?: Number)

Returns the code for a character in the string. If index is not provided, returns the code for the first character. As always, the index may be negative to index from the end of the string, where -1 is the last character and so on.

`String.prototype.k_add`

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

Overloads:

k_add(this: any, left: String, right: String)
k_add(this: String, right: String)

Concatenates two strings together.

`String.prototype.k_at`

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

Overloads:

k_at(this: String, index?: Number)

Returns the a character from the string at an index. The return value is a string of length 1, containing the selected character. As always, the index may be negative to index from the end of the string, where -1 is the last character and so on.

`String.prototype.k_dump`

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

Overloads:

k_dump(this: String, depth?: Number)

Formats the string into a textual form, which is surrounded by " characters and all special characters are escaped.

`String.prototype.k_mul`

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

Overloads:

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

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

`String.prototype.k_string`

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

Overloads:

k_string(this: String)

Returns the string unchanged.

`String.prototype.pad`

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

Overloads:

pad(this: String, length: Number, fill?: String)

If the string is shorter that length, creates a new string that is padded with the fill character (or space character if not provided) to reach the desired length. The string is padded to be right aligned, use String.prototype.padLeft for left alignment.

`String.prototype.padLeft`

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

Overloads:

padLeft(this: String, length: Number, fill?: String)

If the string is shorter that length, creates a new string that is padded with the fill character (or space character if not provided) to reach the desired length. The resulting string is left aligned.

`String.prototype.slice`

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

Overloads:

slice(this: String, from: Number)
slice(this: String, from: Number, to: Number)

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

`String.prototype.startsWith`

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

Overloads:

startsWith(this: String, substring: String)
startsWith(this: String, substring: String, to: Number)

Tests if the string starts with the substring. If index is provided, the substring is expected at this position. As always, the index may be negative to index from the end of the string, where -1 is the last character 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.