This hook is called before the server moves the entity to the given world. Plugins may refuse the changing of the entity to the new world.

See also the HOOK_ENTITY_CHANGED_WORLD hook for a similar hook is called after the entity has been moved to the world.

Callback function

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

function OnEntityChangingWorld(Entity, World)

Parameters:

If the function returns false or no value, the next plugin's callback is called. If the function returns true, no other callback is called for this event and the change of the entity to the world is cancelled.

Code examples

Registering the callback

cPluginManager:AddHook(cPluginManager.HOOK_ENTITY_CHANGING_WORLD, MyOnEntityChangingWorld);