QCherry: Update Lua event reference

2026-08-15T09:49:21Z

Update Lua event reference

New page

= onNpcSpawn =
Triggered after a resource creates a synchronized scripted human NPC.

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

== Callback signature ==
<syntaxhighlight lang="lua">
onNpcSpawn(npcId, name, skinKey, x, y, z, sourceResource)
</syntaxhighlight>

== Parameters ==
{| class="wikitable"
! Name !! Type !! Description
|-
| <code>npcId</code> || <code>int</code> || The server-assigned NPC identifier.
|-
| <code>name</code> || <code>string</code> || The NPC's validated display name.
|-
| <code>skinKey</code> || <code>string</code> || The NPC's stable body-and-face appearance key.
|-
| <code>x</code> || <code>number</code> || Spawn X coordinate in metres.
|-
| <code>y</code> || <code>number</code> || Spawn Y coordinate in metres.
|-
| <code>z</code> || <code>number</code> || Spawn Z coordinate in metres.
|-
| <code>sourceResource</code> || <code>string</code> || The resource that owns the NPC.
|}

== Examples ==
Handle the event:
<syntaxhighlight lang="lua" line>
addEventHandler("onNpcSpawn", root, function(npcId, name, skinKey, x, y, z, sourceResource)
outputDebugString("Spawned NPC " .. name .. " (" .. npcId .. ")")
end)
</syntaxhighlight>

== Notes ==
* The complete visual state is also sent on relevance entry and late join.

[[Category:Lua Events]]
[[Category:Server Events]]
[[Category:NPC Events]]

OnNpcSpawn - Revision history

QCherry: Update Lua event reference