Sara/behaviour-tree-test
1
0
Fork 0
Code Issues Pull requests Projects Releases 2 Packages Wiki Activity Actions

Merge pull request #11919 from Toizi/array_sort_ref

Browse source 
Array::sort/invert now return reference to Array
This commit is contained in:
Andreas Haas 2017-10-10 20:31:48 +02:00 • committed by GitHub
commit 1d8a546a07
3 changed files with 19 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

12
doc/classes/Array.xml
View file

@ -178,8 +178,10 @@
</description>
</method>
<method name="invert">
<return type="Array">
</return>
<description>
Reverse the order of the elements in the array (so first element will now be the last).
Reverse the order of the elements in the array (so first element will now be the last) and return reference to the array.
</description>
</method>
<method name="pop_back">
@ -239,17 +241,21 @@
</description>
</method>
<method name="sort">
<return type="Array">
</return>
<description>
Sort the array using natural order.
Sort the array using natural order and return reference to the array.
</description>
</method>
<method name="sort_custom">
<return type="Array">
</return>
<argument index="0" name="obj" type="Object">
</argument>
<argument index="1" name="func" type="String">
</argument>
<description>
Sort 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 true if the first argument is less than the second, and return false otherwise. Note: you cannot randomize the return value as the heapsort algorithm expects a deterministic result. Doing so will result in unexpected behavior.
Sort the array using a custom method and return reference to the array. 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 true if the first argument is less than the second, and return false otherwise. Note: you cannot randomize the return value as the heapsort algorithm expects a deterministic result. Doing so will result in unexpected behavior.
</description>
</method>
</methods>