summaryrefslogtreecommitdiffstats
path: root/MCServer/Plugins/APIDump
diff options
context:
space:
mode:
authorjoshi07 <schumacher@20ma.de>2015-03-05 20:08:32 +0100
committerjoshi07 <schumacher@20ma.de>2015-03-05 20:08:32 +0100
commit3cef52a7f722e9ecc0e71f6e7a7e7b991dbf6dac (patch)
treec105b707fd53dce9fd7ad3c4010bb44f94ffb427 /MCServer/Plugins/APIDump
parentAdded description to APIDump for OnEntityTeleport (diff)
downloadcuberite-3cef52a7f722e9ecc0e71f6e7a7e7b991dbf6dac.tar
cuberite-3cef52a7f722e9ecc0e71f6e7a7e7b991dbf6dac.tar.gz
cuberite-3cef52a7f722e9ecc0e71f6e7a7e7b991dbf6dac.tar.bz2
cuberite-3cef52a7f722e9ecc0e71f6e7a7e7b991dbf6dac.tar.lz
cuberite-3cef52a7f722e9ecc0e71f6e7a7e7b991dbf6dac.tar.xz
cuberite-3cef52a7f722e9ecc0e71f6e7a7e7b991dbf6dac.tar.zst
cuberite-3cef52a7f722e9ecc0e71f6e7a7e7b991dbf6dac.zip
Diffstat (limited to 'MCServer/Plugins/APIDump')
-rw-r--r--MCServer/Plugins/APIDump/Hooks/OnEntityTeleport.lua29
1 files changed, 29 insertions, 0 deletions
diff --git a/MCServer/Plugins/APIDump/Hooks/OnEntityTeleport.lua b/MCServer/Plugins/APIDump/Hooks/OnEntityTeleport.lua
new file mode 100644
index 000000000..cdeb0947f
--- /dev/null
+++ b/MCServer/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
+}
+
+
+
+
+