Custom Denizen Commands: Difference between revisions

From Citizens Wiki
Line 156: Line 156:


{{codebox|height=300px|Denizen Command Template|<syntaxhighlight line='true' lang="java">
{{codebox|height=300px|Denizen Command Template|<syntaxhighlight line='true' lang="java">
package your.name.project.package;
package net.aufdemrand.denizen.commands.core;
 
import java.util.logging.Level;


import org.bukkit.Location;
import org.bukkit.Location;


import net.aufdemrand.denizen.bookmarks.BookmarkHelper.BookmarkType;
import net.aufdemrand.denizen.commands.AbstractCommand;
import net.aufdemrand.denizen.commands.AbstractCommand;
import net.aufdemrand.denizen.scripts.ScriptEntry;
import net.aufdemrand.denizen.scripts.ScriptEntry;
Line 195: Line 192:
*/
*/


@SuppressWarnings("unused") // This should be removed in your code.
@SuppressWarnings("unused") // This should be removed from your code.
@Override
@Override
// This is the method that is called when your command is ready to be executed.
// This is the method that is called when your command is ready to be executed.
public boolean execute(ScriptEntry theEntry) throws CommandException {
public boolean execute(ScriptEntry theEntry) throws CommandException {
Line 210: Line 206:
/* Match arguments to expected variables */
/* Match arguments to expected variables */
if (theEntry.arguments() != null) {
if (theEntry.arguments() != null) {
for (String thisArgument : theEntry.arguments()) {
for (String thisArg : theEntry.arguments()) {
// Do this routine for each argument supplied.
// Do this routine for each argument supplied.
if (plugin.debugMode) plugin.getLogger().info("Processing command " + theEntry.getCommand() + " argument: " + thisArgument);
// Includes are some typical arguments. Modify/add code to handle your command needs.
// Includes are some typical arguments. Modify/add code to handle your command needs.
// If argument is a number.
// If argument is a number.
if (thisArgument.matches("((-|\\+)?[0-9]+(\\.[0-9]+)?)+")) {
if (aRegex.matchesInteger(thisArg)) {
 
// Insert code here.
// Insert code here.
echoDebug("...number argument set to '%s'.", thisArg);
}
}
// If argument is a valid bookmark, set location.
else if (aRegex.matchesScript(thisArg)) {
else if (plugin.bookmarks.exists(theEntry.getDenizen(), thisArgument)) {
// Insert code here.
if (plugin.debugMode) plugin.getLogger().log(Level.INFO, "...matched bookmark '" + thisArgument + "'.");
sampleBookmark = plugin.bookmarks.get(theEntry.getDenizen(), thisArgument, BookmarkType.LOCATION);
echoDebug("...affected script now set to '%s'.", thisArg);
} else if (thisArgument.split(":").length == 2) {
}
if (plugin.bookmarks.exists(thisArgument.split(":")[0], thisArgument.split(":")[1]))
if (plugin.debugMode) plugin.getLogger().log(Level.INFO, "...matched bookmark '" + thisArgument.split(":")[0] + "'.");
sampleBookmark = plugin.bookmarks.get(thisArgument.split(":")[0], thisArgument.split(":")[1], BookmarkType.LOCATION);
}
// If argument is a modifier.
else if (aRegex.matchesDuration(thisArg)) {
else if (thisArgument.toUpperCase().contains("MODIFIER:")) {
if (plugin.debugMode) plugin.getLogger().log(Level.INFO, "...matched modifier '" + thisArgument.split(":")[0].toUpperCase() + "'.");
 
// Insert code here.
// Insert code here.
echoDebug("...duration set to '%s'.", thisArg);
}
}
// If can't match to anything...
// If can't match to anything...
// This isn't always possible, depending on the arguments your command uses, but nice if you can.
// This isn't always possible, depending on the arguments your  
// command uses, but nice if you can. Keep the users informed!
else {
else {
if (plugin.debugMode) plugin.getLogger().log(Level.INFO, "...unable to match argument!");
echoDebug("...'%s' could not be matched!", thisArg);
}
}
Line 268: Line 256:
/* Error processing */
/* Error processing */
// Processing has gotten to here, there's probably not been enough arguments.
// If processing has gotten to here, there's probably not been enough arguments, or correct
// Let's alert the console.
// arguments have not been met. Let's alert the Command Executer.
if (plugin.debugMode) if (theEntry.arguments() == null)
throw new CommandException("...not enough arguments! Usage: SAMPLECOMMAND [TYPICAL] (ARGUMENTS)");
throw new CommandException("...not enough arguments! Usage: SAMPLECOMMAND [TYPICAL] (ARGUMENTS)");
return false;
}
}


Line 282: Line 267:
}}
}}
</div>
</div>


=== The ScriptEntry object ===
=== The ScriptEntry object ===

Revision as of 15:23, 12 August 2012

Custom Commands

Denizen is extensible! In addition to Triggers, Activities, and soon Requirement, an API is being provided to help you make custom Script Commands in your project! Have a neat idea for a command? Have a better way to STRIKE a player? (MEGASTRIKE command, anybody?)

Keep reading!

YourCommand extends AbstractCommand

The first thing you need is a custom command class that extends the Denizen AbstractCommand. This contains the method called when it's time for your command to be executed. This is called every-single-time a script contains your command.

Example Command

Sometimes the easiest way to work is to see an actual example. View a copy of the STRIKE command on Pastie.org for a very simple command, or check the code below. For more examples, you can always check Core Denizen Commands.


Code: STRIKE Denizen Command
[Location Bookmark]


Command Template

Below is a command template copy for a copy/paste of the skeleton of a custom denizen commmand.


Code: Denizen Command Template
{{{2}}}

The ScriptEntry object

When Denizen reads scripts, each line is turned into a SciptEntry object that contains the command, the arguments, and various other data and objects, as described below. Your command is an extension of this AbstractCommand class, and each time your command is called in for execution, it's this class that is executed and handled a ScriptEntry. How your Command uses the ScriptEntry information is of course, up to you.

The Denizen ScriptEngine and Executer construct and fill a ScriptEntry with information that can be used in your command. Below is a list of methods you can use against the scriptEntry sent to your commands execute method.

Template:DenizenCommand

arguments()
String[] value of the arguments used in the script
This is the output of Denizen's argBuilder method. It splits the command arguments up with spaces and quotes. For instance: arg1 arg2 'this is argument 3' "and that's argument 4" would return a string array with a size of 4. Note argument 4, which handles an argument using a single quote. Hint: Double quotes around the argument, and vice-versa.
sendingQueue()
QueueType of either QueueType.TRIGGER, QueueType.TASK, or QueueType.ACTIVITY
Denizen's Script Engine contains a method called runQeues which sends the ScriptEntries off to the executer. During this process, it stores which queue the command was called from. Can be used in advanced situations. Typically, if called by an Interact Script, this contains QueueType.TRIGGER.
getScript()
String value of the script name
Could be useful if storing information about a Script. For example, Denizen's FINISH command takes this information for granted if no script is otherwise indicated in the arguments.
getStep()
Integer value of the script's step
Could be used similarly to getScript(). The ZAP command uses this information to know which step to proceed to.
getPlayer()
Player object of the script triggerer
Pretty straight forward. The bukkit Player object can get all kinds of information about the player.
getDenizen()
DenizenNPC object of the script triggeree
DenizenNPC makes it easy to work with the Denizen that has been interacted with. Good example: LOOK command.
getInitiatedTime()
Long value of System.currentTimeMillis()
Contains a Long System.currentTimeMillis() of the system time in which it was sent to your Command for processing which you can use to check against.
setDelayedTime()
should be a Long value in the format of System.currentTimeMillis()
Advanced usage. See the DELAY command for an example.
getDelayedTime()
Long value that was set with setDelayedTime()
Advanced usage. Again, see the DELAY command for an example. If not set with setDelayedTime(), this is null by default.
getTexts()
String[2] of text sent by a Trigger
Vanilla Denizen will use this to store information sent to/from a Chat Trigger. Element [0] contains the text typed by the Player when the script was triggered, and element [1] contains the text as set in the Trigger: node of the script.

Registering your command

In order for Denizen to use your command, it needs to be registered. This could probably be done in your plugin's onEnable() method.

Example code

Code: Example Code for registering a Denizen Command
{{{2}}}
Retrieved from ‘https://wiki.citizensnpcs.co/index.php?title=Custom_Denizen_Commands&oldid=2272’