From 5a152435b3fa1452a842519e21ab0643020bc1ab Mon Sep 17 00:00:00 2001
From: Howaner <franzi.moos@googlemail.com>
Date: Mon, 30 Jun 2014 15:22:48 +0200
Subject: [PATCH] Add documentation.

---
 .../APIDump/Hooks/OnPlayerFoodLevelChange.lua | 22 +++++++++++++++++++
 1 file changed, 22 insertions(+)
 create mode 100644 MCServer/Plugins/APIDump/Hooks/OnPlayerFoodLevelChange.lua

diff --git a/MCServer/Plugins/APIDump/Hooks/OnPlayerFoodLevelChange.lua b/MCServer/Plugins/APIDump/Hooks/OnPlayerFoodLevelChange.lua
new file mode 100644
index 000000000..4838573e5
--- /dev/null
+++ b/MCServer/Plugins/APIDump/Hooks/OnPlayerFoodLevelChange.lua
@@ -0,0 +1,22 @@
+return
+{
+	HOOK_PLAYER_FOOD_LEVEL_CHANGE =
+	{
+		CalledWhen = "Called before the player food level changed. Plugin may override / refuse.",
+		DefaultFnName = "OnPlayerFoodLevelChange", -- also used as pagename
+		Desc = [[
+			This hook is called just before the food level change.
+			The food level is not yet changed, plugins may choose to override the new food level or refuse the change.
+		]],
+		Params =
+		{
+			{ Name = "Player", Type = "{{cPlayer}}", Notes = "The player who change the food level." },
+			{ Name = "NewFoodLevel", Type = "number", Notes = "The new food level." },
+		},
+		Returns = [[
+			If the function returns false or no value, the next plugin's callback is called. Afterwards, the
+			server change the food level from the player. If the function returns true, no
+			other callback is called for this event and the player's food level doesn't change.
+		]],
+	}, -- HOOK_PLAYER_FOOD_LEVEL_CHANGE
+};