Commands - Revision history

SuperHawksman at 16:41, 15 February 2015

2015-02-15T16:41:45Z

SuperHawksman at 16:40, 15 February 2015

2015-02-15T16:40:39Z

Lugdunon: /* Server Invoked Commands */

2013-10-13T18:20:27Z

‎Server Invoked Commands

Lugdunon: /* GM Only Commands */

2013-10-13T18:20:06Z

‎GM Only Commands

Lugdunon: /* Console Fired Commands */

2013-10-13T18:19:59Z

‎Console Fired Commands

Lugdunon: /* Server Side Command API */

2013-10-13T18:19:46Z

‎Server Side Command API

Lugdunon: /* Invoking Commands on the Client */

2013-10-13T18:09:01Z

‎Invoking Commands on the Client

Lugdunon: /* Server Invoked Commands */

2013-10-13T18:07:58Z

‎Server Invoked Commands

Lugdunon: /* GM Only Commands */

2013-10-13T18:05:33Z

‎GM Only Commands

Lugdunon: /* GM Only Commands */

2013-10-13T18:05:18Z

‎GM Only Commands

← Older revision		Revision as of 16:41, 15 February 2015
Line 463:		Line 463:
	game.client.sendCommand(command);		game.client.sendCommand(command);
	</syntaxhighlight>		</syntaxhighlight>
		+
		+	[[Category:Modding\|Commands]]

← Older revision		Revision as of 16:40, 15 February 2015
Line 1:		Line 1:
		+	{{rewrite\|Exact application of the information is vague}}
		+
		+	{{engine}}
		+
	==Introduction==		==Introduction==

@@ Line 336: / Line 336: @@
-<syntaxhighlight lang="javascript" line start="100" highlight="5" enclose="div">
+<syntaxhighlight lang="java" line start="100" highlight="5" enclose="div">
 /**
   * Adds a command request to the incoming request queue, where it will be processed in the next update cycle.
@@ Line 377: / Line 377: @@
-<syntaxhighlight lang="javascript" line start="100" highlight="5" enclose="div">
+<syntaxhighlight lang="java" line start="100" highlight="5" enclose="div">
 // account defined previously
 // create a new instance of command properties

@@ Line 308: / Line 308: @@
-<syntaxhighlight lang="javascript" line start="100" highlight="5" enclose="div">
+<syntaxhighlight lang="java" line start="100" highlight="5" enclose="div">
 /**
   * Commands that are restricted to players that have GM privileges should implement this method

@@ Line 278: / Line 278: @@
-<syntaxhighlight lang="javascript" line start="100" highlight="5" enclose="div">
+<syntaxhighlight lang="java" line start="100" highlight="5" enclose="div">
 /**
   * Evaluates the passed in opCodeAlias and determines if this command is a match.

@@ Line 188: / Line 188: @@
-<syntaxhighlight lang="javascript" line start="100" highlight="5" enclose="div">
+<syntaxhighlight lang="java" line start="100" highlight="5" enclose="div">
 /**
-  * Returns the length (in bytes) of the command call�s data.
+  * Returns the length (in bytes) of the command call's data.
+  *
   * @return {int}

← Older revision		Revision as of 18:09, 13 October 2013
Line 420:		Line 420:


		+	Client-side commmand requests are first built, and then sent to the server in a separate function call. The two functions in question belong to the '''''net.lugdunon.command.Client''''' class. The client singleton instance can be referenced at '''''game.client'''''.


		+
		+	<syntaxhighlight lang="javascript" line start="100" highlight="5" enclose="div">
		+	/**
		+	* Builds a command, and returns the resulting ArrayBuffer object.
		+	*
		+	* @param commandId {String} the command id of the command to process.
		+	* @param data {Object} and object containing any data needed by the command. Passed to the Command.opInit(data) function.
		+	*
		+	* @return {ArrayBuffer}
		+	*/
		+	this.buildCommand=function(commandId,data);
		+
		+	/**
		+	* Sends a command to the server.
		+	*
		+	* @param command {ArrayBuffer} the command data to send to the server.
		+	*/
		+	this.sendCommand=function(command);
		+	</syntaxhighlight>
		+
		+
		+
		+	For instance, to call the ‘consume food’ command with the instruction to consume the food located in the 8th action bar item from the left you might use the following code.



	<syntaxhighlight lang="javascript" line start="100" highlight="5" enclose="div">		<syntaxhighlight lang="javascript" line start="100" highlight="5" enclose="div">
		+	// build command
		+	var command=game.client.buildCommand(
		+	"CORE.COMMAND.CONSUME.FOOD",
		+	{actionBarIndex:7}
		+	);

		+	// send command for processing
		+	game.client.sendCommand(command);
	</syntaxhighlight>		</syntaxhighlight>

