From 0b71b3bd141816869eb19b3a9841a8d16f5e4be9 Mon Sep 17 00:00:00 2001
From: madmaxoft <github@xoft.cz>
Date: Mon, 14 Oct 2013 15:50:11 +0200
Subject: APIDump: Documented HOOK_CHUNK_UNLOADING.

---
 MCServer/Plugins/APIDump/APIDesc.lua | 23 +++++++++++++++++++++++
 1 file changed, 23 insertions(+)

(limited to 'MCServer/Plugins/APIDump')

diff --git a/MCServer/Plugins/APIDump/APIDesc.lua b/MCServer/Plugins/APIDump/APIDesc.lua
index 6be0b6887..013b3c69e 100644
--- a/MCServer/Plugins/APIDump/APIDesc.lua
+++ b/MCServer/Plugins/APIDump/APIDesc.lua
@@ -2274,6 +2274,29 @@ end;
 			]],
 		},  -- HOOK_CHUNK_UNLOADED
 
+		HOOK_CHUNK_UNLOADING =
+		{
+			CalledWhen = " 	A chunk is about to be unloaded from the memory. Plugins may refuse the unload.",
+			DefaultFnName = "OnChunkUnloading",  -- also used as pagename
+			Desc = [[
+				MCServer calls this function when a chunk is about to be unloaded from the memory. A plugin may
+				force MCServer to keep the chunk in memory by returning true.</p>
+				<p>
+				FIXME: The return value should be used only for event propagation stopping, not for the actual
+				decision whether to unload.
+			]],
+			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 and finally MCServer
+				unloads the chunk. If the function returns true, no other callback is called for this event and the
+				chunk is left in the memory.
+			]],
+		},  -- HOOK_CHUNK_UNLOADING
 	},  -- Hooks[]
 	
 
-- 
cgit v1.2.3