diff options
| author | AnnieRuru <jeankof@ymail.com> | 2018-06-16 18:27:42 +0800 |
|---|---|---|
| committer | AnnieRuru <jeankof@ymail.com> | 2018-06-16 18:27:42 +0800 |
| commit | 04db00cb3153b0d9b845430c8328f61d0bf25375 (patch) | |
| tree | a80b6be6179664ead14051f78073093bb60f983d | |
| parent | d2c0e453fc95b3f8ce9270e8290d15687e6e3235 (diff) | |
| download | hercules-04db00cb3153b0d9b845430c8328f61d0bf25375.tar.gz hercules-04db00cb3153b0d9b845430c8328f61d0bf25375.tar.bz2 hercules-04db00cb3153b0d9b845430c8328f61d0bf25375.tar.xz hercules-04db00cb3153b0d9b845430c8328f61d0bf25375.zip | |
Fix *queueopt documentation
| -rw-r--r-- | doc/script_commands.txt | 8 | ||||
| -rw-r--r-- | src/map/script.c | 6 |
2 files changed, 7 insertions, 7 deletions
diff --git a/doc/script_commands.txt b/doc/script_commands.txt index 36c4da35a..01fd47401 100644 --- a/doc/script_commands.txt +++ b/doc/script_commands.txt @@ -9734,11 +9734,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. diff --git a/src/map/script.c b/src/map/script.c index 88d8095e5..3e493748d 100644 --- a/src/map/script.c +++ b/src/map/script.c @@ -22731,7 +22731,7 @@ BUILDIN(queueremove) /** * Script command queueopt: Modifies the options of a queue. * - * When the option value isn't provided, the option is removed. + * When the <event label> isn't provided, the option is removed. * * Returns 1 (true) on success, 0 (false) on failure. * @@ -22741,10 +22741,10 @@ BUILDIN(queueremove) * - QUEUEOPT_MAPCHANGE * * When the QUEUEOPT_MAPCHANGE event is triggered, it sets a temporary - * character variable \c @Queue_Destination_Map$ with the destination map name. + * character variable @Queue_Destination_Map$ with the destination map name. * * @code{.herc} - * queueopt(.@queue_id, optionType, <optional val>); + * queueopt(.@queue_id, optionType{, <event label>}); * @endcode */ BUILDIN(queueopt) |