net.sf.freecol.server.ai.mission
Class BuildColonyMission

java.lang.Object
  net.sf.freecol.server.ai.AIObject
      net.sf.freecol.server.ai.mission.Mission
          net.sf.freecol.server.ai.mission.BuildColonyMission

public class BuildColonyMission
extends Mission

Mission for building a Colony.

This mission can be used in two different ways:

• Build a colony at a specific location.
• Find a site for a colony and build it there.

This mission will be aborted in the former case if the value gets below a given threshold, while a colony will always get built (if there is sufficient space on the map) in the latter case. Use the appropriate constructor to get the desired behaviour.

See Also:

Colony

Field Summary

static java.lang.String	COPYRIGHT
static java.lang.String	LICENSE
static java.lang.String	REVISION

Fields inherited from class net.sf.freecol.server.ai.mission.Mission

MINIMUM_TRANSPORT_PRIORITY, NO_MORE_MOVES_LEFT, NO_PATH_TO_TARGET, NORMAL_TRANSPORT_PRIORITY

Fields inherited from class net.sf.freecol.server.ai.AIObject

id, uninitialized

Constructor Summary

BuildColonyMission(AIMain aiMain, AIUnit aiUnit)
Creates a BuildColonyMission for the given AIUnit.

BuildColonyMission(AIMain aiMain, AIUnit aiUnit, Tile target, int colonyValue)
Creates a mission for the given AIUnit.

BuildColonyMission(AIMain aiMain, org.w3c.dom.Element element)
Creates a new BuildColonyMission.

BuildColonyMission(AIMain aiMain, javax.xml.stream.XMLStreamReader in)
Creates a new BuildColonyMission and reads the given element.

Method Summary

void	doMission(Connection connection) Performs this mission.
static Tile	findColonyLocation(Unit unit) Finds a site for a new colony.
java.lang.String	getDebuggingInfo() Gets debugging information about this mission.
Tile	getTransportDestination() Returns the destination for this Transportable.
int	getTransportPriority() Returns the priority of getting the unit to the transport destination.
static java.lang.String	getXMLElementTagName() Returns the tag name of the root element representing this object.
boolean	isValid() Checks if this mission is still valid to perform.
protected void	readFromXMLImpl(javax.xml.stream.XMLStreamReader in) Reads all the AIObjects and other AI-related information from XML data.
protected void	toXMLImpl(javax.xml.stream.XMLStreamWriter out) Writes all of the AIObjects and other AI-related information to an XML-stream.

Methods inherited from class net.sf.freecol.server.ai.mission.Mission

dispose, exploreLostCityRumour, findTarget, getAIUnit, getID, getUnit, move, moveTowards, moveTowards, setAIUnit

Methods inherited from class net.sf.freecol.server.ai.AIObject

getAIMain, getGame, getRandom, isUninitialized, readFromXML, readFromXMLElement, toXML, toXMLElement

Methods inherited from class java.lang.Object

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

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT

See Also:

Constant Field Values

LICENSE

public static final java.lang.String LICENSE

See Also:

Constant Field Values

REVISION

public static final java.lang.String REVISION

See Also:

Constant Field Values

Constructor Detail

BuildColonyMission

public BuildColonyMission(AIMain aiMain,
                          AIUnit aiUnit,
                          Tile target,
                          int colonyValue)

Creates a mission for the given AIUnit.

Parameters:

aiMain - The main AI-object.

aiUnit - The AIUnit this mission is created for.

target - The Tile where the Colony should be built.

colonyValue - The value of the Tile to build a Colony upon. This mission will be invalidated if target.getColonyValue() is less than this value.

BuildColonyMission

public BuildColonyMission(AIMain aiMain,
                          AIUnit aiUnit)

Creates a BuildColonyMission for the given AIUnit. The mission will try to find the closest and best site for a colony, and build the colony there. It will not stop until a Colony gets built.

Parameters:

aiMain - The main AI-object.

aiUnit - The AIUnit this mission is created for.

BuildColonyMission

public BuildColonyMission(AIMain aiMain,
                          org.w3c.dom.Element element)

Creates a new BuildColonyMission.

Parameters:

aiMain - The main AI-object.

element - An Element containing an XML-representation of this object.

BuildColonyMission

public BuildColonyMission(AIMain aiMain,
                          javax.xml.stream.XMLStreamReader in)
                   throws javax.xml.stream.XMLStreamException

Creates a new BuildColonyMission and reads the given element.

Parameters:

aiMain - The main AI-object.

in - The input stream containing the XML.

Throws:

javax.xml.stream.XMLStreamException - if a problem was encountered during parsing.

See Also:

AIObject.readFromXML(javax.xml.stream.XMLStreamReader)

Method Detail

doMission

public void doMission(Connection connection)

Performs this mission.

Specified by:

doMission in class Mission

Parameters:

connection - The Connection to the server.

getTransportDestination

public Tile getTransportDestination()

Returns the destination for this Transportable. This can either be the target Tile of the transport or the target for the entire Transportable's mission. The target for the transport is determined by TransportMission in the latter case.

Overrides:

getTransportDestination in class Mission

Returns:

The destination for this Transportable.

getTransportPriority

public int getTransportPriority()

Returns the priority of getting the unit to the transport destination.

Overrides:

getTransportPriority in class Mission

Returns:

The priority.

findColonyLocation

public static Tile findColonyLocation(Unit unit)

Finds a site for a new colony.

Parameters:

unit - The Unit to find a colony site for. This unit will be used for determining the path to a colony location and colony sites far away from the unit (in turns) will be less valuable.

Returns:

A site suitable for a Colony or null if no such site could be found within a fixed distance from the Unit.

isValid

public boolean isValid()

Checks if this mission is still valid to perform.

This mission will be invalidated when the colony has been built or if the target.getColonyValue() decreases.

Overrides:

isValid in class Mission

Returns:

true if this mission is still valid to perform and false otherwise.

toXMLImpl

protected void toXMLImpl(javax.xml.stream.XMLStreamWriter out)
                  throws javax.xml.stream.XMLStreamException

Writes all of the AIObjects and other AI-related information to an XML-stream.

Specified by:

toXMLImpl in class AIObject

Parameters:

out - The target stream.

Throws:

javax.xml.stream.XMLStreamException - if there are any problems writing to the stream.

readFromXMLImpl

protected void readFromXMLImpl(javax.xml.stream.XMLStreamReader in)
                        throws javax.xml.stream.XMLStreamException

Reads all the AIObjects and other AI-related information from XML data.

Specified by:

readFromXMLImpl in class AIObject

Parameters:

in - The input stream with the XML.

Throws:

javax.xml.stream.XMLStreamException - if a problem was encountered during parsing.

getXMLElementTagName

public static java.lang.String getXMLElementTagName()

Returns the tag name of the root element representing this object.

Returns:

The String "buildColonyMission".

getDebuggingInfo

public java.lang.String getDebuggingInfo()

Gets debugging information about this mission. This string is a short representation of this object's state.

Overrides:

getDebuggingInfo in class Mission

Returns:

The String: "(x, y) z" or "(x, y) z!" where x and y is the coordinates of the target tile for this mission, and z is the value of building the colony. The exclamation mark is added if the unit should continue searching for a colony site if the targeted site is lost.