OnPlayerCommand: Difference between revisions
Jump to navigation
Jump to search
(Created page with "{{ScriptItem |endpoint = server |type = event |name = onPlayerCommand |usage = a player submits a chat command.<br>A command starts with a forward slash (the command character...") |
No edit summary |
||
| Line 2: | Line 2: | ||
|endpoint = server | |endpoint = server | ||
|type = event | |type = event | ||
|name = | |name = OnPlayerCommand | ||
|usage = a player submits a chat command.<br>A command starts with a forward slash (the command character), and the command is not displayed in the chat box | |usage = a player submits a chat command.<br>A command starts with a forward slash (the command character), and the command is not displayed in the chat box | ||
|callbackParameters = Event event, Client client, string command, string parameters | |callbackParameters = Event event, Client client, string command, string parameters | ||
| Line 9: | Line 9: | ||
|parameter2 = string command The command name. | |parameter2 = string command The command name. | ||
|parameter3 = string parameters The command parameters as a string. | |parameter3 = string parameters The command parameters as a string. | ||
|exampleJS = addEventHandler('OnPlayerCommand', (event, client, command, parameters) => { | |||
console.log(`(Command) ${client.name} has used the command '/${command} ${parameters}'.`); | |||
}); | |||
|exampleLua = addEventHandler('OnPlayerCommand', function(event, client, command, parameters) | |||
console.log(`(Command) ${client.name} has used the command '/${command} ${parameters}'.`); | |||
end); | |||
}} | }} | ||
Revision as of 16:10, 12 August 2021
Event Server Only 
Online and Offline Cancellable
Available since Server 1.0.0
function(Event event, Client client, string command, string parameters)
The OnPlayerCommand event is invoked when a player submits a chat command.
A command starts with a forward slash (the command character), and the command is not displayed in the chat box.
A command starts with a forward slash (the command character), and the command is not displayed in the chat box.
Parameters
| 1) | Event | event | The event object for this event. |
| 2) | Client | client | The client that submitted a command. |
| 3) | string | command | The command name. |
| 4) | string | parameters | The command parameters as a string. |
Attributes
| cancellable | This event can be cancelled, by using event.preventDefault. |
Notes
There aren't any notes for this event.
Examples
Example 1 - JavaScript:
addEventHandler('OnPlayerCommand', (event, client, command, parameters) => { console.log(`(Command) ${client.name} has used the command '/${command} ${parameters}'.`); });
Example 2 - Lua:
addEventHandler('OnPlayerCommand', function(event, client, command, parameters) console.log(`(Command) ${client.name} has used the command '/${command} ${parameters}'.`); end);
Compatibility
There isn't any compatibility information for this event.
Related
Server Related OnPlayerCommand