summaryrefslogtreecommitdiffstats
path: root/src/main
diff options
context:
space:
mode:
authormd_5 <git@md-5.net>2018-07-20 09:58:45 +1000
committermd_5 <git@md-5.net>2018-07-20 09:58:45 +1000
commit059e2b80f6d8e8ef89350c323836d9933d9241e4 (patch)
treed61a6c190b12f89bb63cbab486387640bcaf7b38 /src/main
parent0bfac352ece5fd5bca7b8476eb233579a0772fab (diff)
downloadbukkit-059e2b80f6d8e8ef89350c323836d9933d9241e4.tar
bukkit-059e2b80f6d8e8ef89350c323836d9933d9241e4.tar.gz
bukkit-059e2b80f6d8e8ef89350c323836d9933d9241e4.tar.lz
bukkit-059e2b80f6d8e8ef89350c323836d9933d9241e4.tar.xz
bukkit-059e2b80f6d8e8ef89350c323836d9933d9241e4.zip
SPIGOT-4075: Add documentation to Levelled regarding fluids
Diffstat (limited to 'src/main')
-rw-r--r--src/main/java/org/bukkit/block/data/Levelled.java6
1 files changed, 6 insertions, 0 deletions
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 {