Merge pull request #283 from toxicity188/codex/implement-hitboxevent-interface-and-refactor

Codex-generated pull request

Author: toxicity188

api/src/main/java/kr/toxicity/model/api/event/ModelInteractAtEvent.java

@@ -4,8 +4,10 @@
  * Licensed under the MIT License.
  * See LICENSE.md file for full license text.
  */
-package kr.toxicity.model.api.event;
+package kr.toxicity.model.api.event.hitbox;
 
+import kr.toxicity.model.api.event.CancellableEvent;
+import kr.toxicity.model.api.event.ModelDamageSource;
 import kr.toxicity.model.api.nms.HitBox;
 import lombok.Getter;
 import lombok.Setter;
@@ -22,7 +24,7 @@
  */
 @Getter
 @Setter
-public final class ModelDamagedEvent implements CancellableEvent {
+public final class HitBoxDamagedEvent implements CancellableEvent, HitBoxEvent {
 
     private final @NotNull HitBox hitBox;
     private final ModelDamageSource source;
@@ -39,7 +41,7 @@ public final class ModelDamagedEvent implements CancellableEvent {
      * @since 2.0.0
      */
     @ApiStatus.Internal
-    public ModelDamagedEvent(@NotNull HitBox hitBox, @NotNull ModelDamageSource source, float damage) {
+    public HitBoxDamagedEvent(@NotNull HitBox hitBox, @NotNull ModelDamageSource source, float damage) {
         this.hitBox = hitBox;
         this.source = source;
         this.damage = damage;

…y/model/api/event/ModelDamagedEvent.java …api/event/hitbox/HitBoxDamagedEvent.javaapi/src/main/java/kr/toxicity/model/api/event/ModelDamagedEvent.java renamed to api/src/main/java/kr/toxicity/model/api/event/hitbox/HitBoxDamagedEvent.java api/src/main/java/kr/toxicity/model/api/event/ModelDamagedEvent.java renamed to api/src/main/java/kr/toxicity/model/api/event/hitbox/HitBoxDamagedEvent.java

@@ -0,0 +1,25 @@
+/**
+ * This source file is part of BetterModel.
+ * Copyright (c) 2024–2026 toxicity188
+ * Licensed under the MIT License.
+ * See LICENSE.md file for full license text.
+ */
+package kr.toxicity.model.api.event.hitbox;
+
+import kr.toxicity.model.api.nms.HitBox;
+import kr.toxicity.model.api.platform.PlatformEntity;
+import org.jetbrains.annotations.NotNull;
+
+/**
+ * An event called when an entity dismounts from a hit box.
+ *
+ * @param hitBox the hit box
+ * @param entity the entity
+ * @since 2.1.0
+ */
+public record HitBoxDismountEvent(@NotNull HitBox hitBox, @NotNull PlatformEntity entity) implements HitBoxEvent {
+    @Override
+    public @NotNull HitBox getHitBox() {
+        return hitBox;
+    }
+}

api/src/main/java/kr/toxicity/model/api/event/hitbox/HitBoxDismountEvent.java

@@ -0,0 +1,28 @@
+/**
+ * This source file is part of BetterModel.
+ * Copyright (c) 2024–2026 toxicity188
+ * Licensed under the MIT License.
+ * See LICENSE.md file for full license text.
+ */
+package kr.toxicity.model.api.event.hitbox;
+
+import kr.toxicity.model.api.event.ModelEvent;
+import kr.toxicity.model.api.nms.HitBox;
+import org.jetbrains.annotations.NotNull;
+
+/**
+ * Base contract for events associated with a {@link HitBox}.
+ *
+ * @since 2.1.0
+ */
+public interface HitBoxEvent extends ModelEvent {
+
+    /**
+     * Returns the target hitbox of this event.
+     *
+     * @return target hitbox
+     * @since 2.1.0
+     */
+    @NotNull HitBox getHitBox();
+}
+

api/src/main/java/kr/toxicity/model/api/event/hitbox/HitBoxEvent.java

@@ -0,0 +1,53 @@
+/**
+ * This source file is part of BetterModel.
+ * Copyright (c) 2024–2026 toxicity188
+ * Licensed under the MIT License.
+ * See LICENSE.md file for full license text.
+ */
+package kr.toxicity.model.api.event.hitbox;
+
+import kr.toxicity.model.api.event.CancellableEvent;
+import kr.toxicity.model.api.nms.HitBox;
+import kr.toxicity.model.api.nms.ModelInteractionHand;
+import kr.toxicity.model.api.platform.PlatformPlayer;
+import lombok.Getter;
+import lombok.Setter;
+import org.jetbrains.annotations.ApiStatus;
+import org.jetbrains.annotations.NotNull;
+import org.joml.Vector3f;
+
+/**
+ * Triggered when a player interacts with a model's hitbox at some position.
+ * <p>
+ * This event corresponds to a right-click interaction.
+ * </p>
+ *
+ * @since 2.0.0
+ */
+@Getter
+public class HitBoxInteractAtEvent implements CancellableEvent, HitBoxEvent {
+
+    @Setter
+    private boolean cancelled;
+    private final PlatformPlayer who;
+    private final @NotNull HitBox hitBox;
+    private final @NotNull ModelInteractionHand hand;
+    private final @NotNull Vector3f position;
+
+    /**
+     * Creates a new HitBoxInteractAtEvent.
+     *
+     * @param who the player interacting
+     * @param hitBox the hitbox being interacted with
+     * @param hand the hand used for interaction
+     * @param position position
+     * @since 2.0.0
+     */
+    @ApiStatus.Internal
+    public HitBoxInteractAtEvent(@NotNull PlatformPlayer who, @NotNull HitBox hitBox, @NotNull ModelInteractionHand hand, @NotNull Vector3f position) {
+        this.who = who;
+        this.hitBox = hitBox;
+        this.hand = hand;
+        this.position = position;
+    }
+}

api/src/main/java/kr/toxicity/model/api/event/hitbox/HitBoxInteractAtEvent.java

@@ -4,8 +4,9 @@
  * Licensed under the MIT License.
  * See LICENSE.md file for full license text.
  */
-package kr.toxicity.model.api.event;
+package kr.toxicity.model.api.event.hitbox;
 
+import kr.toxicity.model.api.event.CancellableEvent;
 import kr.toxicity.model.api.nms.HitBox;
 import kr.toxicity.model.api.nms.ModelInteractionHand;
 import kr.toxicity.model.api.platform.PlatformPlayer;
@@ -23,26 +24,26 @@
  * @since 2.0.0
  */
 @Getter
-public class ModelInteractEvent implements CancellableEvent {
+public class HitBoxInteractEvent implements CancellableEvent, HitBoxEvent {
 
     @Setter
     private boolean cancelled;
     private final PlatformPlayer who;
-    private final @NotNull HitBox hitbox;
+    private final @NotNull HitBox hitBox;
     private final @NotNull ModelInteractionHand hand;
 
     /**
-     * Creates a new ModelInteractEvent.
+     * Creates a new HitBoxInteractEvent.
      *
      * @param who the player interacting
-     * @param hitbox the hitbox being interacted with
+     * @param hitBox the hitbox being interacted with
      * @param hand the hand used for interaction
      * @since 2.0.0
      */
     @ApiStatus.Internal
-    public ModelInteractEvent(@NotNull PlatformPlayer who, @NotNull HitBox hitbox, @NotNull ModelInteractionHand hand) {
+    public HitBoxInteractEvent(@NotNull PlatformPlayer who, @NotNull HitBox hitBox, @NotNull ModelInteractionHand hand) {
         this.who = who;
-        this.hitbox = hitbox;
+        this.hitBox = hitBox;
         this.hand = hand;
     }
 }

…/model/api/event/ModelInteractEvent.java …pi/event/hitbox/HitBoxInteractEvent.javaapi/src/main/java/kr/toxicity/model/api/event/ModelInteractEvent.java renamed to api/src/main/java/kr/toxicity/model/api/event/hitbox/HitBoxInteractEvent.java api/src/main/java/kr/toxicity/model/api/event/ModelInteractEvent.java renamed to api/src/main/java/kr/toxicity/model/api/event/hitbox/HitBoxInteractEvent.java

@@ -0,0 +1,25 @@
+/**
+ * This source file is part of BetterModel.
+ * Copyright (c) 2024–2026 toxicity188
+ * Licensed under the MIT License.
+ * See LICENSE.md file for full license text.
+ */
+package kr.toxicity.model.api.event.hitbox;
+
+import kr.toxicity.model.api.nms.HitBox;
+import kr.toxicity.model.api.platform.PlatformEntity;
+import org.jetbrains.annotations.NotNull;
+
+/**
+ * An event called when an entity mounts to a hit box.
+ *
+ * @param hitBox the hit box
+ * @param entity the entity
+ * @since 2.1.0
+ */
+public record HitBoxMountEvent(@NotNull HitBox hitBox, @NotNull PlatformEntity entity) implements HitBoxEvent {
+    @Override
+    public @NotNull HitBox getHitBox() {
+        return hitBox;
+    }
+}

api/src/main/java/kr/toxicity/model/api/event/hitbox/HitBoxMountEvent.java

@@ -0,0 +1,30 @@
+/**
+ * This source file is part of BetterModel.
+ * Copyright (c) 2024–2026 toxicity188
+ * Licensed under the MIT License.
+ * See LICENSE.md file for full license text.
+ */
+package kr.toxicity.model.api.event.hitbox;
+
+import kr.toxicity.model.api.nms.HitBox;
+import org.jetbrains.annotations.NotNull;
+
+/**
+ * Triggered when a hitbox is removed.
+ *
+ * @param hitBox removed hitbox
+ * @since 2.1.0
+ */
+public record HitBoxRemoveEvent(@NotNull HitBox hitBox) implements HitBoxEvent {
+
+    /**
+     * Returns the removed hitbox.
+     *
+     * @return removed hitbox
+     * @since 2.1.0
+     */
+    @Override
+    public @NotNull HitBox getHitBox() {
+        return hitBox;
+    }
+}

api/src/main/java/kr/toxicity/model/api/event/hitbox/HitBoxRemoveEvent.java

@@ -0,0 +1,30 @@
+/**
+ * This source file is part of BetterModel.
+ * Copyright (c) 2024–2026 toxicity188
+ * Licensed under the MIT License.
+ * See LICENSE.md file for full license text.
+ */
+package kr.toxicity.model.api.event.hitbox;
+
+import kr.toxicity.model.api.nms.HitBox;
+import org.jetbrains.annotations.NotNull;
+
+/**
+ * Triggered when a hitbox is synchronized.
+ *
+ * @param hitBox synchronized hitbox
+ * @since 2.1.0
+ */
+public record HitBoxSyncEvent(@NotNull HitBox hitBox) implements HitBoxEvent {
+
+    /**
+     * Returns the synchronized hitbox.
+     *
+     * @return synchronized hitbox
+     * @since 2.1.0
+     */
+    @Override
+    public @NotNull HitBox getHitBox() {
+        return hitBox;
+    }
+}