API: New DirectChunk API that supports light, biomes and direct chunk modification

Author: SBPrime

src/org/primesoft/asyncworldedit/api/directChunk/IBaseChunkData.java

@@ -41,7 +41,6 @@
 package org.primesoft.asyncworldedit.api.directChunk;
 
 import com.sk89q.jnbt.CompoundTag;
-import com.sk89q.worldedit.BlockVector2D;
 import com.sk89q.worldedit.Vector;
 import com.sk89q.worldedit.blocks.BaseBlock;
 import com.sk89q.worldedit.entity.Entity;
@@ -50,22 +49,7 @@
  *
  * @author SBPrime
  */
-public interface IBaseChunkData {
-
-    /**
-     * Get the chunk coords
-     *
-     * @return
-     */
-    BlockVector2D getChunkCoords();
-
-    /**
-     * Set the chunk coords
-     *
-     * @param coords
-     */
-    void setChunkCoords(BlockVector2D coords);
-
+public interface IBaseChunkData extends ISimpleChunkData {
     /**
      * Set chunk block
      *
@@ -76,15 +60,30 @@ public interface IBaseChunkData {
      */
     void setBlock(int x, int y, int z, BaseBlock b);
 
+
     /**
+     * Set chunk tile eneity
+     *
+     * @param x X coordinate inside chunk (0-15)
+     * @param y Y coordinate inside chunk (0-15)
+     * @param z Z coordinate inside chunk (0-15)
+     * @param id Material ID of the tile entitiy
+     * @param ct Tile entity NBT data
+     */
+    void setTileEntity(int x, int y, int z, char id, CompoundTag ct);
+    
+    
+        /**
      * Set chunk block
      *
      * @param x X coordinate inside chunk (0-15)
      * @param y Y coordinate inside chunk (0-15)
      * @param z Z coordinate inside chunk (0-15)
-     * @param id Material ID
+     * @param b WorldEdit block
+     * @param emission The block emission level
      */
-    void setBlock(int x, int y, int z, char id);
+    void setBlockAndEmission(int x, int y, int z, BaseBlock b, byte emission);
+
 
     /**
      * Set chunk tile eneity
@@ -94,8 +93,10 @@ public interface IBaseChunkData {
      * @param z Z coordinate inside chunk (0-15)
      * @param id Material ID of the tile entitiy
      * @param ct Tile entity NBT data
+     * @param emission The block emission level
      */
-    void setTileEntity(int x, int y, int z, char id, CompoundTag ct);
+    void setTileEntityAndEmission(int x, int y, int z, char id, CompoundTag ct, byte emission);
+    
 
     /**
      * Remove entity from chunk
@@ -121,7 +122,6 @@ public interface IBaseChunkData {
      */
     ISerializedEntity addEntity(Vector pos, Entity entity);
 
-    
     /**
      * Get block from chunk data
      *
@@ -131,11 +131,11 @@ public interface IBaseChunkData {
      * @return
      */
     BaseBlock getBlock(int x, int y, int z);
-        
-    
+
     /**
      * Get the chunk entities
-     * @return 
+     *
+     * @return
      */
-    ISerializedEntity[] getEntity();
-}
+    ISerializedEntity[] getEntity();   
+}

src/org/primesoft/asyncworldedit/api/directChunk/IBiomeEntry.java

@@ -0,0 +1,55 @@
+/*
+ * AsyncWorldEdit API
+ * Copyright (c) 2016, SBPrime <https://github.com/SBPrime/>
+ * Copyright (c) AsyncWorldEdit API contributors
+ *
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted free of charge provided that the following 
+ * conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice, this
+ *    list of conditions and the following disclaimer. 
+ * 2. Redistributions in binary form must reproduce the above copyright notice,
+ *    this list of conditions and the following disclaimer in the documentation
+ *    and/or other materials provided with the distribution,
+ * 3. Redistributions of source code, with or without modification, in any form 
+ *    other then free of charge is not allowed,
+ * 4. Redistributions in binary form in any form other then free of charge is 
+ *    not allowed.
+ * 5. Any derived work based on or containing parts of this software must reproduce 
+ *    the above copyright notice, this list of conditions and the following 
+ *    disclaimer in the documentation and/or other materials provided with the 
+ *    derived work.
+ * 6. The original author of the software is allowed to change the license 
+ *    terms or the entire license of the software as he sees fit.
+ * 7. The original author of the software is allowed to sublicense the software 
+ *    or its parts using any license terms he sees fit.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+ * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
+ * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+package org.primesoft.asyncworldedit.api.directChunk;
+
+/**
+ *
+ * @author SBPrime
+ */
+public interface IBiomeEntry extends IVector2dEntry {
+
+    /**
+     * Get the bime ID
+     *
+     * @return
+     */
+    byte getId();
+}

