blob: 7d0480a0462a35abc9ae08f4d509a7d53b70538b (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
|
name: array
long_name: Array
description: An array of elements. See [arrays](Syntax.md#arrays).
is_container: true
methods:
- name: contains
returns: bool
description: |
Returns `true` if the array contains the object
given as argument, `false` otherwise
arg_flattening: false
posargs:
item:
type: any
description: The item to check
- name: get
returns: any
description: |
returns the object at the given index,
negative indices count from the back of the array, indexing out of
bounds returns the `fallback` value *(since 0.38.0)* or, if it is
not specified, causes a fatal error
arg_flattening: false
posargs:
index:
type: int
description: Index of the array position to query. Negative values start at the end of the array
optargs:
fallback:
type: any
description: Fallback value that is returned if the index is out of range.
- name: length
returns: int
description: Returns the current size of the array.
- name: flatten
returns: array[any]
since: 1.9.0
description: Returns a flattened copy of the array, with all nested arrays removed.
|
