diff options
| author | kobewi <kobewi4e@gmail.com> | 2021-06-03 17:41:02 +0200 |
|---|---|---|
| committer | kobewi <kobewi4e@gmail.com> | 2021-06-03 17:43:39 +0200 |
| commit | 48f0368ddc19c16387f190ef8339de69b70d11ae (patch) | |
| tree | 464de990313323bdca4096f26417007e999caa64 | |
| parent | f288a79482ad5272d872fdc84fdb64a228334d8e (diff) | |
Improve sort_custom() description
| -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] |