Denizen API - Revision history

Mcmonkey at 21:45, 8 November 2020

2020-11-08T21:45:29Z

@@ Line 1: / Line 1: @@
 In Denizen, the Script Command system is extensible by design. It's very easy to make your own commands (and soon Requirements) extend the built-in features. On top of that, Denizen has some features available that may be of use to Plugin Developers.
 = Building your own Commands =
@@ Line 42: / Line 56: @@
 To summarize, here's a list of methods that can be used to get information about the ScriptCommand.
-* <code>.getCommand()</code> <code>.arguments()</code> <code>.sendingQueue()</code> <code>.getScript()</code> <code>.getStep()</code> <code>.getTriggerType()</code> <code>.getPlayer()</code> <code>.getDenizen()</code> <code>.getInitiatedTime()</code> <code>.getDelayedTime()</code> <code>.getTexts()</code>
+* <code>.getCommand()</code> <code>.arguments()</code> <code>.sendingQueue()</code> <code>.getScript()</code> <code>.getStep()</code> <code>.getTriggerType()</code> <code>.getPlayer()</code> <code>.getDenizen()</code> <code>.getInitiatedTime()</code> <code>.getDelayedTime()</code> <code>.getTexts()</code></s>

Aufdemrand: /* What a ScriptCommand holds */

2012-07-05T21:33:46Z

What a ScriptCommand holds

← Older revision		Revision as of 21:33, 5 July 2012
Line 9:		Line 9:
	==== What a ScriptCommand holds ====		==== What a ScriptCommand holds ====

	ScriptCommands hold data about the situation surrounding the event that activates your command. Which type of script activates your Command, the ScriptCommand can have a multitude of information available.		ScriptCommands hold data about the situation surrounding the event that activates your command. Which type of script activates your Command, the ScriptCommand can have a multitude of information available. Keep in mind that the ScriptCommand object sent along may not have ALL this information, depending on the circumstances sent.

	* <code>.getCommand()</code> of course, contains a <code>String</code> of the name of your command.		* <code>.getCommand()</code> of course, contains a <code>String</code> of the name of your command.

Aufdemrand: /* What a ScriptCommand holds */

2012-07-05T21:32:11Z

What a ScriptCommand holds

← Older revision		Revision as of 21:32, 5 July 2012
Line 42:		Line 42:

	To summarize, here's a list of methods that can be used to get information about the ScriptCommand.		To summarize, here's a list of methods that can be used to get information about the ScriptCommand.
	* <code>.getCommand()<code> <code>.arguments()<code> <code>.sendingQueue()<code> <code>.getScript()<code> <code>.getStep()<code> <code>.getTriggerType()<code> <code>.getPlayer()<code> <code>.getDenizen()<code> <code>.getInitiatedTime()<code> <code>.getDelayedTime()<code> <code>.getTexts()<code>		* <code>.getCommand()</code> <code>.arguments()</code> <code>.sendingQueue()</code> <code>.getScript()</code> <code>.getStep()</code> <code>.getTriggerType()</code> <code>.getPlayer()</code> <code>.getDenizen()</code> <code>.getInitiatedTime()</code> <code>.getDelayedTime()</code> <code>.getTexts()</code>

Aufdemrand: /* What a ScriptCommand holds */

2012-07-05T21:31:05Z

What a ScriptCommand holds

← Older revision		Revision as of 21:31, 5 July 2012
Line 40:		Line 40:
	* <code>.getTexts()</code> contains a <code>String[]</code> of 2 elements.		* <code>.getTexts()</code> contains a <code>String[]</code> of 2 elements.
	*: First element, <code>.getTexts[0]</code> for example, has the 'raw text' that the player typed to initiate the command. Second element, <code>.getTexts[1]</code> contains the 'friendly text', most likely the Chat Trigger that was set in the script. As you can probaly guess, if <code>.getTriggerType()</code> isn't a <code>TriggerType.CHAT</code> this will most likely be null.		*: First element, <code>.getTexts[0]</code> for example, has the 'raw text' that the player typed to initiate the command. Second element, <code>.getTexts[1]</code> contains the 'friendly text', most likely the Chat Trigger that was set in the script. As you can probaly guess, if <code>.getTriggerType()</code> isn't a <code>TriggerType.CHAT</code> this will most likely be null.

			To summarize, here's a list of methods that can be used to get information about the ScriptCommand.
			* <code>.getCommand()<code> <code>.arguments()<code> <code>.sendingQueue()<code> <code>.getScript()<code> <code>.getStep()<code> <code>.getTriggerType()<code> <code>.getPlayer()<code> <code>.getDenizen()<code> <code>.getInitiatedTime()<code> <code>.getDelayedTime()<code> <code>.getTexts()<code>

