summaryrefslogtreecommitdiffstats
path: root/MCServer/Plugins/APIDump/Hooks/OnEntityChangingWorld.lua
diff options
context:
space:
mode:
authorLukas Pioch <lukas@zgow.de>2015-05-21 12:27:54 +0200
committerLukas Pioch <lukas@zgow.de>2015-05-21 12:27:54 +0200
commitbc838e5bd28172cf6dd1c1a4568270cb4250cac4 (patch)
treecb7d0aa34f6f3bff4ce24642c4e23a0328eb6c65 /MCServer/Plugins/APIDump/Hooks/OnEntityChangingWorld.lua
parentMerge pull request #2074 from SafwatHalaby/rmUnique (diff)
downloadcuberite-bc838e5bd28172cf6dd1c1a4568270cb4250cac4.tar
cuberite-bc838e5bd28172cf6dd1c1a4568270cb4250cac4.tar.gz
cuberite-bc838e5bd28172cf6dd1c1a4568270cb4250cac4.tar.bz2
cuberite-bc838e5bd28172cf6dd1c1a4568270cb4250cac4.tar.lz
cuberite-bc838e5bd28172cf6dd1c1a4568270cb4250cac4.tar.xz
cuberite-bc838e5bd28172cf6dd1c1a4568270cb4250cac4.tar.zst
cuberite-bc838e5bd28172cf6dd1c1a4568270cb4250cac4.zip
Diffstat (limited to 'MCServer/Plugins/APIDump/Hooks/OnEntityChangingWorld.lua')
-rw-r--r--MCServer/Plugins/APIDump/Hooks/OnEntityChangingWorld.lua29
1 files changed, 29 insertions, 0 deletions
diff --git a/MCServer/Plugins/APIDump/Hooks/OnEntityChangingWorld.lua b/MCServer/Plugins/APIDump/Hooks/OnEntityChangingWorld.lua
new file mode 100644
index 000000000..521f829c7
--- /dev/null
+++ b/MCServer/Plugins/APIDump/Hooks/OnEntityChangingWorld.lua
@@ -0,0 +1,29 @@
+return
+{
+ HOOK_ENTITY_CHANGING_WORLD =
+ {
+ CalledWhen = "Before a entity is changing the world.",
+ DefaultFnName = "OnEntityChangingWorld", -- also used as pagename
+ Desc = [[
+ This hook is called before the server moves the {{cEntity|entity}} to the given world. Plugins may
+ refuse the changing of the entity to the new world.<p>
+ See also the {{OnEntityChangedWorld|HOOK_ENTITY_CHANGED_WORLD}} hook for a similar hook is called after the
+ entity has been moved to the world.
+ ]],
+ Params =
+ {
+ { Name = "Entity", Type = "{{cEntity}}", Notes = "The entity that wants to change the world" },
+ { Name = "World", Type = "{{cWorld}}", Notes = "The world to which the entity wants to change" },
+ },
+ Returns = [[
+ If the function returns false or no value, the next plugin's callback is called. If the function
+ returns true, no other callback is called for this event and the change of the entity to the world is
+ cancelled.
+ ]],
+ }, -- HOOK_ENTITY_CHANGING_WORLD
+}
+
+
+
+
+