summaryrefslogtreecommitdiffstats
path: root/MCServer/Plugins/APIDump
diff options
context:
space:
mode:
authormadmaxoft <github@xoft.cz>2013-10-16 15:44:04 +0200
committermadmaxoft <github@xoft.cz>2013-10-16 15:44:04 +0200
commit0aa20762bc0c615751e604b0b700f51e67d38a5f (patch)
tree11075904692669d0daa328ab808f85fa58bdc406 /MCServer/Plugins/APIDump
parentAPIDump: Documented HOOK_WORLD_TICK. (diff)
downloadcuberite-0aa20762bc0c615751e604b0b700f51e67d38a5f.tar
cuberite-0aa20762bc0c615751e604b0b700f51e67d38a5f.tar.gz
cuberite-0aa20762bc0c615751e604b0b700f51e67d38a5f.tar.bz2
cuberite-0aa20762bc0c615751e604b0b700f51e67d38a5f.tar.lz
cuberite-0aa20762bc0c615751e604b0b700f51e67d38a5f.tar.xz
cuberite-0aa20762bc0c615751e604b0b700f51e67d38a5f.tar.zst
cuberite-0aa20762bc0c615751e604b0b700f51e67d38a5f.zip
Diffstat (limited to '')
-rw-r--r--MCServer/Plugins/APIDump/APIDesc.lua24
1 files changed, 24 insertions, 0 deletions
diff --git a/MCServer/Plugins/APIDump/APIDesc.lua b/MCServer/Plugins/APIDump/APIDesc.lua
index f67b2f08a..42158f2e4 100644
--- a/MCServer/Plugins/APIDump/APIDesc.lua
+++ b/MCServer/Plugins/APIDump/APIDesc.lua
@@ -3052,6 +3052,30 @@ end;
}, -- HOOK_SPAWNING_MONSTER
+ 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
HOOK_WORLD_TICK =
{