summaryrefslogtreecommitdiffstats
path: root/MCServer/Plugins/APIDump/Hooks
diff options
context:
space:
mode:
Diffstat (limited to 'MCServer/Plugins/APIDump/Hooks')
-rw-r--r--MCServer/Plugins/APIDump/Hooks/OnWorldStarted.lua24
1 files changed, 24 insertions, 0 deletions
diff --git a/MCServer/Plugins/APIDump/Hooks/OnWorldStarted.lua b/MCServer/Plugins/APIDump/Hooks/OnWorldStarted.lua
new file mode 100644
index 000000000..61e3de86e
--- /dev/null
+++ b/MCServer/Plugins/APIDump/Hooks/OnWorldStarted.lua
@@ -0,0 +1,24 @@
+return
+{
+ HOOK_WORLD_STARTED =
+ {
+ CalledWhen = "A {{cWorld|world}} is initialized",
+ DefaultFnName = "OnWorldStarted", -- also used as pagename
+ Desc = [[
+ This hook is called whenever a {{cWorld|world}} is initialized.
+ ]],
+ Params =
+ {
+ { Name = "World", Type = "{{cWorld}}", Notes = "World that is started" },
+ },
+ 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_STARTED
+}
+
+
+
+
+