Aufdemrand: /* What a ScriptCommand holds */

2012-07-05T21:24:26Z

What a ScriptCommand holds

← Older revision		Revision as of 21:24, 5 July 2012
Line 27:		Line 27:
	* <code>.getTriggerType()</code> contains a <code>TriggerType</code> of the script, that is, what type of 'TRIGGER' triggered it.		* <code>.getTriggerType()</code> contains a <code>TriggerType</code> of the script, that is, what type of 'TRIGGER' triggered it.
	*: This will be either <code>TriggerType.ATTACK</code>, <code>TriggerType.CLICK</code>, <code>TriggerType.CHAT</code>, <code>TriggerType.PROXIMITY</code>, <code>TriggerType.TASK</code>, or <code>TriggerType.LOCATION</code>. More types are likely to be implemented.		*: This will be either <code>TriggerType.ATTACK</code>, <code>TriggerType.CLICK</code>, <code>TriggerType.CHAT</code>, <code>TriggerType.PROXIMITY</code>, <code>TriggerType.TASK</code>, or <code>TriggerType.LOCATION</code>. More types are likely to be implemented.

			* <code>.getPlayer()</code> contains a <code>Player</code> object of the triggering Player, if triggered by a player, that is.
			*: If triggered from a <code>ACTIVITY</code> script, this would be null.

			* <code>.getDenizen()</code> contains a <code>NPC</code> Citizens2 object, again, if a NPC object is sent with it.
			*: If triggered from a <code>TASK</code> script, this is null.

	* <code>.getInitiatedTime()</code> contains a <code>Long System.currentTimeMillis()</code> of the system time in which it was sent to your Command for processing.		* <code>.getInitiatedTime()</code> contains a <code>Long System.currentTimeMillis()</code> of the system time in which it was sent to your Command for processing.
Line 33:		Line 39:

	* <code>.getTexts()</code> contains a <code>String[]</code> of 2 elements.		* <code>.getTexts()</code> contains a <code>String[]</code> of 2 elements.
	*: First element, <code>.getTexts[0]</code> for example, has the 'raw text' that the player typed to initiate the command. Second element, <code>.getTexts[1]</code> contains the 'friendly text', most likely the Chat Trigger that was set in the script. As you can probaly guess, if ~~the~~ <code>~~TriggerType~~</code> isn't a <code>TriggerType.CHAT</code> this will most likely be null.		*: First element, <code>.getTexts[0]</code> for example, has the 'raw text' that the player typed to initiate the command. Second element, <code>.getTexts[1]</code> contains the 'friendly text', most likely the Chat Trigger that was set in the script. As you can probaly guess, if <code>.getTriggerType()</code> isn't a <code>TriggerType.CHAT</code> this will most likely be null.

Aufdemrand: /* What a ScriptCommand holds */

2012-07-05T21:04:47Z

What a ScriptCommand holds

← Older revision		Revision as of 21:04, 5 July 2012
Line 10:		Line 10:

	ScriptCommands hold data about the situation surrounding the event that activates your command. Which type of script activates your Command, the ScriptCommand can have a multitude of information available.		ScriptCommands hold data about the situation surrounding the event that activates your command. Which type of script activates your Command, the ScriptCommand can have a multitude of information available.

			* <code>.getCommand()</code> of course, contains a <code>String</code> of the name of your command.
			*: Useful if your command module contains instructions for more than one command. You can register multiple commands to your module, as discussed later in this document. See the <code>ENGAGE</code> command for a useful example of utilizing this information.

			* <code>.arguments()</code> has a <code>String[]</code> of all the arguments the player provided.
			*: This pre-formats arguments that have used quotes, for instance, if the script command is <code>YOURCOMMAND argument1 argument2 'this is argument3'</code>, this object would have 3 items in the array.

	* <code>.sendingQueue()</code> returns a <code>QueueType</code> of either <code>QueueType.TRIGGER</code>, <code>QueueType.TASK</code>, or <code>QueueType.ACTIVITY</code>		* <code>.sendingQueue()</code> returns a <code>QueueType</code> of either <code>QueueType.TRIGGER</code>, <code>QueueType.TASK</code>, or <code>QueueType.ACTIVITY</code>
