mirror of
https://github.com/IntellectualSites/PlotSquared.git
synced 2024-11-26 07:06:44 +01:00
Move PlotAPI to Core and move bukkit specific methods to BukkitUtil.
This commit is contained in:
parent
be9fb3bd3a
commit
e98c648244
@ -1,15 +1,10 @@
|
|||||||
package com.github.intellectualsites.plotsquared.bukkit.util;
|
package com.github.intellectualsites.plotsquared.bukkit.util;
|
||||||
|
|
||||||
import com.github.intellectualsites.plotsquared.bukkit.object.BukkitPlayer;
|
import com.github.intellectualsites.plotsquared.bukkit.object.BukkitPlayer;
|
||||||
import com.github.intellectualsites.plotsquared.plot.object.Location;
|
import com.github.intellectualsites.plotsquared.plot.config.C;
|
||||||
import com.github.intellectualsites.plotsquared.plot.object.PlotBlock;
|
import com.github.intellectualsites.plotsquared.plot.object.*;
|
||||||
import com.github.intellectualsites.plotsquared.plot.object.PlotPlayer;
|
|
||||||
import com.github.intellectualsites.plotsquared.plot.object.RegionWrapper;
|
|
||||||
import com.github.intellectualsites.plotsquared.plot.object.schematic.PlotItem;
|
import com.github.intellectualsites.plotsquared.plot.object.schematic.PlotItem;
|
||||||
import com.github.intellectualsites.plotsquared.plot.util.MathMan;
|
import com.github.intellectualsites.plotsquared.plot.util.*;
|
||||||
import com.github.intellectualsites.plotsquared.plot.util.StringComparison;
|
|
||||||
import com.github.intellectualsites.plotsquared.plot.util.UUIDHandler;
|
|
||||||
import com.github.intellectualsites.plotsquared.plot.util.WorldUtil;
|
|
||||||
import lombok.NonNull;
|
import lombok.NonNull;
|
||||||
import org.bukkit.Bukkit;
|
import org.bukkit.Bukkit;
|
||||||
import org.bukkit.Material;
|
import org.bukkit.Material;
|
||||||
@ -27,9 +22,7 @@ import org.bukkit.inventory.ItemStack;
|
|||||||
import org.bukkit.material.*;
|
import org.bukkit.material.*;
|
||||||
|
|
||||||
import javax.annotation.Nullable;
|
import javax.annotation.Nullable;
|
||||||
import java.util.ArrayList;
|
import java.util.*;
|
||||||
import java.util.Arrays;
|
|
||||||
import java.util.List;
|
|
||||||
|
|
||||||
@SuppressWarnings({"unused", "WeakerAccess"})
|
@SuppressWarnings({"unused", "WeakerAccess"})
|
||||||
public class BukkitUtil extends WorldUtil {
|
public class BukkitUtil extends WorldUtil {
|
||||||
@ -54,6 +47,141 @@ public class BukkitUtil extends WorldUtil {
|
|||||||
return new BukkitPlayer(player, true);
|
return new BukkitPlayer(player, true);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get a plot based on the location.
|
||||||
|
*
|
||||||
|
* @param location the location to check
|
||||||
|
* @return plot if found, otherwise it creates a temporary plot
|
||||||
|
* @see Plot
|
||||||
|
*/
|
||||||
|
public static Plot getPlot(org.bukkit.Location location) {
|
||||||
|
if (location == null) {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
return getLocation(location).getPlot();
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get a plot based on the player location.
|
||||||
|
*
|
||||||
|
* @param player the player to check
|
||||||
|
* @return plot if found, otherwise it creates a temporary plot
|
||||||
|
* @see #getPlot(org.bukkit.Location)
|
||||||
|
* @see Plot
|
||||||
|
*/
|
||||||
|
public static Plot getPlot(Player player) {
|
||||||
|
return getPlot(player.getLocation());
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get home location.
|
||||||
|
*
|
||||||
|
* @param plot Plot that you want to get the location for
|
||||||
|
* @return plot bottom location
|
||||||
|
* @see Plot
|
||||||
|
*/
|
||||||
|
public static org.bukkit.Location getHomeLocation(Plot plot) {
|
||||||
|
return BukkitUtil.getLocation(plot.getHome());
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get the PlotPlayer for an offline player.
|
||||||
|
* <p>
|
||||||
|
* <p>Note that this will work if the player is offline, however not all
|
||||||
|
* functionality will work.
|
||||||
|
*
|
||||||
|
* @param player the player to wrap
|
||||||
|
* @return a {@code PlotPlayer}
|
||||||
|
* @see PlotPlayer#wrap(Object)
|
||||||
|
*/
|
||||||
|
public static PlotPlayer wrapPlayer(OfflinePlayer player) {
|
||||||
|
return PlotPlayer.wrap(player);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Gets the PlotPlayer for a player. The PlotPlayer is usually cached and
|
||||||
|
* will provide useful functions relating to players.
|
||||||
|
*
|
||||||
|
* @param player the player to wrap
|
||||||
|
* @return a {@code PlotPlayer}
|
||||||
|
* @see PlotPlayer#wrap(Object)
|
||||||
|
*/
|
||||||
|
public static PlotPlayer wrapPlayer(Player player) {
|
||||||
|
return PlotPlayer.wrap(player);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Gets the number of plots, which the player is able to build in.
|
||||||
|
*
|
||||||
|
* @param player player, for whom we're getting the plots
|
||||||
|
* @return the number of allowed plots
|
||||||
|
*/
|
||||||
|
public static int getAllowedPlots(Player player) {
|
||||||
|
PlotPlayer plotPlayer = PlotPlayer.wrap(player);
|
||||||
|
return plotPlayer.getAllowedPlots();
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Check whether or not a player is in a plot.
|
||||||
|
*
|
||||||
|
* @param player who we're checking for
|
||||||
|
* @return true if the player is in a plot, false if not-
|
||||||
|
*/
|
||||||
|
public static boolean isInPlot(Player player) {
|
||||||
|
return getPlot(player) != null;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Gets a collection containing the players plots.
|
||||||
|
*
|
||||||
|
* @param world Specify the world we want to select the plots from
|
||||||
|
* @param player Player, for whom we're getting the plots
|
||||||
|
* @return a set containing the players plots
|
||||||
|
* @see Plot
|
||||||
|
*/
|
||||||
|
public static Set<Plot> getPlayerPlots(String world, Player player) {
|
||||||
|
if (world == null) {
|
||||||
|
return new HashSet<>();
|
||||||
|
}
|
||||||
|
return PlotPlayer.wrap(player).getPlots(world);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Send a message to a player. The message supports color codes.
|
||||||
|
*
|
||||||
|
* @param player the recipient of the message
|
||||||
|
* @param string the message
|
||||||
|
* @see MainUtil#sendMessage(PlotPlayer, String)
|
||||||
|
*/
|
||||||
|
public static void sendMessage(Player player, String string) {
|
||||||
|
MainUtil.sendMessage(BukkitUtil.getPlayer(player), string);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Gets the player plot count.
|
||||||
|
*
|
||||||
|
* @param world Specify the world we want to select the plots from
|
||||||
|
* @param player Player, for whom we're getting the plot count
|
||||||
|
* @return the number of plots the player has
|
||||||
|
*/
|
||||||
|
public static int getPlayerPlotCount(String world, Player player) {
|
||||||
|
if (world == null) {
|
||||||
|
return 0;
|
||||||
|
}
|
||||||
|
return BukkitUtil.getPlayer(player).getPlotCount(world);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Send a message to a player.
|
||||||
|
*
|
||||||
|
* @param player the recipient of the message
|
||||||
|
* @param caption the message
|
||||||
|
* @see MainUtil#sendMessage(PlotPlayer, C, String...)
|
||||||
|
*/
|
||||||
|
public static void sendMessage(Player player, C caption) {
|
||||||
|
MainUtil.sendMessage(BukkitUtil.getPlayer(player), caption);
|
||||||
|
}
|
||||||
|
|
||||||
public static PlotPlayer getPlayer(@NonNull final Player player) {
|
public static PlotPlayer getPlayer(@NonNull final Player player) {
|
||||||
if (player == lastPlayer) {
|
if (player == lastPlayer) {
|
||||||
return lastPlotPlayer;
|
return lastPlotPlayer;
|
||||||
|
@ -1,6 +1,5 @@
|
|||||||
package com.github.intellectualsites.plotsquared.plot.api;
|
package com.github.intellectualsites.plotsquared.api;
|
||||||
|
|
||||||
import com.github.intellectualsites.plotsquared.bukkit.util.BukkitUtil;
|
|
||||||
import com.github.intellectualsites.plotsquared.configuration.file.YamlConfiguration;
|
import com.github.intellectualsites.plotsquared.configuration.file.YamlConfiguration;
|
||||||
import com.github.intellectualsites.plotsquared.plot.PS;
|
import com.github.intellectualsites.plotsquared.plot.PS;
|
||||||
import com.github.intellectualsites.plotsquared.plot.config.C;
|
import com.github.intellectualsites.plotsquared.plot.config.C;
|
||||||
@ -16,19 +15,16 @@ import com.github.intellectualsites.plotsquared.plot.util.UUIDHandler;
|
|||||||
import com.github.intellectualsites.plotsquared.plot.util.block.GlobalBlockQueue;
|
import com.github.intellectualsites.plotsquared.plot.util.block.GlobalBlockQueue;
|
||||||
import com.github.intellectualsites.plotsquared.plot.uuid.UUIDWrapper;
|
import com.github.intellectualsites.plotsquared.plot.uuid.UUIDWrapper;
|
||||||
import lombok.NoArgsConstructor;
|
import lombok.NoArgsConstructor;
|
||||||
import org.bukkit.Location;
|
|
||||||
import org.bukkit.OfflinePlayer;
|
|
||||||
import org.bukkit.World;
|
|
||||||
import org.bukkit.entity.Player;
|
|
||||||
|
|
||||||
import java.util.*;
|
import java.util.Collections;
|
||||||
|
import java.util.Set;
|
||||||
|
import java.util.UUID;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* PlotSquared API.
|
* PlotSquared API.
|
||||||
* <p>
|
* <p>
|
||||||
* <p>Useful classes:
|
* <p>Useful classes:
|
||||||
* <ul>
|
* <ul>
|
||||||
* <li>{@link BukkitUtil}</li>
|
|
||||||
* <li>{@link PlotPlayer}</li>
|
* <li>{@link PlotPlayer}</li>
|
||||||
* <li>{@link Plot}</li>
|
* <li>{@link Plot}</li>
|
||||||
* <li>{@link com.github.intellectualsites.plotsquared.plot.object.Location}</li>
|
* <li>{@link com.github.intellectualsites.plotsquared.plot.object.Location}</li>
|
||||||
@ -57,8 +53,8 @@ public class PlotAPI {
|
|||||||
* @param player Player, whose plots to search for
|
* @param player Player, whose plots to search for
|
||||||
* @return all plots that a player owns
|
* @return all plots that a player owns
|
||||||
*/
|
*/
|
||||||
public Set<Plot> getPlayerPlots(Player player) {
|
public Set<Plot> getPlayerPlots(PlotPlayer player) {
|
||||||
return PS.get().getPlots(BukkitUtil.getPlayer(player));
|
return PS.get().getPlots(player);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@ -155,33 +151,11 @@ public class PlotAPI {
|
|||||||
* @param world The world to check for plot areas
|
* @param world The world to check for plot areas
|
||||||
* @return A set of PlotAreas
|
* @return A set of PlotAreas
|
||||||
*/
|
*/
|
||||||
public Set<PlotArea> getPlotAreas(World world) {
|
public Set<PlotArea> getPlotAreas(String world) {
|
||||||
if (world == null) {
|
if (world == null) {
|
||||||
return Collections.emptySet();
|
return Collections.emptySet();
|
||||||
}
|
}
|
||||||
return PS.get().getPlotAreas(world.getName());
|
return PS.get().getPlotAreas(world);
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Send a message to a player.
|
|
||||||
*
|
|
||||||
* @param player the recipient of the message
|
|
||||||
* @param caption the message
|
|
||||||
* @see MainUtil#sendMessage(PlotPlayer, C, String...)
|
|
||||||
*/
|
|
||||||
public void sendMessage(Player player, C caption) {
|
|
||||||
MainUtil.sendMessage(BukkitUtil.getPlayer(player), caption);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Send a message to a player. The message supports color codes.
|
|
||||||
*
|
|
||||||
* @param player the recipient of the message
|
|
||||||
* @param string the message
|
|
||||||
* @see MainUtil#sendMessage(PlotPlayer, String)
|
|
||||||
*/
|
|
||||||
public void sendMessage(Player player, String string) {
|
|
||||||
MainUtil.sendMessage(BukkitUtil.getPlayer(player), string);
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@ -214,53 +188,6 @@ public class PlotAPI {
|
|||||||
Flags.registerFlag(flag);
|
Flags.registerFlag(flag);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* Get a plot based on the location.
|
|
||||||
*
|
|
||||||
* @param location the location to check
|
|
||||||
* @return plot if found, otherwise it creates a temporary plot
|
|
||||||
* @see Plot
|
|
||||||
*/
|
|
||||||
public Plot getPlot(Location location) {
|
|
||||||
if (location == null) {
|
|
||||||
return null;
|
|
||||||
}
|
|
||||||
return BukkitUtil.getLocation(location).getPlot();
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Get a plot based on the player location.
|
|
||||||
*
|
|
||||||
* @param player the player to check
|
|
||||||
* @return plot if found, otherwise it creates a temporary plot
|
|
||||||
* @see #getPlot(Location)
|
|
||||||
* @see Plot
|
|
||||||
*/
|
|
||||||
public Plot getPlot(Player player) {
|
|
||||||
return this.getPlot(player.getLocation());
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Get home location.
|
|
||||||
*
|
|
||||||
* @param plot Plot that you want to get the location for
|
|
||||||
* @return plot bottom location
|
|
||||||
* @see Plot
|
|
||||||
*/
|
|
||||||
public Location getHomeLocation(Plot plot) {
|
|
||||||
return BukkitUtil.getLocation(plot.getHome());
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Check whether or not a player is in a plot.
|
|
||||||
*
|
|
||||||
* @param player who we're checking for
|
|
||||||
* @return true if the player is in a plot, false if not-
|
|
||||||
*/
|
|
||||||
public boolean isInPlot(Player player) {
|
|
||||||
return getPlot(player) != null;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Gets the PlotSquared class.
|
* Gets the PlotSquared class.
|
||||||
*
|
*
|
||||||
@ -271,59 +198,6 @@ public class PlotAPI {
|
|||||||
return PS.get();
|
return PS.get();
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* Gets the player plot count.
|
|
||||||
*
|
|
||||||
* @param world Specify the world we want to select the plots from
|
|
||||||
* @param player Player, for whom we're getting the plot count
|
|
||||||
* @return the number of plots the player has
|
|
||||||
*/
|
|
||||||
public int getPlayerPlotCount(World world, Player player) {
|
|
||||||
if (world == null) {
|
|
||||||
return 0;
|
|
||||||
}
|
|
||||||
return BukkitUtil.getPlayer(player).getPlotCount(world.getName());
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Gets a collection containing the players plots.
|
|
||||||
*
|
|
||||||
* @param world Specify the world we want to select the plots from
|
|
||||||
* @param player Player, for whom we're getting the plots
|
|
||||||
* @return a set containing the players plots
|
|
||||||
* @see PS#getPlots(String, PlotPlayer)
|
|
||||||
* @see Plot
|
|
||||||
*/
|
|
||||||
public Set<Plot> getPlayerPlots(World world, Player player) {
|
|
||||||
if (world == null) {
|
|
||||||
return new HashSet<>();
|
|
||||||
}
|
|
||||||
return PlotPlayer.wrap(player).getPlots(world.getName());
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Gets the number of plots, which the player is able to build in.
|
|
||||||
*
|
|
||||||
* @param player player, for whom we're getting the plots
|
|
||||||
* @return the number of allowed plots
|
|
||||||
*/
|
|
||||||
public int getAllowedPlots(Player player) {
|
|
||||||
PlotPlayer plotPlayer = PlotPlayer.wrap(player);
|
|
||||||
return plotPlayer.getAllowedPlots();
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Gets the PlotPlayer for a player. The PlotPlayer is usually cached and
|
|
||||||
* will provide useful functions relating to players.
|
|
||||||
*
|
|
||||||
* @param player the player to wrap
|
|
||||||
* @return a {@code PlotPlayer}
|
|
||||||
* @see PlotPlayer#wrap(Object)
|
|
||||||
*/
|
|
||||||
public PlotPlayer wrapPlayer(Player player) {
|
|
||||||
return PlotPlayer.wrap(player);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Get the PlotPlayer for a UUID.
|
* Get the PlotPlayer for a UUID.
|
||||||
* <p>
|
* <p>
|
||||||
@ -348,18 +222,4 @@ public class PlotAPI {
|
|||||||
public PlotPlayer wrapPlayer(String player) {
|
public PlotPlayer wrapPlayer(String player) {
|
||||||
return PlotPlayer.wrap(player);
|
return PlotPlayer.wrap(player);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* Get the PlotPlayer for an offline player.
|
|
||||||
* <p>
|
|
||||||
* <p>Note that this will work if the player is offline, however not all
|
|
||||||
* functionality will work.
|
|
||||||
*
|
|
||||||
* @param player the player to wrap
|
|
||||||
* @return a {@code PlotPlayer}
|
|
||||||
* @see PlotPlayer#wrap(Object)
|
|
||||||
*/
|
|
||||||
public PlotPlayer wrapPlayer(OfflinePlayer player) {
|
|
||||||
return PlotPlayer.wrap(player);
|
|
||||||
}
|
|
||||||
}
|
}
|
Loading…
Reference in New Issue
Block a user