com.sk89q.worldedit.extension.platform

Class AbstractPlayerActor

java.lang.Object

com.sk89q.worldedit.extension.platform.AbstractPlayerActor

All Implemented Interfaces:

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

Direct Known Subclasses:

LocalPlayer

public abstract class AbstractPlayerActor
extends Object
implements Actor, Player, Cloneable

An abstract implementation of both a Actor and a Player that is intended for implementations of WorldEdit to use to wrap players that make use of WorldEdit.

Constructor Summary

Constructors

Constructor and Description
AbstractPlayerActor()

Method Summary

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 actor can destroy bedrock.
void	checkPermission(String permission) Check whether this subject has been granted the given permission and throw an exception on error.
Object	clone()
boolean	descendLevel() Go up one level to the next free space above.
void	dispatchCUIEvent(CUIEvent event) Send a CUI event.
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 actor 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) Get the face that the player is looking at.
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.
Extent	getExtent() Get the extent that this entity is on.
WorldVector	getSolidBlockTrace(int range) Get the point of the block being looked at.
boolean	hasCreativeMode() Return whether this actor has creative mode.
int	hashCode()
boolean	isHoldingPickAxe() Returns true if the entity is holding a pick axe.
boolean	isPlayer() Return whether this actor is a player.
File	openFileOpenDialog(String[] extensions) Open a file open dialog.
File	openFileSaveDialog(String[] extensions) Open a file save dialog.
boolean	passThroughForwardWall(int range) Get the player's view yaw.
boolean	remove() Remove this entity from it container.
void	setOnGround(WorldVector searchPos) Set the actor on the ground.
void	setPosition(Vector pos) Move the player.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.sk89q.worldedit.entity.Player

getInventoryBlockBag, getItemInHand, getPitch, getPosition, getWorld, getYaw, giveItem, setPosition

Methods inherited from interface com.sk89q.worldedit.entity.Entity

getLocation, getState

Methods inherited from interface com.sk89q.worldedit.util.Faceted

getFacet

Methods inherited from interface com.sk89q.worldedit.extension.platform.Actor

getName, print, printDebug, printError, printRaw

Methods inherited from interface com.sk89q.worldedit.util.Identifiable

getUniqueId

Methods inherited from interface com.sk89q.worldedit.session.SessionOwner

getSessionKey

Constructor Detail

AbstractPlayerActor

public AbstractPlayerActor()

Method Detail

getExtent

public final Extent getExtent()

Description copied from interface: Entity

Get the extent that this entity is on.

Specified by:

getExtent in interface Entity

Returns:

the extent

isHoldingPickAxe

public boolean isHoldingPickAxe()

Description copied from interface: Player

Returns true if the entity is holding a pick axe.

Specified by:

isHoldingPickAxe in interface Player

Returns:

whether a pick axe is held

findFreePosition

public void findFreePosition(WorldVector searchPos)

Description copied from interface: Player

Find a position for the actor 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 actor will be teleported to that free position.

Specified by:

findFreePosition in interface Player

Parameters:

searchPos - search position

setOnGround

public void setOnGround(WorldVector searchPos)

Description copied from interface: Player

Set the actor on the ground.

Specified by:

setOnGround in interface Player

Parameters:

searchPos - The location to start searching from

findFreePosition

public void findFreePosition()

Description copied from interface: Player

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.

Specified by:

findFreePosition in interface Player

ascendLevel

public boolean ascendLevel()

Description copied from interface: Player

Go up one level to the next free space above.

Specified by:

ascendLevel in interface Player

Returns:

true if a spot was found

descendLevel

public boolean descendLevel()

Description copied from interface: Player

Go up one level to the next free space above.

Specified by:

descendLevel in interface Player

Returns:

true if a spot was found

ascendToCeiling

public boolean ascendToCeiling(int clearance)

Description copied from interface: Player

Ascend to the ceiling above.

Specified by:

ascendToCeiling in interface Player

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)

Description copied from interface: Player

Ascend to the ceiling above.

Specified by:

ascendToCeiling in interface Player

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)

Description copied from interface: Player

Just go up.

Specified by:

ascendUpwards in interface Player

Parameters:

distance - How far up to teleport

Returns:

