List

Classes

List(...)

A data structure that stores entries sequentially and dynamically adjusts its size. Equivalent to DS Lists.

ListIterator(list)

An iterator class designed to efficiently loop through the list in linear time. It stores its current position in index and current value in value.

• hasNext(): Return whether there are more values to iterate.
• next(): Iterate to the next value.
• remove(): Remove the current value from the list.
• set(val): Set the current value in the list to the given value.

A for loop using ListIterator takes this form:

for (var i = list.iterator(); i.hasNext(); i.next()) {
    /* Use i.index and i.value here */
}

Ported Methods

• add(...): See ds_list_add(id, val, ...).
• clear(): See ds_list_clear(id).
• copy(sourceList): See ds_list_copy(id, source).
• empty(): See ds_list_empty(id).
• findIndex(val): See ds_list_find_index(id, val).
• findValue(pos): See ds_list_find_value(id, pos).
• insert(pos, val): See ds_list_insert(id, pos, val).
• read(datastr): See ds_list_read(id, str).
• remove(pos): See ds_list_delete(id, pos).
• replace(pos, val): See ds_list_replace(id, pos, val).
• set(pos, val): See ds_list_set(id, pos, val).
• shuffle(): See ds_list_shuffle(id).
• sort([ascend], [keyer], [comparer]): See ds_list_sort(id, ascend). Special: You can optionally specify a keyer method taking a value and returning the value in it to compare (e.g. function(entry) { return entry.points; } for sorting a list of entries by points), and a comparer method taking two values a and b and returning true if a > b (e.g. function(v1, v2) { return sqr(v1[0])+sqr(v1[1]) > sqr(v2[0])+sqr(v2[1]); } for sorting a list of 2D vectors by length).
• size(): See ds_list_size(id).
• write(): See ds_list_write(id).

Aliases

• get(pos): Same as findValue(pos)

New Methods

• clone(): Return a shallow clone of the list.
• cloneDeep(): Same as clone(), but also making deep copies of everything in the list.
• copyDeep(sourceList): Same as copy(sourceList), but with deep copies of everything in the source.
• forEach(func): Call the method or script func for each value in the list. On each iteration, it will be passed the current value followed by the current position.
• iterator(): Return a new ListIterator set to track this list.
• mapEach(func): Set each value v in the list to func(v). If func throws undefined, the value is removed from the list.
• toArray(): Return the list's contents in array form. Note that this is a shallow conversion --- other lists nested inside will remain as lists in the returned array.