addCommandHandler: Difference between revisions

From GTA Connected
Jump to navigation Jump to search
No edit summary
 
No edit summary
 
(2 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{ScriptItem
{{ScriptItem2
|endpoint = shared
|name = addCommandHandler
|side = shared
|type = function
|type = function
|name = addCommandHandler
|games = iii vc sa iv
|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'''
|desc = set a function to call when a player types the specified command in-game.
|parameters = string command, function handler, [ bool replace = false ]
|arg1 = string command The command name to be typed in-game in the chat box.
|parameter1 = string command The command name to be typed in-game in the chat box.
|arg2 = function handler The scripting function to be called when a player types the command in-game in the chat box.
|parameter2 = function handler The scripting function to be called when a player types the command in-game in the chat box.
|arg3 = [bool replace = false] Whether to replace the handler for the command if one is already bound to the command.
|parameter3 = bool replace optional false Whether to replace the handler for the command if one is already bound to the command.
|return = bool Whether the handler was bound to the command.
|return1 = bool Whether the handler was bound to the command.
|freturn = bool false
|returnFail1 = bool false
|note = If replace is true, the existing callback function is replaced with the new callback function specified.
|callback2SyntaxSS = string command, string parameters, Client client
|note2 = 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'''
|callback2ParameterSS1 = string command The command that was typed.
|cb2arg1SS = string command The command that was typed.
|callback2ParameterSS2 = string parameters The parameters string that was typed.
|cb2arg2SS = string parameters The parameters string that was typed.
|callback2ParameterSS3 = Client client The client that typed the command.
|cb2arg3SS = Client client The client that typed the command.
|callback2SyntaxCS = string command, string parameters
|cb2arg1CS = string command The command that was typed.
|callback2ParameterCS1 = string command The command that was typed.
|cb2arg2CS = string parameters The parameters string that was typed.
|callback2ParameterCS2 = string parameters The parameters string that was typed.
|notes = If replace is true, the existing callback function is replaced with the new callback function specified.
|exampleJSSS = addCommandHandler('test', function(command, text, client)
|exampleJSSS = addCommandHandler('test', function(command, text, client)
{
{

Latest revision as of 20:17, 19 November 2022

Function Server and Client icon-iii.png icon-vc.png icon-sa.png icon-iv.png 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.

Parameters

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.

Return

bool Whether the handler was bound to the command.

Notes

  • If replace is true, the existing callback function is replaced with the new callback function specified.
  • Command names are case-insensitive.
    If a function is already added for the command, the function is only set for the command if replace is bool true.

Examples

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
});

Compatibility

There isn't any compatibility information for this function.

Related

Server Related

icon-iii.png icon-vc.png icon-sa.png icon-iv.png addCommandHandler
icon-iii.png icon-vc.png icon-sa.png icon-iv.png consoleCommand
icon-iii.png icon-vc.png icon-sa.png icon-iv.png hasCommandHandler
icon-iii.png icon-vc.png icon-sa.png icon-iv.png removeCommandHandler


Client Related

icon-iii.png icon-vc.png icon-sa.png icon-iv.png addCommandHandler
icon-iii.png icon-vc.png icon-sa.png icon-iv.png consoleCommand
icon-iii.png icon-vc.png icon-sa.png icon-iv.png hasCommandHandler
icon-iii.png icon-vc.png icon-sa.png icon-iv.png removeCommandHandler