diff options
| author | Rémi Verschelde <remi@verschelde.fr> | 2021-06-03 21:53:15 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-06-03 21:53:15 +0200 |
| commit | 4e4f96f9896eef06afb5b22ae6019bd85d24a354 (patch) | |
| tree | 9656a6b3afa0c180d736432b321ea87057e5121c /doc/classes | |
| parent | a9c6d2a96c484d704391395b73dd6a12c8447635 (diff) | |
| parent | 48f0368ddc19c16387f190ef8339de69b70d11ae (diff) | |
Merge pull request #49283 from KoBeWi/a&b
Improve sort_custom() description
Diffstat (limited to 'doc/classes')
| -rw-r--r-- | doc/classes/Array.xml | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/doc/classes/Array.xml b/doc/classes/Array.xml index 879b61a880..49775fa28b 100644 --- a/doc/classes/Array.xml +++ b/doc/classes/Array.xml @@ -615,7 +615,7 @@ <argument index="0" name="func" type="Callable"> </argument> <description> - 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]. + 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]. For two elements [code]a[/code] and [code]b[/code], if the given method returns [code]true[/code], element [code]b[/code] will be after element [code]a[/code] in the array. [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] |