From e5f3ad873eb3ffac5fdf2c9a2f726e270fb3734b Mon Sep 17 00:00:00 2001
From: Glease <4586901+Glease@users.noreply.github.com>
Date: Wed, 18 Oct 2023 15:36:31 +0800
Subject: [PATCH] add a bit javadoc

Signed-off-by: Glease <4586901+Glease@users.noreply.github.com>
---
 .../structurelib/structure/StructureUtility.java            | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

diff --git a/src/main/java/com/gtnewhorizon/structurelib/structure/StructureUtility.java b/src/main/java/com/gtnewhorizon/structurelib/structure/StructureUtility.java
index fba7b170..b735e3d1 100644
--- a/src/main/java/com/gtnewhorizon/structurelib/structure/StructureUtility.java
+++ b/src/main/java/com/gtnewhorizon/structurelib/structure/StructureUtility.java
@@ -577,6 +577,9 @@ public class StructureUtility {
      * Implementation wise, this allows a block only when we don't yet have a tier, or the block at that location has
      * the same tier as we already have.
      * <p>
+     * Notice that if your tier extractor function returns null on any (Block, meta) pair, then it means this block is
+     * rejected, since null can never be a valid tier.
+     * <p>
      * There is yet no TileEntity counterpart of this utility. Feel free to submit a PR to add it.
      * <p>
      * For most typical use cases, you will NOT want to return notSet from your tierExtractor. If you do so, we will
@@ -620,7 +623,8 @@ public class StructureUtility {
      * </pre>
      *
      * @param tierExtractor a function to extract tier info from a block. This function can return null and will never
-     *                      be passed a null block or an invalid block meta.
+     *                      be passed a null block or an invalid block meta. If this function returns null, then the block
+     *                      would be considered invalid.
      * @param allKnownTiers A list of all known tiers as of calling. Can be empty or null. No hint will be spawned if
      *                      empty or null. Cannot have null elements. First element denotes the most primitive tier.
      *                      Last element denotes the most advanced tier. If not all tiers are available at definition