This function is called in each server tick for each Entity that has teleported. Plugins may refuse the teleport.

Callback function

The default name for the callback function is OnEntityTeleport. It has the following signature:

function OnEntityTeleport(Entity, OldPosition, NewPosition)

Parameters:

If the function returns true, teleport is prohibited.

If the function returns false or no value, other plugins' callbacks are called and finally the new position is permanently stored in the cEntity object.

Code examples

Registering the callback

cPluginManager:AddHook(cPluginManager.HOOK_ENTITY_TELEPORT, MyOnEntityTeleport);