Class MasterHex

java.lang.Object

net.sf.colossus.variant.Hex

net.sf.colossus.variant.MasterHex

public class MasterHex
extends Hex

Class MasterHex describes one Masterboard hex, without GUI info.

Author:

David Ripton, Romain Dolbeau

Field Summary

Fields

Modifier and Type	Field	Description
private final String[]	baseExitLabel
private final Constants.HexsideGates[]	baseExitType	TODO these base exit types and labels are somehow used only during setup of the MasterBoard, no real need to keep them around.
private final Constants.HexsideGates[]	entranceType
private final Constants.HexsideGates[]	exitType
private int	labelSide
private final MasterHex[]	neighbors
private final MasterBoardTerrain	terrain

Constructor Summary

Constructors

Constructor	Description
MasterHex(String label, MasterBoardTerrain terrain, int xCoord, int yCoord)

Method Summary

Modifier and Type	Method	Description
int	findDirectionForEntrySide(EntrySide wantedEntrySide)	For a given EntrySide, find out which direction that means.
String	getBaseExitLabel(int i)
Constants.HexsideGates	getBaseExitType(int i)
Constants.HexsideGates	getEntranceType(int i)
Constants.HexsideGates	getExitType(int i)
int	getLabelSide()
MasterHex	getNeighbor(int i)
MasterBoardTerrain	getTerrain()
Color	getTerrainColor()
String	getTerrainDisplayName()
String	getTerrainName()
void	setBaseExitLabel(int i, String label)
void	setBaseExitType(int i, Constants.HexsideGates exitType)
void	setEntranceType(int i, Constants.HexsideGates entranceType)
void	setExitType(int i, Constants.HexsideGates exitType)
void	setLabelSide(int labelSide)
(package private) void	setNeighbor(int i, MasterHex hex)

Methods inherited from class Hex

equals, getDescription, getLabel, getXCoord, getYCoord, hashCode, toString

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

neighbors

private final MasterHex[] neighbors

labelSide

private int labelSide

exitType

private final Constants.HexsideGates[] exitType

entranceType

private final Constants.HexsideGates[] entranceType

baseExitType

private final Constants.HexsideGates[] baseExitType

TODO these base exit types and labels are somehow used only during setup of the MasterBoard, no real need to keep them around. It seems to be related to the fact that the master board hexes are really triangles and stored as such in the XML files. Maybe they should not be hexes in the code either.

baseExitLabel

private final String[] baseExitLabel

terrain

private final MasterBoardTerrain terrain

Constructor Details

MasterHex

public MasterHex(String label,
 MasterBoardTerrain terrain,
 int xCoord,
 int yCoord)

Method Details

getTerrain

public MasterBoardTerrain getTerrain()

getTerrainName

public String getTerrainName()

Specified by:

getTerrainName in class Hex

getTerrainDisplayName

public String getTerrainDisplayName()

getTerrainColor

public Color getTerrainColor()

getNeighbor

public MasterHex getNeighbor(int i)

setNeighbor

void setNeighbor(int i,
 MasterHex hex)

getLabelSide

public int getLabelSide()

findDirectionForEntrySide

public int findDirectionForEntrySide(EntrySide wantedEntrySide)

For a given EntrySide, find out which direction that means. Caller can use that e.g. to figure out what is the neighbor hex from where an attacker is coming TODO should this rather be somewhere else? Since it uses entryside, it makes variant package depending on game package ...

Parameters:

wantedEntrySide -

Returns:

The direction towards which that entryside is placed

setLabelSide

public void setLabelSide(int labelSide)

getExitType

public Constants.HexsideGates getExitType(int i)

setExitType

public void setExitType(int i,
 Constants.HexsideGates exitType)

getBaseExitType

public Constants.HexsideGates getBaseExitType(int i)

setBaseExitType

public void setBaseExitType(int i,
 Constants.HexsideGates exitType)

getBaseExitLabel

public String getBaseExitLabel(int i)

setBaseExitLabel

public void setBaseExitLabel(int i,
 String label)

getEntranceType

public Constants.HexsideGates getEntranceType(int i)

setEntranceType

public void setEntranceType(int i,
 Constants.HexsideGates entranceType)