com.sk89q.worldedit

Class LocalPlayer

java.lang.Object

com.sk89q.worldedit.LocalPlayer

Direct Known Subclasses:

BukkitCommandSender, BukkitPlayer

public abstract class LocalPlayer
extends Object

Author:

sk89q

Field Summary

Fields

Modifier and Type	Field and Description
protected ServerInterface	server Server.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	LocalPlayer(ServerInterface server) Construct the object.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	ascendLevel() Go up one level to the next free space above.
boolean	ascendToCeiling(int clearance) Ascend to the ceiling above.
boolean	ascendToCeiling(int clearance, boolean alwaysGlass) Ascend to the ceiling above.
boolean	ascendUpwards(int distance) Just go up.
boolean	ascendUpwards(int distance, boolean alwaysGlass) Just go up.
boolean	canDestroyBedrock() Returns true if the player can destroy bedrock.
void	checkPermission(String permission)
boolean	descendLevel() Go up one level to the next free space above.
void	dispatchCUIEvent(CUIEvent event) Send a CUI event.
void	dispatchCUIHandshake() Deprecated. Not used anymore; The CUI begins the handshake
boolean	equals(Object other)
void	findFreePosition() Find a position for the player to stand that is not inside a block.
void	findFreePosition(WorldVector searchPos) Find a position for the player to stand that is not inside a block.
void	floatAt(int x, int y, int z, boolean alwaysGlass) Make the player float in the given blocks.
WorldVector	getBlockIn() Get the point of the block that is being stood in.
BaseBlock	getBlockInHand() Get the Block that the player is holding.
WorldVector	getBlockOn() Get the point of the block that is being stood upon.
WorldVector	getBlockTrace(int range) Get the point of the block being looked at.
WorldVector	getBlockTrace(int range, boolean useLastBlock) Get the point of the block being looked at.
WorldVectorFace	getBlockTraceFace(int range, boolean useLastBlock)
PlayerDirection	getCardinalDirection() Get the player's cardinal direction (N, W, NW, etc.).
PlayerDirection	getCardinalDirection(int yawOffset) Get the player's cardinal direction (N, W, NW, etc.) with an offset.
abstract String[]	getGroups() Get a player's list of groups.
abstract BlockBag	getInventoryBlockBag() Get this player's block bag.
abstract int	getItemInHand() Get the ID of the item that the player is holding.
abstract String	getName() Get the name of the player.
abstract double	getPitch() Get the player's view pitch.
abstract WorldVector	getPosition() Get the player's position.
WorldVector	getSolidBlockTrace(int range) Get the point of the block being looked at.
abstract LocalWorld	getWorld() Get the player's world.
abstract double	getYaw() Get the player's view yaw.
abstract void	giveItem(int type, int amount) Gives the player an item.
boolean	hasCreativeMode()
int	hashCode()
abstract boolean	hasPermission(String perm) Checks if a player has permission.
boolean	isHoldingPickAxe() Returns true if the player is holding a pick axe.
boolean	isPlayer()
File	openFileOpenDialog(String[] extensions) Open a file open dialog.
File	openFileSaveDialog(String[] extensions) Open a file save dialog.
boolean	passThroughForwardWall(int range) Pass through the wall that you are looking at.
abstract void	print(String msg) Print a WorldEdit message.
abstract void	printDebug(String msg) Print a WorldEdit message.
abstract void	printError(String msg) Print a WorldEdit error.
abstract void	printRaw(String msg) Print a message.
void	setOnGround(WorldVector searchPos) Set the player on the ground.
void	setPosition(Vector pos) Move the player.
abstract void	setPosition(Vector pos, float pitch, float yaw) Move the player.

Methods inherited from class java.lang.Object

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

Field Detail

server

protected ServerInterface server

Server.

Constructor Detail

LocalPlayer

protected LocalPlayer(ServerInterface server)

Construct the object.

Parameters:

server - A reference to the server this player is on

Method Detail

isHoldingPickAxe

public boolean isHoldingPickAxe()

Returns true if the player is holding a pick axe.

Returns:

whether a pick axe is held

findFreePosition

public void findFreePosition(WorldVector searchPos)

Find a position for the player to stand that is not inside a block. Blocks above the player will be iteratively tested until there is a series of two free blocks. The player will be teleported to that free position.

Parameters:

searchPos - search position

setOnGround

public void setOnGround(WorldVector searchPos)

Set the player on the ground.

Parameters:

searchPos - The location to start searching from

findFreePosition

public void findFreePosition()

Find a position for the player to stand that is not inside a block. Blocks above the player will be iteratively tested until there is a series of two free blocks. The player will be teleported to that free position.

ascendLevel

public boolean ascendLevel()

Go up one level to the next free space above.

Returns:

true if a spot was found

descendLevel

public boolean descendLevel()

Go up one level to the next free space above.

Returns:

true if a spot was found

ascendToCeiling

public boolean ascendToCeiling(int clearance)

Ascend to the ceiling above.

Parameters:

clearance - How many blocks to leave above the player's head

Returns:

whether the player was moved

ascendToCeiling

