From 059e2b80f6d8e8ef89350c323836d9933d9241e4 Mon Sep 17 00:00:00 2001
From: md_5 <git@md-5.net>
Date: Fri, 20 Jul 2018 09:58:45 +1000
Subject: SPIGOT-4075: Add documentation to Levelled regarding fluids

---
 src/main/java/org/bukkit/block/data/Levelled.java | 6 ++++++
 1 file changed, 6 insertions(+)

(limited to 'src/main/java/org')

diff --git a/src/main/java/org/bukkit/block/data/Levelled.java b/src/main/java/org/bukkit/block/data/Levelled.java
index 9eb10290..87610dc9 100644
--- a/src/main/java/org/bukkit/block/data/Levelled.java
+++ b/src/main/java/org/bukkit/block/data/Levelled.java
@@ -4,6 +4,12 @@ package org.bukkit.block.data;
  * 'level' represents the amount of fluid contained within this block, either by
  * itself or inside a cauldron.
  * <br>
+ * In the case of water and lava blocks the levels have special meanings: a
+ * level of 0 corresponds to a source block, 1-7 regular fluid heights, and 8-15
+ * to "falling" fluids. All falling fluids have the same behaviour, but the
+ * level corresponds to that of the block above them, equal to
+ * <code>this.level - 8</code>
+ * <br>
  * May not be higher than {@link #getMaximumLevel()}.
  */
 public interface Levelled extends BlockData {
-- 
cgit v1.2.3