summaryrefslogtreecommitdiffstats
path: root/MCServer/Plugins
diff options
context:
space:
mode:
authormadmaxoft <github@xoft.cz>2013-10-14 15:46:01 +0200
committermadmaxoft <github@xoft.cz>2013-10-14 15:46:01 +0200
commit37ea7ec0c1e9b278a53d0cc1485e216099ea1eee (patch)
tree4ba2ccd33437cd32aa097b6fd72c57aafe65d1fb /MCServer/Plugins
parentAPIDump: Documented HOOK_CHUNK_GENERATING. (diff)
downloadcuberite-37ea7ec0c1e9b278a53d0cc1485e216099ea1eee.tar
cuberite-37ea7ec0c1e9b278a53d0cc1485e216099ea1eee.tar.gz
cuberite-37ea7ec0c1e9b278a53d0cc1485e216099ea1eee.tar.bz2
cuberite-37ea7ec0c1e9b278a53d0cc1485e216099ea1eee.tar.lz
cuberite-37ea7ec0c1e9b278a53d0cc1485e216099ea1eee.tar.xz
cuberite-37ea7ec0c1e9b278a53d0cc1485e216099ea1eee.tar.zst
cuberite-37ea7ec0c1e9b278a53d0cc1485e216099ea1eee.zip
Diffstat (limited to '')
-rw-r--r--MCServer/Plugins/APIDump/APIDesc.lua22
1 files changed, 22 insertions, 0 deletions
diff --git a/MCServer/Plugins/APIDump/APIDesc.lua b/MCServer/Plugins/APIDump/APIDesc.lua
index 578d6aeab..6be0b6887 100644
--- a/MCServer/Plugins/APIDump/APIDesc.lua
+++ b/MCServer/Plugins/APIDump/APIDesc.lua
@@ -2252,6 +2252,28 @@ end;
]],
}, -- HOOK_CHUNK_GENERATING
+ HOOK_CHUNK_UNLOADED =
+ {
+ CalledWhen = "A chunk has been unloaded from the memory.",
+ DefaultFnName = "OnChunkUnloaded", -- also used as pagename
+ Desc = [[
+ This hook is called when a chunk is unloaded from the memory. Though technically still in memory,
+ the plugin should behave as if the chunk was already not present. In particular, {{cWorld}} block
+ API should not be used in the area of the specified chunk.
+ ]],
+ Params =
+ {
+ { Name = "World", Type = "{{cWorld}}", Notes = "The world from which the chunk is unloading" },
+ { Name = "ChunkX", Type = "number", Notes = "X-coord of the chunk" },
+ { Name = "ChunkZ", Type = "number", Notes = "Z-coord of the chunk" },
+ },
+ 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. There is no behavior that plugins could
+ override.
+ ]],
+ }, -- HOOK_CHUNK_UNLOADED
+
}, -- Hooks[]