Class UnitWanderHostileMission

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

    public class UnitWanderHostileMission
    extends Mission
    Mission for wandering around, attacking targets owned by a player we do not like.
    • 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
    • Constructor Detail

      • UnitWanderHostileMission

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

        public UnitWanderHostileMission​(AIMain aiMain,
                                        AIUnit aiUnit,
                                        FreeColXMLReader xr)
                                 throws javax.xml.stream.XMLStreamException
        Creates a new UnitWanderHostileMission 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

      • invalidUnitReason

        private static java.lang.String invalidUnitReason​(AIUnit aiUnit)
        Why would this mission be invalid with the given unit.
        Parameters:
        aiUnit - The AIUnit to check.
        Returns:
        A reason why the mission would be invalid with the unit, 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 check.
        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.
      • 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.
      • isOneTime

        public boolean isOneTime()
        Should this mission be considered a mere fallback to be replaced at will? Missions are not one-time by default, true one-time missions must override this routine.
        Overrides:
        isOneTime in class Mission
        Returns:
        False.
      • 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.
      • getXMLTagName

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