/
RuntaskCommand.java
215 lines (183 loc) · 9.61 KB
/
RuntaskCommand.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
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
package net.aufdemrand.denizen.scripts.commands.core;
import java.util.HashMap;
import java.util.Map;
import net.aufdemrand.denizen.exceptions.CommandExecutionException;
import net.aufdemrand.denizen.exceptions.InvalidArgumentsException;
import net.aufdemrand.denizen.objects.dScript;
import net.aufdemrand.denizen.scripts.ScriptEntry;
import net.aufdemrand.denizen.scripts.ScriptQueue;
import net.aufdemrand.denizen.scripts.ScriptRegistry;
import net.aufdemrand.denizen.scripts.commands.AbstractCommand;
import net.aufdemrand.denizen.scripts.containers.core.TaskScriptContainer;
import net.aufdemrand.denizen.objects.Duration;
import net.aufdemrand.denizen.objects.aH;
import net.aufdemrand.denizen.utilities.debugging.dB;
import net.aufdemrand.denizen.utilities.debugging.dB.Messages;
/**
* Runs a task script.
*
* <b>dScript Usage:</b><br>
* <pre>RUNTASK (ID:id_name{script_name}) [SCRIPT:script_name] (INSTANT|QUEUE:QueueType{PLAYER_TASK})
* (DELAY:#{0}) </pre>
*
* <ol><tt>Arguments: [] - Required, () - Optional, {} - Default</ol></tt>
*
* <ol><tt>(ID:id_name{script_name})</tt><br>
* The unique ID of this task, useful if the possibility of a CANCELTASK command may be used.
* If not specified, the name of the script specified is used.</ol>
*
* <ol><tt>[SCRIPT:script_name]</tt><br>
* The name of the script that should be run.</ol>
*
* <ol><tt>(INSTANT|QUEUE:QueueType{PLAYER_TASK})</tt><br>
* Specifies how the script should be run. If using INSTANT, all commands in the script are
* run without being queued, resulting in an 'instant' execution of all commands (the initial DELAY
* will still be honored). If using a QUEUE, choose whether to use PLAYER_TASK or NPC queue-type.
* Default is PLAYER_TASK queue if not specified otherwise.</ol>
*
* <ol><tt>(DELAY:#{0})</tt><br>
* Specifying a delay will set the script to be run in the future. Uses the dScript time format,
* (ie. 30, 6m, 1h, etc). Delayed RUNTASKs can be cancelled with the CANCELTASK command when given
* the specified ID. Also note: Delayed Tasks WILL BE LOST on a server reboot, so delaying scripts
* for long periods of time may not be honored if your server reboots during the wait period.</ol>
*
* <br><b>Example Usage:</b><br>
* <ol><tt>
* - RUNTASK ID:<player.name>_spiders SCRIPT:Spawn_spiders INSTANT DELAY:60
* - RUNTASK SCRIPT:Drop_reward QUEUE:NPC
* - RUNTASK 'SCRIPT:Welcome to Chakkor'
* </ol></tt>
*
*
* @author Jeremy Schroeder
*
*/
public class RuntaskCommand extends AbstractCommand {
@Override
public void parseArgs(ScriptEntry scriptEntry) throws InvalidArgumentsException {
// Initialize necessary fields
Map<String, String> context = null;
Boolean instant = false;
dScript script = null;
Duration delay = null;
ScriptQueue queue = scriptEntry.getResidingQueue();
// Iterate through Arguments to extract needed information
for (String arg : scriptEntry.getArguments()) {
// Specify scriptContainer to use
if (aH.matchesScript(arg)) {
script = aH.getScriptFrom(arg);
} // Delay the start of the queue
else if (aH.matchesValueArg("DELAY", arg, aH.ArgumentType.Duration)) {
delay = aH.getDurationFrom(arg);
} // Use a specific queue
else if (aH.matchesQueue(arg)) {
queue = aH.getQueueFrom(arg);
} // TODO: Remove this argument for version 1.0
else if (aH.matchesValueArg("SPEED", arg, aH.ArgumentType.Duration)) {
dB.log("SPEED argument has been removed from RUNTASK! Instead, specify " +
"a speed on the task script itself, or use the 'QUEUE SET_SPEED:#' command " +
"inside the task script. This warning will be removed in version 1.0 " +
"and this argument deprecated.");
} // Gets a new, randomly named queue
else if (aH.matchesArg("QUEUE", arg)) {
queue = ScriptQueue._getQueue(ScriptQueue._getNextId());
instant = false;
} // Run the script instantly.
else if (aH.matchesArg("INSTANT, INSTANTLY", arg)) {
queue = ScriptQueue._getQueue(ScriptQueue._getNextId());
instant = true;
} // Build context map if specified
else if (aH.matchesContext(arg)) {
context = aH.getContextFrom(arg);
} // Specify a script name without the 'script:' prefix
else if (ScriptRegistry.containsScript(aH.getStringFrom(arg))) {
script = aH.getScriptFrom(arg);
if (!script.getType().equalsIgnoreCase("TASK"))
script = null;
} else throw new InvalidArgumentsException(Messages.ERROR_UNKNOWN_ARGUMENT, arg);
}
// Must specify at least a valid script to run...
if (script == null)
throw new InvalidArgumentsException("Must define a SCRIPT to be run.");
// If not queue, and delayed, throw an exception... this cannot happen.
if (queue == scriptEntry.getResidingQueue() && delay != null)
throw new InvalidArgumentsException("Cannot delay an INJECTED task script! Use 'QUEUE'.");
// Put important objects inside the scriptEntry to be sent to execute()
scriptEntry.addObject("instant", instant)
.addObject("queue", queue)
.addObject("delay", (delay != null ? delay.setPrefix("Delay") : null))
.addObject("script", script)
.addObject("context", context);
}
@SuppressWarnings("unchecked")
@Override
public void execute(ScriptEntry scriptEntry) throws CommandExecutionException {
Map<String, String> context = (HashMap<String, String>) scriptEntry.getObject("context");
dScript script = (dScript) scriptEntry.getObject("script");
ScriptQueue queue = (ScriptQueue) scriptEntry.getObject("queue");
Boolean instant = (Boolean) scriptEntry.getObject("instant");
Duration delay = (Duration) scriptEntry.getObject("delay");
// Debug output
dB.report(this.getName(),
script.debug()
+ (delay != null ? delay.debug() : "")
+ aH.debugObj("Instant", instant.toString())
+ aH.debugObj("Queue", queue.id)
+ (instant == false ? aH.debugObj("Speed", queue.getSpeed()) : "" )
+ (context != null ? aH.debugObj("Context", context.toString()) : "")
+ (scriptEntry.getPlayer() != null
? aH.debugObj("Player", scriptEntry.getPlayer().getName()) : "")
+ (scriptEntry.getNPC() != null
? aH.debugObj("NPC", scriptEntry.getNPC().toString()) : ""));
if (instant) {
// Instant, but no delay
if (delay == null)
if (scriptEntry.getResidingQueue() != queue)
// Instant, no delay, new queue
((TaskScriptContainer) script.getContainer()).setSpeed(Duration.valueOf("0"))
.runTaskScript(queue.id,
scriptEntry.getPlayer(),
scriptEntry.getNPC(),
context);
else
// Instant, no delay, injection into current queue
((TaskScriptContainer) script.getContainer()).setSpeed(Duration.valueOf("0"))
.injectTaskScript(queue.id,
scriptEntry.getPlayer(),
scriptEntry.getNPC(),
context);
else
// Instant, has delay, new queue
((TaskScriptContainer) script.getContainer()).setSpeed(Duration.valueOf("0"))
.runTaskScriptWithDelay(queue.id,
scriptEntry.getPlayer(),
scriptEntry.getNPC(),
context,
delay);
} else {
if (delay == null)
// Not instant, no delay, new queue
if (scriptEntry.getResidingQueue() != queue)
((TaskScriptContainer) script.getContainer())
.runTaskScript(queue.id,
scriptEntry.getPlayer(),
scriptEntry.getNPC(),
context);
else
// Not instant, no delay, injection into current queue
((TaskScriptContainer) script.getContainer())
.injectTaskScript(queue.id,
scriptEntry.getPlayer(),
scriptEntry.getNPC(),
context);
else
// Not instant, delayed, new queue
((TaskScriptContainer) script.getContainer())
.runTaskScriptWithDelay(queue.id,
scriptEntry.getPlayer(),
scriptEntry.getNPC(),
context,
delay);
}
}
}