Denizen API Command Template - Revision history

Mcmonkey at 18:56, 3 September 2021

2021-09-03T18:56:27Z

← Older revision		Revision as of 18:56, 3 September 2021
Line 1:		Line 1:

			For more up-to-date information and full details on specific features (individual commands or tags, for example), check the [https://meta.denizenscript.com/ Meta Documentation].

			If you want a full tutorial to help get you set up, check out the [https://guide.denizenscript.com/ Beginner's Guide] text website.

			If you need quick help, visit our [https://discord.gg/Q6pZGSR Discord group].

			<br><br><br>

			<span style="font-family:natalya-alternate-one; font-size:300%; margin-right:-7px; margin-left:-10px;">This wiki is outdated, please view the tutorial videos/guide, meta documentation, or Discord group (all linked above) for up-to-date information!</span>

			<br><br><br>









	== Custom Commands ==		== Custom Commands ==
	<div style="margin-right:2.0em; padding:10px">		<div style="margin-right:2.0em; padding:10px">

Aufdemrand: /* Example code */

2012-08-01T04:07:54Z

Example code

← Older revision		Revision as of 04:07, 1 August 2012
Line 108:		Line 108:
	==== Example code ====		==== Example code ====
	<div style="margin-right:2.0em; padding:10px">		<div style="margin-right:2.0em; padding:10px">
	You can also see a [http://~~www.~~pastie.org formatted version on Pastie.org].		You can also see a [http://pastie.org/4369286 formatted version on Pastie.org].

	<pre>		<pre>

Aufdemrand: /* Example code */

2012-08-01T04:06:38Z

Example code

← Older revision		Revision as of 04:06, 1 August 2012
Line 125:		Line 125:
	} catch (ActivationException e) {		} catch (ActivationException e) {
	plugin.getLogger().log(Level.SEVERE, "Oh no! Activation Exception!");		plugin.getLogger().log(Level.SEVERE, "Oh no! Activation Exception!");
	e.printStackTrace();		e.printStackTrace();
	}		}
	}		}
	</pre>		</pre>

Aufdemrand: /* Example code */

2012-08-01T04:06:21Z

Example code

← Older revision		Revision as of 04:06, 1 August 2012
Line 124:		Line 124:
	myCommand.registerAs("CUSTOM_COMMAND");		myCommand.registerAs("CUSTOM_COMMAND");
	} catch (ActivationException e) {		} catch (ActivationException e) {
	plugin.getLogger().log(Level.SEVERE, "Oh no! ~~Denizen has run into a problem registering the core commands~~!");		plugin.getLogger().log(Level.SEVERE, "Oh no! Activation Exception!");
	e.printStackTrace();		e.printStackTrace();
	}		}
	}		}
	</pre>		</pre>

Aufdemrand: /* Example code */

2012-08-01T04:05:50Z

Example code

← Older revision		Revision as of 04:05, 1 August 2012
Line 120:		Line 120:
	public void onEnable() {		public void onEnable() {
	getLogger().info("Enabling my plugin!");		getLogger().info("Enabling my plugin!");
	myCommand.registerAs("CUSTOM_COMMAND");
			try {
			myCommand.registerAs("CUSTOM_COMMAND");
			} catch (ActivationException e) {
			plugin.getLogger().log(Level.SEVERE, "Oh no! Denizen has run into a problem registering the core commands!");
			e.printStackTrace();
			}
	}		}
	</pre>		</pre>

Aufdemrand: /* Example code */

2012-08-01T04:03:31Z

Example code

