Implement Function: Array.pick_random()

[nonunknown]

Implements: godotengine/godot-proposals#3454

This is partially implemented, since some users suggested adding for another classes, but I think each class should have their own PR, what you guys think?

IMPORTANT:
First merge #54940 before this one, to avoid #54939

test code:

var arr:Array = []

func _ready() -> void:
	arr.append_array(["test",1,2,3])
	print(arr)
	for i in range(10):
		print("Result: ", arr.pick_random())

output:

First Run:

[test, 1, 2, 3]
Result: 2
Result: 1
Result: 3
Result: 1
Result: 3
Result: 3
Result: 2
Result: 1
Result: 1
Result: 1

Second Run:

[test, 1, 2, 3]
Result: 1
Result: test
Result: 2
Result: 2
Result: 1
Result: 1
Result: 2
Result: 3
Result: 3
Result: 2

[sairam4123]

Would be interested in adding in probabilities too?
Like this?
[1, 0, 2, 3].pick_random([0.25, 0.25, 0.25, 0.25])
It's your choice to to decide whether the sum of all probabilities must be 1. It's how it works in Python.

[nonunknown]

Would be interested in adding in probabilities too? Like this? [1, 0, 2, 3].pick_random([0.25, 0.25, 0.25, 0.25]) It's your choice to to decide whether the sum of all probabilities must be 1. It's how it works in Python.

please create a proposal for that, every implementation depends on the users needs.

[Xrayez]

Would be interested in adding in probabilities too?

Recent proposal: godotengine/godot-proposals#3948

I do think having both methods is fine and even needed, though. Random.choice() exists in Goost btw, but if choices() is implemented as well, I've been thinking that choice() could be renamed to pick() (as seen in this PR):

• API renames for Goost 2.0 goostengine/goost#176 (comment)

[akien-mga]

Approved in proposals review meeting.

[akien-mga]

You need to update the class reference with --doctool and write documentation for the new method: https://docs.godotengine.org/en/latest/community/contributing/updating_the_class_reference.html

Apparently there's also a style issue but not sure which, you should likely run clang-format.

[mhilbrunner]

Seems this includes a lot of other commits :) Needs a proper rebase.

[akien-mga]

@nonunknown has been struggling with rebasing on this one. Maybe a contributor can help salvage this?

Closing for now as this is likely best redone from a clean master checkout.