/
RunCommand.java
277 lines (237 loc) · 11.9 KB
/
RunCommand.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
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
package net.aufdemrand.denizen.scripts.commands.core;
import net.aufdemrand.denizen.BukkitScriptEntryData;
import net.aufdemrand.denizen.objects.dNPC;
import net.aufdemrand.denizen.objects.dPlayer;
import net.aufdemrand.denizen.utilities.debugging.dB;
import net.aufdemrand.denizencore.exceptions.CommandExecutionException;
import net.aufdemrand.denizencore.exceptions.InvalidArgumentsException;
import net.aufdemrand.denizencore.objects.*;
import net.aufdemrand.denizencore.scripts.ScriptBuilder;
import net.aufdemrand.denizencore.scripts.ScriptEntry;
import net.aufdemrand.denizencore.scripts.commands.AbstractCommand;
import net.aufdemrand.denizencore.scripts.commands.Holdable;
import net.aufdemrand.denizencore.scripts.commands.core.DetermineCommand;
import net.aufdemrand.denizencore.scripts.queues.ScriptQueue;
import net.aufdemrand.denizencore.scripts.queues.core.InstantQueue;
import net.aufdemrand.denizencore.scripts.queues.core.TimedQueue;
import java.util.List;
/**
* Runs a task script in a new ScriptQueue.
* This replaces the now-deprecated runtask command with queue argument.
*
* @author Jeremy Schroeder
*/
public class RunCommand extends AbstractCommand implements Holdable {
// <--[example]
// @Title Using Local Scripts tutorial
// @Description
// Use local scripts as a way to avoid making unnecessary script containers
// or to group together utility task scripts.
//
// @Code
// # +--------------------
// # | Using Local Scripts tutorial
// # |
// # | Since Script Containers are stored inside Denizen on a global level,
// # | the problem of duplicate container names can become a problem.
// # |
// # | Using local scripts can be a good way to avoid situations by cutting
// # | down on the amount of total script containers needed by allowing task utility
// # | scripts to be included in other containers, or grouped together in a single
// # | container.
//
// Local Script Tutorial:
// type: task
//
// # As you probably already know, to run a 'base script' inside a task script
// # the 'run' or 'inject' commands can be used. This requires the name of the
// # script container as an argument in the commands. For example, type
// # /ex run 's@Local Script Tutorial' .. to run the script
// # below.
//
// script:
// - narrate "This is the 'base script' of this task script container."
// - narrate "The current time is <util.date.time>!"
//
//
// # Local Script support by Denizen allows you to stash more scripts. Just specify
// # a new node. To run this script from other containers, specify the script as well as
// # the local script name node with a 'p' or 'path:' prefix. For example, to run the
// # script below, type /ex run 's@Local Script Tutorial' 'p:subscript_1'
//
// subscript_1:
// - narrate "This is a 'local script' in the task script container 'LocalScript Tutorial'."
//
// # But wait, there's more! If wanting to run a local script that is within the
// # same container, the run command can be even simpler by specifying 'local'
// # in place of the script name. Take a look at the next two local scripts. Type
// # /ex run 's@Local Script Tutorial' 'p:subscript_2' .. to run the script below
// # which will in turn run 'subscript_3' locally. Notice if you specify locally,
// # the script used is
//
// subscript_2:
// - narrate "This is the second 'local script' in this task script container."
// - narrate "This script will now run 'subscript_3'."
// - run locally 'subscript_3'
//
// subscript_3:
// - narrate "Done. This has been a message from subscript_3!"
//
//
// # There you have it! Three separate scripts inside a single task script container!
// # Both the 'run' command and 'inject' command support local scripts.
//
// -->
@Override
public void parseArgs(ScriptEntry scriptEntry) throws InvalidArgumentsException {
for (aH.Argument arg : aH.interpret(scriptEntry.getArguments())) {
if (arg.matchesPrefix("i", "id")) {
scriptEntry.addObject("id", arg.asElement());
}
else if (arg.matchesPrefix("a", "as")
&& arg.matchesArgumentType(dPlayer.class)) {
((BukkitScriptEntryData) scriptEntry.entryData).setPlayer(arg.asType(dPlayer.class));
dB.echoError(scriptEntry.getResidingQueue(), "Run as:<player> is outdated, use player:<player>");
}
else if (arg.matchesPrefix("a", "as")
&& arg.matchesArgumentType(dNPC.class)) {
((BukkitScriptEntryData) scriptEntry.entryData).setNPC(arg.asType(dNPC.class));
dB.echoError(scriptEntry.getResidingQueue(), "Run as:<npc> is outdated, use npc:<npc>");
}
// Catch invalid entry for 'as' argument
else if (arg.matchesPrefix("a", "as")) {
dB.echoError(scriptEntry.getResidingQueue(), "Specified target was not attached. Value must contain a valid PLAYER or NPC object.");
}
else if (arg.matchesPrefix("d", "def", "define", "c", "context")) {
scriptEntry.addObject("definitions", arg.asType(dList.class));
}
else if (arg.matches("instant", "instantly")) {
scriptEntry.addObject("instant", new Element(true));
}
else if (arg.matchesPrefix("delay")
&& arg.matchesArgumentType(Duration.class)) {
scriptEntry.addObject("delay", arg.asType(Duration.class));
}
else if (arg.matches("local", "locally")) {
scriptEntry.addObject("local", new Element("true"));
scriptEntry.addObject("script", scriptEntry.getScript());
}
else if (!scriptEntry.hasObject("script")
&& arg.matchesArgumentType(dScript.class)
&& !arg.matchesPrefix("p", "path")) {
scriptEntry.addObject("script", arg.asType(dScript.class));
}
else if (!scriptEntry.hasObject("speed") && arg.matchesPrefix("speed")
&& arg.matchesArgumentType(Duration.class)) {
scriptEntry.addObject("speed", arg.asType(Duration.class));
}
else if (!scriptEntry.hasObject("path")) {
scriptEntry.addObject("path", arg.asElement());
}
else {
arg.reportUnhandled();
}
}
if (!scriptEntry.hasObject("script") && !scriptEntry.hasObject("local")) {
throw new InvalidArgumentsException("Must define a SCRIPT to be run.");
}
if (!scriptEntry.hasObject("path") && scriptEntry.hasObject("local")) {
throw new InvalidArgumentsException("Must specify a PATH.");
}
}
@Override
public void execute(ScriptEntry scriptEntry) throws CommandExecutionException {
dB.report(scriptEntry, getName(),
(scriptEntry.hasObject("script") ? scriptEntry.getdObject("script").debug() : scriptEntry.getScript().debug())
+ (scriptEntry.hasObject("instant") ? scriptEntry.getdObject("instant").debug() : "")
+ (scriptEntry.hasObject("path") ? scriptEntry.getElement("path").debug() : "")
+ (scriptEntry.hasObject("local") ? scriptEntry.getElement("local").debug() : "")
+ (scriptEntry.hasObject("delay") ? scriptEntry.getdObject("delay").debug() : "")
+ (scriptEntry.hasObject("id") ? scriptEntry.getdObject("id").debug() : "")
+ (scriptEntry.hasObject("definitions") ? scriptEntry.getdObject("definitions").debug() : "")
+ (scriptEntry.hasObject("speed") ? scriptEntry.getdObject("speed").debug() : ""));
// Get the script
dScript script = scriptEntry.getdObject("script");
// Get the entries
List<ScriptEntry> entries;
// If it's local
if (scriptEntry.hasObject("local")) {
entries = scriptEntry.getScript().getContainer().getEntries(scriptEntry.entryData.clone(),
scriptEntry.getElement("path").asString());
script = scriptEntry.getScript();
}
// If it has a path
else if (scriptEntry.hasObject("path") && scriptEntry.getObject("path") != null) {
entries = script.getContainer().getEntries(scriptEntry.entryData.clone(),
scriptEntry.getElement("path").asString());
}
// Else, assume standard path
else {
entries = script.getContainer().getBaseEntries(scriptEntry.entryData.clone());
}
// Get the 'id' if specified
String id = (scriptEntry.hasObject("id") ?
(scriptEntry.getElement("id")).asString() : ScriptQueue.getNextId(script.getContainer().getName()));
// Build the queue
ScriptQueue queue;
if (scriptEntry.hasObject("instant")) {
queue = InstantQueue.getQueue(id).addEntries(entries);
}
else {
queue = TimedQueue.getQueue(id).addEntries(entries);
if (scriptEntry.hasObject("speed")) {
Duration speed = scriptEntry.getdObject("speed");
((TimedQueue) queue).setSpeed(speed.getTicks());
}
else {
// Check speed of the script if a TimedQueue -- if identified, use the speed from the script.
if (script != null && script.getContainer().contains("SPEED")) {
((TimedQueue) queue).setSpeed(Duration.valueOf(script.getContainer().getString("SPEED", "0")).getTicks());
}
}
}
// Set any delay
if (scriptEntry.hasObject("delay")) {
queue.delayUntil(System.currentTimeMillis() + ((Duration) scriptEntry.getObject("delay")).getMillis());
}
// Set any definitions
if (scriptEntry.hasObject("definitions")) {
int x = 1;
dList definitions = (dList) scriptEntry.getObject("definitions");
String[] definition_names = null;
try {
definition_names = script.getContainer().getString("definitions").split("\\|");
}
catch (Exception e) {
// TODO: less lazy handling
}
for (String definition : definitions) {
String name = definition_names != null && definition_names.length >= x ?
definition_names[x - 1].trim() : String.valueOf(x);
queue.addDefinition(name, definition);
dB.echoDebug(scriptEntry, "Adding definition %" + name + "% as " + definition);
x++;
}
}
// Setup a callback if the queue is being waited on
if (scriptEntry.shouldWaitFor()) {
// Record the ScriptEntry
final ScriptEntry se = scriptEntry;
queue.callBack(new Runnable() {
@Override
public void run() {
se.setFinished(true);
}
});
}
// Allow determinations because why not
long reqId = DetermineCommand.getNewId();
queue.setReqId(reqId);
// Also add the reqId to each of the entries for reasons
ScriptBuilder.addObjectToEntries(entries, "ReqId", reqId);
// Save the queue for script referencing
scriptEntry.addObject("created_queue", queue);
// OK, GO!
queue.start();
}
}