add documentation

Terrails · May 7, 2024 · 3fca38f · 3fca38f
1 parent 3892cd4
commit 3fca38f
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/fabric/src/main/java/terrails/colorfulhearts/fabric/api/event/FabHeartEvents.java b/fabric/src/main/java/terrails/colorfulhearts/fabric/api/event/FabHeartEvents.java
@@ -14,6 +14,9 @@ public class FabHeartEvents {
     public static final Event<Consumer<HeartRenderEvent.Pre>> PRE_RENDER = createEvent();
     public static final Event<Consumer<HeartRenderEvent.Post>> POST_RENDER = createEvent();
 
+    /**
+     * Just an empty event used to notify about in-game changes from the Config Screen
+     */
     public static final Event<Runnable> UPDATE = EventFactory.createArrayBacked(Runnable.class, listeners -> () -> {
         for (Runnable listener : listeners) {
             listener.run();