pl.joegreen.sergeants.framework.model

Class Field

java.lang.Object

pl.joegreen.sergeants.framework.model.Field

Direct Known Subclasses:

VisibleField

public class Field
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
protected GameStateFieldContext	gameStateContext

Constructor Summary

Constructors

Constructor and Description
Field(GameStateFieldContext gameStateContext, Position position, FieldTerrainType terrainType)

Method Summary

Modifier and Type	Method and Description
VisibleField	asVisibleField() Converts to a VisibleField instance that exposes more details about the field.
int	getIndex()
Set<Field>	getNeighbours() Returns fields that can be reached from this field in one move.
Position	getPosition()
FieldTerrainType	getTerrainType()
Set<VisibleField>	getVisibleNeighbours() Same as getNeighbours() but filtered with isVisible().
boolean	isObstacle() If the field is not visible, true indicates city or mountain, if the field is visible true indicates only mountain.
boolean	isVisible() Determines whether in the current round the field is visible or in the fog of war.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

gameStateContext

protected final GameStateFieldContext gameStateContext

Constructor Detail

Field

public Field(GameStateFieldContext gameStateContext,
             Position position,
             FieldTerrainType terrainType)

Method Detail

getPosition

public Position getPosition()

isVisible

public boolean isVisible()

Determines whether in the current round the field is visible or in the fog of war. If this method returns true, asVisibleField() method can be used to obtain additional info about this field.

Returns:

true if all details of this field are known, false if the field is behind the fog of war (too far to be seen)

isObstacle

public boolean isObstacle()

If the field is not visible, true indicates city or mountain, if the field is visible true indicates only mountain.

asVisibleField

public VisibleField asVisibleField()

Converts to a VisibleField instance that exposes more details about the field. Throws an exception if the field is not visible, so it should be checked before calling this method with isVisible().

getNeighbours

public Set<Field> getNeighbours()

Returns fields that can be reached from this field in one move. Those fields are the field directly above, below, on the right and on the left. Method will ommit fields not being inside the map, so it handles borders well.

getVisibleNeighbours

public Set<VisibleField> getVisibleNeighbours()

Same as getNeighbours() but filtered with isVisible().

getIndex

public int getIndex()

getTerrainType

public FieldTerrainType getTerrainType()

toString

public String toString()

Overrides:

toString in class Object