-
-
Notifications
You must be signed in to change notification settings - Fork 30
/
QueueCommand.java
151 lines (128 loc) · 5.2 KB
/
QueueCommand.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
package net.aufdemrand.denizencore.scripts.commands.core;
import net.aufdemrand.denizencore.exceptions.InvalidArgumentsException;
import net.aufdemrand.denizencore.objects.Duration;
import net.aufdemrand.denizencore.objects.aH;
import net.aufdemrand.denizencore.scripts.ScriptEntry;
import net.aufdemrand.denizencore.scripts.commands.AbstractCommand;
import net.aufdemrand.denizencore.scripts.queues.ScriptQueue;
import net.aufdemrand.denizencore.scripts.queues.core.Delayable;
import net.aufdemrand.denizencore.utilities.debugging.dB;
public class QueueCommand extends AbstractCommand {
// <--[command]
// @Name Queue
// @Syntax queue (<queue>) [clear/stop/pause/resume/delay:<#>]
// @Required 1
// @Short Modifies the current state of a script queue.
// @Group core
//
// @Description
// Allows queues to be modified during their run. It can also be used to modify other queues currently running
// Clearing a queue will remove it and not run any of the next commands in the queue.
// It is possible to pause a queue but it will try to finish its last command that was executed.
// TODO: Document Command Details
//
// @Tags
// <queue>
// <queue.id>
// <queue.size>
// <queue.list>
// <queue.stats>
// <queue.exists[queue_id]>
// <s@script.list_queues>
//
// @Usage
// Use to clear the current queue.
// - queue clear
//
// @Usage
// Use to force-stop a given queue.
// - queue <server.flag[OtherQueue]> clear
//
// @Usage
// Use to delay the current queue (use <@link command wait> instead!)
// - queue delay:5t
//
// @Usage
// Use to pause the given queue.
// - queue <server.flag[OtherQueue]> pause
//
// @Usage
// Use to resume the given queue.
// - queue <server.flag[OtherQueue]> resume
// -->
private enum Action {CLEAR, DELAY, PAUSE, RESUME, STOP}
@Override
public void parseArgs(ScriptEntry scriptEntry) throws InvalidArgumentsException {
for (aH.Argument arg : aH.interpretArguments(scriptEntry.aHArgs)) {
if (!scriptEntry.hasObject("action")
&& arg.matchesEnum(Action.values())) {
scriptEntry.addObject("action", Action.valueOf(arg.getValue().toUpperCase()));
if (scriptEntry.getObject("action") == Action.DELAY
&& arg.matchesArgumentType(Duration.class)) {
scriptEntry.addObject("delay", arg.asType(Duration.class));
}
}
// No prefix required to specify the queue
else if ((arg.matchesArgumentType(ScriptQueue.class)
|| arg.matchesPrefix("queue"))
&& !scriptEntry.hasObject("queue")) {
scriptEntry.addObject("queue", arg.asType(ScriptQueue.class));
}
// ...but we also need to error out this command if the queue was not found.
else {
throw new InvalidArgumentsException("The specified queue could not be found: " + arg.raw_value);
}
}
// If no queues have been added, assume 'residing queue'
scriptEntry.defaultObject("queue", scriptEntry.getResidingQueue());
// Check required args
if (!scriptEntry.hasObject("action")) {
throw new InvalidArgumentsException("Must specify an action. Valid: CLEAR, DELAY, PAUSE, RESUME");
}
if (scriptEntry.getObject("action") == Action.DELAY && !scriptEntry.hasObject("delay")) {
throw new InvalidArgumentsException("Must specify a delay.");
}
}
@Override
public void execute(ScriptEntry scriptEntry) {
ScriptQueue queue = (ScriptQueue) scriptEntry.getObject("queue");
Action action = (Action) scriptEntry.getObject("action");
Duration delay = (Duration) scriptEntry.getObject("delay");
// Debugger
if (scriptEntry.dbCallShouldDebug()) {
dB.report(scriptEntry, getName(), queue.debug()
+ aH.debugObj("Action", action.toString())
+ (action == Action.DELAY ? delay.debug() : ""));
}
switch (action) {
case CLEAR:
queue.clear();
return;
case STOP:
queue.clear();
queue.stop();
return;
case PAUSE:
if (queue instanceof Delayable) {
((Delayable) queue).setPaused(true);
}
else {
queue.forceToTimed(new Duration(1L)).setPaused(true);
}
return;
case RESUME:
if (queue instanceof Delayable) {
((Delayable) queue).setPaused(false);
}
return;
case DELAY:
if (queue instanceof Delayable) {
((Delayable) queue).delayFor(delay);
}
else {
queue.forceToTimed(delay);
}
return;
}
}
}