From ea5e231959365622607c8bfd953f6d96ec54a394 Mon Sep 17 00:00:00 2001
From: HybridDog <3192173+HybridDog@users.noreply.github.com>
Date: Sat, 1 Feb 2020 16:09:45 +0100
Subject: Add table.shuffle (#8299)

---
 doc/lua_api.txt | 7 +++++++
 1 file changed, 7 insertions(+)

(limited to 'doc/lua_api.txt')

diff --git a/doc/lua_api.txt b/doc/lua_api.txt
index 80b694ee9..6b8dcb5fc 100644
--- a/doc/lua_api.txt
+++ b/doc/lua_api.txt
@@ -2925,6 +2925,13 @@ Helper functions
       find new indices.
 * `table.key_value_swap(t)`: returns a table with keys and values swapped
     * If multiple keys in `t` map to the same value, the result is undefined.
+* `table.shuffle(table, [from], [to], [random_func])`:
+    * Shuffles elements `from` to `to` in `table` in place
+    * `from` defaults to `1`
+    * `to` defaults to `#table`
+    * `random_func` defaults to `math.random`. This function receives two
+      integers as arguments and should return a random integer inclusively
+      between them.
 * `minetest.pointed_thing_to_face_pos(placer, pointed_thing)`: returns a
   position.
     * returns the exact position on the surface of a pointed node
-- 
cgit v1.2.3