Some comments

amorphine · Nov 28, 2016 · 3c746b3 · 3c746b3
1 parent a50683a
commit 3c746b3
Show file tree

Hide file tree

Showing 5 changed files with 44 additions and 10 deletions.
diff --git a/src/main/java/ru/wpstuio/amorphine/exception/EmptySection.java b/src/main/java/ru/wpstuio/amorphine/exception/EmptySection.java
@@ -1,8 +1,5 @@
 package ru.wpstuio.amorphine.exception;
 
-/**
- * Created by amorphine on 28.11.16.
- */
 public class EmptySection extends Exception {
 
 }
diff --git a/src/main/java/ru/wpstuio/amorphine/mcaliases/Chunk.java b/src/main/java/ru/wpstuio/amorphine/mcaliases/Chunk.java
@@ -103,6 +103,11 @@ public void changeBlockId(int x, int y, int z, byte id) {
         block_bytes_tag.data[offset] = id;
     }
 
+    /**
+     * Writes main block id with given coordinates
+     * @param cords
+     * @param id
+     */
     public void changeBlockId(Coordinates3d cords, byte id) {
         int local_x = localBlockFromBlock(cords.getX());
         int local_y = localBlockFromBlock(cords.getY());

diff --git a/src/main/java/ru/wpstuio/amorphine/mcaliases/Region.java b/src/main/java/ru/wpstuio/amorphine/mcaliases/Region.java
@@ -120,6 +120,12 @@ public void save() throws IOException {
         }
     }
 
+    /**
+     * Writes block id with given coordinates
+     * @param cords
+     * @param id
+     * @throws IOException
+     */
     public void changeBlockId(Coordinates3d cords, byte id) throws IOException {
         int block_global_x = cords.getX();
         int block_global_z = cords.getZ();
@@ -132,6 +138,11 @@ public void changeBlockId(Coordinates3d cords, byte id) throws IOException {
 
     }
 
+    /**
+     * Returns block id with given coordinates
+     * @param cords
+     * @return
+     */
     public byte getBlockId(Coordinates3d cords) {
         int block_global_x = cords.getX();
         int block_global_z = cords.getZ();

diff --git a/src/main/java/ru/wpstuio/amorphine/mcaliases/Section.java b/src/main/java/ru/wpstuio/amorphine/mcaliases/Section.java
@@ -12,13 +12,6 @@ public class Section {
     private final byte index;
     private CompoundTag tag;
 
-    public byte getIndex() {
-        return index;
-    }
-
-    public CompoundTag getTag() {
-        return tag;
-    }
 
     public Section(byte index, CompoundTag tag) {
         this.index = index;
@@ -46,6 +39,19 @@ public Section(byte index) {
         this.tag = main_tag;
     }
 
+    public byte getIndex() {
+        return index;
+    }
+
+    public CompoundTag getTag() {
+        return tag;
+    }
+
+    /**
+     * Returns tag with given name
+     * @param name string name of the tag to be returned
+     * @return
+     */
     public Tag get(String name) {
         return this.tag.get(name);
     }

diff --git a/src/main/java/ru/wpstuio/amorphine/mcaliases/World.java b/src/main/java/ru/wpstuio/amorphine/mcaliases/World.java
@@ -54,6 +54,10 @@ public World(File world_dir) throws IOException {
         }
     }
 
+    /**
+     * Save all cashed regions to their files
+     * @throws IOException
+     */
     public void save() throws IOException {
         for(Map.Entry entry: regions.entrySet()) {
             Region region = (Region) entry.getValue();
@@ -83,6 +87,12 @@ public Region getRegion(int x, int z) {
         }
     }
 
+    /**
+     * Changes specified block basic id to with the given one
+     * @param cords
+     * @param id
+     * @throws IOException
+     */
     public void changeBlockID(Coordinates3d cords, byte id) throws IOException {
         int region_x = regionFromBlock(cords.getX());
         int region_z = regionFromBlock(cords.getZ());
@@ -91,6 +101,11 @@ public void changeBlockID(Coordinates3d cords, byte id) throws IOException {
         region.changeBlockId(cords, id);
     }
 
+    /**
+     * Returns id of the block with specified XYZ coordinates
+     * @param cords
+     * @return
+     */
     public byte getBlockId(Coordinates3d cords) {
         int region_x = regionFromBlock(cords.getX());
         int region_z = regionFromBlock(cords.getZ());