diff options
Diffstat (limited to 'Server/Plugins/APIDump/Hooks/OnEntityTeleport.lua')
| -rw-r--r-- | Server/Plugins/APIDump/Hooks/OnEntityTeleport.lua | 29 |
1 files changed, 29 insertions, 0 deletions
diff --git a/Server/Plugins/APIDump/Hooks/OnEntityTeleport.lua b/Server/Plugins/APIDump/Hooks/OnEntityTeleport.lua new file mode 100644 index 000000000..cdeb0947f --- /dev/null +++ b/Server/Plugins/APIDump/Hooks/OnEntityTeleport.lua @@ -0,0 +1,29 @@ +return +{ + HOOK_ENTITY_TELEPORT = + { + CalledWhen = "Any entity teleports. Plugin may refuse teleport.", + DefaultFnName = "OnEntityTeleport", -- also used as pagename + Desc = [[ + This function is called in each server tick for each {{cEntity|Entity}} that has + teleported. Plugins may refuse the teleport. + ]], + Params = + { + { Name = "Entity", Type = "{{cEntity}}", Notes = "The entity who has teleported. New position is set in the object after successfull teleport" }, + { Name = "OldPosition", Type = "{{Vector3d}}", Notes = "The old position." }, + { Name = "NewPosition", Type = "{{Vector3d}}", Notes = "The new position." }, + }, + Returns = [[ + If the function returns true, teleport is prohibited.</p> + <p> + 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.</p> + ]], + }, -- HOOK_ENTITY_TELEPORT +} + + + + + |