Name | Queue |
Syntax | queue (<queue>) [clear/stop/pause/resume/delay:<duration>] |
Short Description | Modifies the current state of a script queue. |
Full Description | Allows queues to be modified during their run. This can also be used to modify other queues currently running.
Clearing a queue will remove any commands still queued within it, and thus end the queue. When trying to clear the current queue, use stop instead. Using the "stop" argument will force the queue to immediately stop running. When trying to stop the current queue, use stop instead. Using the "delay:<duration>" argument will cause the queue to wait for a specified duration. When trying to delay the current queue, use wait instead. Using the "pause" argument will freeze the queue but keep it listed, waiting for a "resume" instruction. It is of course not possible to resume the current queue (as if you're running a 'queue' command, the queue can't be paused). Generally, the queue is considered a non-ideal way of doing things - that is, there's usually a better/cleaner way to achieve similar results. It's most useful within the "/ex" command for quick problem solving (eg if a script in testing gets caught in an infinite loop, you can do "/ex queue ID_HERE stop" to fix that). |
Related Tags | <queue> Returns a queue object constructed from the input value. (...)
<QueueTag.id> Returns the full textual id of the queue.
<QueueTag.size> Returns the number of script entries in the queue.
<util.queues> Returns a list of all currently running queues on the server.
<ScriptTag.queues> Returns all queues which are running for this script.
|
Usage Example |
|
Usage Example |
|
Usage Example |
|
Usage Example |
|
Group | queue |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/scripts/commands/queue/QueueCommand.java#L22 |