summaryrefslogtreecommitdiffstats
path: root/Server/Plugins/APIDump/Hooks/OnBrewingCompleting.lua
diff options
context:
space:
mode:
authorLukas Pioch <lukas@zgow.de>2015-09-24 10:48:33 +0200
committerLukas Pioch <lukas@zgow.de>2015-11-03 18:00:55 +0100
commit9749c3aac9dbfbc46a919193c97bb9c9e5339e03 (patch)
tree7ea9f3b0029bbf5041c2f05c7d3f3e156c3e6186 /Server/Plugins/APIDump/Hooks/OnBrewingCompleting.lua
parentMerge pull request #2595 from cengizIO/master (diff)
downloadcuberite-9749c3aac9dbfbc46a919193c97bb9c9e5339e03.tar
cuberite-9749c3aac9dbfbc46a919193c97bb9c9e5339e03.tar.gz
cuberite-9749c3aac9dbfbc46a919193c97bb9c9e5339e03.tar.bz2
cuberite-9749c3aac9dbfbc46a919193c97bb9c9e5339e03.tar.lz
cuberite-9749c3aac9dbfbc46a919193c97bb9c9e5339e03.tar.xz
cuberite-9749c3aac9dbfbc46a919193c97bb9c9e5339e03.tar.zst
cuberite-9749c3aac9dbfbc46a919193c97bb9c9e5339e03.zip
Diffstat (limited to 'Server/Plugins/APIDump/Hooks/OnBrewingCompleting.lua')
-rw-r--r--Server/Plugins/APIDump/Hooks/OnBrewingCompleting.lua28
1 files changed, 28 insertions, 0 deletions
diff --git a/Server/Plugins/APIDump/Hooks/OnBrewingCompleting.lua b/Server/Plugins/APIDump/Hooks/OnBrewingCompleting.lua
new file mode 100644
index 000000000..14429c8ff
--- /dev/null
+++ b/Server/Plugins/APIDump/Hooks/OnBrewingCompleting.lua
@@ -0,0 +1,28 @@
+return
+{
+ HOOK_BREWING_COMPLETING =
+ {
+ CalledWhen = "A brewing process is completing.",
+ DefaultFnName = "OnBrewingCompleting", -- also used as pagename
+ Desc = [[
+ This hook is called whenever a {{cBrewingstand|brewing stand}} is completing the brewing process. Plugins may
+ refuse the completing of the brewing process.<p>
+ See also the {{OnBrewingCompleted|HOOK_BREWING_COMPLETED}} hook for a similar hook, is called after the
+ brewing process has been completed.
+ ]],
+ Params =
+ {
+ { Name = "World", Type = "{{cWorld}}", Notes = "World where the brewing stand resides." },
+ { Name = "Brewingstand", Type = "{{cBrewingstand}}", Notes = "The brewing stand that completes the brewing process." },
+ },
+ Returns = [[
+ If the function returns false or no value, Cuberite calls other plugins with this event. If the function returns true,
+ no other plugin's callback is called and the brewing process is canceled.
+ <p>
+ ]],
+ }, -- HOOK_BREWING_COMPLETING
+}
+
+
+
+