mirror of
https://github.com/IntellectualSites/PlotSquared.git
synced 2024-11-22 05:06:44 +01:00
clean up some javadoc stuff
This commit is contained in:
parent
ed2302e545
commit
12def37194
@ -45,6 +45,9 @@ public class BukkitOfflinePlayer implements OfflinePlotPlayer {
|
|||||||
/**
|
/**
|
||||||
* Please do not use this method. Instead use BukkitUtil.getPlayer(Player),
|
* Please do not use this method. Instead use BukkitUtil.getPlayer(Player),
|
||||||
* as it caches player objects.
|
* as it caches player objects.
|
||||||
|
*
|
||||||
|
* @param player Bukkit OfflinePlayer player to convert
|
||||||
|
* @param permissionHandler Permission Profile to be used
|
||||||
*/
|
*/
|
||||||
public BukkitOfflinePlayer(@Nonnull final OfflinePlayer player, @Nonnull final
|
public BukkitOfflinePlayer(@Nonnull final OfflinePlayer player, @Nonnull final
|
||||||
PermissionHandler permissionHandler) {
|
PermissionHandler permissionHandler) {
|
||||||
|
@ -78,7 +78,11 @@ public class BukkitPlayer extends PlotPlayer<Player> {
|
|||||||
* <p>Please do not use this method. Instead use
|
* <p>Please do not use this method. Instead use
|
||||||
* BukkitUtil.getPlayer(Player), as it caches player objects.</p>
|
* BukkitUtil.getPlayer(Player), as it caches player objects.</p>
|
||||||
*
|
*
|
||||||
|
* @param plotAreaManager PlotAreaManager instance
|
||||||
|
* @param eventDispatcher EventDispatcher instance
|
||||||
* @param player Bukkit player instance
|
* @param player Bukkit player instance
|
||||||
|
* @param econHandler EconHandler instance
|
||||||
|
* @param permissionHandler PermissionHandler instance
|
||||||
*/
|
*/
|
||||||
public BukkitPlayer(@Nonnull final PlotAreaManager plotAreaManager, @Nonnull final EventDispatcher eventDispatcher,
|
public BukkitPlayer(@Nonnull final PlotAreaManager plotAreaManager, @Nonnull final EventDispatcher eventDispatcher,
|
||||||
@Nonnull final Player player, @Nullable final EconHandler econHandler, @Nonnull final PermissionHandler permissionHandler) {
|
@Nonnull final Player player, @Nullable final EconHandler econHandler, @Nonnull final PermissionHandler permissionHandler) {
|
||||||
|
@ -55,7 +55,7 @@ import java.util.function.Consumer;
|
|||||||
* and allows the caller to specify a sink for the loaded chunks. The
|
* and allows the caller to specify a sink for the loaded chunks. The
|
||||||
* coordinator will prevent the chunks from being unloaded until the sink
|
* coordinator will prevent the chunks from being unloaded until the sink
|
||||||
* has fully consumed the chunk
|
* has fully consumed the chunk
|
||||||
* <p>
|
* </p>
|
||||||
**/
|
**/
|
||||||
public final class BukkitChunkCoordinator extends ChunkCoordinator {
|
public final class BukkitChunkCoordinator extends ChunkCoordinator {
|
||||||
|
|
||||||
|
@ -71,6 +71,8 @@ public class GenChunk extends ScopedQueueCoordinator {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Set the internal Bukkit chunk data
|
* Set the internal Bukkit chunk data
|
||||||
|
*
|
||||||
|
* @param chunkData Bukkit ChunkData
|
||||||
*/
|
*/
|
||||||
public void setChunkData(@Nonnull ChunkData chunkData) {
|
public void setChunkData(@Nonnull ChunkData chunkData) {
|
||||||
this.chunkData = chunkData;
|
this.chunkData = chunkData;
|
||||||
@ -88,6 +90,8 @@ public class GenChunk extends ScopedQueueCoordinator {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Set the chunk being represented
|
* Set the chunk being represented
|
||||||
|
*
|
||||||
|
* @param chunk Bukkit Chunk
|
||||||
*/
|
*/
|
||||||
public void setChunk(@Nonnull Chunk chunk) {
|
public void setChunk(@Nonnull Chunk chunk) {
|
||||||
this.chunk = chunk;
|
this.chunk = chunk;
|
||||||
@ -96,6 +100,8 @@ public class GenChunk extends ScopedQueueCoordinator {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Set the world and XZ of the chunk being represented via {@link ChunkWrapper}
|
* Set the world and XZ of the chunk being represented via {@link ChunkWrapper}
|
||||||
|
*
|
||||||
|
* @param wrap P2 ChunkWrapper
|
||||||
*/
|
*/
|
||||||
public void setChunk(@Nonnull ChunkWrapper wrap) {
|
public void setChunk(@Nonnull ChunkWrapper wrap) {
|
||||||
chunk = null;
|
chunk = null;
|
||||||
@ -146,6 +152,12 @@ public class GenChunk extends ScopedQueueCoordinator {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Set the in the whole column of XZ
|
* Set the in the whole column of XZ
|
||||||
|
*
|
||||||
|
* @param x Relative x location within the chunk (0 - 15)
|
||||||
|
* @param z Relative z location within the chunk (0 - 15)
|
||||||
|
* @param biome Bukkit biome to set
|
||||||
|
*
|
||||||
|
* @return if successful
|
||||||
*/
|
*/
|
||||||
public boolean setBiome(int x, int z, @Nonnull Biome biome) {
|
public boolean setBiome(int x, int z, @Nonnull Biome biome) {
|
||||||
if (this.biomeGrid != null) {
|
if (this.biomeGrid != null) {
|
||||||
|
@ -70,6 +70,8 @@ public class PlayerAutoPlotEvent extends PlotEvent implements CancellablePlotEve
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Set the schematic string used in the claim.
|
* Set the schematic string used in the claim.
|
||||||
|
*
|
||||||
|
* @param schematic the schematic name
|
||||||
*/
|
*/
|
||||||
public void setSchematic(String schematic) {
|
public void setSchematic(String schematic) {
|
||||||
this.schematic = schematic;
|
this.schematic = schematic;
|
||||||
|
@ -59,6 +59,8 @@ public class PlayerClaimPlotEvent extends PlotPlayerEvent implements Cancellable
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Set the schematic string used in the claim.
|
* Set the schematic string used in the claim.
|
||||||
|
*
|
||||||
|
* @param schematic the schematic name
|
||||||
*/
|
*/
|
||||||
public void setSchematic(String schematic) {
|
public void setSchematic(String schematic) {
|
||||||
this.schematic = schematic;
|
this.schematic = schematic;
|
||||||
|
Loading…
Reference in New Issue
Block a user