QCherry: Update Lua event reference

2026-08-14T22:31:45Z

Update Lua event reference

New page

= onPlayerInteractionStart =
Triggered when a replicated general interaction begins.

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

== Callback signature ==
<syntaxhighlight lang="lua">
onPlayerInteractionStart(playerId, kind, actionId, serverStartTimeMs)
</syntaxhighlight>

== Parameters ==
{| class="wikitable"
! Name !! Type !! Description
|-
| <code>playerId</code> || <code>int</code> || The interacting player ID.
|-
| <code>kind</code> || <code>string</code> || The interaction kind, such as mining or sitting.
|-
| <code>actionId</code> || <code>int</code> || The replicated action ID.
|-
| <code>serverStartTimeMs</code> || <code>int</code> || Server time at which the action began.
|}

== Examples ==
Handle the event:
<syntaxhighlight lang="lua" line>
addEventHandler("onPlayerInteractionStart", root, function(playerId, kind, actionId, serverStartTimeMs)
outputDebugString("onPlayerInteractionStart: player=" .. playerId .. " kind=" .. kind)
end)
</syntaxhighlight>

== Notes ==
* Use the specialized mining and sitting events when the interaction type matters.

[[Category:Lua Events]]
[[Category:Server Events]]
[[Category:Interaction Events]]

OnPlayerInteractionStart - Revision history

QCherry: Update Lua event reference