mirror of
https://github.com/IntellectualSites/PlotSquared.git
synced 2024-11-26 07:06:44 +01:00
Fixes javadoc errors
It does not improve upon the existing documentation but instead removes all broken documentation and has minor changes to some existing. More work will need to be done later to documentation.
This commit is contained in:
parent
ce387333d2
commit
d65bd7a704
@ -545,7 +545,7 @@ public class PS {
|
||||
/**
|
||||
* Get the raw plot object
|
||||
* @return set of plot
|
||||
* @see #setAllPlotsRaw(LinkedHashMap) to set the raw plot object
|
||||
* @see #setAllPlotsRaw(ConcurrentHashMap) to set the raw plot object
|
||||
*/
|
||||
@Deprecated
|
||||
public Set<Plot> getPlotsRaw() {
|
||||
|
@ -56,7 +56,9 @@ import com.plotsquared.bukkit.util.BukkitUtil;
|
||||
|
||||
/**
|
||||
* PlotSquared API
|
||||
*
|
||||
*
|
||||
|
||||
|
||||
* @version API 2.0
|
||||
*
|
||||
*/
|
||||
@ -78,11 +80,7 @@ public class PlotAPI {
|
||||
public PlotAPI(final JavaPlugin plugin) {}
|
||||
|
||||
/**
|
||||
* @param plugin Plugin used to access this method
|
||||
*
|
||||
* @throws com.intellectualcrafters.plot.util.PlotSquaredException if the program fails to fetch the PlotSquared
|
||||
* instance
|
||||
* @see com.intellectualcrafters.plot.PS
|
||||
* @see PS
|
||||
*
|
||||
* @deprecated Use this class if you just want to do a few simple things.<br>
|
||||
* - It will remain stable for future versions of the plugin
|
||||
@ -99,7 +97,7 @@ public class PlotAPI {
|
||||
*
|
||||
* @return all plots
|
||||
*
|
||||
* @see com.intellectualcrafters.plot.PS#getPlots()
|
||||
* @see PS#getPlots()
|
||||
*/
|
||||
public Set<Plot> getAllPlots() {
|
||||
return PS.get().getPlots();
|
||||
@ -123,7 +121,7 @@ public class PlotAPI {
|
||||
* @param plotWorld Plot World Object
|
||||
* @param manager World Manager
|
||||
*
|
||||
* @see com.intellectualcrafters.plot.PS#addPlotWorld(String, com.intellectualcrafters.plot.object.PlotWorld,
|
||||
* @see PS#addPlotWorld(String, com.intellectualcrafters.plot.object.PlotWorld,
|
||||
* com.intellectualcrafters.plot.object.PlotManager)
|
||||
*/
|
||||
public void addPlotWorld(final String world, final PlotWorld plotWorld, final PlotManager manager) {
|
||||
@ -133,7 +131,7 @@ public class PlotAPI {
|
||||
/**
|
||||
* @return main configuration
|
||||
*
|
||||
* @see com.intellectualcrafters.plot.PS#config
|
||||
* @see PS#config
|
||||
*/
|
||||
public YamlConfiguration getConfig() {
|
||||
return PS.get().config;
|
||||
@ -142,7 +140,7 @@ public class PlotAPI {
|
||||
/**
|
||||
* @return storage configuration
|
||||
*
|
||||
* @see com.intellectualcrafters.plot.PS#storage
|
||||
* @see PS#storage
|
||||
*/
|
||||
public YamlConfiguration getStorage() {
|
||||
return PS.get().storage;
|
||||
@ -154,7 +152,7 @@ public class PlotAPI {
|
||||
*
|
||||
* @return PlotSquared PlotSquared Main Class
|
||||
*
|
||||
* @see com.intellectualcrafters.plot.PS
|
||||
* @see PS
|
||||
*/
|
||||
public PS getMain() {
|
||||
return PS.get();
|
||||
@ -241,7 +239,7 @@ public class PlotAPI {
|
||||
*
|
||||
* @return MainUtil
|
||||
*
|
||||
* @see com.intellectualcrafters.plot.util.MainUtil
|
||||
* @see MainUtil
|
||||
*/
|
||||
@Deprecated
|
||||
public MainUtil getMainUtil() {
|
||||
@ -354,7 +352,7 @@ public class PlotAPI {
|
||||
* @param player Player that will receive the message
|
||||
* @param c (Caption)
|
||||
*
|
||||
* @see com.intellectualcrafters.plot.util.MainUtil#sendMessage(PlotPlayer, C, String...)
|
||||
* @see MainUtil#sendMessage(PlotPlayer, C, String...)
|
||||
* com.intellectualcrafters.plot.config.C, String...)
|
||||
*/
|
||||
public void sendMessage(final Player player, final C c) {
|
||||
@ -367,7 +365,7 @@ public class PlotAPI {
|
||||
* @param player Player that will receive the message
|
||||
* @param string The message
|
||||
*
|
||||
* @see com.intellectualcrafters.plot.util.MainUtil#sendMessage(PlotPlayer, String)
|
||||
* @see MainUtil#sendMessage(PlotPlayer, String)
|
||||
*/
|
||||
public void sendMessage(final Player player, final String string) {
|
||||
MainUtil.sendMessage(BukkitUtil.getPlayer(player), string);
|
||||
@ -430,7 +428,7 @@ public class PlotAPI {
|
||||
* @return plot, null if ID is wrong
|
||||
*
|
||||
* @see MainUtil#getPlotAbs(String, com.intellectualcrafters.plot.object.PlotId)
|
||||
* @see com.intellectualcrafters.plot.object.Plot
|
||||
* @see Plot
|
||||
*/
|
||||
public Plot getPlot(final World world, final int x, final int z) {
|
||||
return MainUtil.getPlotAbs(world.getName(), new PlotId(x, z));
|
||||
@ -444,7 +442,7 @@ public class PlotAPI {
|
||||
* @return plot if found, otherwise it creates a temporary plot-
|
||||
*
|
||||
* @see MainUtil#getPlotAbs(com.intellectualcrafters.plot.object.Location)
|
||||
* @see com.intellectualcrafters.plot.object.Plot
|
||||
* @see Plot
|
||||
*/
|
||||
public Plot getPlot(final Location l) {
|
||||
return MainUtil.getPlotAbs(BukkitUtil.getLocation(l));
|
||||
@ -458,7 +456,7 @@ public class PlotAPI {
|
||||
* @return plot if found, otherwise it creates a temporary plot
|
||||
*
|
||||
* @see #getPlot(org.bukkit.Location)
|
||||
* @see com.intellectualcrafters.plot.object.Plot
|
||||
* @see Plot
|
||||
*/
|
||||
public Plot getPlot(final Player player) {
|
||||
return this.getPlot(player.getLocation());
|
||||
@ -483,7 +481,7 @@ public class PlotAPI {
|
||||
* @param plr to search for
|
||||
* @param just_owner should we just search for owner? Or with rights?
|
||||
*
|
||||
* @see com.intellectualcrafters.plot.object.Plot
|
||||
* @see Plot
|
||||
*/
|
||||
public Plot[] getPlots(final World world, final Player plr, final boolean just_owner) {
|
||||
final ArrayList<Plot> pPlots = new ArrayList<>();
|
||||
@ -509,7 +507,7 @@ public class PlotAPI {
|
||||
* @return Plot[] - array of plot objects in world
|
||||
*
|
||||
* @see PS#getPlots(String)
|
||||
* @see com.intellectualcrafters.plot.object.Plot
|
||||
* @see Plot
|
||||
*/
|
||||
public Plot[] getPlots(final World world) {
|
||||
final Collection<Plot> plots = PS.get().getPlotsInWorld(world.getName());
|
||||
@ -521,7 +519,7 @@ public class PlotAPI {
|
||||
*
|
||||
* @return World[] - array of plot worlds
|
||||
*
|
||||
* @see com.intellectualcrafters.plot.PS#getPlotWorlds()
|
||||
* @see PS#getPlotWorlds()
|
||||
*/
|
||||
public String[] getPlotWorlds() {
|
||||
final Set<String> worlds = PS.get().getPlotWorlds();
|
||||
@ -535,7 +533,7 @@ public class PlotAPI {
|
||||
*
|
||||
* @return boolean (if plot world or not)
|
||||
*
|
||||
* @see com.intellectualcrafters.plot.PS#isPlotWorld(String)
|
||||
* @see PS#isPlotWorld(String)
|
||||
*/
|
||||
public boolean isPlotWorld(final World world) {
|
||||
return PS.get().isPlotWorld(world.getName());
|
||||
@ -548,13 +546,10 @@ public class PlotAPI {
|
||||
*
|
||||
* @return [0] = bottomLc, [1] = topLoc, [2] = home
|
||||
*
|
||||
* @see com.intellectualcrafters.plot.util.MainUtil#getPlotBottomLoc(String,
|
||||
* com.intellectualcrafters.plot.object.PlotId)
|
||||
* @see com.intellectualcrafters.plot.util.MainUtil#getPlotTopLoc(String,
|
||||
* com.intellectualcrafters.plot.object.PlotId)
|
||||
* @see com.intellectualcrafters.plot.util.MainUtil#getPlotHome(String,
|
||||
* com.intellectualcrafters.plot.object.Plot)
|
||||
* @see com.intellectualcrafters.plot.object.Plot
|
||||
* @see MainUtil#getPlotBottomLocAbs(String, PlotId)
|
||||
* @see MainUtil#getPlotTopLocAbs(String, PlotId)
|
||||
* @see MainUtil#getPlotHome(String, PlotId)
|
||||
* @see Plot
|
||||
*/
|
||||
public Location[] getLocations(final Plot p) {
|
||||
return new Location[] {
|
||||
@ -570,9 +565,8 @@ public class PlotAPI {
|
||||
*
|
||||
* @return plot bottom location
|
||||
*
|
||||
* @see com.intellectualcrafters.plot.util.MainUtil#getPlotHome(String,
|
||||
* com.intellectualcrafters.plot.object.Plot)
|
||||
* @see com.intellectualcrafters.plot.object.Plot
|
||||
* @see MainUtil#getPlotHome(String, PlotId)
|
||||
* @see Plot
|
||||
*/
|
||||
public Location getHomeLocation(final Plot p) {
|
||||
return BukkitUtil.getLocation(MainUtil.getPlotHome(p.world, p.id));
|
||||
@ -585,9 +579,8 @@ public class PlotAPI {
|
||||
*
|
||||
* @return plot bottom location
|
||||
*
|
||||
* @see com.intellectualcrafters.plot.util.MainUtil#getPlotBottomLoc(String,
|
||||
* com.intellectualcrafters.plot.object.PlotId)
|
||||
* @see com.intellectualcrafters.plot.object.Plot
|
||||
* @see MainUtil#getPlotBottomLocAbs(String, PlotId)
|
||||
* @see Plot
|
||||
*/
|
||||
public Location getBottomLocation(final Plot p) {
|
||||
return BukkitUtil.getLocation(MainUtil.getPlotBottomLocAbs(p.world, p.id).subtract(1, 0, 1));
|
||||
@ -600,8 +593,8 @@ public class PlotAPI {
|
||||
*
|
||||
* @return plot top location
|
||||
*
|
||||
* @see MainUtil#getPlotTopLoc(String, com.intellectualcrafters.plot.object.PlotId)
|
||||
* @see com.intellectualcrafters.plot.object.Plot
|
||||
* @see MainUtil#getPlotTopLocAbs(String, PlotId)
|
||||
* @see Plot
|
||||
*/
|
||||
public Location getTopLocation(final Plot p) {
|
||||
return BukkitUtil.getLocation(MainUtil.getPlotTopLocAbs(p.world, p.id));
|
||||
@ -614,7 +607,7 @@ public class PlotAPI {
|
||||
*
|
||||
* @return true if the player is in a plot, false if not-
|
||||
*
|
||||
* @see com.intellectualcrafters.plot.util.MainUtil#getPlotAbs(com.intellectualcrafters.plot.object.Location)
|
||||
* @see MainUtil#getPlotAbs(com.intellectualcrafters.plot.object.Location)
|
||||
*/
|
||||
public boolean isInPlot(final Player player) {
|
||||
return MainUtil.getPlotAbs(BukkitUtil.getLocation(player)) != null;
|
||||
@ -640,7 +633,7 @@ public class PlotAPI {
|
||||
*
|
||||
* @return PlotSquared Class
|
||||
*
|
||||
* @see com.intellectualcrafters.plot.PS
|
||||
* @see PS
|
||||
*/
|
||||
public PS getPlotSquared() {
|
||||
return PS.get();
|
||||
@ -654,7 +647,7 @@ public class PlotAPI {
|
||||
*
|
||||
* @return the number of plots the player has
|
||||
*
|
||||
* @see com.intellectualcrafters.plot.util.MainUtil#getPlayerPlotCount(String, PlotPlayer)
|
||||
* @see MainUtil#getPlayerPlotCount(String, PlotPlayer)
|
||||
*/
|
||||
public int getPlayerPlotCount(final World world, final Player player) {
|
||||
return MainUtil.getPlayerPlotCount(world.getName(), BukkitUtil.getPlayer(player));
|
||||
@ -668,9 +661,9 @@ public class PlotAPI {
|
||||
*
|
||||
* @return a set containing the players plots
|
||||
*
|
||||
* @see com.intellectualcrafters.plot.PS#getPlots(String, PlotPlayer)
|
||||
* org.bukkit.entity.Player)
|
||||
* @see com.intellectualcrafters.plot.object.Plot
|
||||
* @see PS#getPlots(String, PlotPlayer)
|
||||
*
|
||||
* @see Plot
|
||||
*/
|
||||
public Set<Plot> getPlayerPlots(final World world, final Player player) {
|
||||
return PS.get().getPlots(world.getName(), BukkitUtil.getPlayer(player));
|
||||
@ -693,7 +686,7 @@ public class PlotAPI {
|
||||
* Get the PlotPlayer for a player<br>
|
||||
* - The PlotPlayer is usually cached and will provide useful functions relating to players
|
||||
*
|
||||
* @see PlotPlayer.wrap(Player|OfflinePlayer|String|UUID)
|
||||
* @see PlotPlayer#wrap(Object)
|
||||
*
|
||||
* @param player
|
||||
* @return
|
||||
@ -705,9 +698,9 @@ public class PlotAPI {
|
||||
/**
|
||||
* Get the PlotPlayer for a UUID (Please note that PlotSquared can be configured to provide different UUIDs than bukkit)
|
||||
*
|
||||
* @see PlotPlayer.wrap(UUID uuid)
|
||||
* @see PlotPlayer#wrap(Object)
|
||||
*
|
||||
* @param player
|
||||
* @param uuid
|
||||
* @return
|
||||
*/
|
||||
public PlotPlayer wrapPlayer(final UUID uuid) {
|
||||
@ -717,7 +710,7 @@ public class PlotAPI {
|
||||
/**
|
||||
* Get the PlotPlayer for a username
|
||||
*
|
||||
* @see PlotPlayer.wrap(String name)
|
||||
* @see PlotPlayer#wrap(Object)
|
||||
*
|
||||
* @param player
|
||||
* @return
|
||||
@ -730,7 +723,7 @@ public class PlotAPI {
|
||||
* Get the PlotPlayer for an offline player<br>
|
||||
* Note that this will work if the player is offline, however not all functionality will work
|
||||
*
|
||||
* @see PlotPlayer.wrap(OfflinePlayer op)
|
||||
* @see PlotPlayer#wrap(Object)
|
||||
*
|
||||
* @param player
|
||||
* @return
|
||||
|
@ -37,7 +37,9 @@ import com.intellectualcrafters.plot.object.PlotId;
|
||||
import com.intellectualcrafters.plot.object.RunnableVal;
|
||||
import com.intellectualcrafters.plot.object.comment.PlotComment;
|
||||
|
||||
/**
|
||||
/**
|
||||
|
||||
|
||||
*/
|
||||
public interface AbstractDB {
|
||||
|
||||
@ -71,8 +73,6 @@ public interface AbstractDB {
|
||||
/**
|
||||
* Create tables
|
||||
*
|
||||
* @param database Database in which the tables will be created
|
||||
*
|
||||
* @throws SQLException If the database manager is unable to create the tables
|
||||
*/
|
||||
void createTables() throws Exception;
|
||||
@ -109,8 +109,7 @@ public interface AbstractDB {
|
||||
/**
|
||||
* Get the table entry ID
|
||||
*
|
||||
* @param world Which the plot is located in
|
||||
* @param id2 Plot ID
|
||||
* @param plot Plot Object
|
||||
*
|
||||
* @return Integer = Plot Entry Id
|
||||
*/
|
||||
@ -119,8 +118,7 @@ public interface AbstractDB {
|
||||
/**
|
||||
* Get the id of a given plot cluster
|
||||
*
|
||||
* @param world Which the plot is located in
|
||||
* @param id cluster id
|
||||
* @param cluster PlotCluster Object
|
||||
*
|
||||
* @return Integer = Cluster Entry Id
|
||||
*/
|
||||
@ -144,7 +142,6 @@ public interface AbstractDB {
|
||||
/**
|
||||
* Set the merged status for a plot
|
||||
*
|
||||
* @param world World in which the plot is located
|
||||
* @param plot Plot Object
|
||||
* @param merged boolean[]
|
||||
*/
|
||||
@ -160,7 +157,6 @@ public interface AbstractDB {
|
||||
/**
|
||||
* Set plot flags
|
||||
*
|
||||
* @param world World in which the plot is located
|
||||
* @param plot Plot Object
|
||||
* @param flags flags to set (flag[])
|
||||
*/
|
||||
@ -262,7 +258,6 @@ public interface AbstractDB {
|
||||
|
||||
/**
|
||||
*
|
||||
* @param world
|
||||
* @param cluster
|
||||
* @param uuid
|
||||
*/
|
||||
@ -300,7 +295,6 @@ public interface AbstractDB {
|
||||
/**
|
||||
* Remove a plot comment
|
||||
*
|
||||
* @param world World in which the plot is located
|
||||
* @param plot Plot Object
|
||||
* @param comment Comment to remove
|
||||
*/
|
||||
@ -316,7 +310,6 @@ public interface AbstractDB {
|
||||
/**
|
||||
* Set a plot comment
|
||||
*
|
||||
* @param world World in which the plot is located
|
||||
* @param plot Plot Object
|
||||
* @param comment Comment to add
|
||||
*/
|
||||
@ -325,10 +318,7 @@ public interface AbstractDB {
|
||||
/**
|
||||
* Get Plot Comments
|
||||
*
|
||||
* @param world World in which the plot is located
|
||||
* @param plot Plot Object
|
||||
* @param tier Comment Tier
|
||||
*
|
||||
* @return Plot Comments within the specified tier
|
||||
*/
|
||||
void getComments(final Plot plot, final String inbox, final RunnableVal whenDone);
|
||||
|
@ -66,8 +66,8 @@ public class DBFunc {
|
||||
|
||||
/**
|
||||
* Check if a resultset contains a column
|
||||
* @param rs
|
||||
* @param columnName
|
||||
* @param r
|
||||
* @param name
|
||||
* @return
|
||||
* @throws SQLException
|
||||
*/
|
||||
@ -244,8 +244,7 @@ public class DBFunc {
|
||||
/**
|
||||
* Get a plot id
|
||||
*
|
||||
* @param world World
|
||||
* @param id2 Plot ID
|
||||
* @param plot Plot Object
|
||||
*
|
||||
* @return ID
|
||||
*/
|
||||
@ -413,7 +412,6 @@ public class DBFunc {
|
||||
}
|
||||
|
||||
/**
|
||||
* @param world
|
||||
* @param plot
|
||||
* @param uuid
|
||||
*/
|
||||
@ -429,7 +427,6 @@ public class DBFunc {
|
||||
}
|
||||
|
||||
/**
|
||||
* @param world
|
||||
* @param plot
|
||||
* @param uuid
|
||||
*/
|
||||
@ -445,7 +442,6 @@ public class DBFunc {
|
||||
}
|
||||
|
||||
/**
|
||||
* @param world
|
||||
* @param plot
|
||||
* @param uuid
|
||||
*/
|
||||
@ -457,7 +453,6 @@ public class DBFunc {
|
||||
}
|
||||
|
||||
/**
|
||||
* @param world
|
||||
* @param plot
|
||||
* @param uuid
|
||||
*/
|
||||
|
@ -57,7 +57,8 @@ import com.intellectualcrafters.plot.util.MainUtil;
|
||||
import com.intellectualcrafters.plot.util.StringMan;
|
||||
import com.intellectualcrafters.plot.util.TaskManager;
|
||||
|
||||
/**
|
||||
/**
|
||||
|
||||
*/
|
||||
public class SQLManager implements AbstractDB {
|
||||
// Public final
|
||||
@ -185,7 +186,7 @@ public class SQLManager implements AbstractDB {
|
||||
/**
|
||||
* Constructor
|
||||
*
|
||||
* @param c connection
|
||||
* @param database
|
||||
* @param p prefix
|
||||
* @throws Exception
|
||||
*/
|
||||
|
@ -41,7 +41,9 @@ import com.intellectualcrafters.plot.util.Permissions;
|
||||
|
||||
/**
|
||||
* Flag Manager Utility
|
||||
*
|
||||
*
|
||||
|
||||
|
||||
*/
|
||||
@SuppressWarnings("unused")
|
||||
public class FlagManager {
|
||||
@ -210,7 +212,7 @@ public class FlagManager {
|
||||
|
||||
/**
|
||||
* Add a flag to a plot
|
||||
* @param plot
|
||||
* @param origin
|
||||
* @param flag
|
||||
*/
|
||||
public static boolean addPlotFlag(final Plot origin, final Flag flag) {
|
||||
|
@ -21,7 +21,6 @@ public abstract class PlotGenerator<T> {
|
||||
* new AugmentedPopulator(world, generator, cluster, plotWorld.TERRAIN == 2, plotWorld.TERRAIN != 2);
|
||||
* TYPE = 1
|
||||
* new AugmentedPopulator(world, gen_class, null, plotWorld.TERRAIN == 2, plotWorld.TERRAIN != 2);
|
||||
* @param generator
|
||||
* @param cluster Will be the cluster, or null
|
||||
* @param plotworld
|
||||
*/
|
||||
|
@ -636,7 +636,7 @@ public class Plot {
|
||||
* Clear a plot
|
||||
* @see MainUtil#clear(Plot, boolean, Runnable)
|
||||
* @see MainUtil#clearAsPlayer(Plot, boolean, Runnable)
|
||||
* @see #deletePlot() to clear and delete a plot
|
||||
* @see #deletePlot(Runnable) to clear and delete a plot
|
||||
* @param whenDone A runnable to execute when clearing finishes, or null
|
||||
*/
|
||||
public void clear(final Runnable whenDone) {
|
||||
@ -666,8 +666,7 @@ public class Plot {
|
||||
|
||||
/**
|
||||
* Set a flag for this plot
|
||||
* @param flag
|
||||
* @param value
|
||||
* @param flags
|
||||
*/
|
||||
public void setFlags(Set<Flag> flags) {
|
||||
FlagManager.setPlotFlags(this, flags);
|
||||
@ -683,7 +682,7 @@ public class Plot {
|
||||
|
||||
/**
|
||||
* Get the flag for a given key
|
||||
* @param flag
|
||||
* @param key
|
||||
*/
|
||||
public Flag getFlag(final String key) {
|
||||
return FlagManager.getPlotFlagRaw(this, key);
|
||||
@ -737,7 +736,7 @@ public class Plot {
|
||||
|
||||
/**
|
||||
* Unlink a plot and remove the roads
|
||||
* @see MainUtil#unlinkPlot(Plot, boolean removeRoad)
|
||||
* @see MainUtil#unlinkPlot(Plot, boolean, boolean)
|
||||
* @return true if plot was linked
|
||||
*/
|
||||
public boolean unlink() {
|
||||
@ -884,7 +883,7 @@ public class Plot {
|
||||
|
||||
/**
|
||||
* Auto merge the plot with any adjacent plots of the same owner
|
||||
* @see MainUtil#autoMerge(Plot, UUID) to specify the owner
|
||||
* @see MainUtil#autoMerge(Plot, int, int, UUID, boolean) to specify the owner
|
||||
* @param removeRoads If to remove roads when merging
|
||||
*/
|
||||
public boolean autoMerge(final boolean removeRoads) {
|
||||
@ -947,7 +946,6 @@ public class Plot {
|
||||
* - If the plot is not connected, it will return its own corners<br>
|
||||
* - the returned locations will not necessarily correspond to claimed plots if the connected plots do not form a rectangular shape
|
||||
* @deprecated as merged plots no longer need to be rectangular
|
||||
* @param plot
|
||||
* @return new Location[] { bottom, top }
|
||||
* @see MainUtil#getCorners(Plot)
|
||||
*/
|
||||
@ -961,7 +959,6 @@ public class Plot {
|
||||
* - If the plot is not connected, it will return itself for the top/bottom<br>
|
||||
* - the returned ids will not necessarily correspond to claimed plots if the connected plots do not form a rectangular shape
|
||||
* @deprecated as merged plots no longer need to be rectangular
|
||||
* @param plot
|
||||
* @return new Plot[] { bottom, top }
|
||||
* @see MainUtil#getCornerIds(Plot)
|
||||
*/
|
||||
@ -1012,12 +1009,12 @@ public class Plot {
|
||||
/**
|
||||
* Swap the plot contents and settings with another location<br>
|
||||
* - The destination must correspond to a valid plot of equal dimensions
|
||||
* @see ChunkManager#swap(String, bot1, top1, bot2, top2) to swap terrain
|
||||
* @see ChunkManager#swap(Location, Location, Location, Location, Runnable) to swap terrain
|
||||
* @see MainUtil#getPlotSelectionIds(PlotId, PlotId) to get the plots inside a selection
|
||||
* @see MainUtil#swapData(String, PlotId, PlotId, Runnable) to swap plot settings
|
||||
* @param other The other plot to swap with
|
||||
* @see MainUtil#swapData(Plot, Plot, Runnable) to swap plot settings
|
||||
* @param destination The other plot to swap with
|
||||
* @param whenDone A task to run when finished, or null
|
||||
* @see MainUtil#swapData(String, PlotId, PlotId, Runnable)
|
||||
* @see MainUtil#swapData(Plot, Plot, Runnable)
|
||||
* @return boolean if swap was successful
|
||||
*/
|
||||
public boolean swap(final Plot destination, final Runnable whenDone) {
|
||||
@ -1261,7 +1258,8 @@ public class Plot {
|
||||
* 2 = south<br>
|
||||
* 3 = west<br>
|
||||
* ----------<br>
|
||||
* @param merged
|
||||
* @param direction
|
||||
* @param value
|
||||
*/
|
||||
public void setMerged(int direction, boolean value) {
|
||||
if (getSettings().setMerged(direction, value)) {
|
||||
|
@ -136,7 +136,7 @@ public abstract class PlotPlayer implements CommandCaller {
|
||||
|
||||
/**
|
||||
* Get the plots the player owns
|
||||
* @see #PS.java for more searching functions
|
||||
* @see PS for more searching functions
|
||||
* @see #getPlotCount() for the number of plots
|
||||
* @return Set of plots
|
||||
*/
|
||||
|
@ -78,7 +78,6 @@ public class PlotSettings {
|
||||
/**
|
||||
* Constructor
|
||||
*
|
||||
* @param plot object
|
||||
*/
|
||||
public PlotSettings() {
|
||||
flags = new HashMap<>();
|
||||
|
@ -26,7 +26,7 @@ import com.intellectualcrafters.plot.object.RegionWrapper;
|
||||
public class BO3Handler {
|
||||
|
||||
/**
|
||||
* @see #saveBO3(null, Plot)
|
||||
* @see #saveBO3(PlotPlayer, Plot)
|
||||
* @param plot
|
||||
* @return if successfully exported
|
||||
*/
|
||||
|
@ -63,7 +63,8 @@ import com.plotsquared.listener.PlotListener;
|
||||
|
||||
/**
|
||||
* plot functions
|
||||
*
|
||||
*
|
||||
|
||||
*/
|
||||
public class MainUtil {
|
||||
public final static HashMap<Plot, Integer> runners = new HashMap<>();
|
||||
@ -122,7 +123,7 @@ public class MainUtil {
|
||||
|
||||
/**
|
||||
* This will combine each plot into effective rectangular regions
|
||||
* @param plot
|
||||
* @param origin
|
||||
* @return
|
||||
*/
|
||||
public static HashSet<RegionWrapper> getRegions(Plot origin) {
|
||||
@ -816,7 +817,7 @@ public class MainUtil {
|
||||
/**
|
||||
* direction 0 = north, 1 = south, etc:
|
||||
*
|
||||
* @param id
|
||||
* @param plot
|
||||
* @param direction
|
||||
*
|
||||
* @return Plot relative
|
||||
@ -1677,9 +1678,7 @@ public class MainUtil {
|
||||
* Gets the top loc of a plot (if mega, returns top loc of that mega plot) - If you would like each plot treated as
|
||||
* a small plot use getPlotTopLocAbs(...)
|
||||
*
|
||||
* @param world
|
||||
* @param id
|
||||
*
|
||||
* @param plot
|
||||
* @return Location top of mega plot
|
||||
*/
|
||||
public static Location getPlotTopLoc_(Plot plot) {
|
||||
|
@ -281,7 +281,7 @@ public class NbtFactory {
|
||||
* Represents a root NBT list.
|
||||
* See also:
|
||||
* <ul>
|
||||
* <li>{@link NbtFactory#createNbtList()}</li>
|
||||
* <li>{@link NbtFactory#createList(Iterable)}}</li>
|
||||
* <li>{@link NbtFactory#fromList(Object)}</li>
|
||||
* </ul>
|
||||
* @author Kristian
|
||||
@ -408,7 +408,7 @@ public class NbtFactory {
|
||||
/**
|
||||
* Construct a new NBT compound.
|
||||
* <p>
|
||||
* Use {@link NbtCompound#asMap()} to modify it.
|
||||
*
|
||||
* @return The NBT compound.
|
||||
*/
|
||||
public static NbtCompound createCompound() {
|
||||
@ -497,8 +497,6 @@ public class NbtFactory {
|
||||
/**
|
||||
* Set the NBT compound tag of a given item stack.
|
||||
* <p>
|
||||
* The item stack must be a wrapper for a CraftItemStack. Use
|
||||
* {@link MinecraftReflection#getBukkitItemStack(ItemStack)} if not.
|
||||
* @param stack - the item stack, cannot be air.
|
||||
* @param compound - the new NBT compound, or NULL to remove it.
|
||||
* @throws IllegalArgumentException If the stack is not a CraftItemStack, or it represents air.
|
||||
@ -572,7 +570,6 @@ public class NbtFactory {
|
||||
|
||||
/**
|
||||
* Convert wrapped List and Map objects into their respective NBT counterparts.
|
||||
* @param name - the name of the NBT element to create.
|
||||
* @param value - the value of the element to create. Can be a List or a Map.
|
||||
* @return The NBT element.
|
||||
*/
|
||||
|
@ -479,7 +479,7 @@ public abstract class SchematicHandler {
|
||||
/**
|
||||
* Get a schematic
|
||||
*
|
||||
* @param name to check
|
||||
* @param file to check
|
||||
*
|
||||
* @return schematic if found, else null
|
||||
*/
|
||||
@ -725,7 +725,8 @@ public abstract class SchematicHandler {
|
||||
|
||||
/**
|
||||
* Schematic Class
|
||||
*
|
||||
*
|
||||
|
||||
*/
|
||||
public class Schematic {
|
||||
// Lossy but fast
|
||||
@ -744,7 +745,6 @@ public abstract class SchematicHandler {
|
||||
* -
|
||||
* @param blockCollection
|
||||
* @param schematicDimension
|
||||
* @param file
|
||||
*/
|
||||
@Deprecated
|
||||
public Schematic(final DataCollection[] blockCollection, final Dimension schematicDimension) {
|
||||
@ -877,7 +877,8 @@ public abstract class SchematicHandler {
|
||||
|
||||
/**
|
||||
* Schematic Dimensions
|
||||
*
|
||||
*
|
||||
|
||||
*/
|
||||
public static class Dimension {
|
||||
private final int x;
|
||||
@ -905,7 +906,8 @@ public abstract class SchematicHandler {
|
||||
|
||||
/**
|
||||
* Schematic Data Collection
|
||||
* @deprecated as it is slow to wrap each block
|
||||
* @deprecated as it is slow to wrap each block
|
||||
|
||||
*/
|
||||
@Deprecated
|
||||
public class DataCollection {
|
||||
|
@ -36,7 +36,7 @@ public abstract class UUIDHandlerImplementation {
|
||||
|
||||
/**
|
||||
* If the UUID is not found, some commands can request to fetch the UUID when possible
|
||||
* @param player
|
||||
* @param name
|
||||
* @param ifFetch
|
||||
*/
|
||||
public abstract void fetchUUID(final String name, final RunnableVal<UUID> ifFetch);
|
||||
|
@ -42,7 +42,7 @@ import com.intellectualcrafters.configuration.serialization.ConfigurationSeriali
|
||||
* <p>
|
||||
* This class follows the builder pattern, allowing for method chaining.
|
||||
* It is set up such that invocations of property-setting methods will affect the current editing component,
|
||||
* and a call to {@link #then()} or {@link #then(Object)} will append a new editing component to the end of the message,
|
||||
* and a call to {@link #then(String)} or {@link #text(TextualComponent)} will append a new editing component to the end of the message,
|
||||
* optionally initializing it with text. Further property-setting method calls will affect that editing component.
|
||||
* </p>
|
||||
*/
|
||||
|
@ -29,7 +29,9 @@ import com.intellectualcrafters.plot.object.PlotCluster;
|
||||
|
||||
/**
|
||||
* Called when a flag is removed from a plot
|
||||
*
|
||||
*
|
||||
|
||||
|
||||
*/
|
||||
public class ClusterFlagRemoveEvent extends Event implements Cancellable {
|
||||
private static HandlerList handlers = new HandlerList();
|
||||
@ -41,7 +43,7 @@ public class ClusterFlagRemoveEvent extends Event implements Cancellable {
|
||||
* PlotFlagRemoveEvent: Called when a flag is removed from a plot
|
||||
*
|
||||
* @param flag Flag that was removed
|
||||
* @param plot Plot from which the flag was removed
|
||||
* @param cluster PlotCluster from which the flag was removed
|
||||
*/
|
||||
public ClusterFlagRemoveEvent(final Flag flag, final PlotCluster cluster) {
|
||||
this.cluster = cluster;
|
||||
|
@ -223,7 +223,6 @@ public abstract class BukkitPlotGenerator extends ChunkGenerator {
|
||||
* @param cz
|
||||
* @param requiredRegion
|
||||
* @param biomes
|
||||
* @param result
|
||||
* @return
|
||||
*/
|
||||
public abstract void generateChunk(final World world, final RegionWrapper requiredRegion, final PseudoRandom random, final int cx, final int cz, final BiomeGrid biomes);
|
||||
|
@ -63,8 +63,7 @@ public abstract class SpongePlotPopulator<T extends SpongePlotGenerator> impleme
|
||||
* @param x
|
||||
* @param y
|
||||
* @param z
|
||||
* @param id
|
||||
* @param data
|
||||
* @param state
|
||||
*/
|
||||
public void setBlock(final int x, final int y, final int z, final BlockState state) {
|
||||
buffer.setBlock(X + x, y, Z + z, state);
|
||||
|
Loading…
Reference in New Issue
Block a user