Document PropertyDelegateHolderunstable/2.0

1 files changed, 14 insertions, 0 deletions

diff --git a/src/main/java/io/github/cottonmc/cotton/gui/PropertyDelegateHolder.java b/src/main/java/io/github/cottonmc/cotton/gui/PropertyDelegateHolder.java
index 5b33320..af61892 100644
--- a/src/main/java/io/github/cottonmc/cotton/gui/PropertyDelegateHolder.java
+++ b/src/main/java/io/github/cottonmc/cotton/gui/PropertyDelegateHolder.java
@@ -2,6 +2,20 @@ package io.github.cottonmc.cotton.gui;
 
 import net.minecraft.screen.PropertyDelegate;
 
+/**
+ * This interface can be implemented on block entity classes
+ * for providing a property delegate.
+ *
+ * @see CottonInventoryController#getBlockPropertyDelegate(net.minecraft.screen.ScreenHandlerContext)
+ */
 public interface PropertyDelegateHolder {
+	/**
+	 * Gets this block entity's property delegate.
+	 *
+	 * <p>On the client, the returned property delegate <b>must</b> have a working implementation of
+	 * {@link PropertyDelegate#set(int, int)}.
+	 *
+	 * @return the property delegate
+	 */
 	public PropertyDelegate getPropertyDelegate();
 }