client.map.view.mapState

Interface IMapState

All Known Implementing Classes:

NormalState, RoadBuilderState, RoadSetupState, SettlementSetupState

public interface IMapState

The map state handles what the map should do in special cases, for instance during setup when a settlement and road should be placed consecutively.

Author:

Jonathan Sadler

Method Summary

Modifier and Type	Method and Description
java.lang.Boolean	AllowCancel() Returns if the current state allows cancelling placement.
IMapState	GetNextMapState() Gets the next state after the completion of the current state.
PieceType	GetPieceType() Gets the piece type associated with the current state.
java.lang.Boolean	IsSetup() Returns if the current state is a map setup state.

Method Detail

GetPieceType

PieceType GetPieceType()

Gets the piece type associated with the current state.

Returns:

The current piece type.

GetNextMapState

IMapState GetNextMapState()

Gets the next state after the completion of the current state.

Returns:

The next state object.

IsSetup

java.lang.Boolean IsSetup()

Returns if the current state is a map setup state.

Returns:

True if yes, else false.

AllowCancel

java.lang.Boolean AllowCancel()

Returns if the current state allows cancelling placement.

Returns:

True if yes, else false.