list

Generated from the engine catalog by tools/gen-docs.mjs; do not edit.

list.clear

list.clear(l)

Removes every element.

list.contains

list.contains(l, v) -> bool

True when an element equals v.

list.copy

list.copy(l) -> list<any>

Copy of the list.

list.create

list.create(type, size = 0, fill = na) -> list<any>

Growable list of one element type (float, int, bool, color, text, id, a struct or an enum).

list.fill

list.fill(l, v)

Sets every element.

list.first

list.first(l) -> any

First element (na when empty).

list.get

list.get(l, i) -> any

Element i (negative counts from the end); na when out of range.

list.index_of

list.index_of(l, v) -> int

Index of the first element equal to v, or -1.

list.insert

list.insert(l, i, v)

Inserts v before element i.

list.last

list.last(l) -> any

Last element (na when empty).

list.max

list.max(l) -> num

Statistic over a numeric list.

list.mean

list.mean(l) -> num

Statistic over a numeric list.

list.min

list.min(l) -> num

Statistic over a numeric list.

list.of

list.of(v0) -> list<any>

List of the given values (the [a, b, c] literal).

list.percentile

list.percentile(l, pct = 50) -> num

Percentile of a numeric list (50 = median).

list.pop

list.pop(l) -> any

Removes and returns the last element.

list.push

list.push(l, v)

Appends v.

list.remove

list.remove(l, i) -> any

Removes and returns element i.

list.reverse

list.reverse(l)

Reverses in place.

list.set

list.set(l, i, v)

Replaces element i.

list.shift

list.shift(l) -> any

Removes and returns the first element.

list.size

list.size(l) -> int

Number of elements.

list.slice

list.slice(l, from, to = na) -> list<any>

Copy of [from, to).

list.sort

list.sort(l, descending = 0)

Sorts numbers or texts in place.

list.sort_by

list.sort_by(l, field, descending = 0)

Sorts a struct list by one field (stable).

list.stdev

list.stdev(l) -> num

Statistic over a numeric list.

list.sum

list.sum(l) -> num

Statistic over a numeric list.

list.unshift

list.unshift(l, v)

Inserts v at the front.