soc.game
Class SOCSettlement

java.lang.Object
  soc.game.SOCPlayingPiece
      soc.game.SOCSettlement

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class SOCSettlement
extends SOCPlayingPiece

A settlement playing piece

See Also:

Serialized Form

Field Summary

Fields inherited from class soc.game.SOCPlayingPiece

board, CITY, coord, FORTRESS, MAXPLUSONE, MIN, pieceType, player, ROAD, SETTLEMENT, SHIP, specialVP, specialVPEvent, VILLAGE

Constructor Summary

SOCSettlement(SOCPlayer pl, int co, SOCBoard board)
Make a new settlement

Method Summary

java.util.Vector<java.lang.Integer>

getAdjacentHexes()

Methods inherited from class soc.game.SOCPlayingPiece

equals, getAdjacentEdges, getCoordinates, getPlayer, getPlayerNumber, getResourcesToBuild, getType, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

SOCSettlement

public SOCSettlement(SOCPlayer pl,
                     int co,
                     SOCBoard board)
              throws java.lang.IllegalArgumentException

Make a new settlement

Parameters:

pl - player who owns the settlement

co - coordinates

board - board if known; otherwise will extract from pl

Throws:

java.lang.IllegalArgumentException - if pl null, or board null and pl.board also null

Method Detail

getAdjacentHexes

public java.util.Vector<java.lang.Integer> getAdjacentHexes()

Returns:

the hexes touching this settlement, same format as SOCBoard.getAdjacentHexesToNode(int)