Line 24:		Line 30:
	* <code>.getInitiatedTime()</code> contains a <code>Long System.currentTimeMillis()</code> of the system time in which it was sent to your Command for processing.		* <code>.getInitiatedTime()</code> contains a <code>Long System.currentTimeMillis()</code> of the system time in which it was sent to your Command for processing.

	* <code>.getDelayedTime()</code> contains a <code>Long System.currentTimeMillis()</code> of the system time that was set by using the <code>.setDelay(Long newTime)</code>. This is null by default. Check out the <~~script~~>WAIT</~~script~~> command for a functional example of usage.		* <code>.getDelayedTime()</code> contains a <code>Long System.currentTimeMillis()</code> of the system time that was set by using the <code>.setDelay(Long newTime)</code>. This is null by default. Check out the <code>WAIT</code> command for a functional example of usage.

	* <code>.getTexts()</code> contains a <code>String[]</code> of 2 elements.		* <code>.getTexts()</code> contains a <code>String[]</code> of 2 elements.
	*: First element, <code>.getTexts[0]</code> for example, has the 'raw text' that the player typed to initiate the command. Second element, <code>.getTexts[1]</code> contains the 'friendly text', most likely the Chat Trigger that was set in the script. As you can probaly guess, if the <code>TriggerType</code> isn't a <code>TriggerType.CHAT</code> this will most likely be null.		*: First element, <code>.getTexts[0]</code> for example, has the 'raw text' that the player typed to initiate the command. Second element, <code>.getTexts[1]</code> contains the 'friendly text', most likely the Chat Trigger that was set in the script. As you can probaly guess, if the <code>TriggerType</code> isn't a <code>TriggerType.CHAT</code> this will most likely be null.

Aufdemrand: /* What a ScriptCommand holds */

2012-07-05T20:56:43Z

What a ScriptCommand holds

← Older revision		Revision as of 20:56, 5 July 2012
Line 19:		Line 19:
	*: Note that if this was a <code>TASK</code> script, for example, this would be null.		*: Note that if this was a <code>TASK</code> script, for example, this would be null.

	* <code>.getTriggerType()</code> contains a <code>TriggerType</code> of the script.		* <code>.getTriggerType()</code> contains a <code>TriggerType</code> of the script, that is, what type of 'TRIGGER' triggered it.
	*: This will be either <code>TriggerType.ATTACK</code>, <code>TriggerType.CLICK</code>, <code>TriggerType.CHAT</code>, <code>TriggerType.PROXIMITY</code>, <code>TriggerType.TASK</code>, or <code>TriggerType.LOCATION</code>. More types are likely to be implemented.		*: This will be either <code>TriggerType.ATTACK</code>, <code>TriggerType.CLICK</code>, <code>TriggerType.CHAT</code>, <code>TriggerType.PROXIMITY</code>, <code>TriggerType.TASK</code>, or <code>TriggerType.LOCATION</code>. More types are likely to be implemented.

			* <code>.getInitiatedTime()</code> contains a <code>Long System.currentTimeMillis()</code> of the system time in which it was sent to your Command for processing.

			* <code>.getDelayedTime()</code> contains a <code>Long System.currentTimeMillis()</code> of the system time that was set by using the <code>.setDelay(Long newTime)</code>. This is null by default. Check out the <script>WAIT</script> command for a functional example of usage.

			* <code>.getTexts()</code> contains a <code>String[]</code> of 2 elements.
			*: First element, <code>.getTexts[0]</code> for example, has the 'raw text' that the player typed to initiate the command. Second element, <code>.getTexts[1]</code> contains the 'friendly text', most likely the Chat Trigger that was set in the script. As you can probaly guess, if the <code>TriggerType</code> isn't a <code>TriggerType.CHAT</code> this will most likely be null.

