com.codelanx.codelanxlib.util

Class Players

java.lang.Object

com.codelanx.codelanxlib.util.Players

public final class Players
extends Object

Class description for Players

Since:

0.0.1

Version:

0.1.0

Author:

1Rogue

Method Summary

Modifier and Type	Method and Description
static org.bukkit.entity.Player	getClosestPlayer(org.bukkit.Location loc) Returns the closest Player to a specific Location
static org.bukkit.entity.Player	getClosestPlayer(org.bukkit.entity.Player p) Returns the closest Player adjacent to another Player
static Map<org.bukkit.entity.Player,Double>	getPlayersInRange(int range, org.bukkit.Location origin) Gets any players within range of a specific location
static Map<org.bukkit.entity.Player,Double>	getPlayersInRange(int range, org.bukkit.entity.Player origin) Gets any players within range of a specific player, exclusive of the player themselves.

Methods inherited from class java.lang.Object

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

Method Detail

getPlayersInRange

public static Map<org.bukkit.entity.Player,Double> getPlayersInRange(int range,
                                                                     org.bukkit.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<org.bukkit.entity.Player,Double> getPlayersInRange(int range,
                                                                     org.bukkit.entity.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 org.bukkit.entity.Player getClosestPlayer(org.bukkit.entity.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 org.bukkit.entity.Player getClosestPlayer(org.bukkit.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