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:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class megamek.common.strategicBattleSystems.SBFFormation

SBFFormation.MoraleStatus

Field Summary

Fields inherited from class megamek.common.strategicBattleSystems.SBFFormation

moraleStatus, type

Fields inherited from interface megamek.common.units.BTObject

NONE

Constructor Summary

Constructors

Constructor	Description
Formation()

Method Summary

Modifier and Type	Method	Description
void	addBeingTargetedBy(Formation formation)
int	beingTargetByHowMany()
int	currentSize()
int	getCurrentMovement()
String	getDisplayName()
List<String>	getElementNames()
EngagementControl	getEngagementControl()
Entity	getEntity()
InitiativeRoll	getInitiativeRoll()
Memory	getMemory()
int	getMovement()
int	getPointValue()
ASRange	getRange(int formationId)
Role	getRole()
int	getSize()
int	getSkill()
int	getStartingSize()
ASDamageVector	getStdDamage()
int	getTactics()
int	getTargetFormationId()
int	getTmm()
boolean	hadHighStressEpisode()
boolean	hasDamageAtRange(ASRange range)
boolean	isClan()
boolean	isCrippled()	Checks if the formation is crippled.
boolean	isEngagementControlFailed()
boolean	isRangeSet(int formationId)
boolean	isSingleEntity()
boolean	isUnitIsCrippledLatch()
boolean	isWithdrawing()
void	reset()
void	setEngagementControl(EngagementControl engagementControl)
void	setEngagementControlFailed(boolean engagementControlFailed)
void	setEntity(Entity entity)
void	setHighStressEpisode()
void	setInitiativeRoll(InitiativeRoll initiativeRoll)
void	setIsClan(boolean clanFormation)
void	setRange(int formationId, ASRange range)
void	setRole(Role role)
void	setStartingSize(int startingSize)
void	setStdDamage(ASDamageVector stdDamage)
void	setTargetFormationId(int targetFormationId)
void	setUnitIsCrippledLatch(boolean unitIsCrippledLatch)
void	setWithdrawing(boolean withdrawing)
String	toString()

Methods inherited from class megamek.common.strategicBattleSystems.SBFFormation

addUnit, equals, formatSUA, generalName, getConversionReport, getDeployRound, getForceId, getForceString, getId, getJumpMove, getJumpUsedThisTurn, getMorale, getMovementCode, getMovementMode, getName, getOwnerId, getPosition, getSbfArtilleryDamage, getSbfArtilleryHomingDamage, getSpecialAbilities, getSpecialsDisplayString, getStrength, getSUA, getTrspMovement, getTrspMovementCode, getTrspMovementMode, getType, getUnits, hashCode, hasSUA, isAerospace, isAnyTypeOf, isBroken, isDeployed, isDone, isEligibleForPhase, isHidden, isRouted, isShaken, isType, isUnitGroup, isUnsteady, moraleStatus, removeUnit, setConversionReport, setDeployed, setDeployRound, setDone, setForceId, setForceString, setId, setJumpMove, setJumpUsedThisTurn, setMorale, setMoraleStatus, setMovement, setMovementMode, setName, setOwnerId, setPointValue, setPosition, setSize, setSkill, setTactics, setTmm, setTrspMovement, setTrspMovementMode, setType, setUnits, specificName

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface megamek.common.alphaStrike.ASSpecialAbilityCollector

getAC, getBIM, getCAP, getCAR, getCT, getFLK, getFUEL, getHT, getIATM, getIF, getIT, getJMPS, getLAM, getLRM, getMHQ, getMSL, getREAR, getSCAP, getSpecialsDisplayString, getSRM, getSUBS, getTOR, getTUR, hasAnySUAOf

Methods inherited from interface megamek.common.strategicBattleSystems.BattleForceSUAFormatter

showSUA

Methods inherited from interface megamek.common.units.BTObject

getFluffImage, getIcon, hasAerodyneSpheroidDistinction, isAero, isAerodyne, isAerospaceFighter, isAerospaceSV, isBattleArmor, isBattleMek, isCarryableObject, isCombatVehicle, isConventionalFighter, isConventionalInfantry, isDropShip, isFighter, isFixedWingSupport, isGround, isHandheldWeapon, isIndustrialMek, isInfantry, isJumpShip, isLargeAerospace, isMek, isObjectiveMarker, isProtoMek, isQuadMek, isSingleUnit, isSmallCraft, isSpaceStation, isSpheroid, isSupportVehicle, isTripodMek, isVehicle, isWarShip

Methods inherited from interface megamek.common.units.Deployable

getBoardId, getFleeZone, hasFleeZone

Methods inherited from interface megamek.common.interfaces.ForceAssignable

partOfForce

Methods inherited from interface megamek.common.game.InGameObject

countForStrengthSum, hasOwner

Constructor Details

Formation

public Formation()

Method Details

addBeingTargetedBy

public void addBeingTargetedBy(Formation formation)

beingTargetByHowMany

public int beingTargetByHowMany()

getStartingSize

public int getStartingSize()

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

public void setEngagementControl(EngagementControl engagementControl)

getTargetFormationId

public int getTargetFormationId()

isUnitIsCrippledLatch

public boolean isUnitIsCrippledLatch()

setUnitIsCrippledLatch

public void setUnitIsCrippledLatch(boolean unitIsCrippledLatch)

setTargetFormationId

public void setTargetFormationId(int targetFormationId)

setIsClan

public void setIsClan(boolean clanFormation)

isClan

public boolean isClan()

isEngagementControlFailed

public boolean isEngagementControlFailed()

setEngagementControlFailed

public void setEngagementControlFailed(boolean engagementControlFailed)

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

public InitiativeRoll getInitiativeRoll()

setInitiativeRoll

public void setInitiativeRoll(InitiativeRoll initiativeRoll)

toString

public String toString()

Overrides:

toString in class SBFFormation