diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/script_commands.txt | 43 |
1 files changed, 28 insertions, 15 deletions
diff --git a/doc/script_commands.txt b/doc/script_commands.txt index 218bb4803..5219eed47 100644 --- a/doc/script_commands.txt +++ b/doc/script_commands.txt @@ -8964,17 +8964,21 @@ Returns the amount of entries in the queue instance of <queue_id>. --------------------------------------- -*queueadd(<queue_id>,<var_id>); +*queueadd(<queue_id>, <var_id>); -Adds <var_id> to queue of <queue_id>, returning 1 if <var_id> is already -present in the queue, otherwise returning 0. +Adds <var_id> to queue of <queue_id>. + +Returns false if <var_id> couldn't be added (was already present in the queue), +true otherwise. --------------------------------------- -*queueremove(<queue_id>,<var_id>); +*queueremove(<queue_id>, <var_id>); + +Removes <var_id> from queue of <queue_id>. -Removes <var_id> from queue of <queue_id>, returning 1 if <var_id> is not -present in the queue, otherwise returning 0. +Returns false if <var_id> couldn't be removed (wasn't present in the queue), +true otherwise. --------------------------------------- @@ -8984,20 +8988,26 @@ 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. +Returns true on success, false on failure. + Currently 3 options are available: -HQO_OnDeath (1), HQO_OnLogout (2), HQO_OnMapChange (3) +- QUEUEOPT_DEATH (1) +- QUEUEOPT_LOGOUT (2) +- QUEUEOPT_MAPCHANGE (3) -Note: The constant names are not final. +When the QUEUEOPT_MAPCHANGE event is triggered, it sets a temp char var +@Queue_Destination_Map$ with the destination map name. Example: - queueopt(.@queue_id,0,"MyNPC::MyOnQueueMemberDeathEventName"); + queueopt(.@queue_id, QUEUEOPT_DEATH, "MyNPC::MyOnQueueMemberDeathEventName"); --------------------------------------- *queuedel(<queue_id>); -Deletes <queue_id> and returns 1 when <queue_id> is not found, otherwise -0 is returned. +Deletes the queue <queue_id>. + +Returns false if the queue wasn't found, true otherwise. --------------------------------------- @@ -9011,8 +9021,10 @@ even if you remove them from the queue. --------------------------------------- *qicheck(<queue_iterator_id>); -checks whether there is a next member in the iterator's queue, 1 when -it does, 0 otherwise. + +Checks whether the current member in the iterator's queue exists. + +Returns 1 when it does, 0 otherwise. --------------------------------------- @@ -9030,8 +9042,9 @@ Example: *qiclear(<queue_iterator_id>); -Deletes a queue iterator from memory and returns 1 when it fails, -otherwise 0 is returned. +Deletes a queue iterator from memory. + +Returns false when it fails, otherwise 1 is returned. --------------------------------------- //===================================== |