Added entity id utilities

Author: pianoman911

api/src/main/java/de/pianoman911/mapengine/api/clientside/IFrame.java

@@ -0,0 +1,28 @@
+package de.pianoman911.mapengine.api.clientside;
+
+/**
+ * Single frame of a map display.
+ * The main purpose of this is to provide the entity IDs of the item frame and the interaction
+ * entity for own packet handling and entity modification.
+ * <p>
+ * <b>Note: Frames only exist on the network level,
+ * so the server doesn't know about this frame entity.
+ */
+public interface IFrame {
+
+    /**
+     * <b>Note: Frames only exist on the network level,
+     * so the server doesn't know about this frame entity.
+     *
+     * @return the entity id of the item frame
+     */
+    int frameEntityId();
+
+    /**
+     * <b>Note: Frames only exist on the network level,
+     * so the server doesn't know about this frame entity.
+     *
+     * @return the entity id of the interaction entity
+     */
+    int interactionEntityId();
+}

api/src/main/java/de/pianoman911/mapengine/api/clientside/IMapDisplay.java

@@ -1,10 +1,13 @@
 package de.pianoman911.mapengine.api.clientside;
 
+import de.pianoman911.mapengine.api.util.Vec2i;
 import org.bukkit.block.BlockFace;
 import org.bukkit.entity.Player;
 import org.bukkit.util.BoundingBox;
 import org.jetbrains.annotations.Range;
 
+import java.util.function.BiConsumer;
+
 /**
  * A map display which creates packet-level item frame
  * displays with a custom width and height.
@@ -174,4 +177,50 @@ default void spawn(Player player) {
      * to update the map ids.</strong>
      */
     void cutOffCloneGroupIds();
+
+    /**
+     * Returns the frames of this display in a flattened 2d array.
+     * Frames are ordered from left to right, top to bottom.
+     * <p>
+     * x = 0 &and; y = 0 is positioned at the top left.
+     * The index of this is 0.
+     * <p>
+     * Use {@link #frameAt(int, int)} to easily get a specific
+     * frame of this display.
+     *
+     * @return the frames of this display
+     * @see #frameAt(int, int)
+     */
+    IFrame[] frames();
+
+    /**
+     * Returns the frame at the given x and y position.
+     *
+     * @param x the x position
+     * @param y the y position
+     * @return the frame at the given position
+     * @throws ArrayIndexOutOfBoundsException if the x or y position is out of bounds
+     */
+    default IFrame frameAt(int x, int y) {
+        int width = this.width();
+        if (x < 0 || x >= width || y < 0 || y >= this.height()) {
+            throw new ArrayIndexOutOfBoundsException("x or y position is out of bounds");
+        }
+        return this.frames()[x + y * width];
+    }
+
+    /**
+     * Consumes all frames of this display with a consumer.<br>
+     * The arguments provided to the specified consumer are immutable.
+     *
+     * @param consumer the consumer to consume the frames
+     */
+    default void consumeFrames(BiConsumer<IFrame, Vec2i> consumer) {
+        IFrame[] frames = this.frames();
+        for (int y = 0, w = this.width(), h = this.height(); y < h; ++y) {
+            for (int x = 0; x < w; ++x) {
+                consumer.accept(frames[x + y * w], new Vec2i(x, y));
+            }
+        }
+    }
 }

plugin/src/main/java/de/pianoman911/mapengine/core/clientside/Frame.java

@@ -1,5 +1,6 @@
 package de.pianoman911.mapengine.core.clientside;
 
+import de.pianoman911.mapengine.api.clientside.IFrame;
 import de.pianoman911.mapengine.common.platform.PacketContainer;
 import de.pianoman911.mapengine.core.MapEnginePlugin;
 import it.unimi.dsi.fastutil.ints.IntArrayList;
@@ -8,7 +9,7 @@
 import org.bukkit.util.BlockVector;
 import org.bukkit.util.Vector;
 
-public class Frame extends FilledMap {
+public class Frame extends FilledMap implements IFrame {
 
     public static final double INVISIBLE_MAP_DEPTH = 0.0078125;
     public static final double INTERACTION_OFFSET = 0.0626;
@@ -85,4 +86,14 @@ protected PacketContainer<?> rotationPacket(float yaw, float pitch) {
     public PacketContainer<?> itemRotationPacket(int rotation) {
         return plugin.platform().createItemRotationPacket(entityId, rotation);
     }
+
+    @Override
+    public int frameEntityId() {
+        return this.entityId;
+    }
+
+    @Override
+    public int interactionEntityId() {
+        return this.interactionId;
+    }
 }

plugin/src/main/java/de/pianoman911/mapengine/core/clientside/FrameContainer.java

@@ -280,6 +280,11 @@ public void cutOffCloneGroupIds() {
         }
     }
 
+    @Override
+    public Frame[] frames() {
+        return this.frames;
+    }
+
     private void spawn0(Player player, BlockFace visualDirection, int z) {
         for (Frame frame : frames) {
             frame.spawnPacket(visualDirection, this.glowing).send(player);