diff options
| author | Rémi Verschelde <rverschelde@gmail.com> | 2022-01-10 13:56:55 +0100 |
|---|---|---|
| committer | Rémi Verschelde <rverschelde@gmail.com> | 2022-01-10 22:42:03 +0100 |
| commit | c6cefb1b79d207af1bc78ce20c01b5788e806252 (patch) | |
| tree | ca713ba3bf904b57a7408ec50029c9fbcc275d40 /doc/classes/PackedInt32Array.xml | |
| parent | 4acc819f9bafacf5f912caf5ba2ebc15f70e3dbb (diff) | |
| download | redot-engine-c6cefb1b79d207af1bc78ce20c01b5788e806252.tar.gz | |
`Array`: Relax `slice` bound checks to properly handle negative indices
The same is done for `Vector` (and thus `Packed*Array`).
`begin` and `end` can now take any value and will be clamped to
`[-size(), size()]`. Negative values are a shorthand for indexing the array
from the last element upward.
`end` is given a default `INT_MAX` value (which will be clamped to `size()`)
so that the `end` parameter can be omitted to go from `begin` to the max size
of the array.
This makes `slice` works similarly to numpy's and JavaScript's.
Diffstat (limited to 'doc/classes/PackedInt32Array.xml')
| -rw-r--r-- | doc/classes/PackedInt32Array.xml | 5 |
1 files changed, 4 insertions, 1 deletions
diff --git a/doc/classes/PackedInt32Array.xml b/doc/classes/PackedInt32Array.xml index da26e93b96..ec698ed8e5 100644 --- a/doc/classes/PackedInt32Array.xml +++ b/doc/classes/PackedInt32Array.xml @@ -133,8 +133,11 @@ <method name="slice" qualifiers="const"> <return type="PackedInt32Array" /> <argument index="0" name="begin" type="int" /> - <argument index="1" name="end" type="int" /> + <argument index="1" name="end" type="int" default="2147483647" /> <description> + Returns the slice of the [PackedInt32Array], from [code]begin[/code] (inclusive) to [code]end[/code] (exclusive), as a new [PackedInt32Array]. + The absolute value of [code]begin[/code] and [code]end[/code] will be clamped to the array size, so the default value for [code]end[/code] makes it slice to the size of the array by default (i.e. [code]arr.slice(1)[/code] is a shorthand for [code]arr.slice(1, arr.size())[/code]). + If either [code]begin[/code] or [code]end[/code] are negative, they will be relative to the end of the array (i.e. [code]arr.slice(0, -2)[/code] is a shorthand for [code]arr.slice(0, arr.size() - 2)[/code]). </description> </method> <method name="sort"> |