OnNpcDimensionChange

onNpcDimensionChange

AVAILABLE FROM UPDATE 0.1.8

This event is available in G1R:MP 0.1.8 and later. The contract below includes the compatibility guarantees introduced in that update.

Emitted after an actual successful server-side dimension change of a human NPC.

Availability

This event is available in server-side scripts.

Callback signature

function(npcId, oldDimension, newDimension)

Parameters

Name	Type	Description
npcId	number	Numeric NPC ID returned by spawnNpc; not a player ID.
oldDimension	number	Previous dimension.
newDimension	number	New dimension accepted by the server.

Examples

addEventHandler("onNpcDimensionChange", root,
    function(npcId, oldDimension, newDimension)
        outputDebugString("Dimension " .. oldDimension .. " -> " .. newDimension)
    end)

Notes

• Available since 0.1.8 / Protocol 40. Both client and server must update together.
• Register on root. This is a server-local event, not a client rendering or transition-readiness acknowledgement.
• Not emitted for an unchanged dimension, rejected setter, initial spawn or ordinary connection.
• See Character dimensions. Avoid unbounded recursive dimension changes inside this handler.