classes/class_array

[giscus[bot]]

classes/class_array

A built-in data structure that holds a sequence of elements. Description: An array data structure that can contain a sequence of elements of any Variant type. Elements are accessed by a numerical i...

https://docs.godotengine.org/en/stable/classes/class_array.html

[whogben]

The documentation example of sort_custom's behavior is inaccurate - it reads (in part):

# Sort descending, using a lambda function.
my_items.sort_custom(func(a, b): return a[0] > b[0])
print(my_items) # Prints [["Apple", 9], ["Tomato", 5], ["Rice", 4]]

It should instead read:

# Sort descending, using a lambda function.
my_items.sort_custom(func(a, b): return a[0] > b[0])
print(my_items) # Prints [["Tomato", 5], ["Rice", 4], ["Apple", 9]]

Tested on Godot 4.3

[Calinou]

I can't reproduce this. Here, I get the following on 4.3.stable when I copy-paste the code sample and run it:

# Sort ascending
[["Rice", 4], ["Tomato", 5], ["Apple", 9]]

# Sort descending
[["Apple", 9], ["Tomato", 5], ["Rice", 4]]

[timothyqiu]

The indices used in the lambda are different.

It has been fixed in godotengine/godot#96118

[GersonFeDutra]

The example in the slice method's description is inaccurate, on reverse slicing:

var letters = ["A", "B", "C", "D", "E", "F"]

print(letters.slice(2, -2)) # Prints ["C", "D"]
print(letters.slice(4, 1, -1)) # Prints ["E", "D", "C"]

Correct output:

print(letters.slice(2, -2)) # Prints ["C", "D", "E"]
print(letters.slice(4, 1, -1)) # Prints ["E", "D", "C", "B"]

It's actually inclusive with the negative step.

[timothyqiu]

You are probably using the wrong version. It's inclusive in 3.x, but exclusive in 4.x.

[GersonFeDutra]

You are right indeed. I was testing on gdscript online and didn't saw the version.

I was trying to get a full reverse slice with:

print(letters.slice(4, -1, -1)) # Prints []

and

print(letters.slice(4, 0, -1)) # Prints ["E", "D", "C", "B"]

Given that -1 its a count from end, I was able to get the full reverse array with the ackward:

var index: int = 4
print(letters.slice(index - letters.size(), -(letters.size() + 1), -1)) # Prints ["E", "D", "C", "B", "A"]

[akumagamo]

Just stumbled upon this, the docs for the sort_custom are incorrect, it states "The function should return true if the first element should be moved before the second one, otherwise it should return false." and in the editor help it says"...behind...", what produces the correct result.

[RedpingDev]

In the Godot 4 game engine documentation, the description for the array append function has a mistake in the variable name. It should be "numbers" but it is incorrectly written as "nums."

var numbers = [1, 2, 3]
var extra = [4, 5, 6]
numbers.append_array(extra)
print(nums) # Prints [1, 2, 3, 4, 5, 6]

[Calinou]

This was fixed in godotengine/godot#96033, but it's not part of the stable class reference yet. You should see it being fixed on /latest already.

[BaconEggsRL]

Note: Arrays marked const in GDScript will give a constant pointer to the given array, rather than making the array itself a constant.

Immutable arrays are apparently not a thing.

https://godotforums.org/d/23252-array-typed-as-const-is-not-constant

[PeraBajaDev]

Use make_read_only() for inmuttable arrays

[DevSavvySerge]

About sort_custom (https://docs.godotengine.org/en/stable/classes/class_array.html#class-array-method-sort-custom) how are we supposed to deal when "a" & "b" share the same priority (for instance, when a & b are equals)?

[timothyqiu]

otherwise it should return false