com.sk89q.worldedit.bukkit

Class BukkitPlayer

java.lang.Object

com.sk89q.worldedit.extension.platform.AbstractPlayerActor

com.sk89q.worldedit.LocalPlayer

com.sk89q.worldedit.bukkit.BukkitPlayer

All Implemented Interfaces:

Entity, Player, Actor, SessionOwner, Subject, Faceted, Identifiable, Cloneable

public class BukkitPlayer
extends LocalPlayer

Constructor Summary

Constructors

Constructor and Description
BukkitPlayer(WorldEditPlugin plugin, ServerInterface server, org.bukkit.entity.Player player)

Method Summary

Modifier and Type	Method and Description
void	dispatchCUIEvent(CUIEvent event) Send a CUI event.
void	floatAt(int x, int y, int z, boolean alwaysGlass) Make the player float in the given blocks.
BaseBlock	getBlockInHand() Get the Block that the player is holding.
<T> T	getFacet(Class<? extends T> cls) Get the facet corresponding to the given class or interface.
String[]	getGroups() Get a list of groups that this subject is a part of.
BlockBag	getInventoryBlockBag() Get this actor's block bag.
int	getItemInHand() Get the ID of the item that the player is holding.
Location	getLocation() Get the location of this entity.
String	getName() Get the name of the actor.
double	getPitch() Get the player's view pitch in degrees.
org.bukkit.entity.Player	getPlayer()
WorldVector	getPosition() Get the actor's position.
SessionKey	getSessionKey() Get an object describing this session.
BaseEntity	getState() Get a copy of the entity's state.
UUID	getUniqueId() Get the UUID for this object.
LocalWorld	getWorld() Return the world that the player is on.
double	getYaw() Get the player's view yaw in degrees.
void	giveItem(int type, int amt) Gives the player an item.
boolean	hasCreativeMode() Return whether this actor has creative mode.
boolean	hasPermission(String perm) Return whether this subject has the given permission.
void	print(String msg) Print a WorldEdit message.
void	printDebug(String msg) Print a WorldEdit message.
void	printError(String msg) Print a WorldEdit error.
void	printRaw(String msg) Print a message.
void	setPosition(Vector pos, float pitch, float yaw) Move the player.

Methods inherited from class com.sk89q.worldedit.extension.platform.AbstractPlayerActor

ascendLevel, ascendToCeiling, ascendToCeiling, ascendUpwards, ascendUpwards, canDestroyBedrock, checkPermission, clone, descendLevel, equals, findFreePosition, findFreePosition, getBlockIn, getBlockOn, getBlockTrace, getBlockTrace, getBlockTraceFace, getCardinalDirection, getCardinalDirection, getExtent, getSolidBlockTrace, hashCode, isHoldingPickAxe, isPlayer, openFileOpenDialog, openFileSaveDialog, passThroughForwardWall, remove, setOnGround, setPosition

Methods inherited from class java.lang.Object

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

Constructor Detail

BukkitPlayer

public BukkitPlayer(WorldEditPlugin plugin,
                    ServerInterface server,
                    org.bukkit.entity.Player player)

Method Detail

getUniqueId

public UUID getUniqueId()

Description copied from interface: Identifiable

Get the UUID for this object.

Returns:

the UUID

getItemInHand

public int getItemInHand()

Description copied from interface: Player

Get the ID of the item that the player is holding.

Returns:

the item id of the item the player is holding

getBlockInHand

public BaseBlock getBlockInHand()
                         throws WorldEditException

Description copied from interface: Player

Get the Block that the player is holding.

Specified by:

getBlockInHand in interface Player

Overrides:

getBlockInHand in class AbstractPlayerActor

Returns:

the item id of the item the player is holding

Throws:

WorldEditException

getName

public String getName()

Description copied from interface: Actor

Get the name of the actor.

Returns:

String

getPosition

public WorldVector getPosition()

Description copied from interface: Player

Get the actor's position.

If the actor has no permission, then a dummy location is returned.

Returns:

the actor's position

getPitch

public double getPitch()

Description copied from interface: Player

Get the player's view pitch in degrees.

Returns:

pitch

getYaw

public double getYaw()

Description copied from interface: Player

Get the player's view yaw in degrees.

Returns:

yaw

giveItem

public void giveItem(int type,
                     int amt)

Description copied from interface: Player

Gives the player an item.

Parameters:

type - The item id of the item to be given to the player

amt - How many items in the stack

printRaw

public void printRaw(String msg)

Description copied from interface: Actor

Print a message.

Parameters:

msg - The message text

print

public void print(String msg)

Description copied from interface: Actor

Print a WorldEdit message.

Parameters:

msg - The message text

printDebug

public void printDebug(String msg)

Description copied from interface: Actor

Print a WorldEdit message.

Parameters:

msg - The message text

printError

public void printError(String msg)

Description copied from interface: Actor

Print a WorldEdit error.

Parameters:

msg - The error message text

setPosition

public void setPosition(Vector pos,
                        float pitch,
                        float yaw)

Description copied from interface: Player

Move the player.

Parameters:

pos - where to move them

pitch - the pitch (up/down) of the player's view in degrees

yaw - the yaw (left/right) of the player's view in degrees

getGroups

public String[] getGroups()

Description copied from interface: Subject

Get a list of groups that this subject is a part of.

Returns:

an array containing a group name per entry

getInventoryBlockBag

public BlockBag getInventoryBlockBag()

Description copied from interface: Player

Get this actor's block bag.

Returns:

the actor's block bag

hasPermission

public boolean hasPermission(String perm)

Description copied from interface: Subject

Return whether this subject has the given permission.

Parameters:

perm - the permission

Returns:

true if permission is granted

getWorld

public LocalWorld getWorld()

Description copied from interface: Player

Return the world that the player is on.

Returns:

the world

dispatchCUIEvent

public void dispatchCUIEvent(CUIEvent event)

Description copied from interface: Actor

Send a CUI event.

Specified by:

dispatchCUIEvent in interface Actor

Overrides:

dispatchCUIEvent in class AbstractPlayerActor

Parameters:

event - the event

getPlayer

public org.bukkit.entity.Player getPlayer()

hasCreativeMode

public boolean hasCreativeMode()

Description copied from interface: Player

Return whether this actor has creative mode.

Specified by:

hasCreativeMode in interface Player

Overrides:

hasCreativeMode in class AbstractPlayerActor

Returns:

true if creative mode is enabled

floatAt

public void floatAt(int x,
                    int y,
                    int z,
                    boolean alwaysGlass)

Description copied from interface: Player

Make the player float in the given blocks.

Specified by:

floatAt in interface Player

Overrides:

floatAt in class AbstractPlayerActor

Parameters:

x - The X coordinate of the block to float in

y - The Y coordinate of the block to float in

z - The Z coordinate of the block to float in

getState

public BaseEntity getState()

Description copied from interface: Entity

Get a copy of the entity's state.

In some cases, this method may return null if a snapshot of the entity can't be created. It may not be possible, for example, to get a snapshot of a player.

Returns:

the entity's state or null if one cannot be created

getLocation

public Location getLocation()

Description copied from interface: Entity

Get the location of this entity.

Returns:

the location of the entity

getFacet

@Nullable
public <T> T getFacet(Class<? extends T> cls)

Description copied from interface: Faceted

Get the facet corresponding to the given class or interface.

Type Parameters:

T - the type

Parameters:

cls - the class or interface

Returns:

an implementation of the facet or null if one is unavailable

getSessionKey

public SessionKey getSessionKey()

Description copied from interface: SessionOwner

Get an object describing this session.

Returns:

the status object