flewkey/cuberite-2a
1
0
Fork 0
Code Releases Activity

APIDump: Updated OnWeatherChanging docs after latest code changes.

Browse Source
This commit is contained in:
madmaxoft 2014-07-03 17:53:57 +02:00
parent 2dbed03cbc
commit 20afd5d70e
1 changed files with 7 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
MCServer/Plugins/APIDump/Hooks/OnWeatherChanging.lua
View File

@ -6,7 +6,7 @@ return
DefaultFnName = "OnWeatherChanging", -- also used as pagename DefaultFnName = "OnWeatherChanging", -- also used as pagename
Desc = [[ Desc = [[
This hook is called when the current weather has expired and a new weather is selected. Plugins may This hook is called when the current weather has expired and a new weather is selected. Plugins may
override the new weather setting.</p> override the new weather being set.</p>
<p> <p>
The new weather setting is sent to the clients only after this hook has been processed.</p> The new weather setting is sent to the clients only after this hook has been processed.</p>
<p> <p>
@ -19,9 +19,12 @@ return
{ Name = "Weather", Type = "number", Notes = "The newly selected weather. One of wSunny, wRain, wStorm" }, { Name = "Weather", Type = "number", Notes = "The newly selected weather. One of wSunny, wRain, wStorm" },
}, },
Returns = [[ Returns = [[
If the function returns false or no value, the server calls other plugins' callbacks and finally The hook handler can return up to two values. If the first value is false or not present, the server
sets the weather. If the function returns true, the server takes the second returned value (wSunny calls other plugins' callbacks and finally sets the weather. If it is true, the server doesn't call any
by default) and sets it as the new weather. No other plugins' callbacks are called in this case. more callbacks for this hook. The second value returned is used as the new weather. If no value is
given, the weather from the parameters is used as the weather. Returning false as the first value and a
specific weather constant as the second value makes the server call the rest of the hook handlers with
the new weather value.
]], ]],
}, -- HOOK_WEATHER_CHANGING }, -- HOOK_WEATHER_CHANGING
} }