client.map.view.mapState

Class SettlementSetupState

java.lang.Object

client.map.view.mapState.SettlementSetupState

All Implemented Interfaces:

IMapState

public class SettlementSetupState
extends java.lang.Object
implements IMapState

Settlement setup is used when settlements are being placed during the setup phase of the game.

Author:

Jonathan Sadler

Constructor Summary

Constructors

Constructor and Description
SettlementSetupState()

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.

Methods inherited from class java.lang.Object

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

Constructor Detail

SettlementSetupState

public SettlementSetupState()

Method Detail

GetPieceType

public PieceType GetPieceType()

Description copied from interface: IMapState

Gets the piece type associated with the current state.

Specified by:

GetPieceType in interface IMapState

Returns:

The current piece type.

GetNextMapState

public IMapState GetNextMapState()

Description copied from interface: IMapState

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

Specified by:

GetNextMapState in interface IMapState

Returns:

The next state object.

IsSetup

public java.lang.Boolean IsSetup()

Description copied from interface: IMapState

Returns if the current state is a map setup state.

Specified by:

IsSetup in interface IMapState

Returns:

True if yes, else false.

AllowCancel

public java.lang.Boolean AllowCancel()

Description copied from interface: IMapState

Returns if the current state allows cancelling placement.

Specified by:

AllowCancel in interface IMapState

Returns:

True if yes, else false.