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

APIDump: Documented HOOK_WORLD_TICK.

Browse Source
This commit is contained in:
madmaxoft 2013-10-16 15:33:56 +02:00
parent 6a1149cf46
commit f8e3cbe44f
1 changed files with 24 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
MCServer/Plugins/APIDump/APIDesc.lua
View File

@ -3051,6 +3051,30 @@ end;
]],
}, -- HOOK_SPAWNING_MONSTER
HOOK_WORLD_TICK =
{
CalledWhen = "Every world tick (about 20 times per second), separately for each world",
DefaultFnName = "OnWorldTick", -- also used as pagename
Desc = [[
This hook is called for each {{cWorld|world}} every tick (50 msec, or 20 times a second). If the
world is overloaded, the interval is larger, which is indicated by the TimeDelta parameter.</p>
<p>
This hook is called in the world's tick thread context and thus has access to all world data
guaranteed without blocking.
]],
Params =
{
{ Name = "World", Type = "{{cWorld}}", Notes = "World that is ticking" },
{ Name = "TimeDelta", Type = "number", Notes = "The number of milliseconds since the previous game tick. Will not be less than 50 msec" },
},
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_WORLD_TICK
}, -- Hooks[]