TartJS

Class: List

List

new tart.List()

List.js, line 31

List data structure

Extends

Methods

addItem(value){boolean}

List.js, line 46

Adds a new item to list .

Name Type Description
value *

Value for the pair.
Returns:
Type Description
boolean .

inherited getActiveItem(){tart.JSON}

Collection.js, line 103

Returns active item as JSON object.

Returns:
Type Description
tart.JSON returns the active key-value pair from the collection.

inherited getActiveItemIndex(){number}

Collection.js, line 132

Returns active item's index.

Returns:
Type Description
number returns the active index in the collection.

inherited getActiveItemKey(){string|number}

Collection.js, line 113

Returns active item's key.

Returns:
Type Description
string | number returns the active key from the collection.

inherited getActiveItemValue(){*}

Collection.js, line 123

Returns active item's value.

Returns:
Type Description
* returns the active value from the collection.

inherited getAll(){Array}

Collection.js, line 178

Dumps all items in an array.

Returns:
Type Description
Array returns all pairs as an array.

inherited getByIndex(index){tart.JSON|boolean|undefined}

Collection.js, line 165

Returns item by given index.

Name Type Description
index number

Index to search in the collection.
Returns:
Type Description
tart.JSON | boolean | undefined returns the key-value pair given an index.

inherited getByKey(key){tart.JSON}

Collection.js, line 143

Returns item by given key. If not found, returns boolean false.

Name Type Description
key string | number

key to search for.
Returns:
Type Description
tart.JSON returns the key-value pair given a specific key.

inherited getByValue(val){tart.JSON}

Collection.js, line 154

Returns item by given value. If not found, returns boolean false.

Name Type Description
val string | number

value to search for.
Returns:
Type Description
tart.JSON returns the key-value pair given a specific value.

inherited getItems(){tart.JSON}

Collection.js, line 203

Returns all items in a kvp format.

Returns:
Type Description
tart.JSON obj returns an object that contains keys as its keys and values as its values.

inherited getKeys(){Array}

Collection.js, line 194

Returns all keys in an array.

Returns:
Type Description
Array returns all keys in an array.

inherited getValues(){Array}

Collection.js, line 186

Returns all values in an array.

Returns:
Type Description
Array returns all values in an array.

inherited removeByIndex(index){number|boolean|undefined}

Collection.js, line 222

Removes an item from collection which given by index and rebuilds the item collection. Returns new activeItemIndex if item successfully removed or FALSE if not.

Name Type Description
index number

Index to remove.
Returns:
Type Description
number | boolean | undefined Condition of the operation or the active item index.

inherited removeByKey(key)

Collection.js, line 245

Removes items by key.

Name Type Description
key string

Game items key.

inherited setActiveItemIndex(newIndex){boolean}

Collection.js, line 257

Sets active item index.

Name Type Description
newIndex number

index to set as the new active item.
Returns:
Type Description
boolean Whether the method was able to set the item.