From 79e0459a3afc128cdef0066d35a82f6dc432399e Mon Sep 17 00:00:00 2001 From: boy0001 Date: Sat, 11 Oct 2014 19:51:48 +1100 Subject: [PATCH] jdoc --- .../plot/generator/DefaultPlotManager.java | 20 ++++++------ .../plot/generator/WorldGenerator.java | 32 +++++++++++-------- 2 files changed, 28 insertions(+), 24 deletions(-) diff --git a/PlotSquared/src/com/intellectualcrafters/plot/generator/DefaultPlotManager.java b/PlotSquared/src/com/intellectualcrafters/plot/generator/DefaultPlotManager.java index 1095d678b..0668d9ffe 100644 --- a/PlotSquared/src/com/intellectualcrafters/plot/generator/DefaultPlotManager.java +++ b/PlotSquared/src/com/intellectualcrafters/plot/generator/DefaultPlotManager.java @@ -20,7 +20,7 @@ import com.intellectualcrafters.plot.PlotWorld; public class DefaultPlotManager extends PlotManager { - /* + /** * Default implementation of getting a plot at a given location * * For a simplified explanation of the math involved: - Get the current @@ -80,7 +80,7 @@ public class DefaultPlotManager extends PlotManager { return new PlotId(dx + 1, dz + 1); } - /* + /** * Some complex stuff for traversing mega plots (return getPlotIdAbs if you * do not support mega plots) */ @@ -169,7 +169,7 @@ public class DefaultPlotManager extends PlotManager { return PlayerFunctions.getBottomPlot(loc.getWorld(), plot).id; } - /* + /** * Check if a location is inside a specific plot(non-Javadoc) - For this * implementation, we don't need to do anything fancier than referring to * getPlotIdAbs(...) @@ -183,7 +183,7 @@ public class DefaultPlotManager extends PlotManager { return result == plotid; } - /* + /** * Get the bottom plot loc (some basic math) */ @Override @@ -201,7 +201,7 @@ public class DefaultPlotManager extends PlotManager { return new Location(Bukkit.getWorld(plotworld.worldname), x, 1, z); } - /* + /** * Get the top plot loc (some basic math) */ @Override @@ -219,7 +219,7 @@ public class DefaultPlotManager extends PlotManager { return new Location(Bukkit.getWorld(plotworld.worldname), x, 256, z); } - /* + /** * Clearing the plot needs to only consider removing the blocks - This * implementation has used the SetCuboid function, as it is fast, and uses * NMS code - It also makes use of the fact that deleting chunks is a lot @@ -519,7 +519,7 @@ public class DefaultPlotManager extends PlotManager { return true; } - /* + /** * Remove sign for a plot */ @Override @@ -586,7 +586,7 @@ public class DefaultPlotManager extends PlotManager { return true; } - /* + /** * Set a plot biome */ @Override @@ -612,7 +612,7 @@ public class DefaultPlotManager extends PlotManager { return true; } - /* + /** * PLOT MERGING */ @@ -797,7 +797,7 @@ public class DefaultPlotManager extends PlotManager { return true; } - /* + /** * Finishing off plot merging by adding in the walls surrounding the plot * (OPTIONAL)(UNFINISHED) */ diff --git a/PlotSquared/src/com/intellectualcrafters/plot/generator/WorldGenerator.java b/PlotSquared/src/com/intellectualcrafters/plot/generator/WorldGenerator.java index 1c34af947..177ed085e 100644 --- a/PlotSquared/src/com/intellectualcrafters/plot/generator/WorldGenerator.java +++ b/PlotSquared/src/com/intellectualcrafters/plot/generator/WorldGenerator.java @@ -27,21 +27,21 @@ import com.intellectualcrafters.plot.PlotWorld; * */ public class WorldGenerator extends PlotGenerator { - /* + /** * result object is returned for each generated chunk, do stuff to it */ short[][] result; - /* + /** * plotworld object */ DefaultPlotWorld plotworld; - /* + /** * Set to static to re-use the same managet for all Default World Generators */ private static PlotManager manager = null; - /* + /** * Some generator specific variables (implementation dependent) */ final int plotsize; @@ -58,8 +58,9 @@ public class WorldGenerator extends PlotGenerator { final PlotBlock[] plotfloors; final PlotBlock[] filling; - /* + /** * Return the plot manager for this type of generator, or create one + * For square plots you may as well use the default plot manager which comes with PlotSquared */ @Override public PlotManager getPlotManager() { @@ -69,15 +70,18 @@ public class WorldGenerator extends PlotGenerator { return manager; } - // return the PlotWorld - + /** + * Get a new plotworld class + * For square plots you can use the DefaultPlotWorld class which comes with PlotSquared + * + */ @Override public PlotWorld getNewPlotWorld(String world) { this.plotworld = new DefaultPlotWorld(world); return this.plotworld; } - /* + /** * Faster sudo-random number generator than java.util.random */ private long state; @@ -100,7 +104,7 @@ public class WorldGenerator extends PlotGenerator { return (int) r; } - /* + /** * Cuboid based plot generation is quick, as it requires no calculations * inside the loop - You don't have to use this this method, but you may * find it useful. @@ -130,7 +134,7 @@ public class WorldGenerator extends PlotGenerator { } } - /* + /** * Standard setblock method for world generation */ private void setBlock(short[][] result, int x, int y, int z, short blkid) { @@ -140,7 +144,7 @@ public class WorldGenerator extends PlotGenerator { result[y >> 4][((y & 0xF) << 8) | (z << 4) | x] = blkid; } - /* + /** * Initialize variables, and create plotworld object used in calculations */ public WorldGenerator(String world) { @@ -165,7 +169,7 @@ public class WorldGenerator extends PlotGenerator { this.biome = this.plotworld.PLOT_BIOME; } - /* + /** * Return the block populator */ @Override @@ -183,7 +187,7 @@ public class WorldGenerator extends PlotGenerator { return Arrays.asList((BlockPopulator) new XPopulator(this.plotworld)); } - /* + /** * Return the default spawn location for this world */ @Override @@ -191,7 +195,7 @@ public class WorldGenerator extends PlotGenerator { return new Location(world, 0, this.plotworld.ROAD_HEIGHT + 2, 0); } - /* + /** * This part is a fucking mess. - Refer to a proper tutorial if you would * like to learn how to make a world generator */