Enum Class LocationUtil
- All Implemented Interfaces:
Serializable
,Comparable<LocationUtil>
,Constable
Responsible for various transformations and queries of locations.
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Method Summary
Modifier and TypeMethodDescriptionstatic org.bukkit.Location
alignToDistance
(org.bukkit.Location loc, int distance) static String
asKey
(org.bukkit.Location loc) static String
asString
(org.bukkit.Location loc) static org.bukkit.Location
centerInBlock
(org.bukkit.Location loc) static org.bukkit.Location
centerOnBlock
(org.bukkit.Location loc) static org.bukkit.Location
findChestLocation
(org.bukkit.Location loc) Finds the nearest block to loc that is a chest.static org.bukkit.Location
findNearestSafeLocation
(org.bukkit.Location loc, org.bukkit.Location lookAt) static Optional<org.bukkit.Location>
findNearestSpawnLocation
(@NotNull org.bukkit.Location loc) static org.bukkit.block.Block
findRoofBlock
(org.bukkit.Location loc) Finds the nearest solid block above the location.static org.bukkit.Location
fromString
(String locString) static String
getCardinalDirection
(float yaw) static String
getIslandName
(org.bukkit.Location location) static boolean
isEmptyLocation
(org.bukkit.Location location) static boolean
isSafeLocation
(org.bukkit.Location l) static void
loadChunkAt
(org.bukkit.Location loc) static LocationUtil
Returns the enum constant of this class with the specified name.static LocationUtil[]
values()
Returns an array containing the constants of this enum class, in the order they are declared.Methods inherited from class java.lang.Enum
compareTo, describeConstable, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
-
Method Details
-
values
Returns an array containing the constants of this enum class, in the order they are declared.- Returns:
- an array containing the constants of this enum class, in the order they are declared
-
valueOf
Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)- Parameters:
name
- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException
- if this enum class has no constant with the specified nameNullPointerException
- if the argument is null
-
asString
-
asKey
-
fromString
-
isEmptyLocation
public static boolean isEmptyLocation(org.bukkit.Location location) -
getIslandName
-
centerOnBlock
public static org.bukkit.Location centerOnBlock(org.bukkit.Location loc) -
centerInBlock
public static org.bukkit.Location centerInBlock(org.bukkit.Location loc) -
isSafeLocation
public static boolean isSafeLocation(org.bukkit.Location l) -
loadChunkAt
public static void loadChunkAt(org.bukkit.Location loc) -
findChestLocation
public static org.bukkit.Location findChestLocation(org.bukkit.Location loc) Finds the nearest block to loc that is a chest.- Parameters:
loc
- The location to scan for a chest.- Returns:
- The location of the chest
-
findNearestSpawnLocation
public static Optional<org.bukkit.Location> findNearestSpawnLocation(@NotNull @NotNull org.bukkit.Location loc) -
findNearestSafeLocation
public static org.bukkit.Location findNearestSafeLocation(org.bukkit.Location loc, org.bukkit.Location lookAt) -
alignToDistance
public static org.bukkit.Location alignToDistance(org.bukkit.Location loc, int distance) -
findRoofBlock
public static org.bukkit.block.Block findRoofBlock(org.bukkit.Location loc) Finds the nearest solid block above the location. -
getCardinalDirection
-