VASSAL.build.module.map
Interface PieceCollection

All Known Implementing Classes:

CompoundPieceCollection, SimplePieceCollection

public interface PieceCollection

Manages a collection of GamePieces in a Map

Method Summary

void	add(GamePiece p) Adds a piece
boolean	canMerge(GamePiece p1, GamePiece p2) Return true if the two pieces can be merged into a single stack
void	clear() Remove all pieces
GamePiece[]	getPieces() Return all pieces in the collection as a read-only array
int	indexOf(GamePiece p) Returns the index of a piece.
void	moveToBack(GamePiece p) Reposition a piece to the back of all others in the same layer
void	moveToFront(GamePiece p) Reposition a piece to the front of all others in the same layer
void	remove(GamePiece p) Removes the piece

Method Detail

moveToFront

public void moveToFront(GamePiece p)

Reposition a piece to the front of all others in the same layer

moveToBack

public void moveToBack(GamePiece p)

Reposition a piece to the back of all others in the same layer

getPieces

public GamePiece[] getPieces()

Return all pieces in the collection as a read-only array

canMerge

public boolean canMerge(GamePiece p1,
                        GamePiece p2)

Return true if the two pieces can be merged into a single stack

indexOf

public int indexOf(GamePiece p)

Returns the index of a piece. When painting the map, pieces are drawn in order of index

remove

public void remove(GamePiece p)

Removes the piece

add

public void add(GamePiece p)

Adds a piece

clear

public void clear()

Remove all pieces