diff options
Diffstat (limited to 'doc/classes/Array.xml')
| -rw-r--r-- | doc/classes/Array.xml | 58 |
1 files changed, 27 insertions, 31 deletions
diff --git a/doc/classes/Array.xml b/doc/classes/Array.xml index de3d89ee0f..54bbe7a94b 100644 --- a/doc/classes/Array.xml +++ b/doc/classes/Array.xml @@ -166,7 +166,7 @@ [/codeblock] </description> </method> - <method name="back"> + <method name="back" qualifiers="const"> <return type="Variant"> </return> <description> @@ -191,15 +191,13 @@ </return> <argument index="0" name="value" type="Variant"> </argument> - <argument index="1" name="obj" type="Object"> + <argument index="1" name="func" type="Callable"> </argument> - <argument index="2" name="func" type="StringName"> - </argument> - <argument index="3" name="before" type="bool" default="true"> + <argument index="2" name="before" type="bool" default="true"> </argument> <description> Finds the index of an existing value (or the insertion index that maintains sorting order, if the value is not yet present in the array) using binary search and a custom comparison method. Optionally, a [code]before[/code] specifier can be passed. If [code]false[/code], the returned index comes after all existing entries of the value in the array. The custom method receives two arguments (an element from the array and the value searched for) and must return [code]true[/code] if the first argument is less than the second, and return [code]false[/code] otherwise. - [b]Note:[/b] Calling [method bsearch] on an unsorted array results in unexpected behavior. + [b]Note:[/b] Calling [method bsearch_custom] on an unsorted array results in unexpected behavior. </description> </method> <method name="clear"> @@ -209,7 +207,7 @@ Clears the array. This is equivalent to using [method resize] with a size of [code]0[/code]. </description> </method> - <method name="count"> + <method name="count" qualifiers="const"> <return type="int"> </return> <argument index="0" name="value" type="Variant"> @@ -218,7 +216,7 @@ Returns the number of times an element is in the array. </description> </method> - <method name="duplicate"> + <method name="duplicate" qualifiers="const"> <return type="Array"> </return> <argument index="0" name="deep" type="bool" default="false"> @@ -239,7 +237,7 @@ [b]Note:[/b] On large arrays, this method will be slower if the removed element is close to the beginning of the array (index 0). This is because all elements placed after the removed element have to be reindexed. </description> </method> - <method name="find"> + <method name="find" qualifiers="const"> <return type="int"> </return> <argument index="0" name="what" type="Variant"> @@ -250,7 +248,7 @@ Searches the array for a value and returns its index or [code]-1[/code] if not found. Optionally, the initial search index can be passed. </description> </method> - <method name="find_last"> + <method name="find_last" qualifiers="const"> <return type="int"> </return> <argument index="0" name="value" type="Variant"> @@ -259,7 +257,7 @@ Searches the array in reverse order for a value and returns its index or [code]-1[/code] if not found. </description> </method> - <method name="front"> + <method name="front" qualifiers="const"> <return type="Variant"> </return> <description> @@ -267,7 +265,7 @@ [b]Note:[/b] Calling this function is not the same as writing [code]array[0][/code]. If the array is empty, accessing by index will pause project execution when running from the editor. </description> </method> - <method name="has"> + <method name="has" qualifiers="const"> <return type="bool"> </return> <argument index="0" name="value" type="Variant"> @@ -309,7 +307,7 @@ [/codeblocks] </description> </method> - <method name="hash"> + <method name="hash" qualifiers="const"> <return type="int"> </return> <description> @@ -330,28 +328,21 @@ [b]Note:[/b] On large arrays, this method will be slower if the inserted element is close to the beginning of the array (index 0). This is because all elements placed after the newly inserted element have to be reindexed. </description> </method> - <method name="invert"> - <return type="void"> - </return> - <description> - Reverses the order of the elements in the array. - </description> - </method> - <method name="is_empty"> + <method name="is_empty" qualifiers="const"> <return type="bool"> </return> <description> Returns [code]true[/code] if the array is empty. </description> </method> - <method name="max"> + <method name="max" qualifiers="const"> <return type="Variant"> </return> <description> Returns the maximum value contained in the array if all elements are of comparable types. If the elements can't be compared, [code]null[/code] is returned. </description> </method> - <method name="min"> + <method name="min" qualifiers="const"> <return type="Variant"> </return> <description> @@ -476,7 +467,14 @@ Resizes the array to contain a different number of elements. If the array size is smaller, elements are cleared, if bigger, new elements are [code]null[/code]. </description> </method> - <method name="rfind"> + <method name="reverse"> + <return type="void"> + </return> + <description> + Reverses the order of the elements in the array. + </description> + </method> + <method name="rfind" qualifiers="const"> <return type="int"> </return> <argument index="0" name="what" type="Variant"> @@ -494,14 +492,14 @@ Shuffles the array such that the items will have a random order. This method uses the global random number generator common to methods such as [method @GlobalScope.randi]. Call [method @GlobalScope.randomize] to ensure that a new seed will be used each time if you want non-reproducible shuffling. </description> </method> - <method name="size"> + <method name="size" qualifiers="const"> <return type="int"> </return> <description> Returns the number of elements in the array. </description> </method> - <method name="slice"> + <method name="slice" qualifiers="const"> <return type="Array"> </return> <argument index="0" name="begin" type="int"> @@ -537,12 +535,10 @@ <method name="sort_custom"> <return type="void"> </return> - <argument index="0" name="obj" type="Object"> - </argument> - <argument index="1" name="func" type="StringName"> + <argument index="0" name="func" type="Callable"> </argument> <description> - Sorts the array using a custom method. The arguments are an object that holds the method and the name of such method. The custom method receives two arguments (a pair of elements from the array) and must return either [code]true[/code] or [code]false[/code]. + Sorts the array using a custom method. The custom method receives two arguments (a pair of elements from the array) and must return either [code]true[/code] or [code]false[/code]. [b]Note:[/b] you cannot randomize the return value as the heapsort algorithm expects a deterministic result. Doing so will result in unexpected behavior. [codeblocks] [gdscript] @@ -553,7 +549,7 @@ return false var my_items = [[5, "Potato"], [9, "Rice"], [4, "Tomato"]] - my_items.sort_custom(MyCustomSorter, "sort_ascending") + my_items.sort_custom(MyCustomSorter.sort_ascending) print(my_items) # Prints [[4, Tomato], [5, Potato], [9, Rice]]. [/gdscript] [csharp] |