summaryrefslogtreecommitdiffstats
path: root/MCServer/Plugins/APIDump
diff options
context:
space:
mode:
authormadmaxoft <github@xoft.cz>2013-10-16 15:47:27 +0200
committermadmaxoft <github@xoft.cz>2013-10-16 15:47:27 +0200
commitd688ac8e508f6797fbcf598a875a66c46f7cfc90 (patch)
tree02aba554c5245568be95c713abe4c0a4ad52aa9a /MCServer/Plugins/APIDump
parentAPIDump: Documented HOOK_WEATHER_CHANGING. (diff)
downloadcuberite-d688ac8e508f6797fbcf598a875a66c46f7cfc90.tar
cuberite-d688ac8e508f6797fbcf598a875a66c46f7cfc90.tar.gz
cuberite-d688ac8e508f6797fbcf598a875a66c46f7cfc90.tar.bz2
cuberite-d688ac8e508f6797fbcf598a875a66c46f7cfc90.tar.lz
cuberite-d688ac8e508f6797fbcf598a875a66c46f7cfc90.tar.xz
cuberite-d688ac8e508f6797fbcf598a875a66c46f7cfc90.tar.zst
cuberite-d688ac8e508f6797fbcf598a875a66c46f7cfc90.zip
Diffstat (limited to 'MCServer/Plugins/APIDump')
-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 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.</p>
+ <p>
+ 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",