com.sk89q.worldguard

Class LocalPlayer

java.lang.Object

com.sk89q.worldguard.LocalPlayer

All Implemented Interfaces:

RegionAssociable

Direct Known Subclasses:

BukkitPlayer

public abstract class LocalPlayer
extends Object
implements RegionAssociable

Constructor Summary

Constructors

Constructor and Description
LocalPlayer()

Method Summary

Modifier and Type	Method and Description
abstract void	ban(String msg) Ban this player.
boolean	equals(Object obj)
Association	getAssociation(List<ProtectedRegion> regions) Get the highest association level for the input regions.
abstract String[]	getGroups() Get this player's list of groups.
abstract String	getName() Get this player's name.
abstract com.sk89q.worldedit.Vector	getPosition() Get this player's position.
abstract UUID	getUniqueId() Get this player's unique ID.
abstract boolean	hasGroup(String group) Returns true if this player is inside a group.
int	hashCode()
abstract boolean	hasPermission(String perm) Returns whether this player has permission.
abstract void	kick(String msg) Kick this player.
abstract void	printRaw(String msg) Send this player a message.

Methods inherited from class java.lang.Object

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

Constructor Detail

LocalPlayer

public LocalPlayer()

Method Detail

getName

public abstract String getName()

Get this player's name.

Returns:

The player's name

getUniqueId

public abstract UUID getUniqueId()

Get this player's unique ID.

Returns:

a UUID

hasGroup

public abstract boolean hasGroup(String group)

Returns true if this player is inside a group.

Parameters:

group - The group to check

Returns:

Whether this player is in group

getPosition

public abstract com.sk89q.worldedit.Vector getPosition()

Get this player's position.

Returns:

The player's position

kick

public abstract void kick(String msg)

Kick this player.

Parameters:

msg - The message to kick the player with

ban

public abstract void ban(String msg)

Ban this player.

Parameters:

msg - The message to ban the player with

printRaw

public abstract void printRaw(String msg)

Send this player a message.

Parameters:

msg - The message to send to the player

getGroups

public abstract String[] getGroups()

Get this player's list of groups.

Returns:

The groups this player is in

hasPermission

public abstract boolean hasPermission(String perm)

Returns whether this player has permission.

Parameters:

perm - The permission to check

Returns:

Whether this player has perm

getAssociation

public Association getAssociation(List<ProtectedRegion> regions)

Description copied from interface: RegionAssociable

Get the highest association level for the input regions.

Specified by:

getAssociation in interface RegionAssociable

Parameters:

regions - a list of regions

Returns:

the highest membership level

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object