summaryrefslogtreecommitdiffstats
path: root/MCServer
diff options
context:
space:
mode:
authormadmaxoft <github@xoft.cz>2013-10-14 09:00:28 +0200
committermadmaxoft <github@xoft.cz>2013-10-14 09:00:28 +0200
commit9d7e638aa2f0aa2528c3bf230b791159a62354e6 (patch)
tree1ba3a7cb2d2eb874f1fc94a5907d312e33dbcc80 /MCServer
parentWebAdmin honors the [WebAdmin].Enable setting. (diff)
downloadcuberite-9d7e638aa2f0aa2528c3bf230b791159a62354e6.tar
cuberite-9d7e638aa2f0aa2528c3bf230b791159a62354e6.tar.gz
cuberite-9d7e638aa2f0aa2528c3bf230b791159a62354e6.tar.bz2
cuberite-9d7e638aa2f0aa2528c3bf230b791159a62354e6.tar.lz
cuberite-9d7e638aa2f0aa2528c3bf230b791159a62354e6.tar.xz
cuberite-9d7e638aa2f0aa2528c3bf230b791159a62354e6.tar.zst
cuberite-9d7e638aa2f0aa2528c3bf230b791159a62354e6.zip
Diffstat (limited to 'MCServer')
-rw-r--r--MCServer/Plugins/APIDump/APIDesc.lua21
1 files changed, 21 insertions, 0 deletions
diff --git a/MCServer/Plugins/APIDump/APIDesc.lua b/MCServer/Plugins/APIDump/APIDesc.lua
index dc04d3e81..de25dd761 100644
--- a/MCServer/Plugins/APIDump/APIDesc.lua
+++ b/MCServer/Plugins/APIDump/APIDesc.lua
@@ -2136,6 +2136,27 @@ end;
the second value is not provided, the original message is used.
]],
}, -- HOOK_CHAT
+
+ HOOK_CHUNK_AVAILABLE =
+ {
+ CalledWhen = "A chunk has just been added to world, either generated or loaded. ",
+ DefaultFnName = "OnChunkAvailable", -- also used as pagename
+ Desc = [[
+ This hook is called after a chunk is either generated or loaded from the disk. The chunk is
+ already available for manipulation using the {{cWorld}} API. This is a notification-only callback,
+ there is no behavior that plugins could override.
+ ]],
+ Params =
+ {
+ { Name = "World", Type = "{{cWorld}}", Notes = "The world to which the chunk belongs" },
+ { 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.
+ ]],
+ }, -- HOOK_CHUNK_AVAILABLE
}, -- Hooks[]