QCherry: Update Lua event reference

2026-08-14T22:31:35Z

Update Lua event reference

New page

= onPlayerCommand =
Triggered when a player submits a slash command that was not consumed before event dispatch.

== Availability ==
This event is available in '''server-side''' scripts.

== Callback signature ==
<syntaxhighlight lang="lua">
onPlayerCommand(playerId, commandName, argumentLine)
</syntaxhighlight>

== Parameters ==
{| class="wikitable"
! Name !! Type !! Description
|-
| <code>playerId</code> || <code>int</code> || The player that submitted the command.
|-
| <code>commandName</code> || <code>string</code> || The lowercase command name without the leading slash.
|-
| <code>argumentLine</code> || <code>string</code> || The unparsed text following the command name.
|}

== Examples ==
Handle the event:
<syntaxhighlight lang="lua" line>
addEventHandler("onPlayerCommand", root, function(playerId, commandName, argumentLine)
outputDebugString("/" .. commandName .. " from player " .. playerId .. ": " .. argumentLine)
end)
</syntaxhighlight>

== Notes ==
* Prefer [[addCommandHandler]] for ordinary commands; use this event for centralized routing or auditing.

[[Category:Lua Events]]
[[Category:Server Events]]
[[Category:Chat Events]]

OnPlayerCommand - Revision history

QCherry: Update Lua event reference