summaryrefslogtreecommitdiff
path: root/doc/script_commands.txt
diff options
context:
space:
mode:
authorHaru <haru@dotalux.com>2018-07-01 18:48:05 +0200
committerGitHub <noreply@github.com>2018-07-01 18:48:05 +0200
commit7b3a4baad373cb90722cd02b60dd0f2e699dacac (patch)
tree98097a5fb90225e1bde8787cb1416c286ae842e0 /doc/script_commands.txt
parenta9b22af50cb5af61486adb810a6724fb3d9f02ee (diff)
parent04db00cb3153b0d9b845430c8328f61d0bf25375 (diff)
downloadhercules-7b3a4baad373cb90722cd02b60dd0f2e699dacac.tar.gz
hercules-7b3a4baad373cb90722cd02b60dd0f2e699dacac.tar.bz2
hercules-7b3a4baad373cb90722cd02b60dd0f2e699dacac.tar.xz
hercules-7b3a4baad373cb90722cd02b60dd0f2e699dacac.zip
Merge pull request #2086 from AnnieRuru/42-queueopt
Fix *queueopt documentation
Diffstat (limited to 'doc/script_commands.txt')
-rw-r--r--doc/script_commands.txt8
1 files changed, 4 insertions, 4 deletions
diff --git a/doc/script_commands.txt b/doc/script_commands.txt
index 53d24de4d..2653f052a 100644
--- a/doc/script_commands.txt
+++ b/doc/script_commands.txt
@@ -9789,11 +9789,11 @@ true otherwise.
---------------------------------------
-*queueopt(<queue_id>, <optionType>, {Optional <option val>})
+*queueopt(<queue_id>, <optionType>{, <event label})
-Modifies <queue_id>'s <optionType>. When <option val> is not present
-<optionType> is removed from <queue_id>. When present it modifies
-<queue_id>'s <optionType> with the new <option val> value.
+Modifies <queue_id>'s <optionType>. When <event label> is not present
+<optionType> is removed from <queue_id>. When present it will execute the
+<event label> when the <queue_id>'s <optionType> condition is met.
Returns true on success, false on failure.