com.sk89q.worldedit.extent.inventory

Class BlockBag

java.lang.Object

com.sk89q.worldedit.extent.inventory.BlockBag

Direct Known Subclasses:

BukkitPlayerBlockBag

public abstract class BlockBag
extends Object

Represents a source to get blocks from and store removed ones.

Constructor Summary

Constructors

Constructor and Description
BlockBag()

Method Summary

Modifier and Type	Method and Description
abstract void	addSingleSourcePosition(WorldVector pos) Adds a position to be used a source.
abstract void	addSourcePosition(WorldVector pos) Adds a position to be used a source.
void	fetchBlock(int id) Get a block.
void	fetchItem(BaseItem item) Get a block.
void	fetchPlacedBlock(int id) Deprecated. Use fetchPlacedBlock(int,int) instead
void	fetchPlacedBlock(int id, int data) Sets a block as if it was placed by hand.
abstract void	flushChanges() Flush any changes.
boolean	peekBlock(int id) Checks to see if a block exists without removing it.
void	storeBlock(int id) Store a block.
void	storeDroppedBlock(int id) Deprecated. Use storeDroppedBlock(int, int) instead
void	storeDroppedBlock(int id, int data) Stores a block as if it was mined.
void	storeItem(BaseItem item) Store a block.

Methods inherited from class java.lang.Object

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

Constructor Detail

BlockBag

public BlockBag()

Method Detail

storeDroppedBlock

@Deprecated
public void storeDroppedBlock(int id)
                                   throws BlockBagException

Deprecated. Use storeDroppedBlock(int, int) instead

Stores a block as if it was mined.

Parameters:

id - the type ID

Throws:

BlockBagException - on error

storeDroppedBlock

public void storeDroppedBlock(int id,
                              int data)
                       throws BlockBagException

Stores a block as if it was mined.

Parameters:

id - the type ID

data - the data value

Throws:

BlockBagException - on error

fetchPlacedBlock

@Deprecated
public void fetchPlacedBlock(int id)
                                  throws BlockBagException

Deprecated. Use fetchPlacedBlock(int,int) instead

Sets a block as if it was placed by hand.

Parameters:

id - the type ID

Throws:

BlockBagException - on error

fetchPlacedBlock

public void fetchPlacedBlock(int id,
                             int data)
                      throws BlockBagException

Sets a block as if it was placed by hand.

Parameters:

id - the type ID

data - the data value

Throws:

BlockBagException - on error

fetchBlock

public void fetchBlock(int id)
                throws BlockBagException

Get a block.

Either this method or fetchItem needs to be overridden.

Parameters:

id - the type ID

Throws:

BlockBagException - on error

fetchItem

public void fetchItem(BaseItem item)
               throws BlockBagException

Get a block.

Either this method or fetchItem needs to be overridden.

Parameters:

item - the item

Throws:

BlockBagException - on error

storeBlock

public void storeBlock(int id)
                throws BlockBagException

Store a block.

Either this method or fetchItem needs to be overridden.

Parameters:

id - the type ID

Throws:

BlockBagException - on error

storeItem

public void storeItem(BaseItem item)
               throws BlockBagException

Store a block.

Either this method or fetchItem needs to be overridden.

Parameters:

item - the item

Throws:

BlockBagException - on error

peekBlock

public boolean peekBlock(int id)

Checks to see if a block exists without removing it.

Parameters:

id - the type ID

Returns:

whether the block exists

flushChanges

public abstract void flushChanges()

Flush any changes. This is called at the end.

addSourcePosition

public abstract void addSourcePosition(WorldVector pos)

Adds a position to be used a source.

Parameters:

pos - the position

addSingleSourcePosition

public abstract void addSingleSourcePosition(WorldVector pos)

Adds a position to be used a source.

Parameters:

pos - the position