diff options
| author | Max Hilbrunner <mhilbrunner@users.noreply.github.com> | 2022-10-21 16:25:52 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-10-21 16:25:52 +0200 |
| commit | 5cefc07d908be50ac88ede8bce5572b030815695 (patch) | |
| tree | 7141c95b9024f92d354c198dc54ce5c2e6000c88 | |
| parent | c4c35ab77a4090b0b8f813bce71fdf3053f65a05 (diff) | |
| parent | 9f4dbf415da6d150788915cb35a9c3dc7f04c547 (diff) | |
Merge pull request #67444 from nonunknown/array_pick_random
Add ability to pick random value from array
| -rw-r--r-- | core/variant/array.cpp | 6 | ||||
| -rw-r--r-- | core/variant/array.h | 1 | ||||
| -rw-r--r-- | core/variant/variant_call.cpp | 1 | ||||
| -rw-r--r-- | doc/classes/Array.xml | 10 |
4 files changed, 18 insertions, 0 deletions
diff --git a/core/variant/array.cpp b/core/variant/array.cpp index 8b958814db..c6bbd43dc4 100644 --- a/core/variant/array.cpp +++ b/core/variant/array.cpp @@ -31,6 +31,7 @@ #include "array.h" #include "container_type_validate.h" +#include "core/math/math_funcs.h" #include "core/object/class_db.h" #include "core/object/script_language.h" #include "core/templates/hashfuncs.h" @@ -299,6 +300,11 @@ Variant Array::back() const { return operator[](_p->array.size() - 1); } +Variant Array::pick_random() const { + ERR_FAIL_COND_V_MSG(_p->array.size() == 0, Variant(), "Can't take value from empty array."); + return operator[](Math::rand() % _p->array.size()); +} + int Array::find(const Variant &p_value, int p_from) const { ERR_FAIL_COND_V(!_p->typed.validate(p_value, "find"), -1); return _p->array.find(p_value, p_from); diff --git a/core/variant/array.h b/core/variant/array.h index 3d9a794969..ee265a9ffd 100644 --- a/core/variant/array.h +++ b/core/variant/array.h @@ -79,6 +79,7 @@ public: Variant front() const; Variant back() const; + Variant pick_random() const; void sort(); void sort_custom(const Callable &p_callable); diff --git a/core/variant/variant_call.cpp b/core/variant/variant_call.cpp index 900e3d8e77..ef4807ba71 100644 --- a/core/variant/variant_call.cpp +++ b/core/variant/variant_call.cpp @@ -2053,6 +2053,7 @@ static void _register_variant_builtin_methods() { bind_method(Array, erase, sarray("value"), varray()); bind_method(Array, front, sarray(), varray()); bind_method(Array, back, sarray(), varray()); + bind_method(Array, pick_random, sarray(), varray()); bind_method(Array, find, sarray("what", "from"), varray(0)); bind_method(Array, rfind, sarray("what", "from"), varray(-1)); bind_method(Array, find_last, sarray("value"), varray()); diff --git a/doc/classes/Array.xml b/doc/classes/Array.xml index a30117725f..0f76639caf 100644 --- a/doc/classes/Array.xml +++ b/doc/classes/Array.xml @@ -435,6 +435,16 @@ Returns the minimum value contained in the array if all elements are of comparable types. If the elements can't be compared, [code]null[/code] is returned. </description> </method> + <method name="pick_random" qualifiers="const"> + <return type="Variant" /> + <description> + Returns a random value from the target array. + [codeblock] + var array: Array[int] = [1, 2, 3, 4] + print(array.pick_random()) # Prints either of the four numbers. + [/codeblock] + </description> + </method> <method name="pop_at"> <return type="Variant" /> <param index="0" name="position" type="int" /> |