From d688ac8e508f6797fbcf598a875a66c46f7cfc90 Mon Sep 17 00:00:00 2001
From: madmaxoft
Date: Wed, 16 Oct 2013 15:47:27 +0200
Subject: APIDump: Documented HOOK_WEATHER_CHANGED.
---
MCServer/Plugins/APIDump/APIDesc.lua | 21 +++++++++++++++++++++
1 file changed, 21 insertions(+)
(limited to 'MCServer/Plugins/APIDump/APIDesc.lua')
diff --git a/MCServer/Plugins/APIDump/APIDesc.lua b/MCServer/Plugins/APIDump/APIDesc.lua
index 42158f2e4..e7352beed 100644
--- a/MCServer/Plugins/APIDump/APIDesc.lua
+++ b/MCServer/Plugins/APIDump/APIDesc.lua
@@ -3052,6 +3052,27 @@ end;
}, -- HOOK_SPAWNING_MONSTER
+ HOOK_WEATHER_CHANGED =
+ {
+ CalledWhen = "The weather has changed",
+ DefaultFnName = "OnWeatherChanged", -- also used as pagename
+ Desc = [[
+ This hook is called after the weather has changed in a {{cWorld|world}}. The new weather has already
+ been sent to the clients.
+
+ See also the {{OnWeatherChanging|HOOK_WEATHER_CHANGING}} hook for a similar hook called before the
+ change.
+ ]],
+ Params =
+ {
+ { Name = "World", Type = "{{cWorld}}", Notes = "World for which the weather has changed" },
+ },
+ 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 overridable behavior.
+ ]],
+ }, -- HOOK_WEATHER_CHANGED
+
HOOK_WEATHER_CHANGING =
{
CalledWhen = "The weather is about to change",
--
cgit v1.2.3