flewkey/cuberite-2a
1
0
Fork 0
Code Releases Activity

Merge pull request #1791 from joshi07/master

Browse Source 
Added OnEntityTeleport.lua + description to APIDump
This commit is contained in:
Tiger Wang 2015-03-05 20:28:59 +00:00
commit 6d62a51d53
2 changed files with 31 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
MCServer/Plugins/APIDump/APIDesc.lua
View File

@ -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 =
{

29
MCServer/Plugins/APIDump/Hooks/OnEntityTeleport.lua Normal file
View File

@ -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
}