diff options
author | Mattes D <github@xoft.cz> | 2015-09-06 10:05:18 +0200 |
---|---|---|
committer | Mattes D <github@xoft.cz> | 2015-09-06 10:05:18 +0200 |
commit | 7da79fdc19a9825b29cda58a698da1fa3cfb8e57 (patch) | |
tree | ec17a9703fe734956e4f151cb5306befc4fd7571 /Server/Plugins/APIDump/Hooks/OnChunkUnloaded.lua | |
parent | Merge pull request #2459 from cuberite/fixes (diff) | |
parent | Renamed output directory to Server (diff) | |
download | cuberite-7da79fdc19a9825b29cda58a698da1fa3cfb8e57.tar cuberite-7da79fdc19a9825b29cda58a698da1fa3cfb8e57.tar.gz cuberite-7da79fdc19a9825b29cda58a698da1fa3cfb8e57.tar.bz2 cuberite-7da79fdc19a9825b29cda58a698da1fa3cfb8e57.tar.lz cuberite-7da79fdc19a9825b29cda58a698da1fa3cfb8e57.tar.xz cuberite-7da79fdc19a9825b29cda58a698da1fa3cfb8e57.tar.zst cuberite-7da79fdc19a9825b29cda58a698da1fa3cfb8e57.zip |
Diffstat (limited to 'Server/Plugins/APIDump/Hooks/OnChunkUnloaded.lua')
-rw-r--r-- | Server/Plugins/APIDump/Hooks/OnChunkUnloaded.lua | 28 |
1 files changed, 28 insertions, 0 deletions
diff --git a/Server/Plugins/APIDump/Hooks/OnChunkUnloaded.lua b/Server/Plugins/APIDump/Hooks/OnChunkUnloaded.lua new file mode 100644 index 000000000..a67d5d461 --- /dev/null +++ b/Server/Plugins/APIDump/Hooks/OnChunkUnloaded.lua @@ -0,0 +1,28 @@ +return +{ + 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 +} + + + + |