src/org/primesoft/asyncworldedit/api/directChunk/IBlockEntry.java

@@ -46,8 +46,7 @@
  *
  * @author SBPrime
  */
-public interface IBlockEntry {
-
+public interface IBlockEntry extends IVectorEntry {
     /**
      * Get the block ID
      *
@@ -61,11 +60,30 @@ public interface IBlockEntry {
      * @return
      */
     CompoundTag getNbt();
-
-    int getX();
-
-    int getY();
-
-    int getZ();
 
+    
+    /**
+     * Get the light emission level
+     * @return 
+     */
+    byte getEmission();
+    
+    /**
+     * Set the light emission level
+     * @param level
+     */
+    void setEmission(byte level);
+    
+    
+    /**
+     * Does the entry have light data
+     * @return 
+     */
+    boolean hasLight();
+    
+    /**
+     * Does the entry have block data
+     * @return 
+     */
+    boolean hasBlock();
 }

src/org/primesoft/asyncworldedit/api/directChunk/IChangesetData.java

@@ -64,5 +64,11 @@ public interface IChangesetData {
      * Get the stored blocks
      * @return
      */
-    IBlockEntry[] getChangedBlocks();
+    IBlockEntry[] getChangedBlocks();    
+    
+    /**
+     * Get the stored biomes
+     * @return
+     */
+    IBiomeEntry[] getChangedBiomes();
 }

src/org/primesoft/asyncworldedit/api/directChunk/IChunkDataCommon.java

@@ -0,0 +1,64 @@
+/*
+ * AsyncWorldEdit API
+ * Copyright (c) 2015, SBPrime <https://github.com/SBPrime/>
+ * Copyright (c) AsyncWorldEdit API contributors
+ *
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted free of charge provided that the following 
+ * conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice, this
+ *    list of conditions and the following disclaimer. 
+ * 2. Redistributions in binary form must reproduce the above copyright notice,
+ *    this list of conditions and the following disclaimer in the documentation
+ *    and/or other materials provided with the distribution,
+ * 3. Redistributions of source code, with or without modification, in any form 
+ *    other then free of charge is not allowed,
+ * 4. Redistributions in binary form in any form other then free of charge is 
+ *    not allowed.
+ * 5. Any derived work based on or containing parts of this software must reproduce 
+ *    the above copyright notice, this list of conditions and the following 
+ *    disclaimer in the documentation and/or other materials provided with the 
+ *    derived work.
+ * 6. The original author of the software is allowed to change the license 
+ *    terms or the entire license of the software as he sees fit.
+ * 7. The original author of the software is allowed to sublicense the software 
+ *    or its parts using any license terms he sees fit.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+ * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
+ * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+package org.primesoft.asyncworldedit.api.directChunk;
+
+import com.sk89q.worldedit.BlockVector2D;
+
+/**
+ *
+ * @author SBPrime
+ */
+public interface IChunkDataCommon {
+
+    /**
+     * Get the chunk coords
+     *
+     * @return
+     */
+    BlockVector2D getChunkCoords();
+    
+    /**
+     * Set the chunk coords
+     *
+     * @param coords
+     */
+    void setChunkCoords(BlockVector2D coords);
+}

src/org/primesoft/asyncworldedit/api/directChunk/IChunkUndoData.java

@@ -47,10 +47,30 @@
  * @author SBPrime
  */
 public interface IChunkUndoData {
-
-    public UUID[] getAddedEntitys();
+    /**
+     * Get the list of added entities
+     *
+     * @return
+     */
+    UUID[] getAddedEntitys();
 
-    public ISerializedEntity[] getRemovedEntitys();
+    /**
+     * Get the list of removed entities
+     *
+     * @return
+     */
+    ISerializedEntity[] getRemovedEntitys();
 
-    public IBlockEntry[] getBlocks();
+    
+    /**
+     * Get the changed blocks
+     * @return
+     */
+    IBlockEntry[] getBlocks();
+    
+    /**
+     * Get the changed biomes
+     * @return
+     */
+    IBiomeEntry[] getChangedBiomes();
 }