whether the player was moved

ascendUpwards

public boolean ascendUpwards(int distance,
                             boolean alwaysGlass)

Description copied from interface: Player

Just go up.

Specified by:

ascendUpwards in interface Player

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)

Description copied from interface: Player

Make the player float in the given blocks.

Specified by:

floatAt in interface Player

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()

Description copied from interface: Player

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

Specified by:

getBlockIn in interface Player

Returns:

point

getBlockOn

public WorldVector getBlockOn()

Description copied from interface: Player

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

Specified by:

getBlockOn in interface Player

Returns:

point

getBlockTrace

public WorldVector getBlockTrace(int range,
                                 boolean useLastBlock)

Description copied from interface: Player

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.

Specified by:

getBlockTrace in interface Player

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)

Description copied from interface: Player

Get the face that the player is looking at.

Specified by:

getBlockTraceFace in interface Player

Parameters:

range - the range

useLastBlock - try to return the last valid air block found

Returns:

a face

getBlockTrace

public WorldVector getBlockTrace(int range)

Description copied from interface: Player

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

Specified by:

getBlockTrace in interface Player

Parameters:

range - How far to checks for blocks

Returns:

point

getSolidBlockTrace

public WorldVector getSolidBlockTrace(int range)

Description copied from interface: Player

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

Specified by:

getSolidBlockTrace in interface Player

Parameters:

range - How far to checks for blocks

Returns:

point

getCardinalDirection

public PlayerDirection getCardinalDirection()

Description copied from interface: Player

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

Specified by:

getCardinalDirection in interface Player

Returns:

the direction

getCardinalDirection

public PlayerDirection getCardinalDirection(int yawOffset)

Description copied from interface: Player

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

Specified by:

getCardinalDirection in interface Player

Parameters:

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

Returns:

the direction

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

Returns:

the item id of the item the player is holding

Throws:

WorldEditException

passThroughForwardWall

public boolean passThroughForwardWall(int range)

Get the player's view yaw.

Specified by:

passThroughForwardWall in interface Player

Parameters:

range - How far to checks for blocks

Returns:

yaw

setPosition

public void setPosition(Vector pos)

Description copied from interface: Player

Move the player.

Specified by:

setPosition in interface Player

Parameters:

pos - where to move them

openFileOpenDialog

public File openFileOpenDialog(String[] extensions)

Description copied from interface: Actor

Open a file open dialog.

Specified by:

openFileOpenDialog in interface Actor

Parameters:

extensions - null to allow all

Returns:

the selected file or null if something went wrong

openFileSaveDialog

public File openFileSaveDialog(String[] extensions)

Description copied from interface: Actor

Open a file save dialog.

Specified by:

openFileSaveDialog in interface Actor

Parameters:

extensions - null to allow all

Returns:

the selected file or null if something went wrong

canDestroyBedrock

public boolean canDestroyBedrock()

Description copied from interface: Actor

Returns true if the actor can destroy bedrock.

Specified by:

canDestroyBedrock in interface Actor

Returns:

true if bedrock can be broken by the actor

dispatchCUIEvent

public void dispatchCUIEvent(CUIEvent event)

Description copied from interface: Actor

Send a CUI event.

Specified by:

dispatchCUIEvent in interface Actor

Parameters:

event - the event

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 AuthorizationException

Description copied from interface: Subject

Check whether this subject has been granted the given permission and throw an exception on error.

Specified by:

checkPermission in interface Subject

Parameters:

permission - the permission

Throws:

AuthorizationException - thrown if not permitted

isPlayer

public boolean isPlayer()

Description copied from interface: Actor

Return whether this actor is a player.

Specified by:

isPlayer in interface Actor

Returns:

true if a player

hasCreativeMode

public boolean hasCreativeMode()

Description copied from interface: Player

Return whether this actor has creative mode.

Specified by:

hasCreativeMode in interface Player

Returns:

true if creative mode is enabled

clone

public Object clone()
             throws CloneNotSupportedException

Overrides:

clone in class Object

Throws:

CloneNotSupportedException

remove

public boolean remove()

Description copied from interface: Entity

Remove this entity from it container.

Specified by:

remove in interface Entity

Returns:

true if removal was successful