OnPlayerChatCommand: Difference between revisions

From Onset Developer Wiki
Created page with "{{Info|Event|Server|1.0}} {{FuncDescription|__EDIT_ME__}} {{FuncSyntax|OnPlayerChatCommand}} {{FuncParameters}} == Example == __EDIT_ME__ {{RelatedFunctions}} {{ServerEven..."
 
No edit summary
 
(6 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Info|Event|Server|1.0}}
{{Info|Event|Server & Client|1.0}}


{{FuncDescription|__EDIT_ME__}}
{{FuncDescription|Called when a player executes a command in the chat. See [[AddCommand]] to handle specific commands. You can return '''false''' in this event to prevent the command from being passed to it's handler.}}


{{FuncSyntax|OnPlayerChatCommand}}
{{FuncSyntax|OnPlayerChatCommand(player, command, exists)}}
{{FuncSyntaxClient|OnPlayerChatCommand(command, exists)}}


{{FuncParameters}}
{{FuncParameters}}
{{FuncParam|player|The player who has executed the command.}}
{{FuncParam|command|The command name without slashes. For example: help}}
{{FuncParam|exists|'''false''' if the command is not bound by [[AddCommand]]. '''true''' if there is such handler.}}
== Example ==
== Example ==
__EDIT_ME__
<syntaxhighlight lang="Lua">
function OnPlayerChatCommand(player, cmd, exists)
if (GetTimeSeconds() - PlayerData[player].cmd_cooldown < 0.5) then
AddPlayerChat(player, "Slow down with your commands")
return false
end
 
PlayerData[player].cmd_cooldown = GetTimeSeconds()
 
if not exists then
AddPlayerChat(player, "Command '/"..cmd.."' not found!")
end
return true
end
AddEvent("OnPlayerChatCommand", OnPlayerChatCommand)
</syntaxhighlight>


{{RelatedFunctions}}
{{RelatedFunctions}}
{{ServerEvents}}
{{PlayerEvents}}

Latest revision as of 13:33, 14 August 2020

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 return false in this event to prevent the command from being passed to it's handler.

Syntax

OnPlayerChatCommand(player, command, exists)
Client Syntax
OnPlayerChatCommand(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
		AddPlayerChat(player, "Slow down with your commands")
		return false
	end

	PlayerData[player].cmd_cooldown = GetTimeSeconds()

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

See also

Retrieved from "https://dev.playonset.com/index.php?title=OnPlayerChatCommand&oldid=4018"