Differences

This shows you the differences between two versions of the page.

--- tutorial:events [2019/07/03 00:22] – clarified sheep setSheared method draylar
+++ tutorial:events [2019/07/03 00:29] – added javadoc description draylar
@@ Line 50: / Line 50: @@
 return ActionResult.PASS;
+</code>
+In the [[https://github.com/FabricMC/fabric|Fabric API]], we add Javadoc comments to the top of callback classes to document what each ActionResult does. In our case, it might be:
+<code java [enable_line_numbers="false"]>
+/**
+ * Callback for shearing a sheep.
+ * Called before the sheep is sheared, items are dropped, and items are damaged.
+ * Upon return:
+ * - SUCCESS cancels further processing and continues with normal shearing behavior.
+ * - PASS falls back to further processing and defaults to SUCCESS if no other listeners are available
+ * - FAIL cancels further processing and does not shear the sheep.
+/**
 </code>