Aufdemrand: /* What a ScriptCommand holds */

2012-07-05T20:44:30Z

What a ScriptCommand holds

← Older revision		Revision as of 20:44, 5 July 2012
Line 11:		Line 11:
	ScriptCommands hold data about the situation surrounding the event that activates your command. Which type of script activates your Command, the ScriptCommand can have a multitude of information available.		ScriptCommands hold data about the situation surrounding the event that activates your command. Which type of script activates your Command, the ScriptCommand can have a multitude of information available.

	* <code>.sendingQueue()</code> returns a <code>QueueType</code> of either <code>QueueType.TRIGGER</code>, </code>QueueType.TASK</code>, or <code>QueueType.ACTIVITY</code>		* <code>.sendingQueue()</code> returns a <code>QueueType</code> of either <code>QueueType.TRIGGER</code>, <code>QueueType.TASK</code>, or <code>QueueType.ACTIVITY</code>
	*: This contains the type of queue that sent the command. If the command was issues from a TASK script, for example, this would contain <code>QueueType.TASK</code>		*: This contains the type of queue that sent the command. If the command was issues from a TASK script, for example, this would contain <code>QueueType.TASK</code>

	</code>		* <code>.getScript()</code> contains a <code>String</code> name of the script.

			* <code>.getStep()</code> contains an <code>Integer</code> of the step of the script.
			*: Note that if this was a <code>TASK</code> script, for example, this would be null.

			* <code>.getTriggerType()</code> contains a <code>TriggerType</code> of the script.
			*: This will be either <code>TriggerType.ATTACK</code>, <code>TriggerType.CLICK</code>, <code>TriggerType.CHAT</code>, <code>TriggerType.PROXIMITY</code>, <code>TriggerType.TASK</code>, or <code>TriggerType.LOCATION</code>. More types are likely to be implemented.

Aufdemrand: /* What a ScriptCommand holds */

2012-07-05T20:37:43Z

What a ScriptCommand holds

← Older revision		Revision as of 20:37, 5 July 2012
Line 12:		Line 12:

	* <code>.sendingQueue()</code> returns a <code>QueueType</code> of either <code>QueueType.TRIGGER</code>, </code>QueueType.TASK</code>, or <code>QueueType.ACTIVITY</code>		* <code>.sendingQueue()</code> returns a <code>QueueType</code> of either <code>QueueType.TRIGGER</code>, </code>QueueType.TASK</code>, or <code>QueueType.ACTIVITY</code>
	*; This contains the type of queue that sent the command. If the command was issues from a TASK script, for example, this would contain <code>QueueType.TASK</code>		*: This contains the type of queue that sent the command. If the command was issues from a TASK script, for example, this would contain <code>QueueType.TASK</code>

	</code>		</code>

Aufdemrand at 20:37, 5 July 2012

2012-07-05T20:37:28Z

← Older revision		Revision as of 20:37, 5 July 2012
Line 1:		Line 1:
	In Denizen, the Script Command system is extensible by design. It's very easy to make your own commands (and soon Requirements) extend the built-in features. On top of that, Denizen has some features available that may be of use to Plugin Developers.		In Denizen, the Script Command system is extensible by design. It's very easy to make your own commands (and soon Requirements) extend the built-in features. On top of that, Denizen has some features available that may be of use to Plugin Developers.

	= Building your own ~~Script~~ Commands =		= Building your own Commands =

	=== The ScriptCommand Object ===		=== The ScriptCommand Object ===

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

	==== ~~Barebones~~ ScriptCommand ~~Class~~ ====		==== What a ScriptCommand holds ====

	~~The following is~~ a ~~Hello World example~~ of ~~a ScriptCommand~~.		ScriptCommands hold data about the situation surrounding the event that activates your command. Which type of script activates your Command, the ScriptCommand can have a multitude of information available.

	~~<code>~~

			* <code>.sendingQueue()</code> returns a <code>QueueType</code> of either <code>QueueType.TRIGGER</code>, </code>QueueType.TASK</code>, or <code>QueueType.ACTIVITY</code>
			*; This contains the type of queue that sent the command. If the command was issues from a TASK script, for example, this would contain <code>QueueType.TASK</code>

	</code>		</code>