Class MovementReporter

java.lang.Object

VASSAL.build.module.map.MovementReporter

Direct Known Subclasses:

MovementReporter.HiddenMovementReporter

public class MovementReporter
extends Object

Builds an auto-report message for a collection of Move Commands

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MovementReporter.HiddenMovementReporter	A version of the MovementReporter for reporting the movement of Invisible pieces.
static class	MovementReporter.HiddenMoveSummary
static class	MovementReporter.MoveSummary

Field Summary

Fields

Modifier and Type	Field	Description
protected FormattedString	format
protected List<MovementReporter.MoveSummary>	movesToMark
protected List<MovementReporter.MoveSummary>	movesToReport

Constructor Summary

Constructors

Constructor	Description
MovementReporter(Command moveCommand)

Method Summary

Modifier and Type	Method	Description
protected MovementReporter.MoveSummary	createMoveSummary(AddPiece c)
protected MovementReporter.MoveSummary	createMoveSummary(MovePiece c)
protected void	extractMoveCommands(Command c)
protected String	getLocation(Map map, Point p)
Command	getReportCommand()
Command	markMoved(GamePiece p)
Command	markMovedPieces()	Mark all pieces with the MovementMarkable trait
protected boolean	shouldMarkMoved(MovementReporter.MoveSummary summary)
protected boolean	shouldReport(AddPiece addPiece)
protected boolean	shouldReport(MovePiece movePiece)

Methods inherited from class java.lang.Object

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

Field Details

format

protected FormattedString format

movesToReport

protected List<MovementReporter.MoveSummary> movesToReport

movesToMark

protected List<MovementReporter.MoveSummary> movesToMark

Constructor Details

MovementReporter

public MovementReporter(Command moveCommand)

Method Details

extractMoveCommands

protected void extractMoveCommands(Command c)

createMoveSummary

protected MovementReporter.MoveSummary createMoveSummary(AddPiece c)

createMoveSummary

protected MovementReporter.MoveSummary createMoveSummary(MovePiece c)

markMovedPieces

public Command markMovedPieces()

Mark all pieces with the MovementMarkable trait

Returns:

the equivalent Command

markMoved

public Command markMoved(GamePiece p)

shouldMarkMoved

protected boolean shouldMarkMoved(MovementReporter.MoveSummary summary)

shouldReport

protected boolean shouldReport(AddPiece addPiece)

shouldReport

protected boolean shouldReport(MovePiece movePiece)

getReportCommand

public Command getReportCommand()

getLocation

protected String getLocation(Map map,
 Point p)