Added API for manipulating map items. Thanks SpaceManiac, codename_B, sk89q and dested!

By: EvilSeph <evilseph@gmail.com>
2011-08-12 21:59:10 -04:00
parent df275c8376
commit cd7da9630a
14 changed files with 1181 additions and 1 deletions
--- a/paper-api/src/main/java/org/bukkit/map/MapView.java
+++ b/paper-api/src/main/java/org/bukkit/map/MapView.java
@ -0,0 +1,133 @@
+package org.bukkit.map;
+
+import java.util.List;
+import org.bukkit.World;
+
+/**
+ * Represents a map item.
+ */
+public interface MapView {
+    
+    /**
+     * An enum representing all possible scales a map can be set to.
+     */
+    public static enum Scale {
+        CLOSEST(0),
+        CLOSE(1),
+        NORMAL(2),
+        FAR(3),
+        FARTHEST(4);
+        
+        private byte value;
+        
+        private Scale(int value) {
+            this.value = (byte) value;
+        }
+        
+        /**
+         * Get the scale given the raw value.
+         */
+        public static Scale valueOf(byte value) {
+            switch(value) {
+                case 0: return CLOSEST;
+                case 1: return CLOSE;
+                case 2: return NORMAL;
+                case 3: return FAR;
+                case 4: return FARTHEST;
+                default: return null;
+            }
+        }
+        
+        /**
+         * Get the raw value of this scale level.
+         */
+        public byte getValue() {
+            return value;
+        }
+    }
+    
+    /**
+     * Get the ID of this map item. Corresponds to the damage value of a map
+     * in an inventory.
+     * @return The ID of the map.
+     */
+    public short getId();
+    
+    /**
+     * Check whether this map is virtual. A map is virtual if its lowermost
+     * MapRenderer is plugin-provided.
+     * @return Whether the map is virtual.
+     */
+    public boolean isVirtual();
+    
+    /**
+     * Get the scale of this map.
+     * @return The scale of the map.
+     */
+    public Scale getScale();
+    
+    /**
+     * Set the scale of this map.
+     * @param scale The scale to set.
+     */
+    public void setScale(Scale scale);
+    
+    /**
+     * Get the center X position of this map.
+     * @return The center X position.
+     */
+    public int getCenterX();
+    
+    /**
+     * Get the center Z position of this map.
+     * @return The center Z position.
+     */
+    public int getCenterZ();
+    
+    /**
+     * Set the center X position of this map.
+     * @param x The center X position.
+     */
+    public void setCenterX(int x);
+    
+    /**
+     * Set the center Z position of this map.
+     * @param z The center Z position.
+     */
+    public void setCenterZ(int z);
+    
+    /**
+     * Get the world that this map is associated with. Primarily used by the
+     * internal renderer, but may be used by external renderers. May return
+     * null if the world the map is associated with is not loaded.
+     * @return The World this map is associated with.
+     */
+    public World getWorld();
+    
+    /**
+     * Set the world that this map is associated with. The world is used by
+     * the internal renderer, and may also be used by external renderers.
+     * @param world The World to associate this map with.
+     */
+    public void setWorld(World world);
+    
+    /**
+     * Get a list of MapRenderers currently in effect.
+     * @return A List<MapRenderer> containing each map renderer.
+     */
+    public List<MapRenderer> getRenderers();
+    
+    /**
+     * Add a renderer to this map.
+     * @param renderer The MapRenderer to add.
+     */
+    public void addRenderer(MapRenderer renderer);
+    
+    /**
+     * Remove a renderer from this map.
+     * @param renderer The MapRenderer to remove.
+     * @return True if the renderer was successfully removed.
+     */
+    public boolean removeRenderer(MapRenderer renderer);
+    
+}