Class CashInTreasureTrainMission

  • All Implemented Interfaces:
    java.lang.Comparable<FreeColObject>, ObjectWithId

    public final class CashInTreasureTrainMission
    extends Mission
    Mission for cashing in a treasure train. FIXME: acquire protection FIXME: Better avoidance of enemy units
    • Field Detail

      • logger

        private static final java.util.logging.Logger logger
      • tag

        private static final java.lang.String tag
        The tag for this mission.
        See Also:
        Constant Field Values
      • target

        private Location target
        The location to cash this treasure train in at, either a Colony or Europe.
    • Constructor Detail

      • CashInTreasureTrainMission

        public CashInTreasureTrainMission​(AIMain aiMain,
                                          AIUnit aiUnit,
                                          Location target)
        Creates a mission for the given AIUnit.
        Parameters:
        aiMain - The main AI-object.
        aiUnit - The AIUnit this mission is created for.
        target - The target Location for this mission.
      • CashInTreasureTrainMission

        public CashInTreasureTrainMission​(AIMain aiMain,
                                          AIUnit aiUnit,
                                          FreeColXMLReader xr)
                                   throws javax.xml.stream.XMLStreamException
        Creates a new CashInTreasureTrainMission from a reader.
        Parameters:
        aiMain - The main AI-object.
        aiUnit - The AIUnit this mission is created for.
        xr - The input stream containing the XML.
        Throws:
        javax.xml.stream.XMLStreamException - if a problem was encountered during parsing.
        See Also:
        FreeColObject.readFromXML(net.sf.freecol.common.io.FreeColXMLReader)
    • Method Detail

      • assignCarrier

        private AIUnit assignCarrier​(LogBuilder lb)
        Assign a carrier for this treasure.
        Parameters:
        lb - A LogBuilder to log to.
        Returns:
        A suitable carrier AIUnit, to which this unit has been queued for transport.
      • extractTarget

        public static Location extractTarget​(AIUnit aiUnit,
                                             PathNode path)
        Extract a valid target for this mission from a path.
        Parameters:
        aiUnit - A AIUnit to perform the mission.
        path - A PathNode to extract a target from, (uses the unit location if null).
        Returns:
        A target for this mission, or null if none found.
      • scorePath

        public static int scorePath​(AIUnit aiUnit,
                                    PathNode path)
        Evaluate a potential cashin mission for a given unit and path.
        Parameters:
        aiUnit - The AIUnit to do the mission.
        path - A PathNode to take to the target.
        Returns:
        A score for the proposed mission.
      • getGoalDecider

        private static GoalDecider getGoalDecider​(AIUnit aiUnit,
                                                  boolean deferOK)
        Makes a goal decider that checks cash in sites.
        Parameters:
        aiUnit - The AIUnit to search with.
        deferOK - Keep track of the nearest colonies to use as a fallback destination.
        Returns:
        A suitable GoalDecider.
      • findTargetPath

        private static PathNode findTargetPath​(AIUnit aiUnit,
                                               int range,
                                               boolean deferOK)
        Find a suitable cash in location for this unit.
        Parameters:
        aiUnit - The AIUnit to execute this mission.
        range - The maximum number of moves to search.
        deferOK - Enables deferring to a fallback colony.
        Returns:
        A PathNode to the target, or null if not found which includes the case when Europe should be preferred (because the unit can not get there by itself).
      • findMissionTarget

        public static Location findMissionTarget​(AIUnit aiUnit,
                                                 int range,
                                                 boolean deferOK)
        Finds a suitable cashin target for the supplied unit.
        Parameters:
        aiUnit - The AIUnit to test.
        range - The maximum number of moves to search.
        deferOK - Enables deferring to a fallback colony.
        Returns:
        A PathNode to the target, or null if none found.
      • invalidUnitReason

        private static java.lang.String invalidUnitReason​(AIUnit aiUnit)
        Why would this mission be invalid with the given unit?
        Parameters:
        aiUnit - The AIUnit to test.
        Returns:
        A reason why the mission would be invalid with the unit, or null if none found.
      • invalidFullColonyReason

        private static java.lang.String invalidFullColonyReason​(AIUnit aiUnit,
                                                                Colony colony)
        Why is this mission invalid with a given colony target, given that intermediate colonies are excluded.
        Parameters:
        aiUnit - The AIUnit to check.
        colony - The potential target Colony.
        Returns:
        A reason for mission invalidity, or null if none found.
      • invalidColonyReason

        private static java.lang.String invalidColonyReason​(AIUnit aiUnit,
                                                            Colony colony)
        Why is this mission invalid with a given colony target, given that intermediate colonies are included.
        Parameters:
        aiUnit - The AIUnit to check.
        colony - The potential target Colony.
        Returns:
        A reason for mission invalidity, or null if none found.
      • invalidEuropeReason

        private static java.lang.String invalidEuropeReason​(AIUnit aiUnit,
                                                            Europe europe)
        Why is this mission invalid with a given Europe target?
        Parameters:
        aiUnit - The AIUnit to check.
        europe - The potential target Europe.
        Returns:
        A reason for mission invalidity, or null if none found.
      • invalidMissionReason

        public static java.lang.String invalidMissionReason​(AIUnit aiUnit)
        Why would this mission be invalid with the given AI unit?
        Parameters:
        aiUnit - The AIUnit to test.
        Returns:
        A reason for invalidity, or null if none found.
      • invalidMissionReason

        public static java.lang.String invalidMissionReason​(AIUnit aiUnit,
                                                            Location loc)
        Why would this mission be invalid with the given AI unit and location?
        Parameters:
        aiUnit - The AIUnit to check.
        loc - The Location to check.
        Returns:
        A reason for invalidity, or null if none found.
      • getBaseTransportPriority

        public int getBaseTransportPriority()
        Get the base transport priority for the unit performing this mission.
        Overrides:
        getBaseTransportPriority in class Mission
        Returns:
        A base transport priority.
      • getTarget

        public Location getTarget()
        Gets the target of this mission, if any.
        Specified by:
        getTarget in class Mission
        Returns:
        The target of this mission, or null if none.
      • setTarget

        public void setTarget​(Location target)
        Sets the target of this mission, if any. The actual target is handled in the missions that really have them, this is a helper to make sure the unit is updated.
        Specified by:
        setTarget in class Mission
        Parameters:
        target - The new target of this mission, or null if none.
      • findTarget

        public Location findTarget()
        Finds a new target for this mission.
        Specified by:
        findTarget in class Mission
        Returns:
        A new target for this mission.
      • invalidReason

        public java.lang.String invalidReason()
        Why is this mission invalid? Mission subclasses must implement this routine, which probably should start by checking invalidAIUnitReason. A mission can be invalid for a number of subclass-specific reasons. For example: a seek-and-destroy mission could be invalid because of a improved stance towards the targeted player.
        Specified by:
        invalidReason in class Mission
        Returns:
        A reason for mission invalidity, or null if none found.
      • doMission

        public Mission doMission​(LogBuilder lb)
        Performs the mission.
        Specified by:
        doMission in class Mission
        Parameters:
        lb - A LogBuilder to log to.
        Returns:
        The Mission to continue with, or null if the current mission has completed.
      • writeAttributes

        protected void writeAttributes​(FreeColXMLWriter xw)
                                throws javax.xml.stream.XMLStreamException
        Write the attributes of this object to a stream. To be overridden if required by any object that has attributes and uses the toXML(FreeColXMLWriter, String) call.
        Overrides:
        writeAttributes in class Mission
        Parameters:
        xw - The FreeColXMLWriter to write to.
        Throws:
        javax.xml.stream.XMLStreamException - if there are any problems writing to the stream.
      • readAttributes

        protected void readAttributes​(FreeColXMLReader xr)
                               throws javax.xml.stream.XMLStreamException
        Reads the attributes of this object from an XML stream.
        Overrides:
        readAttributes in class Mission
        Parameters:
        xr - The FreeColXMLReader to read from.
        Throws:
        javax.xml.stream.XMLStreamException - if there is a problem reading the stream.
      • getXMLTagName

        public java.lang.String getXMLTagName()
        Get the serialization tag for this object.
        Specified by:
        getXMLTagName in class FreeColObject
        Returns:
        The tag.