|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectnet.sf.freecol.common.model.FreeColObject
net.sf.freecol.common.model.FreeColGameObject
net.sf.freecol.common.model.TileItem
net.sf.freecol.common.model.TileImprovement
public class TileImprovement
Represents a tile improvement, such as a river or road.
Field Summary | |
---|---|
static int |
FJORD_RIVER
|
static int |
LARGE_RIVER
|
static int |
NO_RIVER
River magnitudes |
static int |
SMALL_RIVER
|
Fields inherited from class net.sf.freecol.common.model.TileItem |
---|
RESOURCE_ZINDEX, RUMOUR_ZINDEX |
Fields inherited from class net.sf.freecol.common.model.FreeColObject |
---|
ID_ATTRIBUTE_TAG |
Constructor Summary | |
---|---|
TileImprovement(Game game,
org.w3c.dom.Element e)
|
|
TileImprovement(Game game,
java.lang.String id)
Initiates a new TileImprovement with the given ID. |
|
TileImprovement(Game game,
Tile tile,
TileImprovementType type)
Creates a standard TileImprovement -instance. |
|
TileImprovement(Game game,
javax.xml.stream.XMLStreamReader in)
|
Method Summary | |
---|---|
void |
compileStyleBreakdown(int[] base,
int[] breakdown)
|
void |
dispose()
Disposes this improvement. |
int |
doWork()
|
int |
doWork(int turns)
Performs work towards completion of this TileImprovement
This function allows for a unit to perform more than 1 'turn', perhaps in
the event a skilled unit is able to build improvements with a bonus. |
static TileImprovementType |
findBestTileImprovementType(Tile tile,
GoodsType goodsType)
Method for returning the 'most effective' TileImprovementType allowed for a given Tile . |
static int[] |
getBase(Map.Direction[] directions,
int baseNumber)
Returns an int[NUMBER_OF_DIRECTIONS] array based on the baseNumber and the 'active' directions given. |
int |
getBonus(GoodsType goodsType)
Returns the bonus (if any). |
TileType |
getChange(TileType tileType)
Returns any change of TileType |
int |
getDeliverAmount()
|
GoodsType |
getDeliverGoodsType()
|
int |
getExpendedAmount()
|
EquipmentType |
getExpendedEquipmentType()
|
int |
getMagnitude()
|
int |
getMovementCost(int moveCost,
Tile fromTile)
Performs reduction of the movement-cost. |
java.lang.String |
getOccupationString()
|
Modifier |
getProductionModifier(GoodsType goodsType)
Returns the bonus Modifier (if any). |
int |
getStyle()
Returns the Style of this Improvement - used for Rivers |
int[] |
getStyleBreakdown(int[] base)
Breaks the Style of this Improvement into 8 directions - used for Rivers (at the moment) Possible TODO: Modify this later should we modify the usage of Style. |
int[] |
getStyleBreakdown(Map.Direction[] directions,
int baseNumber)
Breaks the Style of this Improvement into 8 directions - used for Rivers (at the moment) |
int |
getTurnsToComplete()
|
TileImprovementType |
getType()
Gets the type of this object. |
static java.lang.String |
getXMLElementTagName()
Gets the tag name of the root element representing this object. |
int |
getZIndex()
Get the ZIndex value. |
boolean |
isComplete()
|
boolean |
isRiver()
Is this TileImprovement a river? |
boolean |
isRoad()
Is this TileImprovement a road? |
boolean |
isVirtual()
Get the Virtual value. |
boolean |
isWorkerAllowed(Unit unit)
Checks if a given worker can work at this Improvement |
void |
setMagnitude(int magnitude)
|
void |
setStyle(int style)
Sets the Style of this Improvement - used for Rivers |
void |
setTurnsToComplete(int turns)
|
void |
setVirtual(boolean newVirtual)
Set the Virtual value. |
java.lang.String |
toString()
Returns a textual representation of this object. |
Methods inherited from class net.sf.freecol.common.model.TileItem |
---|
getLocation, getSpaceTaken, getTile, setLocation |
Methods inherited from class net.sf.freecol.common.model.FreeColGameObject |
---|
addToRemoveElement, equals, equals, getFreeColGameObject, getFreeColGameObject, getGame, getGameOptions, getIntegerID, hashCode, hasID, isDisposed, isUninitialized, readFromXML, setGame, setId, toSavedXML, toXML, updateFreeColGameObject, updateID |
Methods inherited from class java.lang.Object |
---|
getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final int NO_RIVER
public static final int SMALL_RIVER
public static final int LARGE_RIVER
public static final int FJORD_RIVER
Constructor Detail |
---|
public TileImprovement(Game game, Tile tile, TileImprovementType type)
TileImprovement
-instance.
This constructor asserts that the game, tile and type are valid.
game
- The Game
in which this object belongs.tile
- The Tile
on which this object sits.type
- The TileImprovementType
of this TileImprovement.public TileImprovement(Game game, javax.xml.stream.XMLStreamReader in) throws javax.xml.stream.XMLStreamException
javax.xml.stream.XMLStreamException
public TileImprovement(Game game, org.w3c.dom.Element e)
public TileImprovement(Game game, java.lang.String id)
TileImprovement
with the given ID. The object
should later be initialized by calling either
FreeColGameObject.readFromXML(XMLStreamReader)
or
FreeColObject.readFromXMLElement(Element)
.
game
- The Game
in which this object belong.id
- The unique identifier for this object.Method Detail |
---|
public TileImprovementType getType()
Typed
getType
in interface Typed<TileImprovementType>
public int getMagnitude()
public void setMagnitude(int magnitude)
public final boolean isVirtual()
Virtual
value.
boolean
valuepublic final void setVirtual(boolean newVirtual)
Virtual
value.
newVirtual
- The new Virtual value.public boolean isRoad()
TileImprovement
a road?
boolean
valuepublic boolean isRiver()
TileImprovement
a river?
boolean
valuepublic java.lang.String toString()
toString
in class FreeColGameObject
String
of either:
public java.lang.String getOccupationString()
public int getTurnsToComplete()
public void setTurnsToComplete(int turns)
public final int getZIndex()
ZIndex
value.
getZIndex
in class TileItem
int
valuepublic boolean isComplete()
public int doWork(int turns)
TileImprovement
This function allows for a unit to perform more than 1 'turn', perhaps in
the event a skilled unit is able to build improvements with a bonus. The
doWork
function without any input params assumes 1 turn of
work done.
public int doWork()
public EquipmentType getExpendedEquipmentType()
public int getExpendedAmount()
public GoodsType getDeliverGoodsType()
public int getDeliverAmount()
public int getBonus(GoodsType goodsType)
goodsType
- a GoodsType
value
int
valuepublic Modifier getProductionModifier(GoodsType goodsType)
goodsType
- a GoodsType
value
Modifier
valuepublic int getMovementCost(int moveCost, Tile fromTile)
moveCost
- Original movement cost
public TileType getChange(TileType tileType)
public int getStyle()
public void setStyle(int style)
style
- The stylepublic static int[] getBase(Map.Direction[] directions, int baseNumber)
directions
- An int[] that gives the active directions eg
{Map.N, Map.NE, Map.E, Map.SE, Map.S, Map.SW, Map.W, Map.NW},
or {Map.E, Map.SW};baseNumber
- The base to be used to create the base array.
public int[] getStyleBreakdown(Map.Direction[] directions, int baseNumber)
directions
- An int[] that gives the active directions
eg {Map.N, Map.NE, Map.E, Map.SE, Map.S, Map.SW, Map.W, Map.NW},
or {Map.E, Map.SW};baseNumber
- The base to be used to create the base array.
public int[] getStyleBreakdown(int[] base)
base
- Use #getBase(Direction[], int)
public void compileStyleBreakdown(int[] base, int[] breakdown)
public static TileImprovementType findBestTileImprovementType(Tile tile, GoodsType goodsType)
Tile
.
Useful for AI in deciding the Improvements to prioritize.
tile
- The Tile
that will be improvedgoodsType
- The GoodsType
to be prioritized.
public boolean isWorkerAllowed(Unit unit)
public void dispose()
dispose
in class TileItem
public static java.lang.String getXMLElementTagName()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |