OnPlayerChatCommand: Difference between revisions

From Onset Developer Wiki
No edit summary
No edit summary
Line 8: Line 8:
{{FuncParam|player|The player who has executed the command.}}
{{FuncParam|player|The player who has executed the command.}}
{{FuncParam|command|The command name without slashes. For example: help}}
{{FuncParam|command|The command name without slashes. For example: help}}
{{FuncParam|exists|'''0''' if the command is not bound by [[AddCommand]]. '''1''' if there is such handler.}}
{{FuncParam|exists|'''false''' if the command is not bound by [[AddCommand]]. '''true''' if there is such handler.}}


== Example ==
== Example ==

Revision as of 22:42, 29 September 2019

OnPlayerChatCommand

Type: Event
Context: Server & Client
Introduced: v1.0

Description

Called when a player executes a command in the chat. See AddCommand to handle specific commands. You can call CancelChatCommand in this event to prevent the command from further processing.

Syntax

OnPlayerChatCommand(player, command, exists)

Parameters

  • player
    The player who has executed the command.
  • command
    The command name without slashes. For example: help
  • exists
    false if the command is not bound by AddCommand. true if there is such handler.

Example

function OnPlayerChatCommand(player, cmd, exists)	
	if (GetTimeSeconds() - PlayerData[player].cmd_cooldown < 0.5) then
		CancelChatCommand()
		return AddPlayerChat(player, "Slow down with your commands")
	end

	PlayerData[player].cmd_cooldown = GetTimeSeconds()

	if (exists == 0) then
		AddPlayerChat(player, "Command '/"..cmd.."' not found!")
	end
end
AddEvent("OnPlayerChatCommand", OnPlayerChatCommand)

See also

Player

Vehicle

Game

Package

NPC

Object

Pickup

Text3D

Door