From d9dc241e6fe669585d7c0b13d55818a22e1c76bc Mon Sep 17 00:00:00 2001
From: madmaxoft <github@xoft.cz>
Date: Sat, 23 Nov 2013 21:26:24 +0100
Subject: APIDump: The descriptions are read from multiple files.

All the files in the Classes subfolder are read for class descriptions, and in the Hooks subfolder for the hook descriptions.
---
 .../Plugins/APIDump/Hooks/OnChunkUnloading.lua     | 30 ++++++++++++++++++++++
 1 file changed, 30 insertions(+)
 create mode 100644 MCServer/Plugins/APIDump/Hooks/OnChunkUnloading.lua

(limited to 'MCServer/Plugins/APIDump/Hooks/OnChunkUnloading.lua')

diff --git a/MCServer/Plugins/APIDump/Hooks/OnChunkUnloading.lua b/MCServer/Plugins/APIDump/Hooks/OnChunkUnloading.lua
new file mode 100644
index 000000000..cd79e2a13
--- /dev/null
+++ b/MCServer/Plugins/APIDump/Hooks/OnChunkUnloading.lua
@@ -0,0 +1,30 @@
+return
+{
+	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
+}
+
+
+
+
-- 
cgit v1.2.3