summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorgumi <mekolat@users.noreply.github.com>2017-05-31 12:15:47 -0400
committergumi <mekolat@users.noreply.github.com>2017-06-01 12:28:04 -0400
commit7e521f026429f0ccfa9c95197c26453e7caef72b (patch)
tree9185be03f777a5f69140ba71148a8df44bb84e2e
parent0f18b10b7702d53e8dac866ffafb31097dbea5cc (diff)
downloadhercules-7e521f026429f0ccfa9c95197c26453e7caef72b.tar.gz
hercules-7e521f026429f0ccfa9c95197c26453e7caef72b.tar.bz2
hercules-7e521f026429f0ccfa9c95197c26453e7caef72b.tar.xz
hercules-7e521f026429f0ccfa9c95197c26453e7caef72b.zip
add documentation for getarrayindex()
-rw-r--r--doc/script_commands.txt11
1 files changed, 11 insertions, 0 deletions
diff --git a/doc/script_commands.txt b/doc/script_commands.txt
index 923fad96b..49db95153 100644
--- a/doc/script_commands.txt
+++ b/doc/script_commands.txt
@@ -2437,6 +2437,17 @@ If you do this:
---------------------------------------
+*getarrayindex(<array name>)
+
+This command returns the index of the passed array. This is useful when
+used in combination with getarg()
+
+Example:
+
+ getarrayindex(.@foo[42]) // 42
+
+---------------------------------------
+
*getelementofarray(<array name>, <index>)
This command retrieves the value of the element of given array at given