com.sk89q.worldedit.internal.command

Class WorldEditBinding

java.lang.Object

com.sk89q.worldedit.util.command.parametric.BindingHelper

com.sk89q.worldedit.internal.command.WorldEditBinding

All Implemented Interfaces:

Binding

public class WorldEditBinding
extends BindingHelper

Binds standard WorldEdit classes such as Player and LocalSession.

Constructor Summary

Constructors

Constructor and Description
WorldEditBinding(WorldEdit worldEdit) Create a new instance.

Method Summary

Modifier and Type	Method and Description
Actor	getActor(ArgumentStack context) Gets an Actor from a ArgumentStack.
BaseBlock	getBaseBlock(ArgumentStack context) Gets an BaseBlock from a ArgumentStack.
BaseBiome	getBiomeType(ArgumentStack context) Gets an BaseBiome from a ArgumentStack.
Vector	getDirection(ArgumentStack context, Direction direction) Get a direction from the player.
EditSession	getEditSession(ArgumentStack context) Gets an EditSession from a ArgumentStack.
LocalSession	getLocalSession(ArgumentStack context) Gets an LocalSession from a ArgumentStack.
Mask	getMask(ArgumentStack context) Gets an Mask from a ArgumentStack.
Pattern	getPattern(ArgumentStack context) Gets an Pattern from a ArgumentStack.
Player	getPlayer(ArgumentStack context) Gets an Player from a ArgumentStack.
Object	getSelection(ArgumentStack context, Selection selection) Gets a selection from a ArgumentStack.
TreeGenerator.TreeType	getTreeType(ArgumentStack context) Gets an TreeGenerator.TreeType from a ArgumentStack.

Methods inherited from class com.sk89q.worldedit.util.command.parametric.BindingHelper

bind, getBehavior, getConsumedCount, getSuggestions, getTypes

Methods inherited from class java.lang.Object

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

Constructor Detail

WorldEditBinding

public WorldEditBinding(WorldEdit worldEdit)

Create a new instance.

Parameters:

worldEdit - the WorldEdit instance to bind to

Method Detail

getSelection

public Object getSelection(ArgumentStack context,
                           Selection selection)
                    throws IncompleteRegionException,
                           ParameterException

Gets a selection from a ArgumentStack.

Parameters:

context - the context

selection - the annotation

Returns:

a selection

Throws:

IncompleteRegionException - if no selection is available

ParameterException - on other error

getEditSession

public EditSession getEditSession(ArgumentStack context)
                           throws ParameterException

Gets an EditSession from a ArgumentStack.

Parameters:

context - the context

Returns:

an edit session

Throws:

ParameterException - on other error

getLocalSession

public LocalSession getLocalSession(ArgumentStack context)
                             throws ParameterException

Gets an LocalSession from a ArgumentStack.

Parameters:

context - the context

Returns:

a local session

Throws:

ParameterException - on error

getActor

public Actor getActor(ArgumentStack context)
               throws ParameterException

Gets an Actor from a ArgumentStack.

Parameters:

context - the context

Returns:

a local player

Throws:

ParameterException - on error

getPlayer

public Player getPlayer(ArgumentStack context)
                 throws ParameterException

Gets an Player from a ArgumentStack.

Parameters:

context - the context

Returns:

a local player

Throws:

ParameterException - on error

getBaseBlock

public BaseBlock getBaseBlock(ArgumentStack context)
                       throws ParameterException,
                              WorldEditException

Gets an BaseBlock from a ArgumentStack.

Parameters:

context - the context

Returns:

a pattern

Throws:

ParameterException - on error

WorldEditException - on error

getPattern

public Pattern getPattern(ArgumentStack context)
                   throws ParameterException,
                          WorldEditException

Gets an Pattern from a ArgumentStack.

Parameters:

context - the context

Returns:

a pattern

Throws:

ParameterException - on error

WorldEditException - on error

getMask

public Mask getMask(ArgumentStack context)
             throws ParameterException,
                    WorldEditException

Gets an Mask from a ArgumentStack.

Parameters:

context - the context

Returns:

a pattern

Throws:

ParameterException - on error

WorldEditException - on error

getDirection

public Vector getDirection(ArgumentStack context,
                           Direction direction)
                    throws ParameterException,
                           UnknownDirectionException

Get a direction from the player.

Parameters:

context - the context

direction - the direction annotation

Returns:

a pattern

Throws:

ParameterException - on error

UnknownDirectionException - on an unknown direction

getTreeType

public TreeGenerator.TreeType getTreeType(ArgumentStack context)
                                   throws ParameterException,
                                          WorldEditException

Gets an TreeGenerator.TreeType from a ArgumentStack.

Parameters:

context - the context

Returns:

a pattern

Throws:

ParameterException - on error

WorldEditException - on error

getBiomeType

public BaseBiome getBiomeType(ArgumentStack context)
                       throws ParameterException,
                              WorldEditException

Gets an BaseBiome from a ArgumentStack.

Parameters:

context - the context

Returns:

a pattern

Throws:

ParameterException - on error

WorldEditException - on error