Adds comments to BloxPopulator

This commit is contained in:
Kristian Knarvik 2021-02-08 00:32:20 +01:00
parent 27aa0ed29d
commit 9233776b2c

View File

@ -3,44 +3,82 @@ package net.knarcraft.stargate;
import org.bukkit.Axis; import org.bukkit.Axis;
import org.bukkit.Material; import org.bukkit.Material;
/**
* Used to store information about a custom block populator
*/
public class BloxPopulator { public class BloxPopulator {
private BlockLocation blockLocation; private BlockLocation blockLocation;
private Material nextMat; private Material nextMat;
private Axis nextAxis; private Axis nextAxis;
public BloxPopulator(BlockLocation b, Material m) { /**
blockLocation = b; * Instantiates a new block populator
nextMat = m; * @param blockLocation <p>The location to start from</p>
* @param material <p>The material to populate</p>
*/
public BloxPopulator(BlockLocation blockLocation, Material material) {
this.blockLocation = blockLocation;
nextMat = material;
nextAxis = null; nextAxis = null;
} }
public BloxPopulator(BlockLocation b, Material m, Axis a) { /**
blockLocation = b; * Instantiates a new block populator
nextMat = m; * @param blockLocation <p>The location to start from</p>
nextAxis = a; * @param material <p>The material to populate</p>
* @param axis <p>The axis to populate along</p>
*/
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 <p>The new start location</p>
*/
public void setBlockLocation(BlockLocation blockLocation) {
this.blockLocation = blockLocation;
} }
public void setMat(Material m) { /**
nextMat = m; * Sets the polulator material
* @param material <p>The new populator material</p>
*/
public void setMat(Material material) {
nextMat = material;
} }
public void setAxis(Axis a) { /**
nextAxis = a; * Sets the populator axis
* @param axis <p>The new populator axis</p>
*/
public void setAxis(Axis axis) {
nextAxis = axis;
} }
/**
* Gets the location to start from
* @return <p>The location to start from</p>
*/
public BlockLocation getBlockLocation() { public BlockLocation getBlockLocation() {
return blockLocation; return blockLocation;
} }
/**
* Gets the material used for population
* @return <p>The material used for population</p>
*/
public Material getMat() { public Material getMat() {
return nextMat; return nextMat;
} }
/**
* Gets the current population axis
* @return <p>The current population axis</p>
*/
public Axis getAxis() { public Axis getAxis() {
return nextAxis; return nextAxis;
} }