← Older revision		Revision as of 04:03, 1 August 2012
Line 110:		Line 110:
	You can also see a [http://www.pastie.org formatted version on Pastie.org].		You can also see a [http://www.pastie.org formatted version on Pastie.org].

	<~~code~~>		<pre>
	/*		/*
	* Sets up my plugin on start of the craftbukkit server.		* Sets up my plugin on start of the craftbukkit server.
Line 122:		Line 122:
	myCommand.registerAs("CUSTOM_COMMAND");		myCommand.registerAs("CUSTOM_COMMAND");
	}		}
	</~~code~~>		</pre>

Aufdemrand at 04:03, 1 August 2012

2012-08-01T04:03:10Z

@@ Line 101: / Line 101: @@
-==== Registering your command ====
+== Registering your command ==
 <div style="margin-right:2.0em; padding:10px">
-In order for Denizen to use your command, it needs to be registered. This could probably be done in your plugin's onS Use this example:
+In order for Denizen to use your command, it needs to be registered. This could probably be done in your plugin's onEnable() method.
 <code>

Aufdemrand at 03:47, 1 August 2012

2012-08-01T03:47:48Z

← Older revision		Revision as of 03:47, 1 August 2012
Line 1:		Line 1:
	== Custom Commands ==		== Custom Commands ==
			<div style="margin-right:2.0em; padding:10px">
	Denizen is extensible! In addition to Triggers and Requirements(soon!), 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?)		Denizen is extensible! In addition to Triggers and Requirements(soon!), 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!		Keep reading!
			</div>

	== YourCommand extends AbstractCommand ==		== YourCommand extends AbstractCommand ==
			<div style="margin-right:2.0em; padding:10px">
	The first thing you need is a custom command class that extends the Denizen AbstractTrigger. 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.		The first thing you need is a custom command class that extends the Denizen AbstractTrigger. 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.
			</div>

	==== Example Command ====		==== Example Command ====
			<div style="margin-right:2.0em; padding:10px">
	~~I think sometimes~~ the easiest way to work is to see an example. View a copy of the STRIKE command on Pastie.org for a very simple command. For ~~more~~ examples, you can always check [https://github.com/aufdemrand/Denizen/tree/master/src/main/java/net/aufdemrand/denizen/commands/core Core Denizen Commands].		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. For examples, you can always check [https://github.com/aufdemrand/Denizen/tree/master/src/main/java/net/aufdemrand/denizen/commands/core Core Denizen Commands].
			</div>

	==== Command Template ====		==== Command Template ====
			<div style="margin-right:2.0em; padding:10px">
	[http://pastie.org/4368657 View a command template copy on Pastie.org] for a copy/paste of the skeleton of a custom denizen commmand.		[http://pastie.org/4368657 View a command template copy on Pastie.org] for a copy/paste of the skeleton of a custom denizen commmand.
			</div>

	=== The ScriptEntry object ===		=== The ScriptEntry object ===
			<div style="margin-right:2.0em; padding:10px">
	When Denizen reads scripts, each line is turned into a SciptScript 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.		When Denizen reads scripts, each line is turned into a SciptScript 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.

Line 90:		Line 90:
	\|1= getDelayedTime()		\|1= getDelayedTime()
	\|2= Long value that was set with setDelayedTime()		\|2= Long value that was set with setDelayedTime()
	\|3= ~~NULL by default~~. ~~Dee~~ the DELAY command for an example.		\|3= Advanced usage. Again, see the DELAY command for an example. If not set with setDelayedTime(), this is null by default.
	}}		}}

Line 98:		Line 98:
	\|3= 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.		\|3= 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.
	}}		}}
			</div>


			==== Registering your command ====
			<div style="margin-right:2.0em; padding:10px">
			In order for Denizen to use your command, it needs to be registered. This could probably be done in your plugin's onS Use this example:

			<code>

Aufdemrand at 03:32, 1 August 2012

2012-08-01T03:32:26Z

← Older revision		Revision as of 03:32, 1 August 2012
Line 1:		Line 1:
	=== Custom Commands ===		== Custom Commands ==

	Denizen is extensible! In addition to Triggers and Requirements(soon!), 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?)		Denizen is extensible! In addition to Triggers and Requirements(soon!), 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?)
Line 6:		Line 6:


	=== YourCommand extends AbstractCommand ===		== YourCommand extends AbstractCommand ==

	The first thing you need is a custom command class that extends the Denizen AbstractTrigger. 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.		The first thing you need is a custom command class that extends the Denizen AbstractTrigger. 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.

Aufdemrand at 03:31, 1 August 2012

2012-08-01T03:31:43Z

← Older revision		Revision as of 03:31, 1 August 2012
Line 1:		Line 1:
			=== Custom Commands ===

	Denizen is extensible! In addition to Triggers and Requirements(soon!), 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?)		Denizen is extensible! In addition to Triggers and Requirements(soon!), 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!		Keep reading!


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

	When Denizen reads scripts, each line is turned into a SciptScript 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.


Line 17:		Line 14:

	I think sometimes the easiest way to work is to see an example. View a copy of the STRIKE command on Pastie.org for a very simple command. For more examples, you can always check [https://github.com/aufdemrand/Denizen/tree/master/src/main/java/net/aufdemrand/denizen/commands/core Core Denizen Commands].		I think sometimes the easiest way to work is to see an example. View a copy of the STRIKE command on Pastie.org for a very simple command. For more examples, you can always check [https://github.com/aufdemrand/Denizen/tree/master/src/main/java/net/aufdemrand/denizen/commands/core Core Denizen Commands].


	==== Command Template ====		==== Command Template ====
Line 23:		Line 21:


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

			When Denizen reads scripts, each line is turned into a SciptScript 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.		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.