com.codelanx.codelanxlib.util

Class Players

java.lang.Object

com.codelanx.codelanxlib.util.Players

public final class Players
extends Object

Represents utility functions to simplify or clarify common operations with Bukkit's Player object

Since:

0.0.1

Version:

0.1.0

Author:

1Rogue

Method Summary

Modifier and Type	Method and Description
static Player	getClosestPlayer(Location loc) Returns the closest Player to a specific Location
static Player	getClosestPlayer(Player p) Returns the closest Player adjacent to another Player
static Map<Player,Double>	getPlayersInRange(int range, Location origin) Gets any players within range of a specific location
static Map<Player,Double>	getPlayersInRange(int range, Player origin) Gets any players within range of a specific player, exclusive of the player themselves.
static UUID	getUUID(String name) Gets the most correct UUID for the Player in the least expensive way possible.
static boolean	hasCorrectOfflineUUID(String name) Returns whether or not a player by the specified name parameter has played on this server before, or is currently online, thus resulting in having a correct UUID
static boolean	isSafeLocation(Location in) Determines whether or not a location is harmful if a player was to be located there in the current instant of time (such as a teleport)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getPlayersInRange

public static Map<Player,Double> getPlayersInRange(int range,
                                                   Location origin)

Gets any players within range of a specific location

Parameters:

range - The range in which to look for players

origin - The Location representing the center of the circle

Returns:

Any players within the radius range of the origin, mapped to the distance away they are

Since:

0.0.1

getPlayersInRange

public static Map<Player,Double> getPlayersInRange(int range,
                                                   Player origin)

Gets any players within range of a specific player, exclusive of the player themselves.

Parameters:

range - The range in which to look for players

origin - The Player representing the center of the circle

Returns:

Any players within the radius range of the origin, mapped to the distance away they are

Since:

0.0.1

getClosestPlayer

public static Player getClosestPlayer(Player p)

Returns the closest Player adjacent to another Player

Parameters:

p - The Player at the origin to search around

Returns:

The closest Player, or null if no one else is in the world

Since:

0.1.0

getClosestPlayer

public static Player getClosestPlayer(Location loc)

Returns the closest Player to a specific Location

Parameters:

loc - The Location representing the origin to search from

Returns:

The closest Player, or null if no one is in the world

Since:

0.1.0

isSafeLocation

public static boolean isSafeLocation(Location in)

Determines whether or not a location is harmful if a player was to be located there in the current instant of time (such as a teleport)

Parameters:

in - The Location to check

Returns:

true if the location is safe

Since:

0.1.0

getUUID

public static UUID getUUID(String name)

Gets the most correct UUID for the Player in the least expensive way possible. Note however, if there is no UUID information about the player on the server (e.g., they never played before), it will send a blocking web request to Mojang's servers

Parameters:

name - The name of the Player

Returns:

The UUID for that player

Since:

0.1.0

hasCorrectOfflineUUID

public static boolean hasCorrectOfflineUUID(String name)

Returns whether or not a player by the specified name parameter has played on this server before, or is currently online, thus resulting in having a correct UUID

Parameters:

name - The player name to look for

Returns:

true if the UUID will be correct

Since:

0.1.0