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/OnWeatherChanging.lua    | 32 ++++++++++++++++++++++
 1 file changed, 32 insertions(+)
 create mode 100644 MCServer/Plugins/APIDump/Hooks/OnWeatherChanging.lua

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

diff --git a/MCServer/Plugins/APIDump/Hooks/OnWeatherChanging.lua b/MCServer/Plugins/APIDump/Hooks/OnWeatherChanging.lua
new file mode 100644
index 000000000..d36164e8e
--- /dev/null
+++ b/MCServer/Plugins/APIDump/Hooks/OnWeatherChanging.lua
@@ -0,0 +1,32 @@
+return
+{
+	HOOK_WEATHER_CHANGING =
+	{
+		CalledWhen = "The weather is about to change",
+		DefaultFnName = "OnWeatherChanging",  -- also used as pagename
+		Desc = [[
+			This hook is called when the current weather has expired and a new weather is selected. Plugins may
+			override the new weather setting.</p>
+			<p>
+			The new weather setting is sent to the clients only after this hook has been processed.</p>
+			<p>
+			See also the {{OnWeatherChanged|HOOK_WEATHER_CHANGED}} hook for a similar hook called after the
+			change.
+		]],
+		Params =
+		{
+			{ Name = "World", Type = "{{cWorld}}", Notes = "World for which the weather is changing" },
+			{ Name = "Weather", Type = "number", Notes = "The newly selected weather. One of wSunny, wRain, wStorm" },
+		},
+		Returns = [[
+			If the function returns false or no value, the server calls other plugins' callbacks and finally
+			sets the weather. If the function returns true, the server takes the second returned value (wSunny
+			by default) and sets it as the new weather. No other plugins' callbacks are called in this case.
+		]],
+	},  -- HOOK_WEATHER_CHANGING
+}
+
+
+
+
+
-- 
cgit v1.2.3