summaryrefslogtreecommitdiffstats
path: root/MCServer/Plugins/APIDump/Hooks/OnEntityChangeWorld.lua
diff options
context:
space:
mode:
authortycho <work.tycho@gmail.com>2015-05-19 12:55:23 +0200
committertycho <work.tycho@gmail.com>2015-05-19 12:55:23 +0200
commit95e06ab93ff98c7bcffcf8a68a479802c8a56fe3 (patch)
tree87e8224964c12b746e34701dfffbcd3201889cdf /MCServer/Plugins/APIDump/Hooks/OnEntityChangeWorld.lua
parentFixed a lot of warnings (diff)
parentMerge pull request #2019 from mc-server/OverrideArgs (diff)
downloadcuberite-95e06ab93ff98c7bcffcf8a68a479802c8a56fe3.tar
cuberite-95e06ab93ff98c7bcffcf8a68a479802c8a56fe3.tar.gz
cuberite-95e06ab93ff98c7bcffcf8a68a479802c8a56fe3.tar.bz2
cuberite-95e06ab93ff98c7bcffcf8a68a479802c8a56fe3.tar.lz
cuberite-95e06ab93ff98c7bcffcf8a68a479802c8a56fe3.tar.xz
cuberite-95e06ab93ff98c7bcffcf8a68a479802c8a56fe3.tar.zst
cuberite-95e06ab93ff98c7bcffcf8a68a479802c8a56fe3.zip
Diffstat (limited to '')
-rw-r--r--MCServer/Plugins/APIDump/Hooks/OnEntityChangeWorld.lua29
1 files changed, 29 insertions, 0 deletions
diff --git a/MCServer/Plugins/APIDump/Hooks/OnEntityChangeWorld.lua b/MCServer/Plugins/APIDump/Hooks/OnEntityChangeWorld.lua
new file mode 100644
index 000000000..25072ca5c
--- /dev/null
+++ b/MCServer/Plugins/APIDump/Hooks/OnEntityChangeWorld.lua
@@ -0,0 +1,29 @@
+return
+{
+ HOOK_ENTITY_CHANGE_WORLD =
+ {
+ CalledWhen = "Before a entity is changing the world.",
+ DefaultFnName = "OnEntityChangeWorld", -- 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_CHANGE_WORLD
+}
+
+
+
+
+