From dd30253cdcf9b43e401cb3ba6b973f8890551a81 Mon Sep 17 00:00:00 2001 From: Nathan Franke Date: Fri, 26 Nov 2021 19:18:26 -0600 Subject: PackedByteArray, Array slice end exclusive, rename subarray to slice --- doc/classes/Array.xml | 5 ++++- doc/classes/PackedByteArray.xml | 17 +++++++++-------- doc/classes/PackedColorArray.xml | 14 +++++++------- doc/classes/PackedFloat32Array.xml | 14 +++++++------- doc/classes/PackedFloat64Array.xml | 14 +++++++------- doc/classes/PackedInt32Array.xml | 14 +++++++------- doc/classes/PackedInt64Array.xml | 14 +++++++------- doc/classes/PackedStringArray.xml | 14 +++++++------- doc/classes/PackedVector2Array.xml | 14 +++++++------- doc/classes/PackedVector3Array.xml | 14 +++++++------- 10 files changed, 69 insertions(+), 65 deletions(-) (limited to 'doc/classes') diff --git a/doc/classes/Array.xml b/doc/classes/Array.xml index d505ee98cc..5b1861bc9a 100644 --- a/doc/classes/Array.xml +++ b/doc/classes/Array.xml @@ -449,7 +449,10 @@ - Duplicates the subset described in the function and returns it in an array, deeply copying the array if [code]deep[/code] is [code]true[/code]. Lower and upper index are inclusive, with the [code]step[/code] describing the change between indices while slicing. Wraps around if [code]begin[/code] or [code]end[/code] are out of bounds or negative. Returns an empty array for invalid parameters. + Returns the slice of the [Array], from [code]begin[/code] (inclusive) to [code]end[/code] (exclusive), as a new [Array]. + If [code]end[/code] is negative, it will be relative to the end of the array. + If specified, [code]step[/code] is the relative index between source elements. + If [code]deep[/code] is true, each element will be copied by value rather than by reference. diff --git a/doc/classes/PackedByteArray.xml b/doc/classes/PackedByteArray.xml index fd098481e4..b16d45b8ca 100644 --- a/doc/classes/PackedByteArray.xml +++ b/doc/classes/PackedByteArray.xml @@ -366,18 +366,19 @@ Returns the size of the array. - - + + + + - Sorts the elements of the array in ascending order. + Returns the slice of the [PackedByteArray], from [code]begin[/code] (inclusive) to [code]end[/code] (exclusive), as a new [PackedByteArray]. + If [code]end[/code]is negative, it will be relative to the end of the array. - - - - + + - Returns the slice of the [PackedByteArray] between indices (inclusive) as a new [PackedByteArray]. Any negative index is considered to be from the end of the array. + Sorts the elements of the array in ascending order. diff --git a/doc/classes/PackedColorArray.xml b/doc/classes/PackedColorArray.xml index f69c5504da..13d7440bb9 100644 --- a/doc/classes/PackedColorArray.xml +++ b/doc/classes/PackedColorArray.xml @@ -129,17 +129,17 @@ Returns the size of the array. - - + + + + - Sorts the elements of the array in ascending order. - - - - + + + Sorts the elements of the array in ascending order. diff --git a/doc/classes/PackedFloat32Array.xml b/doc/classes/PackedFloat32Array.xml index ccac607386..151014192f 100644 --- a/doc/classes/PackedFloat32Array.xml +++ b/doc/classes/PackedFloat32Array.xml @@ -130,17 +130,17 @@ Returns the size of the array. - - + + + + - Sorts the elements of the array in ascending order. - - - - + + + Sorts the elements of the array in ascending order. diff --git a/doc/classes/PackedFloat64Array.xml b/doc/classes/PackedFloat64Array.xml index b164283b3e..963a02ace8 100644 --- a/doc/classes/PackedFloat64Array.xml +++ b/doc/classes/PackedFloat64Array.xml @@ -130,17 +130,17 @@ Returns the size of the array. - - + + + + - Sorts the elements of the array in ascending order. - - - - + + + Sorts the elements of the array in ascending order. diff --git a/doc/classes/PackedInt32Array.xml b/doc/classes/PackedInt32Array.xml index c6ff31ebdd..cef113dee9 100644 --- a/doc/classes/PackedInt32Array.xml +++ b/doc/classes/PackedInt32Array.xml @@ -130,17 +130,17 @@ Returns the array size. - - + + + + - Sorts the elements of the array in ascending order. - - - - + + + Sorts the elements of the array in ascending order. diff --git a/doc/classes/PackedInt64Array.xml b/doc/classes/PackedInt64Array.xml index ff48eb1aad..072df519c6 100644 --- a/doc/classes/PackedInt64Array.xml +++ b/doc/classes/PackedInt64Array.xml @@ -130,17 +130,17 @@ Returns the array size. - - + + + + - Sorts the elements of the array in ascending order. - - - - + + + Sorts the elements of the array in ascending order. diff --git a/doc/classes/PackedStringArray.xml b/doc/classes/PackedStringArray.xml index 4204277ea2..0bded150a3 100644 --- a/doc/classes/PackedStringArray.xml +++ b/doc/classes/PackedStringArray.xml @@ -130,17 +130,17 @@ Returns the size of the array. - - + + + + - Sorts the elements of the array in ascending order. - - - - + + + Sorts the elements of the array in ascending order. diff --git a/doc/classes/PackedVector2Array.xml b/doc/classes/PackedVector2Array.xml index e6a7b2fa41..8e993c41ab 100644 --- a/doc/classes/PackedVector2Array.xml +++ b/doc/classes/PackedVector2Array.xml @@ -130,17 +130,17 @@ Returns the size of the array. - - + + + + - Sorts the elements of the array in ascending order. - - - - + + + Sorts the elements of the array in ascending order. diff --git a/doc/classes/PackedVector3Array.xml b/doc/classes/PackedVector3Array.xml index 6992bbca01..df69e3cd4a 100644 --- a/doc/classes/PackedVector3Array.xml +++ b/doc/classes/PackedVector3Array.xml @@ -129,17 +129,17 @@ Returns the size of the array. - - + + + + - Sorts the elements of the array in ascending order. - - - - + + + Sorts the elements of the array in ascending order. -- cgit v1.2.3