public boolean ascendToCeiling(int clearance,
                      boolean alwaysGlass)

Ascend to the ceiling above.

Parameters:

clearance - How many blocks to leave above the player's head

alwaysGlass - Always put glass under the player

Returns:

whether the player was moved

ascendUpwards

public boolean ascendUpwards(int distance)

Just go up.

Parameters:

distance - How far up to teleport

Returns:

whether the player was moved

ascendUpwards

public boolean ascendUpwards(int distance,
                    boolean alwaysGlass)

Just go up.

Parameters:

distance - How far up to teleport

alwaysGlass - Always put glass under the player

Returns:

whether the player was moved

floatAt

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

Make the player float in the given blocks.

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

getBlockIn

public WorldVector getBlockIn()

Get the point of the block that is being stood in.

Returns:

point

getBlockOn

public WorldVector getBlockOn()

Get the point of the block that is being stood upon.

Returns:

point

getBlockTrace

public WorldVector getBlockTrace(int range,
                        boolean useLastBlock)

Get the point of the block being looked at. May return null. Will return the farthest away air block if useLastBlock is true and no other block is found.

Parameters:

range - How far to checks for blocks

useLastBlock - Try to return the last valid air block found.

Returns:

point

getBlockTraceFace

public WorldVectorFace getBlockTraceFace(int range,
                                boolean useLastBlock)

getBlockTrace

public WorldVector getBlockTrace(int range)

Get the point of the block being looked at. May return null.

Parameters:

range - How far to checks for blocks

Returns:

point

getSolidBlockTrace

public WorldVector getSolidBlockTrace(int range)

Get the point of the block being looked at. May return null.

Parameters:

range - How far to checks for blocks

Returns:

point

getCardinalDirection

public PlayerDirection getCardinalDirection()

Get the player's cardinal direction (N, W, NW, etc.). May return null.

Returns:

the direction

getCardinalDirection

public PlayerDirection getCardinalDirection(int yawOffset)

Get the player's cardinal direction (N, W, NW, etc.) with an offset. May return null.

Parameters:

yawOffset - offset that is added to the player's yaw before determining the cardinal direction

Returns:

the direction

getItemInHand

public abstract int getItemInHand()

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

Get the Block that the player is holding.

Returns:

the item id of the item the player is holding

Throws:

WorldEditException

getName

public abstract String getName()

Get the name of the player.

Returns:

String

getPosition

public abstract WorldVector getPosition()

Get the player's position.

Returns:

point

getWorld

public abstract LocalWorld getWorld()

Get the player's world.

Returns:

point

getPitch

public abstract double getPitch()

Get the player's view pitch.

Returns:

pitch

getYaw

public abstract double getYaw()

Get the player's view yaw.

Returns:

yaw

giveItem

public abstract void giveItem(int type,
            int amount)

Gives the player an item.

Parameters:

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

amount - How many items in the stack

passThroughForwardWall

public boolean passThroughForwardWall(int range)

Pass through the wall that you are looking at.

Parameters:

range - How far to checks for blocks

Returns:

whether the player was pass through

printRaw

public abstract void printRaw(String msg)

Print a message.

Parameters:

msg - The message text

printDebug

public abstract void printDebug(String msg)

Print a WorldEdit message.

Parameters:

msg - The message text

print

public abstract void print(String msg)

Print a WorldEdit message.

Parameters:

msg - The message text

printError

public abstract void printError(String msg)

Print a WorldEdit error.

Parameters:

msg - The error message text

setPosition

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

Move the player.

Parameters:

pos - Where to move them

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

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

setPosition

public void setPosition(Vector pos)

Move the player.

Parameters:

pos - Where to move them

getGroups

public abstract String[] getGroups()

Get a player's list of groups.

Returns:

an array containing a group name per entry

getInventoryBlockBag

public abstract BlockBag getInventoryBlockBag()

Get this player's block bag.

Returns:

the player's block bag

hasPermission

public abstract boolean hasPermission(String perm)

Checks if a player has permission.

Parameters:

perm - The permission to check

Returns:

true if the player has that permission

openFileOpenDialog

public File openFileOpenDialog(String[] extensions)

Open a file open dialog.

Parameters:

extensions - null to allow all

Returns:

the selected file or null if something went wrong

openFileSaveDialog

public File openFileSaveDialog(String[] extensions)

Open a file save dialog.

Parameters:

extensions - null to allow all

Returns:

the selected file or null if something went wrong

canDestroyBedrock

public boolean canDestroyBedrock()

Returns true if the player can destroy bedrock.

Returns:

dispatchCUIEvent

public void dispatchCUIEvent(CUIEvent event)

Send a CUI event.

Parameters:

event -

dispatchCUIHandshake

@Deprecated
public void dispatchCUIHandshake()

Deprecated. Not used anymore; The CUI begins the handshake

Send the CUI handshake.

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

checkPermission

public void checkPermission(String permission)
                     throws WorldEditPermissionException

Throws:

WorldEditPermissionException

isPlayer

public boolean isPlayer()

hasCreativeMode

public boolean hasCreativeMode()