API: Hint about mcl_hunger var

2017-02-22 13:33:45 +01:00 · 2017-02-22 13:33:45 +01:00 · c8d9ab48c7
parent c60cff8f81
commit c8d9ab48c7
1 changed files with 5 additions and 0 deletions
--- a/mods/PLAYER/mcl_hunger/API.md
+++ b/mods/PLAYER/mcl_hunger/API.md
@ -3,6 +3,11 @@ This API information is WIP. The mod API is still pretty much unofficial;
 this mod is mostly seen as standalone for now.
 This may change in the future development of MineClone 2. Hopefully.

+## Before using this mod
+This mod is a no-op when the game is started with damage disabled.
+Before using any of the functions, first check if global variable
+“`mcl_hunger`” is present.
+
 ## Hunger level
 The hunger level of the player is a whole number between 0 and 20 inclusive.
 0 is starving and 20 is full. The hunger level is represented in