Package VASSAL.command

Class RemovePiece

java.lang.Object

VASSAL.command.Command

VASSAL.command.RemovePiece

public class RemovePiece
extends Command

This Command removed a GamePiece from a game. Its undo Command is AddPiece.

Constructor Summary

Constructors

Constructor	Description
RemovePiece(String id)
RemovePiece(GamePiece p)

Method Summary

Modifier and Type	Method	Description
protected void	executeCommand()	Removes a piece by invoking Map.removePiece(VASSAL.counters.GamePiece) if the piece belongs to a Map, followed by GameState.removePiece(java.lang.String).
String	getId()
GamePiece	getTarget()
protected Command	myUndoCommand()	If the action can be undone, return a Command that performs the inverse action.

Methods inherited from class VASSAL.command.Command

append, execute, getDetails, getSubCommands, getUndoCommand, isAtomic, isLoggable, isNull, isNullOrContainsOnly, stripSubCommands, toString

Methods inherited from class java.lang.Object

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

Constructor Details

RemovePiece

public RemovePiece(GamePiece p)

RemovePiece

public RemovePiece(String id)

Method Details

executeCommand

protected void executeCommand()

Removes a piece by invoking Map.removePiece(VASSAL.counters.GamePiece) if the piece belongs to a Map, followed by GameState.removePiece(java.lang.String).

Specified by:

executeCommand in class Command

myUndoCommand

protected Command myUndoCommand()

Description copied from class: Command

If the action can be undone, return a Command that performs the inverse action. The Command returned should only undo Command.executeCommand(), not the actions of subcommands

Specified by:

myUndoCommand in class Command

getTarget

public GamePiece getTarget()

getId

public String getId()