Add documentation

Terrails · May 4, 2024 · 7f65aca · 7f65aca
1 parent d8157da
commit 7f65aca
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/neoforge/src/main/java/terrails/colorfulhearts/neoforge/api/event/NeoHeartRegistryEvent.java b/neoforge/src/main/java/terrails/colorfulhearts/neoforge/api/event/NeoHeartRegistryEvent.java
@@ -5,6 +5,11 @@
 import terrails.colorfulhearts.api.event.HeartRegistry;
 import terrails.colorfulhearts.api.heart.drawing.StatusEffectHeart;
 
+/**
+ * Used to register custom heart types. Currently, it can only be used to register status effect type hearts.
+ * IMPORTANT: Make sure to register an event listener on the mod-loader bus and not on the regular Neo bus
+ *              as the event is run before the regular event bus is initialized
+ */
 public class NeoHeartRegistryEvent extends Event implements IModBusEvent {
 
     private final HeartRegistry registry;