TickEvent KDocs

Author: Avanatiker

common/src/main/java/com/lambda/mixin/MinecraftClientMixin.java

@@ -37,12 +37,12 @@ void onTickPost(CallbackInfo ci) {
 
     @Inject(method = "render", at = @At("HEAD"))
     void onLoopTickPre(CallbackInfo ci) {
-        EventFlow.post(new TickEvent.GameLoop.Pre());
+        EventFlow.post(new TickEvent.Render.Pre());
     }
 
     @Inject(method = "render", at = @At("RETURN"))
     void onLoopTickPost(CallbackInfo ci) {
-        EventFlow.post(new TickEvent.GameLoop.Post());
+        EventFlow.post(new TickEvent.Render.Post());
     }
 
     @Inject(at = @At(value = "INVOKE", target = "Lorg/slf4j/Logger;info(Ljava/lang/String;)V", shift = At.Shift.AFTER, remap = false), method = "stop")

common/src/main/kotlin/com/lambda/event/events/TickEvent.kt

@@ -1,58 +1,98 @@
 package com.lambda.event.events
 
 import com.lambda.event.Event
-import com.lambda.event.EventFlow
-import com.lambda.event.events.TickEvent.Post
-import com.lambda.event.events.TickEvent.Pre
 
-/**
- * An abstract class representing a [TickEvent] in the [EventFlow].
- *
- * A [TickEvent] is a type of [Event] that is triggered at each tick of the game loop.
- * It has two subclasses: [Pre] and [Post], which are triggered before and after the tick, respectively.
- *
- * The [TickEvent] class is designed to be extended by any class that needs to react to ticks.
- *
- * @see Pre
- * @see Post
- */
 abstract class TickEvent : Event {
     /**
-     * A class representing a [TickEvent] that is triggered before each tick of the tick loop.
+     * Triggered before each iteration of the game loop.
+     *
+     * Phases:
+     *
+     * 1. **Pre-Tick**: Increments uptime, steps world tick manager, decrement item use cooldown.
+     * 2. **GUI Update**: Processes delayed messages, updates HUD.
+     * 3. **Game Mode Update**: Updates targeted entity, ticks tutorial, and interaction managers.
+     * 4. **Texture Update**: Ticks texture manager.
+     * 5. **Screen Handling**: Manages screen logic, ticks current screen.
+     * 6. **Debug HUD Update**: Resets debug HUD chunk.
+     * 7. **Input Handling**: Handles input events, decrements attack cooldown.
+     * 8. **World Update**: Ticks game and world renderers, world entities.
+     * 9. **Music and Sound Update**: Ticks music tracker and sound manager.
+     * 10. **Tutorial and Social Interactions**: Handles tutorial and social interactions, ticks world.
+     * 11. **Pending Connection**: Ticks integrated server connection.
+     * 12. **Keyboard Handling**: Polls for debug crash key presses.
+     *
+     * @see net.minecraft.client.MinecraftClient.tick
      */
     class Pre : TickEvent()
 
     /**
-     * A class representing a [TickEvent] that is triggered after each tick of the tick loop.
+     * Triggered after each iteration of the game loop.
+     * Targeted at 20 ticks per second.
+     *
+     * Phases:
+     *
+     * 1. **Pre-Tick**: Increments uptime, steps world tick manager, decrement item use cooldown.
+     * 2. **GUI Update**: Processes delayed messages, updates HUD.
+     * 3. **Game Mode Update**: Updates targeted entity, ticks tutorial, and interaction managers.
+     * 4. **Texture Update**: Ticks texture manager.
+     * 5. **Screen Handling**: Manages screen logic, ticks current screen.
+     * 6. **Debug HUD Update**: Resets debug HUD chunk.
+     * 7. **Input Handling**: Handles input events, decrements attack cooldown.
+     * 8. **World Update**: Ticks game and world renderers, world entities (such as [TickEvent.Player]).
+     * 9. **Music and Sound Update**: Ticks music tracker and sound manager.
+     * 10. **Tutorial and Social Interactions**: Handles tutorial and social interactions, ticks world.
+     * 11. **Pending Connection**: Ticks integrated server connection.
+     * 12. **Keyboard Handling**: Polls for debug crash key presses.
+     *
+     * @see net.minecraft.client.MinecraftClient.tick
      */
     class Post : TickEvent()
 
     /**
-     * A class representing a [TickEvent] that is triggered on each tick of the game loop.
+     * Triggered before ([Pre]) and after ([Post]) each render tick.
+     *
+     * Phases:
+     *
+     * 1. **Pre-Render**: Prepares the window for rendering, checks for window close, handles resource reloads.
+     * 2. **Task Execution**: Executes pending render tasks.
+     * 3. **Client Tick**: Ticks the client ([TickEvent.Pre] and [TickEvent.Post]) until tick target was met.
+     * 4. **Render**: Performs the actual rendering of the game.
+     * 5. **Post-Render**: Finalizes the rendering process, updates the window.
+     *
+     * @see net.minecraft.client.MinecraftClient.render
      */
-    abstract class GameLoop : TickEvent() {
+    abstract class Render : TickEvent() {
         /**
-         * A class representing a [TickEvent.Player] that is triggered before each tick of the game loop.
+         * Triggered before each render tick ([TickEvent.Render]) of the game loop.
          */
         class Pre : TickEvent()
 
         /**
-         * A class representing a [TickEvent.Player] that is triggered after each tick of the game loop.
+         * Triggered after each render tick ([TickEvent.Render]) of the game loop.
          */
         class Post : TickEvent()
     }
 
     /**
-     * A class representing a [TickEvent] that is triggered when the player gets ticked.
+     * Triggered before ([Pre]) and after ([Post]) each player tick that is run during the game loop [TickEvent.Pre].
+     *
+     * Phases:
+     *
+     * 1. **Pre-Tick**: Prepares player state before the tick.
+     * 2. **Movement**: Handles player movement and input.
+     * 3. **Action**: Processes player actions like swinging hand.
+     * 4. **Post-Tick**: Finalizes player state after the tick.
+     *
+     * @see net.minecraft.client.network.ClientPlayerEntity.tick
      */
     abstract class Player : TickEvent() {
         /**
-         * A class representing a [TickEvent.Player] that is triggered before each player tick.
+         * Triggered before each player tick ([TickEvent.Player]).
          */
         class Pre : Player()
 
         /**
-         * A class representing a [TickEvent.Player] that is triggered after each player tick.
+         * Triggered after each player tick ([TickEvent.Player]).
          */
         class Post : Player()
     }