RegisterCommand
DocsRegisterCommand(commandName, handler, restricted)Description
Registered commands can be executed by entering them in the client console (this works for client side and server side registered commands). Or by entering them in the server console/through an RCON client (only works for server side registered commands). Or if you use a supported chat resource, like the default one provided in the cfx-server-data repository, then you can enter the command in chat by prefixing it with a /.
Commands registered using this function can also be executed by resources, using the INLINE_1 native.
The restricted bool is not used on the client side. Permissions can only be checked on the server side, so if you want to limit your command with an ace permission automatically, make it a server command (by registering it in a server script).
Example result:
Parameters
| Name | Type | Description |
|---|---|---|
commandName | char* | The command you want to register. |
handler | func | A handler function that gets called whenever the command is executed. |
restricted | BOOL | If this is a server command and you set this to true, then players will need the command.yourCommandName ace permission to execute this command. |
Returns
voidThis native does not return a value.
Examples
-- (server side script)
-- Registers a command named 'ping'.
RegisterCommand("ping", function(source, args, rawCommand)
-- If the source is > 0, then that means it must be a player.
if (source > 0) then
-- result (using the default GTA:O chat theme) https://i.imgur.com/TaCnG09.png
TriggerClientEvent("chat:addMessage", -1, {
args = {
GetPlayerName(source),
"PONG!"
},
color = { 5, 255, 255 }
})
-- If it's not a player, then it must be RCON, a resource, or the server console directly.
else
print("This command was executed by the server console, RCON client, or a resource.")
end
end, false --[[this command is not restricted, everyone can use this.]])