From 3cef52a7f722e9ecc0e71f6e7a7e7b991dbf6dac Mon Sep 17 00:00:00 2001
From: joshi07 <schumacher@20ma.de>
Date: Thu, 5 Mar 2015 20:08:32 +0100
Subject: Added OnEntityTeleport.lua hook to APIDump

---
 .../Plugins/APIDump/Hooks/OnEntityTeleport.lua     | 29 ++++++++++++++++++++++
 1 file changed, 29 insertions(+)
 create mode 100644 MCServer/Plugins/APIDump/Hooks/OnEntityTeleport.lua

(limited to 'MCServer/Plugins/APIDump/Hooks/OnEntityTeleport.lua')

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
+}
+
+
+
+
+
-- 
cgit v1.2.3