← Older revision		Revision as of 18:07, 13 October 2013
Line 326:		Line 326:


		+	If a command can be invoked autonomously by the server, or in the course of processing another command, you can implement the '''''net.lugdunon.command.core.IServerInvokedCommand''''' interface which requires the implementation of the following method:


		+	If a command can only be invoked on the server-side, simply leave the '''''handle(CommandRequest request)''''' devoid of logic.
		+
		+
		+	Invoking a server-side command is fairly straightforward. Commands need to be added to the incoming request queue in order to be processed. The '''''net.lugdunon.Game''''' class provides three overloaded instances of the '''''addIncomingRequest()''''' method for this purpose. Access to the singleton instance of the game class can be accomplished by invoking the following method chain '''''State.instance().getGame()'''''.



	<syntaxhighlight lang="javascript" line start="100" highlight="5" enclose="div">		<syntaxhighlight lang="javascript" line start="100" highlight="5" enclose="div">
		+	/**
		+	* Adds a command request to the incoming request queue, where it will be processed in the next update cycle.
		+	*
		+	* This particular instance of the addIncomingRequest method is generally reserved for the engine to add an incoming request originated from a client process.
		+	* For server invoked commands, the other two instances are generally preferred.
		+	*
		+	* @param incomingRequest {CommandRequest} the incoming CommandRequest object.
		+	*/
		+	public synchronized void addIncomingRequest(CommandRequest incomingRequest)
		+
		+	/**
		+	* Adds a command request to the incoming request queue, where it will be processed in the next update cycle.
		+	*
		+	* This instance of the addIncomingRequest method takes a command id as its only parameter, and should be used when a server invoked command requires no accompanying data.
		+	*
		+	* @param commandId {String} the command id of the command to be called when this request is processed.
		+	*
		+	* @throws CommandNotSupportedException
		+	* @throws IsNotServerInvokedCommand
		+	*/
		+	public synchronized void addIncomingRequest(String commandId) throws CommandNotSupportedException, IsNotServerInvokedCommand
		+
		+	/**
		+	* Adds a command request to the incoming request queue, where it will be processed in the next update cycle.
		+	*
		+	* This instance of the addIncomingRequest method takes a command id as its only parameter, and should be used when a server invoked command requires accompanying data.
		+	*
		+	* @param commandId {String} the command id of the command to be called when this request is processed.
		+	* @param props {CommandProperties} the command properties object that contains all relevant data needed by the command.
		+	*
		+	* @throws CommandNotSupportedException
		+	* @throws IsNotServerInvokedCommand
		+	*/
		+	public synchronized void addIncomingRequest(String commandId, CommandProperties props) throws CommandNotSupportedException, IsNotServerInvokedCommand
		+	</syntaxhighlight>
		+
		+
		+	Commands usually require data to process. With server invoked commands, this is accomplished via the '''''net.lugdunon.command.CommandProperties''''' object. A command can then be executed in server-side code like the following example to move a character to tile (0,0):
		+
		+
		+	<syntaxhighlight lang="javascript" line start="100" highlight="5" enclose="div">
		+	// account defined previously
		+	// create a new instance of command properties
		+	CommandProperties props=new CommandProperties();
		+
		+	// set either the account or character property, depending on the account's game mode
		+	if(account.getGameMode() == Account.MODE_EDIT)
		+	{
		+	props.setAccount("account",account);
		+	}
		+	else
		+	{
		+	props.setCharacter("character",account.getActiveCharacter());
		+	}
		+
		+	// tell the client that the viewport is in need of updating
		+	props.setBoolean("viewportChanged",true);
		+
		+	// set the coordinates for the destination
		+	props.setPoint("location",new Point(0,0));

		+	try
		+	{
		+	// add the 'move player' command request to the incoming request queue for processing
		+	State.instance().getGame().addIncomingRequest(
		+	"CORE.COMMAND.PLAYER.MOVE",
		+	props
		+	);
		+	}
		+	catch(CommandNotSupportedException e)
		+	{
		+	e.printStackTrace();
		+	}
		+	catch(IsNotServerInvokedCommand e)
		+	{
		+	e.printStackTrace();
		+	}
	</syntaxhighlight>		</syntaxhighlight>

← Older revision		Revision as of 18:05, 13 October 2013
Line 304:		Line 304:


−	GM only commands are commands that are executable by a player only if they have GM status. Such a command needs but to extend the '''''net.lugdunon.command.core.gm.GmOnlyCommand''''' java class instead of '''''net.lugdunon.command.core.Command'''''. And implement the ''handleAsOp(CommandRequest request)'' method instead of the handle(CommandRequest request).The client is agnostic on this point so nothing needs to be done there.	+	GM only commands are commands that are executable by a player only if they have GM status. Such a command needs but to extend the '''''net.lugdunon.command.core.gm.GmOnlyCommand''''' java class instead of '''''net.lugdunon.command.core.Command'''''. And implement the ''handleAsOp(CommandRequest request)'' method instead of the ''handle(CommandRequest request)''.The client is agnostic on this point so nothing needs to be done there.

@@ Line 304: / Line 304: @@
+GM only commands are commands that are executable by a player only if they have GM status. Such a command needs but to extend the '''''net.lugdunon.command.core.gm.GmOnlyCommand''''' java class instead of '''''net.lugdunon.command.core.Command'''''. And implement the ''handleAsOp(CommandRequest request)'' method instead of the handle(CommandRequest request).The client is agnostic on this point so nothing needs to be done there.
-−
 <syntaxhighlight lang="javascript" line start="100" highlight="5" enclose="div">
+/**
 </syntaxhighlight>