summaryrefslogtreecommitdiffstats
path: root/Server/Plugins/APIDump/Hooks/OnPlayerEditingBook.lua
blob: 455bf4f69fe93d7d64799bed910a17afc76760f5 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
return
{
	HOOK_PLAYER_EDITING_BOOK =
	{
		CalledWhen = "A player is editing a book.",
		DefaultFnName = "OnPlayerEditingBook",  -- also used as pagename
		Desc = [[
			This hook is called whenever a {{cPlayer|player}} is editing a book.
			See also the {{OnPlayerEditingBook|HOOK_PLAYER_EDITED_BOOK}} hook for a similar hook, is called when a
			player has edited a book.
		]],
		Params =
		{
			{ Name = "Player", Type = "cPlayer", Notes = "The player that is editing the book" },
			{ Name = "BookContent", Type = "cBookContent", Notes = "The class that contains the current info of the book" },
			{ Name = "IsSigned", Type = "boolean", Notes = "Player is signing 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's callback is called and the editing of the book is denied.
		]],
	},  -- HOOK_PLAYER_EDITING_BOOK
}