Package megamek.client.bot.princess

Class UnitBehavior

java.lang.Object
megamek.client.bot.princess.UnitBehavior
public class UnitBehavior extends Object

  • Constructor Details

    • UnitBehavior

      public UnitBehavior()

  • Method Details

    • getBehaviorType

      public UnitBehavior.BehaviorType getBehaviorType(Entity entity, Princess owner)
      Gets (and calculates, if necessary), the behavior type for the given entity.

    • getCachedBehaviorType

      @Nullable public UnitBehavior.BehaviorType getCachedBehaviorType(Entity entity)
      The behavior already worked out for this unit, without working one out if none has been.

      For logging and analysis only. getBehaviorType(megamek.common.units.Entity, megamek.client.bot.princess.Princess) computes and caches on a miss, and what it computes depends on where everything is standing at the time - so asking early, for a unit that has not moved yet, would pin an answer the bot would otherwise have reached later with better information.

      Parameters:
      entity - the unit to look up
      Returns:
      the cached behavior, or null if this unit has not been evaluated this turn

    • overrideBehaviorType

      public void overrideBehaviorType(Entity entity, UnitBehavior.BehaviorType behaviorType)

    • getWaypointForEntity

      public Optional<Coords> getWaypointForEntity(Entity entity)

    • isDestinationValidForEntity

      public boolean isDestinationValidForEntity(Entity entity, Coords destination, Princess owner)

    • addEntityWaypoint

      public boolean addEntityWaypoint(Entity entity, List<Coords> waypoints, Princess owner)

    • addEntityWaypoint

      @Deprecated(since="0.51.0", forRemoval=true) public boolean addEntityWaypoint(Entity entity, Coords destination, Princess owner)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • removeHeadWaypoint

      public void removeHeadWaypoint(Entity entity)
      Removes the head waypoint from the entity's waypoint queue If waypoints were added (1,1) then (2,2), then (3,3), this would remove (1,1)
      Parameters:
      entity - the entity to remove the waypoint from

    • removeTailWaypoint

      public void removeTailWaypoint(Entity entity)
      Removes the tail waypoint from the entity's waypoint queue If waypoints were added (1,1) then (2,2) then (3,3), this would remove (3,3), good for an "undo" behavior.
      Parameters:
      entity - the entity to remove the waypoint from

    • setEntityWaypoints

      public void setEntityWaypoints(Entity entity, List<Coords> waypoints, Princess owner)
      Sets the entity's waypoints to the given destination

    • clearWaypoints

      public void clearWaypoints(Entity entity)

    • clearWaypoints

      public void clearWaypoints()

    • clear

      public void clear()
      Clears the entity behavior cache, should be done at the start of each movement phase