summaryrefslogtreecommitdiffstats
path: root/MCServer/Plugins
diff options
context:
space:
mode:
authorAlexander Harkness <me@bearbin.net>2015-05-19 10:24:50 +0200
committerAlexander Harkness <me@bearbin.net>2015-05-19 10:24:50 +0200
commitb50135e78f9967772d585be5a62a4c282162220a (patch)
tree105a4ae13752f4cb8e87c36a5391f615217f2a7b /MCServer/Plugins
parentMerge branch 'master' of https://github.com/mc-server/MCServer (diff)
parentAdded OnEntityChangeWorld.lua and OnEntityChangedWorld.lua hooks to APIDump (diff)
downloadcuberite-b50135e78f9967772d585be5a62a4c282162220a.tar
cuberite-b50135e78f9967772d585be5a62a4c282162220a.tar.gz
cuberite-b50135e78f9967772d585be5a62a4c282162220a.tar.bz2
cuberite-b50135e78f9967772d585be5a62a4c282162220a.tar.lz
cuberite-b50135e78f9967772d585be5a62a4c282162220a.tar.xz
cuberite-b50135e78f9967772d585be5a62a4c282162220a.tar.zst
cuberite-b50135e78f9967772d585be5a62a4c282162220a.zip
Diffstat (limited to 'MCServer/Plugins')
-rw-r--r--MCServer/Plugins/APIDump/Hooks/OnEntityChangeWorld.lua29
-rw-r--r--MCServer/Plugins/APIDump/Hooks/OnEntityChangedWorld.lua28
2 files changed, 57 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
+}
+
+
+
+
+
diff --git a/MCServer/Plugins/APIDump/Hooks/OnEntityChangedWorld.lua b/MCServer/Plugins/APIDump/Hooks/OnEntityChangedWorld.lua
new file mode 100644
index 000000000..00645c152
--- /dev/null
+++ b/MCServer/Plugins/APIDump/Hooks/OnEntityChangedWorld.lua
@@ -0,0 +1,28 @@
+return
+{
+ HOOK_ENTITY_CHANGED_WORLD =
+ {
+ CalledWhen = "After a entity has changed the world.",
+ DefaultFnName = "OnEntityChangedWorld", -- also used as pagename
+ Desc = [[
+ This hook is called after the server has moved the {{cEntity|entity}} to the given world. This is an information-only
+ callback, the entity is already in the new world.<p>
+ See also the {{OnEntityChangeWorld|HOOK_ENTITY_CHANGE_WORLD}} hook for a similar hook called before the
+ entity is moved to the new world.
+ ]],
+ Params =
+ {
+ { Name = "Entity", Type = "{{cEntity}}", Notes = "The entity that has changed the world" },
+ { Name = "World", Type = "{{cWorld}}", Notes = "The world from which the entity has come" },
+ },
+ 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.
+ ]],
+ }, -- HOOK_ENTITY_CHANGED_WORLD
+}
+
+
+
+
+