Package megamek.common.autoResolve.component

Class Formation

java.lang.Object
megamek.common.strategicBattleSystems.SBFFormation
megamek.common.autoResolve.component.Formation
All Implemented Interfaces:
Serializable, ASSpecialAbilityCollector, InGameObject, ForceAssignable, BattleForceSUAFormatter, BTObject, Deployable
public class Formation extends SBFFormation
See Also:

  • Constructor Details

    • Formation

      public Formation()

  • Method Details

    • addBeingTargetedBy

      public void addBeingTargetedBy(Formation formation)

    • beingTargetByHowMany

      public int beingTargetByHowMany()

    • getStartingSize

      @Deprecated(since="0.51.0", forRemoval=true) public int getStartingSize()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • setStartingSize

      public void setStartingSize(int startingSize)

    • currentSize

      public int currentSize()

    • isSingleEntity

      public boolean isSingleEntity()

    • getEntity

      public Entity getEntity()

    • setEntity

      public void setEntity(Entity entity)

    • getRole

      public Role getRole()

    • setRole

      public void setRole(Role role)

    • getMemory

      public Memory getMemory()

    • getEngagementControl

      public EngagementControl getEngagementControl()

    • setEngagementControl

      @Deprecated(since="0.51.0", forRemoval=true) public void setEngagementControl(EngagementControl engagementControl)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • getTargetFormationId

      public int getTargetFormationId()

    • isUnitIsCrippledLatch

      @Deprecated(since="0.51.0", forRemoval=true) public boolean isUnitIsCrippledLatch()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • setUnitIsCrippledLatch

      @Deprecated(since="0.51.0", forRemoval=true) public void setUnitIsCrippledLatch(boolean unitIsCrippledLatch)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • setTargetFormationId

      public void setTargetFormationId(int targetFormationId)

    • setIsClan

      public void setIsClan(boolean clanFormation)

    • isClan

      public boolean isClan()

    • isEngagementControlFailed

      @Deprecated(since="0.51.0", forRemoval=true) public boolean isEngagementControlFailed()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • setEngagementControlFailed

      @Deprecated(since="0.51.0", forRemoval=true) public void setEngagementControlFailed(boolean engagementControlFailed)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • isRangeSet

      public boolean isRangeSet(int formationId)

    • getRange

      public ASRange getRange(int formationId)

    • setRange

      public void setRange(int formationId, ASRange range)

    • setHighStressEpisode

      public void setHighStressEpisode()

    • reset

      public void reset()

    • getDisplayName

      public String getDisplayName()

    • getElementNames

      public List<String> getElementNames()

    • getCurrentMovement

      public int getCurrentMovement()

    • hadHighStressEpisode

      public boolean hadHighStressEpisode()

    • isCrippled

      public boolean isCrippled()
      Checks if the formation is crippled. Rules as described on Interstellar Operations BETA pg 242 - Crippling Damage
      Returns:
      true in case it is crippled

    • hasDamageAtRange

      public boolean hasDamageAtRange(ASRange range)

    • setStdDamage

      public void setStdDamage(ASDamageVector stdDamage)

    • getStdDamage

      public ASDamageVector getStdDamage()
      Returns:
      The standard damage to this element or turret or the STD damage to this arc.

    • getSize

      public int getSize()
      Overrides:
      getSize in class SBFFormation

    • getTmm

      public int getTmm()
      Overrides:
      getTmm in class SBFFormation

    • getSkill

      public int getSkill()
      Overrides:
      getSkill in class SBFFormation

    • getTactics

      public int getTactics()
      Overrides:
      getTactics in class SBFFormation

    • getMovement

      public int getMovement()
      Overrides:
      getMovement in class SBFFormation

    • getPointValue

      public int getPointValue()
      Overrides:
      getPointValue in class SBFFormation

    • isWithdrawing

      public boolean isWithdrawing()

    • setWithdrawing

      public void setWithdrawing(boolean withdrawing)

    • getInitiativeRoll

      @Deprecated(since="0.51.0", forRemoval=true) public InitiativeRoll getInitiativeRoll()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • setInitiativeRoll

      @Deprecated(since="0.51.0", forRemoval=true) public void setInitiativeRoll(InitiativeRoll initiativeRoll)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • toString

      public String toString()
      Overrides:
      toString in class SBFFormation