From a5e1f970a6369121a88a96e0f37328d88587dea8 Mon Sep 17 00:00:00 2001
From: joshi07 <schumacher@20ma.de>
Date: Thu, 5 Mar 2015 19:44:15 +0100
Subject: Added description to APIDump for OnEntityTeleport

---
 MCServer/Plugins/APIDump/APIDesc.lua | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

(limited to 'MCServer/Plugins')

diff --git a/MCServer/Plugins/APIDump/APIDesc.lua b/MCServer/Plugins/APIDump/APIDesc.lua
index f2ec2546a..a7a597fb7 100644
--- a/MCServer/Plugins/APIDump/APIDesc.lua
+++ b/MCServer/Plugins/APIDump/APIDesc.lua
@@ -925,8 +925,8 @@ local Hash = cCryptoHash.sha1HexString("DataToHash")
 					{ Params = "DamageType, AttackerEntity, RawDamage, KnockbackAmount", Return = "", Notes = "Causes this entity to take damage of the specified type, from the specified attacker (may be nil). The final damage is calculated from RawDamage using the currently equipped armor." },
 					{ Params = "DamageType, ArrackerEntity, RawDamage, FinalDamage, KnockbackAmount", Return = "", Notes = "Causes this entity to take damage of the specified type, from the specified attacker (may be nil). The values are wrapped into a {{TakeDamageInfo}} structure and applied directly." },
 				},
-				TeleportToCoords = { Params = "PosX, PosY, PosZ", Return = "", Notes = "Teleports the entity to the specified coords." },
-				TeleportToEntity = { Params = "DestEntity", Return = "", Notes = "Teleports this entity to the specified destination entity." },
+				TeleportToCoords = { Params = "PosX, PosY, PosZ", Return = "", Notes = "Teleports the entity to the specified coords. Asks plugins if the teleport is allowed." },
+				TeleportToEntity = { Params = "DestEntity", Return = "", Notes = "Teleports this entity to the specified destination entity. Asks plugins if the teleport is allowed." },
 			},
 			Constants =
 			{
-- 
cgit v1.2.3


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')

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