diff --git a/src/main/java/net/knarcraft/stargate/BloxPopulator.java b/src/main/java/net/knarcraft/stargate/BloxPopulator.java index 87bedb8..63031c0 100644 --- a/src/main/java/net/knarcraft/stargate/BloxPopulator.java +++ b/src/main/java/net/knarcraft/stargate/BloxPopulator.java @@ -3,44 +3,82 @@ package net.knarcraft.stargate; import org.bukkit.Axis; import org.bukkit.Material; +/** + * Used to store information about a custom block populator + */ public class BloxPopulator { private BlockLocation blockLocation; private Material nextMat; private Axis nextAxis; - public BloxPopulator(BlockLocation b, Material m) { - blockLocation = b; - nextMat = m; + /** + * Instantiates a new block populator + * @param blockLocation

The location to start from

+ * @param material

The material to populate

+ */ + public BloxPopulator(BlockLocation blockLocation, Material material) { + this.blockLocation = blockLocation; + nextMat = material; nextAxis = null; } - public BloxPopulator(BlockLocation b, Material m, Axis a) { - blockLocation = b; - nextMat = m; - nextAxis = a; + /** + * Instantiates a new block populator + * @param blockLocation

The location to start from

+ * @param material

The material to populate

+ * @param axis

The axis to populate along

+ */ + public BloxPopulator(BlockLocation blockLocation, Material material, Axis axis) { + this.blockLocation = blockLocation; + nextMat = material; + nextAxis = axis; } - public void setBlockLocation(BlockLocation b) { - blockLocation = b; + /** + * Sets the location to start from + * @param blockLocation

The new start location

+ */ + public void setBlockLocation(BlockLocation blockLocation) { + this.blockLocation = blockLocation; } - public void setMat(Material m) { - nextMat = m; + /** + * Sets the polulator material + * @param material

The new populator material

+ */ + public void setMat(Material material) { + nextMat = material; } - public void setAxis(Axis a) { - nextAxis = a; + /** + * Sets the populator axis + * @param axis

The new populator axis

+ */ + public void setAxis(Axis axis) { + nextAxis = axis; } + /** + * Gets the location to start from + * @return

The location to start from

+ */ public BlockLocation getBlockLocation() { return blockLocation; } + /** + * Gets the material used for population + * @return

The material used for population

+ */ public Material getMat() { return nextMat; } + /** + * Gets the current population axis + * @return

The current population axis

+ */ public Axis getAxis() { return nextAxis; }