pl.joegreen.sergeants.framework.model

Class VisibleField

java.lang.Object

pl.joegreen.sergeants.framework.model.Field

pl.joegreen.sergeants.framework.model.VisibleField

public class VisibleField
extends Field

Field Summary

Fields inherited from class pl.joegreen.sergeants.framework.model.Field

gameStateContext

Constructor Summary

Constructors

Constructor and Description
VisibleField(GameStateFieldContext gameStateContext, Position position, FieldTerrainType terrainType, Optional<Integer> ownerIndex, int army, boolean city, boolean general)

Method Summary

Modifier and Type	Method and Description
VisibleField	asVisibleField() Converts to a VisibleField instance that exposes more details about the field.
int	getArmy()
Optional<Integer>	getOwnerIndex() Index of player that owns the field.
boolean	hasOwner()
boolean	isBlank() Returns true if field is represented with a white square in the brower (not mountain, not city, no owner).
boolean	isCity()
boolean	isGeneral()
boolean	isObstacle() If the field is not visible, true indicates city or mountain, if the field is visible true indicates only mountain.
boolean	isOwnedBy(int playerIndex)
boolean	isOwnedByEnemy() Returns true if field has an owner but owner is not in the same team as bot.
boolean	isOwnedByMe()
boolean	isOwnedByMyTeam()
boolean	isVisible() Determines whether in the current round the field is visible or in the fog of war.
String	toString()

Methods inherited from class pl.joegreen.sergeants.framework.model.Field

getIndex, getNeighbours, getPosition, getTerrainType, getVisibleNeighbours

Methods inherited from class java.lang.Object

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

Constructor Detail

VisibleField

public VisibleField(GameStateFieldContext gameStateContext,
                    Position position,
                    FieldTerrainType terrainType,
                    Optional<Integer> ownerIndex,
                    int army,
                    boolean city,
                    boolean general)

Method Detail

isVisible

public boolean isVisible()

Description copied from class: Field

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

Overrides:

isVisible in class 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()

Description copied from class: Field

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

Overrides:

isObstacle in class Field

asVisibleField

public VisibleField asVisibleField()

Description copied from class: Field

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 Field.isVisible().

Overrides:

asVisibleField in class Field

getOwnerIndex

public Optional<Integer> getOwnerIndex()

Index of player that owns the field.

isOwnedBy

public boolean isOwnedBy(int playerIndex)

isOwnedByMe

public boolean isOwnedByMe()

isOwnedByMyTeam

public boolean isOwnedByMyTeam()

isOwnedByEnemy

public boolean isOwnedByEnemy()

Returns true if field has an owner but owner is not in the same team as bot.

isBlank

public boolean isBlank()

Returns true if field is represented with a white square in the brower (not mountain, not city, no owner).

hasOwner

public boolean hasOwner()

getArmy

public int getArmy()

isGeneral

public boolean isGeneral()

isCity

public boolean isCity()

toString

public String toString()

Overrides:

toString in class Field