addCommandHandler: Difference between revisions

Revision as of 21:27, 5 November 2020

Function Server and Client Online and Offline

Available since Server 1.0.0, Client 1.0.0

bool addCommandHandler(string command, function handler, [ bool replace = false ])

The addCommandHandler function is used to set a function to call when a player types the specified command in-game.

1)	string	command	The command name to be typed in-game in the chat box.
2)	function	handler	The scripting function to be called when a player types the command in-game in the chat box.
3)	bool	replace	Optional, defaults to false. Whether to replace the handler for the command if one is already bound to the command.

bool	Whether the handler was bound to the command.

Server-Side Callbacks

function handler(string command, string parameters, Client client)

1)	string	command	The command that was typed.
2)	string	parameters	The parameters string that was typed.
3)	Client	client	The client that typed the command.

Client-Side Callbacks

function handler(string command, string parameters)

1)	string	command	The command that was typed.
2)	string	parameters	The parameters string that was typed.

If replace is true, the existing callback function is replaced with the new callback function specified.

Example 1 - JavaScript - Server-Side:

addCommandHandler('test', function(command, text, client)
{
	console.log('test message'); // shown in server console
});

Example 2 - JavaScript - Client-Side:

addCommandHandler('test', function(command, text)
{
	console.log('test message'); // shown in client console
});

There isn't any compatibility information for this function.

@@ Line 3: / Line 3: @@
 |type = function
 |name = addCommandHandler
-|usage = set a function to call when a player types the specified command in-game.<br>Command names are case-insensitive.<br>If a function is already added for the command, the function is only set for the command if '''replace''' is '''bool true'''
+|usage = set a function to call when a player types the specified command in-game.
+|notes = Command names are case-insensitive.<br>If a function is already added for the command, the function is only set for the command if '''replace''' is '''bool true'''
 |parameters = string command, function handler, [ bool replace = false ]
 |parameter1 = string command The command name to be typed in-game in the chat box.