Javadoc improvements

This commit is contained in:
tastybento 2023-05-31 20:15:39 -07:00
parent ff493444a7
commit 463ad68179
13 changed files with 43 additions and 20 deletions

1
src/main/.gitignore vendored Normal file
View File

@ -0,0 +1 @@
/.DS_Store

View File

@ -29,6 +29,7 @@ import world.bentobox.boxed.listeners.NewAreaListener;
import world.bentobox.boxed.listeners.NewAreaListener.Item; import world.bentobox.boxed.listeners.NewAreaListener.Item;
/** /**
* Enables admins to place templates in a Box and have them recorded for future boxes.
* @author tastybento * @author tastybento
* *
*/ */

View File

@ -14,8 +14,8 @@ import com.google.common.base.Enums;
import world.bentobox.bentobox.BentoBox; import world.bentobox.bentobox.BentoBox;
import world.bentobox.boxed.Boxed; import world.bentobox.boxed.Boxed;
import world.bentobox.boxed.generators.chunks.AbstractBoxedChunkGenerator;
import world.bentobox.boxed.generators.chunks.AbstractBoxedChunkGenerator.ChunkStore; import world.bentobox.boxed.generators.chunks.AbstractBoxedChunkGenerator.ChunkStore;
import world.bentobox.boxed.generators.chunks.BoxedChunkGenerator;
/** /**
* Copies biomes from seed world * Copies biomes from seed world
@ -39,8 +39,8 @@ public abstract class AbstractCopyBiomeProvider extends BiomeProvider {
public Biome getBiome(WorldInfo worldInfo, int x, int y, int z) { public Biome getBiome(WorldInfo worldInfo, int x, int y, int z) {
int chunkX = x >> 4; int chunkX = x >> 4;
int chunkZ = z >> 4; int chunkZ = z >> 4;
chunkX = BoxedChunkGenerator.repeatCalc(chunkX); chunkX = AbstractBoxedChunkGenerator.repeatCalc(chunkX);
chunkZ = BoxedChunkGenerator.repeatCalc(chunkZ); chunkZ = AbstractBoxedChunkGenerator.repeatCalc(chunkZ);
@Nullable ChunkStore c = addon.getChunkGenerator(worldInfo.getEnvironment()).getChunk(chunkX, chunkZ); @Nullable ChunkStore c = addon.getChunkGenerator(worldInfo.getEnvironment()).getChunk(chunkX, chunkZ);
if (c != null) { if (c != null) {

View File

@ -26,7 +26,6 @@ import com.google.common.base.Enums;
import world.bentobox.boxed.Boxed; import world.bentobox.boxed.Boxed;
import world.bentobox.boxed.generators.chunks.AbstractBoxedChunkGenerator; import world.bentobox.boxed.generators.chunks.AbstractBoxedChunkGenerator;
import world.bentobox.boxed.generators.chunks.AbstractBoxedChunkGenerator.ChunkStore; import world.bentobox.boxed.generators.chunks.AbstractBoxedChunkGenerator.ChunkStore;
import world.bentobox.boxed.generators.chunks.BoxedChunkGenerator;
/** /**
* Generates the biomes for the seed world. A seed world is the template for the chunks that * Generates the biomes for the seed world. A seed world is the template for the chunks that
@ -115,8 +114,8 @@ public abstract class AbstractSeedBiomeProvider extends BiomeProvider {
@NonNull @NonNull
private Biome getVanillaBiome(WorldInfo worldInfo, int x, int y, int z) { private Biome getVanillaBiome(WorldInfo worldInfo, int x, int y, int z) {
// Get the chunk coordinates // Get the chunk coordinates
int chunkX = BoxedChunkGenerator.repeatCalc(x >> 4); int chunkX = AbstractBoxedChunkGenerator.repeatCalc(x >> 4);
int chunkZ = BoxedChunkGenerator.repeatCalc(z >> 4); int chunkZ = AbstractBoxedChunkGenerator.repeatCalc(z >> 4);
// Get the stored snapshot // Get the stored snapshot
ChunkStore snapshot = this.seedGen.getChunk(chunkX, chunkZ); ChunkStore snapshot = this.seedGen.getChunk(chunkX, chunkZ);
if (snapshot == null) { if (snapshot == null) {

View File

@ -6,6 +6,7 @@ import org.bukkit.block.Biome;
import world.bentobox.boxed.Boxed; import world.bentobox.boxed.Boxed;
/** /**
* Generator for the over world
* @author tastybento * @author tastybento
* *
*/ */

View File

@ -6,6 +6,7 @@ import org.bukkit.block.Biome;
import world.bentobox.boxed.Boxed; import world.bentobox.boxed.Boxed;
/** /**
* Generator for the nether world
* @author tastybento * @author tastybento
* *
*/ */

View File

@ -7,6 +7,7 @@ import world.bentobox.boxed.Boxed;
import world.bentobox.boxed.generators.chunks.AbstractBoxedChunkGenerator; import world.bentobox.boxed.generators.chunks.AbstractBoxedChunkGenerator;
/** /**
* Generator for the Nether seed world
* @author tastybento * @author tastybento
* *
*/ */

View File

@ -7,6 +7,7 @@ import world.bentobox.boxed.Boxed;
import world.bentobox.boxed.generators.chunks.AbstractBoxedChunkGenerator; import world.bentobox.boxed.generators.chunks.AbstractBoxedChunkGenerator;
/** /**
* Generator for the seed world
* @author tastybento * @author tastybento
* *
*/ */

View File

@ -1 +1,5 @@
/**
* Generators to make the worlds with the custom biomes
* @author tastybento
*/
package world.bentobox.boxed.generators.biomes; package world.bentobox.boxed.generators.biomes;

View File

@ -1,4 +1,5 @@
/** /**
* Generators and populators to make the base world
* @author tastybento * @author tastybento
* *
*/ */

View File

@ -2,6 +2,11 @@ package world.bentobox.boxed.objects;
import com.google.gson.annotations.Expose; import com.google.gson.annotations.Expose;
/**
* This replicates a jigsaw block.
* @author tastybento
*
*/
public class BoxedJigsawBlock { public class BoxedJigsawBlock {
// final_state:"minecraft:polished_blackstone_bricks",joint:"aligned",name:"minecraft:empty",pool:"minecraft:bastion/bridge/legs",target:"minecraft:leg_connector" // final_state:"minecraft:polished_blackstone_bricks",joint:"aligned",name:"minecraft:empty",pool:"minecraft:bastion/bridge/legs",target:"minecraft:leg_connector"
@Expose @Expose

View File

@ -7,6 +7,7 @@ import org.bukkit.block.structure.StructureRotation;
import com.google.gson.annotations.Expose; import com.google.gson.annotations.Expose;
/** /**
* This represents a Structure Block
* @author tastybento * @author tastybento
* *
*/ */

View File

@ -10,6 +10,13 @@ import com.google.gson.annotations.Expose;
import world.bentobox.bentobox.database.objects.DataObject; import world.bentobox.bentobox.database.objects.DataObject;
import world.bentobox.bentobox.database.objects.Table; import world.bentobox.bentobox.database.objects.Table;
/**
* Stores all the structures placed in the box when it is made.
* These are used later to identify when a player enters such a structure and
* trigger an Advancement
* @author tastybento
*
*/
@Table(name = "IslandStructures") @Table(name = "IslandStructures")
public class IslandStructures implements DataObject { public class IslandStructures implements DataObject {