summaryrefslogtreecommitdiffstats
path: root/Server/Plugins/APIDump/Hooks/OnPlayerEditedBook.lua
diff options
context:
space:
mode:
authorLukas Pioch <lukas@zgow.de>2017-07-28 12:11:07 +0200
committerLukas Pioch <lukas@zgow.de>2017-08-27 14:54:40 +0200
commitc171b272d96453f1a9d13d4623ac4bd3aa7d19e8 (patch)
tree32828d71b3de14de7489b080f07066dcf49e913e /Server/Plugins/APIDump/Hooks/OnPlayerEditedBook.lua
parentImplement anvil chunk sparsing (diff)
downloadcuberite-c171b272d96453f1a9d13d4623ac4bd3aa7d19e8.tar
cuberite-c171b272d96453f1a9d13d4623ac4bd3aa7d19e8.tar.gz
cuberite-c171b272d96453f1a9d13d4623ac4bd3aa7d19e8.tar.bz2
cuberite-c171b272d96453f1a9d13d4623ac4bd3aa7d19e8.tar.lz
cuberite-c171b272d96453f1a9d13d4623ac4bd3aa7d19e8.tar.xz
cuberite-c171b272d96453f1a9d13d4623ac4bd3aa7d19e8.tar.zst
cuberite-c171b272d96453f1a9d13d4623ac4bd3aa7d19e8.zip
Diffstat (limited to '')
-rw-r--r--Server/Plugins/APIDump/Hooks/OnPlayerEditedBook.lua26
1 files changed, 26 insertions, 0 deletions
diff --git a/Server/Plugins/APIDump/Hooks/OnPlayerEditedBook.lua b/Server/Plugins/APIDump/Hooks/OnPlayerEditedBook.lua
new file mode 100644
index 000000000..275bd129d
--- /dev/null
+++ b/Server/Plugins/APIDump/Hooks/OnPlayerEditedBook.lua
@@ -0,0 +1,26 @@
+return
+{
+ HOOK_PLAYER_EDITED_BOOK =
+ {
+ CalledWhen = "A player has edited a book.",
+ DefaultFnName = "OnPlayerEditedBook", -- also used as pagename
+ Desc = [[
+ This hook is called whenever a {{cPlayer|player}} has edited a book.
+ See also the {{OnPlayerEditingBook|HOOK_PLAYER_EDITING_BOOK}} hook for a similar hook, is called when a
+ player is editing a book.
+ ]],
+ Params =
+ {
+ { Name = "Player", Type = "{{cPlayer}}", Notes = "The player that edited the book" },
+ { Name = "BookContent", Type = "{{cBookContent}}", Notes = "The class that contains the current info of the book" },
+ },
+ Returns = [[
+ If the function returns false or no value, Cuberite calls other plugins with this event. If the
+ function returns true, no other plugin is called for this event.</p>
+ ]],
+ }, -- HOOK_PLAYER_EDITED_BOOK
+}
+
+
+
+