Package megamek.common.units

Class Tank

java.lang.Object

megamek.common.turns.TurnOrdered

megamek.common.units.Entity

megamek.common.units.Tank

All Implemented Interfaces:

Serializable, ICarryable, Transporter, InGameObject, CombatRole, ForceAssignable, ITechnology, ITurnOrdered, PhaseUpdated, RoundUpdated, BTObject, Deployable, Fortifiable, RubbleClearer, Targetable

Direct Known Subclasses:

GunEmplacement, SuperHeavyTank, SupportTank, VTOL

public class Tank
extends Entity
implements Fortifiable, RubbleClearer

You know what tanks are, silly.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class megamek.common.units.Entity

Entity.InvalidSourceBuildReason

Nested classes/interfaces inherited from interface megamek.common.equipment.ICarryable

ICarryable.CarriedObjectDamageAllocation

Field Summary

Fields

Modifier and Type	Field	Description
static final int	BASE_CHASSIS_TURRET_WT_UNASSIGNED	Keeps track of the base weight of the turret for omni tanks.
static final int	CRIT_AMMO
static final int	CRIT_CARGO
static final int	CRIT_COMMANDER
static final int	CRIT_CREW_KILLED
static final int	CRIT_CREW_STUNNED
static final int	CRIT_DRIVER
static final int	CRIT_ENGINE
static final int	CRIT_FUEL_TANK
static final int	CRIT_NONE
static final int	CRIT_SENSOR
static final int	CRIT_SENSOR_MAX
static final int	CRIT_STABILIZER
static final int	CRIT_TURRET_DESTROYED
static final int	CRIT_TURRET_JAM
static final int	CRIT_TURRET_LOCK
static final int	CRIT_WEAPON_DESTROYED
static final int	CRIT_WEAPON_JAM
protected boolean	engineHit
protected boolean	hasPintle
protected boolean	hasSponsons
static final int	LOC_BODY
static final int	LOC_FRONT
static final int	LOC_LEFT
static final int	LOC_REAR
static final int	LOC_RIGHT
static final int	LOC_TURRET	for dual turret tanks, this is the rear turret
static final int	LOC_TURRET_2	for dual turret tanks, this is the front turret
protected boolean	m_bDualTurretEverJammed
protected boolean	m_bDualTurretJammed
protected boolean	m_bDualTurretLocked
protected boolean	m_bHasNoDualTurret
protected boolean	m_bHasNoTurret
protected boolean	m_bTurretEverJammed
protected boolean	m_bTurretJammed
protected boolean	m_bTurretLocked
protected int	motiveDamage
protected int	motivePenalty
protected static final Map<Integer,Integer>	SIDE_LOC_MAPPING

Fields inherited from class megamek.common.units.Entity

_isEMId, abandonmentAnnouncedRound, ALTERNATE_MASC_FAILURE, ALTERNATE_MASC_FAILURE_ENHANCED, altitude, ammoList, armorTechLevel, armorTechRating, armorTonnage, armorType, armsFlipped, asewAffectedTurns, aTracker, baVDNINeedsFeedbackMessage, BLOOD_STALKER_TARGET_CLEARED, bMASCWentUp, bombList, boobyTrapInitiated, bSuperchargerWentUp, C3_NETWORK_ID_SEPARATOR, c3CompanyMasterIndex, c3Master, c3NetIdString, camouflage, canUnstickByJumping, carcass, chassis, clanChassisName, climbing, climbingLevelsChosen, consecutiveRHSUses, convertingNow, coolFromExternal, crits, damageThisPhase, damageThisRound, dangling, delta_distance, designValid, destroyed, displacementAttack, DMG_CRIPPLED, DMG_HEAVY, DMG_LIGHT, DMG_MODERATE, DMG_NONE, dodging, DOES_NOT_TRACK_HEAT, done, doomed, eiShutdown, elevation, empInterferenceHeat, empInterferenceRounds, empShutdownRounds, engineHitsThisPhase, engineTechRating, equipmentList, ETYPE_AERO, ETYPE_AEROSPACE_FIGHTER, ETYPE_ARMLESS_MEK, ETYPE_BATTLEARMOR, ETYPE_BATTLEFIELD_SUPPORT_ASSET, ETYPE_BIPED_MEK, ETYPE_BUILDING_ENTITY, ETYPE_COMBAT_VEHICLE_ESCAPE_POD, ETYPE_CONV_FIGHTER, ETYPE_DROPSHIP, ETYPE_FIGHTER_SQUADRON, ETYPE_FIXED_WING_SUPPORT, ETYPE_GUN_EMPLACEMENT, ETYPE_HANDHELD_WEAPON, ETYPE_INFANTRY, ETYPE_JUMPSHIP, ETYPE_LAND_AIR_MEK, ETYPE_LARGE_SUPPORT_TANK, ETYPE_MEK, ETYPE_MEKWARRIOR, ETYPE_PROTOMEK, ETYPE_QUAD_MEK, ETYPE_QUADVEE, ETYPE_SMALL_CRAFT, ETYPE_SPACE_STATION, ETYPE_SUPER_HEAVY_TANK, ETYPE_SUPPORT_TANK, ETYPE_SUPPORT_VTOL, ETYPE_TANK, ETYPE_TELEMISSILE, ETYPE_TRIPOD_MEK, ETYPE_VTOL, ETYPE_WARSHIP, externalId, facing, failedEquipmentList, fell, findingClub, firingSolutions, fluff, game, gotPavementOrRoadBonus, GRAPPLE_BOTH, GRAPPLE_LEFT, GRAPPLE_RIGHT, hardenedArmorDamaged, hasDamagedRHS, hasExternalSearchlight, heat, heatBuildup, heatFromExternal, heatSinkCoolantFailureFactor, hiddenActivationPhase, hullDown, icon, id, iGame, illuminated, iNarcPods, incomingGuidedAttacks, infernos, initialBV, inReverse, isC3ecmAffected, isCarefulStanding, isHidden, isJumpingNow, jumpMP, killerId, lastTarget, lastTargetDisplayName, layingMines, LOC_DESTROYED, LOC_NONE, locationBlownOff, locationBlownOffThisPhase, m_lNarcedBy, m_lPendingNarc, madePointblankShot, manualBV, manualShutdown, MASC_FAILURE, MAX_C3_NODES, MAX_C3i_NODES, MAX_NOVA_CEWS_NODES, military, miscList, mixedTech, model, moved, movedLastRound, movementMode, mpUsed, mpUsedLastRound, mulId, narcPods, nCrew, nMarines, nMASCLevel, nPassenger, nSuperchargerLevel, OBSOLETE_UNKNOWN_MARKER, omni, owner, ownerId, pendingAbandon, pendingINarcPods, pendingNarcPods, previousMovementMode, prone, published, reckless, reportedVDNIFeedbackThisPhase, rhsWentUp, rolledForEngineExplosion, searchlightIsActive, searchlightOverride, sec_facing, secondaryPositions, selfDestructedThisTurn, selfDestructing, selfDestructInitiated, sensorContacts, shutDown, shutdownByBATaser, shutDownThisPhase, source, spotting, STARTING_ANY_NONE, startupThisPhase, struck, structuralTechRating, structureTechLevel, structureType, stuckInSwamp, TA_ARMORED_COMPONENT, TA_MIXED_TECH, TA_OMNI, TA_PATCHWORK_ARMOR, taggedBy, targetBay, taserFeedBackRounds, taserInterference, taserInterferenceHeat, taserInterferenceRounds, taserShutdownRounds, techFaction, techLevel, tmTracker, totalWeaponList, traitorId, twistedPhase, underwaterRounds, unjammingRAC, UNLIMITED_JUMP_DOWN, usedMASC, usedRHSLastTurn, usedSearchlight, usedSupercharger, useManualBV, vectors, walkMP, weaponBayList, weaponGroupList, weaponList, weight, wigeBonus, year

Fields inherited from interface megamek.common.units.BTObject

NONE

Fields inherited from interface megamek.common.units.Fortifiable

DUG_IN_FORTIFYING_FIRST, DUG_IN_FORTIFYING_LAST, DUG_IN_NONE, FORTIFY_LOGGER

Fields inherited from interface megamek.common.interfaces.ITechnology

DATE_ES, DATE_NONE, DATE_PS

Fields inherited from interface megamek.common.units.Targetable

TYPE_BLDG_IGNITE, TYPE_BLDG_TAG, TYPE_BUILDING, TYPE_ENTITY, TYPE_FLARE_DELIVER, TYPE_FUEL_TANK, TYPE_FUEL_TANK_IGNITE, TYPE_HEX_AERO_BOMB, TYPE_HEX_ARTILLERY, TYPE_HEX_BOMB, TYPE_HEX_CLEAR, TYPE_HEX_EXTINGUISH, TYPE_HEX_IGNITE, TYPE_HEX_SCREEN, TYPE_HEX_TAG, TYPE_I_NARC_POD, TYPE_MINEFIELD_CLEAR, TYPE_MINEFIELD_DELIVER, TYPE_SATURATION, TYPE_SEARCHLIGHT

Constructor Summary

Constructors

Constructor	Description
Tank()

Method Summary

Modifier and Type	Method	Description
PilotingRollData	addEntityBonuses(PilotingRollData prd)	Add in any piloting skill mods
void	addEquipment(Mounted<?> mounted, int loc, boolean rearMounted)	Adds the given mounted equipment to the unit in the given location, possibly rear-facing depending on the given parameter.
void	addIntrinsicTransporters()	Some entities will always have certain transporters.
void	addJammedWeapon(Mounted<?> weapon)	Adds the provided weapon as a weapon that is jammed via the vehicle "weapon malfunction" critical hit
void	addMovementDamage(int level)	adds minor, moderate or heavy movement system damage
protected void	addSystemTechAdvancement(CompositeTechLevel techLevel)	Incorporate dates for components that are not in the equipment list, such as engines and structure.
void	applyDamage()	Applies any damage that the entity has suffered.
void	applyMovementDamage()	Applies movement damage to the Tank.
void	autoSetInternal()	Sets the internal structure for every location to appropriate undamaged values for the unit and location.
boolean	canAbandon()	Returns true if this vehicle can be abandoned by its crew.
boolean	canAnnounceAbandon()	Checks whether this unit can announce abandonment of its crew in the End Phase.
boolean	canChangeSecondaryFacing()	Can this entity change secondary facing at all?
boolean	canCharge()
boolean	canClearTurret()	Convenience function that determines if this tank can issue a "clear turret" command.
boolean	canDFA()
boolean	canEjectCrew()	A vehicle crew can abandon where the game's options allow vehicle crews to leave at all.
boolean	canGoHullDown()	Checks to see if a Tank is capable of going hull-down.
boolean	canLaunchEscapePod()	Returns true if the crew can launch the Combat Vehicle Escape Pod this turn.
boolean	canPerformGroundSalvageOperations()	Determines whether salvage operations can be performed on the ground.
boolean	canSpot()	Tanks can't spot when stunned.
boolean	canUnjamWeapon()	Convenience function that determines if this tank can issue an "unjam weapon" command.
void	clearStabiliserHit(int loc)
int	clipSecondaryFacing(int n)	Returns the closest valid secondary facing to the given direction.
int	currentFortifyHealthSignature()
CrewType	defaultCrewType()
boolean	doomedInVacuum()
void	engineFix()
void	engineHit()	apply the effects of an "engine hit" crit
void	extinguishAll()	extinguish all inferno fire on this Tank
void	extinguishLocation(int location)
int	firstArmorIndex()
double	fuelTonnagePer100km()	Calculates fuel mass based on engine type and mass.
double	getBaseChassisSponsonPintleWeight()	Used for omni vehicles, which must set the weight of sponson or pintle mounts in the base chassis, limiting the amount of pod space in the turret(s).
double	getBaseChassisTurret2Weight()	Used for omni vehicles, which must set the weight of turrets the base chassis, limiting the amount of pod space in the turret.
double	getBaseChassisTurretWeight()	Used for omni vehicles, which must set the weight of turrets the base chassis, limiting the amount of pod space in the turret.
int	getBodyLocation()	Determines where to place equipment that does not require a specific location.
TechAdvancement	getConstructionTechAdvancement()	return - the base construction option tech advancement
double	getCost(CalculationReport calcReport, boolean ignoreAmmo)	Calculates and returns the C-bill cost of the unit.
int	getCriticalEffect(int roll, int loc, boolean damagedByFire)	get the type of critical caused by a critical roll, taking account of existing damage
int	getDualTurretFacing()
static TechAdvancement	getDualTurretTA()
int	getDugIn()
int	getEngineHits()
long	getEntityType()
int	getExtraCrewSeats()
FortifyState	getFortifyState()
int	getForwardArc()	see Entity.getForwardArc()
int	getFreeSlots()	get the free item slots for this tank
double	getFuelTonnage()	Returns the mass of the fuel, which is used for calculating operating range.
int	getGenericBattleValue()	Calculates a "generic" Battle Value that is based on the average of all units of this type and tonnage.
int	getHQIniBonus()
FuelType	getICEFuelType()	The type of fuel for internal combustion engines.
ArrayList<Mounted<?>>	getJammedWeapons()	All weapons that a vehicle could use "unjam weapon" for
String[]	getLocationAbbreviations()
String	getLocationDamage(int loc)
String[]	getLocationNames()
int	getLocTurret()
int	getLocTurret2()
int	getMaxElevationDown(int currElevation)	Returns the maximum number of downward elevation changes a unit can make.
int	getMotiveDamage()
int	getMotivePenalty()
String	getMovementAbbr(EntityMovementType movementType)	Returns the name of the type of movement used.
String	getMovementString(EntityMovementType movementType)	Returns the name of the type of movement used.
int[]	getNoOfSlots()
boolean	getOverThresh()	Deprecated, for removal: This API element is subject to removal in a future version.
int	getPotCrit()
double	getPriceMultiplier()	Returns a multiplier that combines multiplicative construction cost modifiers for this Entity.
int	getRearArc()	see Entity.getRearArc()
int	getRecoveryTime()	Returns the recovery time for this entity in minutes.
Coords	getRubbleClearTarget()
int	getRubbleClearTurnsCompleted()
int	getRubbleClearTurnsRequired()
int	getRunMP(MPCalculationSetting mpCalculationSetting)
String	getRunMPasString(boolean gameState)	Returns this entity's running/flank mp as a string.
int	getRunningGravityLimit()	get the gravity limit for ground movement
boolean	getsAutoExternalSearchlight()
int	getSensorHits()
int	getSprintMP()	Returns this entity's sprinting MP, modified for all its current circumstances such as gravity and damage.
int	getSprintMP(MPCalculationSetting mpCalculationSetting)	Returns this entity's sprinting MP, modified according to the given setting.
int	getSpriteDrawPriority()	Used to determine the draw priority of different Entity subclasses.
TargetRoll	getStealthModifier(int range, Entity ae)	Determine the stealth modifier for firing at this unit from the given range.
int	getStunnedTurns()
int	getSuspensionFactor()
static int	getSuspensionFactor(EntityMovementMode movementMode, double weight)	Static method to calculate suspension factor without needing a vehicle
int	getTotalCommGearTons()
int	getTotalSlots()	get the total amount of item slots available for this tank
HitData	getTransferLocation(HitData hit)	Gets the location that excess damage transfers to
int	getTurretCount()
int	getUnitType()
int	getWalkMP(MPCalculationSetting mpCalculationSetting)
int	getWeaponArc(int weaponNumber)	Returns the Compute.ARC that the weapon fires into.
boolean	hasArmedMASC()	Checks if a mek has an armed MASC system.
boolean	hasArmoredEngine()
boolean	hasCombatVehicleEscapePod()	Returns true if this vehicle has a Combat Vehicle Escape Pod installed.
boolean	hasCommandConsoleBonus()	Units with a cockpit command console provide an initiative bonus to their side, provided that the commander is not currently functioning as pilot, the unit has advanced fire control, and the unit is heavy or assault weight class.
boolean	hasEnvironmentalSealing()
boolean	hasFrontMountedBulldozer()	Checks if this entity has a working front-mounted bulldozer.
boolean	hasFrontMountedSaw()	Checks if this entity has a front-mounted chainsaw or dual saw.
boolean	hasHeavyMovementDamage()
boolean	hasMinorMovementDamage()
boolean	hasModerateMovementDamage()
boolean	hasMovementDamage()	Deprecated, for removal: This API element is subject to removal in a future version.
boolean	hasNoControlSystems()
boolean	hasNoDualTurret()
boolean	hasNoTurret()
boolean	hasRearMountedBulldozer()	Checks if this entity has a working rear-mounted bulldozer.
protected boolean	hasTrailerHitchTransporter()	Check to see if the unit has a trailer hitch transporter already We need this to prevent duplicate transporters being created
boolean	hasUndamagedCombatVehicleEscapePod()	Returns true if this vehicle has an undamaged Combat Vehicle Escape Pod.
boolean	hasWorkingBackhoe()	Checks if this entity has a working backhoe.
boolean	hasWorkingBulldozer()	Checks if this entity has a working bulldozer in any location.
void	immobilize()	Marks this tank for immobilization, most likely from a related motive system hit.
int	implicitClanCASE()	Used to for cost calculations.
boolean	isAbandoned()	Returns true if this vehicle has been abandoned - the crew has exited but the vehicle itself is not destroyed.
boolean	isBackedIntoHullDown()	Returns True if this tank moved backwards before going Hull Down
boolean	isCarryableObject()	For future reference.
boolean	isChassisFamiliarityEligible()	Returns whether this unit is a chassis-familiarity-eligible type for MekHQ's Familiarity system
boolean	isCombatVehicle()	Returns true when this object is a ground Combat Vehicle, including VTOL but not including Support Vehicles, or of type CV for Alpha Strike.
boolean	isCommanderHit()
boolean	isCommanderHitPS()
boolean	isCrewHitPS()
boolean	isCrippled()	Returns TRUE if the entity meets the requirements for crippling damage as detailed in TW pg 258.
boolean	isCrippled(boolean checkCrew)	Returns TRUE if the entity meets the requirements for crippling damage as detailed in TW pg 258.
boolean	isDmgHeavy()	Returns TRUE if the entity has been heavily damaged.
boolean	isDmgLight()	Returns TRUE if the entity has been lightly damaged.
boolean	isDmgModerate()	Returns TRUE if the entity has been moderately damaged.
boolean	isDriverHit()
boolean	isDriverHitPS()
boolean	isEjectionPossible()
boolean	isEligibleFor(GamePhase phase)	Determines if an entity is eligible for a phase.
boolean	isEligibleForPavementOrRoadBonus()	Tanks and certain other units can get a +1 bonus to MP if their move is entirely on pavement.
boolean	isEngineHit()
boolean	isHullDownCapable()	Whether this vehicle type can use hull-down at all, independent of its current hex.
boolean	isImmobile(boolean checkCrew)	Returns true if the target is considered immobile (-4 to hit) as a target and also if it is considered immobile or temporarily or permanently immbolized for active movement.
boolean	isImmobileForJump()	Per BT Forums CVs with working engines and Jump Jets should still have the option to jump during the movement phase, even if reduced to 0 MP by motive hits, or rolling 12 on the Motive System Damage table.
boolean	isInfernoFire()
boolean	isLargeVehicleForHullDown()	Large Vehicles (Large Support Vehicles and super-heavy combat vehicles) are too big to take advantage of the cover offered by a fortified ("infantry-built") hex, and so cannot go hull-down in one.
boolean	isLocationBurning(int location)	Deprecated, for removal: This API element is subject to removal in a future version.
boolean	isLocationProhibited(Coords c, int testBoardId, int currElevation)	Tanks have all sorts of prohibited terrain.
boolean	isLocationProhibitedWiGE(Coords c, int currElevation)
boolean	isMovementHit()	Determines whether the unit is considered to have suffered a movement hit.
boolean	isMovementHitPending()
boolean	isOnFire()
boolean	isPermanentlyImmobilized(boolean checkCrew)	Whether this unit is irreversibly immobilized for the rest of the game.
boolean	isRepairable()	Determine if the unit can be repaired, or only harvested for spares.
boolean	isSecondaryArcWeapon(int weaponId)	Returns true if this weapon fires into the secondary facing arc.
boolean	isSideLocation(int location)
boolean	isStabiliserHit(int loc)
boolean	isStealthActive()	Determine if this unit has an active and working stealth system.
boolean	isStealthOn()	Determine if this unit has an active and working stealth system.
boolean	isTractor()	Used to determine if this vehicle can be the engine/tractor for a bunch of trailers
boolean	isTrailer()	Used to determine if this vehicle can be towed by a tractor
boolean	isTurretEverJammed(int turret)
boolean	isTurretJammed(int turret)
boolean	isTurretLocked(int turret)
boolean	isUsingConsoleCommander()
boolean	isValidSecondaryFacing(int n)	Can this entity torso/turret twist the given direction?
void	jamTurret(int turret)
int	locations()	Returns the number of locations in the entity
void	lockTurret(int turret)
void	newRound(int roundNumber)	Start a new round
int	operatingRange()	Calculates the operating range of the vehicle based on engine type and fuel mass.
void	resetJammedWeapons()	Resets the list of weapons a vehicle has jammed via "weapon malfunction" crits to empty
void	resetMovementDamage()
HitData	rollHitLocation(int table, int side)	Rolls up a hit location
HitData	rollHitLocation(int table, int side, int aimedLocation, AimingMode aimingMode, int cover)	Rolls up a hit location
void	setArmorType(int armType)
void	setArmorType(int armType, boolean addMount)
void	setBAGrabBars()
void	setBaseChassisSponsonPintleWeight(double baseChassisSponsonPintleWeight)	Sets the fixed weight of any pintle (small SV) or sponson (CV, M/L SV) turrets on an OmniVehicle.
void	setBaseChassisTurret2Weight(double baseChassisTurret2Weight)	Sets the fixed weight of the second turret on a dual-turret OmniVehicle.
void	setBaseChassisTurretWeight(double baseChassisTurretWeight)	Sets the fixed weight of the primary turret on a dual-turret OmniVehicle.
void	setCommanderHit(boolean hit)
void	setCommanderHitPS(boolean hit)
void	setCrewHitPS(boolean hit)
void	setDriverHit(boolean hit)
void	setDriverHitPS(boolean hit)
void	setDualTurretOffset(int offset)
void	setDugIn(int stage)
void	setExtraCrewSeats(int seats)
void	setFacing(int facing)	Sets the primary facing.
void	setFuelTonnage(double fuel)	Sets the fuel mass for support vehicles.
void	setHasNoControlSystems(boolean hasNoControlSystems)
void	setHasNoDualTurret(boolean b)
void	setHasNoTurret(boolean b)
void	setHullDown(boolean down)	Tanks go Hull Down slightly differently, this method accounts for this
void	setICEFuelType(FuelType fuelType)
void	setMotiveDamage(int d)
void	setMotivePenalty(int p)
void	setOmni(boolean omni)	OmniVehicles have handles for Battle Armor squads to latch onto.
void	setOnFire(boolean inferno)
void	setOverThresh(boolean tf)	Deprecated, for removal: This API element is subject to removal in a future version.
void	setPotCrit(int crit)
void	setRubbleClearTarget(Coords target)
void	setRubbleClearTurnsCompleted(int turns)
void	setRubbleClearTurnsRequired(int turns)
void	setSecondaryFacing(int sec_facing)
void	setSensorHits(int hits)
void	setStabiliserHit(int loc)
void	setStunnedTurns(int turns)
void	setTrailer(boolean trailer)	Marks whether the tank is constructed as a trailer.
void	setTrailerHitches()	Add a transporter for each trailer hitch the unit is equipped with, with a maximum of one each in the front and the rear.
void	setUsingConsoleCommander(boolean b)
void	stunCrew()
void	unjamTurret(int turret)
void	unlockTurret()
boolean	usesTurnMode()	Only check for satisfied turn mode for Tanks or QuadVees in vehicle mode, or LAMs in AirMek mode.
Vector<Report>	victoryReport()	Generates a vector containing reports on all useful information about this entity.

Methods inherited from class megamek.common.units.Entity

activateRadicalHS, addAttackedByThisTurn, addBeenDetectedBy, addBeenSeenBy, addBomb, addBomb, addClanCase, addConditionBonuses, addCoolantFailureAmount, addCritical, addCritical, addCritical, addEquipment, addEquipment, addEquipment, addEquipment, addEquipment, addEquipment, addEquipment, addEquipment, addEquipment, addEquipment, addEquipment, addFailedEquipment, addFiringSolution, addGhostTargetDefensiveBonus, addGhostTargetOffensiveBonus, addGroundAttackedByThisTurn, addIMPHits, addKill, addOffBoardObserver, addPassedThrough, addPilotingModifierForTerrain, addPilotingModifierForTerrain, addPilotingModifierForTerrain, addPilotingModifierForTerrain, addRoofRack, addSensorContact, addTargetedBySwarm, addTechComponent, addTowedUnit, addTransporter, addTransporter, addTsempHitThisTurn, addWeaponGroup, antiTSMVulnerable, applyGravityEffectsOnMP, applyMagneticPulse, armorStringFor, assignAMS, assignTMAMS, assignWeaponQuirk, attachINarcPod, attachNarcPod, braceLocation, C3MasterIs, calcElevation, calcElevation, calculateBattleValue, calculateBattleValue, calculateBattleValue, calculateBattleValue, calculateFreeC3MNodes, calculateFreeC3Nodes, canActivateBloodStalker, canAssaultDrop, canAssist, canBePickedUp, canBrace, canEscape, canFall, canFall, canFireWeapon, canFlee, canFlee, canFleeFrom, canFleeInState, canFlipArms, canGoDown, canGoDown, canGoUp, canHide, canInitiateInfantryVsInfantryCombat, canLayDemolitionCharges, canLayMine, canLoad, canLoad, canLoad, canonUnitWithInvalidBuild, canPerformSpaceSalvageOperations, canPickupCarryableObject, canPickupGroundObject, canRam, canReinforceInfantryVsInfantry, canShutdownEi, canTow, canTransferCriticalSlots, canUnjamRAC, canUnstickByJumping, changeHeatBuildup, checkBogDown, checkDislodgeSwarmers, checkForMASCFailure, checkForSuperchargerFailure, checkGetUp, checkGunningIt, checkLandingInHeavyWoods, checkLandingOnBlackIce, checkLandingOnIce, checkLandingWithDamage, checkLandingWithPrototypeJJ, checkMovedTooFast, checkMovementInBuilding, checkRecklessMove, checkRubbleMove, checkRunningWithDamage, checkSideSlip, checkSkid, checkSprintingWithMASCAndSupercharger, checkSprintingWithMASCXorSupercharger, checkTurnModeFailure, checkUnstall, checkUsingOverdrive, checkWaterMove, checkWaterMove, chooseSide, clearAttackedByThisTurn, clearBombs, clearDestroyedNarcPods, clearDetectedBy, clearFiringSolutions, clearHeatBreakdown, clearInfantryCombatState, clearNarcAndiNarcPods, clearPartialRepairs, clearSeenBy, clearSensorContacts, climbMode, countEquipment, countForStrengthSum, countMisc, countPartialRepairs, countQuirks, countQuirks, countWeaponQuirks, countWorkingMisc, countWorkingMisc, countWorkingMisc, crewCanLeave, critStateCount, damage, damageBayDoor, damagedJumpJets, damageDockCollar, damageDoorRecovery, damagedSCMCritCount, damageSystem, damageSystem, deactivateRadicalHS, deployOffBoard, destroy, destroyLocation, destroyLocation, destroyOneSearchlight, destroyRetractableBlade, disconnectUnit, doBattleValueCalculation, doCheckEngineStallRoll, doomedInAtmosphere, doomedInExtremeTemp, doomedInSpace, doomedOnGround, dropCarriedObject, dropCarriedObject, dropGroundObjects, elevationOccupied, elevationOccupied, endOfTurnCargoInteraction, entityIsQuad, equals, extendBlade, factionTechLevel, findTargetedDisplacement, fixElevation, formatHeat, gameOptions, generalName, generateDisplayName, generateShortName, getAbandonmentAnnouncedRound, getActiveAMS, getActiveSensor, getActiveSubEntities, getActiveUMUCount, getActiveVibrobladeHeat, getActiveVibrobladeHeat, getAllGyroCodeName, getAllowedPhysicalAttacks, getAllTowedUnits, getAllUMUCount, getAlreadyTwisted, getAlternateCost, getAltitude, getAmmo, getAmmo, getAmmo, getAnyTypeMaxJumpMP, getArmedMPBoosters, getArmor, getArmor, getArmor, getArmoredComponentTechAdvancement, getArmorForReal, getArmorForReal, getArmorRemainingPercent, getArmorString, getArmorString, getArmorTechLevel, getArmorTechRating, getArmorType, getArmorWeight, getArmorWeight, getArmsFlipped, getASEWAffected, getAttackedByThisTurn, getAttackingEntity, getBadCriticalSlots, getBAPRange, getBARRating, getBase64Icon, getBaseAvailability, getBaseChassisFireConWeight, getBaseChassisValue, getBaseEngineValue, getBasePilotingRoll, getBasePilotingRoll, getBay, getBayByAmmo, getBayById, getBayLoadedUnitIds, getBayPersonnel, getBlockedFiringLocations, getBloodStalkerTarget, getBlueShieldRounds, getBoardId, getBoardLocation, getBombLoadout, getBombLoadout, getBombs, getBombs, getBoobyTrap, getBoobyTrapDamage, getBraceMPCost, getBvCalculator, getC3ecmAffected, getC3iNextUUIDAsString, getC3Master, getC3MasterId, getC3MasterIsUUIDAsString, getC3NetId, getC3Top, getC3UUIDAsString, getCamouflage, getCamouflageOrElse, getCamouflageOrElse, getCamouflageOrElseOwners, getCargoMpReduction, getCarriedObject, getCarriedObjects, getChassis, getClanChassisName, getClimbingLevelsChosen, getClubs, getCollarById, getCommonDate, getCommonDateRange, getConnectedUnits, getConsecutiveRHSUses, getConversionMode, getCoolantFailureAmount, getCost, getCrew, getCritical, getCriticalSlots, getCustomWeaponOrder, getCustomWeaponOrder, getDamagedCriticalSlots, getDamageLevel, getDamageLevel, getDamageReductionFromModularArmor, getDefaultPickupLocations, getDependentLocation, getDeployRound, getDisplacementAttack, getDisplayName, getDistinctCarriedObjects, getDockingCollars, getDocks, getDocks, getDropCargoLocationMap, getDroppableUnits, getDuplicateMarker, getEarliestTechDate, getEarliestTechDateAndEra, getECCMInfo, getECCMStrength, getECMInfo, getECMRange, getECMStrength, getElevation, getEMPInterferenceRounds, getEMPShutdownRounds, getEmptyCriticalSlots, getEngine, getEngineCritHeat, getEngineTechRating, getEngineType, getEntityMajorTypeName, getEntityTypeName, getEquipment, getEquipment, getEquipmentForWeaponQuirk, getEquipmentNum, getEquipmentType, getEvasionBonus, getExteriorUnitAt, getExternalBombLoadout, getExternalId, getExternalIdAsString, getExternalUnits, getExtinctionDate, getExtinctionDate, getExtinctionRange, getExtraC3BV, getExtraCommGearTons, getExtremeRangeModifier, getFacing, getFacingName, getFailedEquipment, getFighterBays, getFiringSolutions, getFleeZone, getFluff, getFluffImage, getForceGeneratorAvailability, getForceId, getForceString, getFreeC3iUUID, getFreeNC3UUID, getFullChassis, getGame, getGaveKillCredit, getGhostTargetDefensiveBonus, getGhostTargetOffensiveBonus, getGhostTargetOverride, getGhostTargetRoll, getGhostTargetRollMoS, getGoodCriticalSlots, getGrappled, getGrappleSide, getGroundAttackedByThisTurn, getGyroType, getHeading, getHeat, getHeatBreakdown, getHeatCapacity, getHeatCapacity, getHeatCapacityWithWater, getHeatFiringModifier, getHeatInArc, getHeatMPReduction, getHeight, getHiddenActivationPhase, getHitchCarrying, getHitchLocations, getHitCriticalSlots, getHittableCriticalSlots, getIcon, getId, getImpLastTurn, getImpMpReduction, getImpToHitModifier, getINarcPodsAttached, getIndividualWeaponList, getInfantryCombatTargetId, getInfantryCombatTurnCount, getInitialBV, getInternal, getInternal, getInternalBombLoadout, getInternalForReal, getInternalRemainingPercent, getInternalString, getIntroductionDate, getIntroductionDate, getIntroductionDateAndEra, getInvalidSourceBuildReasons, getIsJumpingNow, getJumpHeat, getJumpMP, getJumpMP, getJumpMPWithTerrain, getJumpType, getKillerId, getKillNumber, getKills, getLabArmorTonnage, getLabTotalArmorPoints, getLastTarget, getLastTargetDisplayName, getLaunchableDropships, getLaunchableFighters, getLaunchableSmallCraft, getLoadedKeepers, getLoadedTrailers, getLoadedUnits, getLocationAbbr, getLocationAbbr, getLocationFromAbbr, getLocationName, getLocationName, getLocationStatus, getLongRangeModifier, getLOSRangeModifier, getMagneticPulseRounds, getManualBV, getMASC, getMASCTarget, getMASCTurns, getMaxElevationChange, getMaxElevationDown, getMaxWeaponRange, getMaxWeaponRange, getMechanicalJumpBoosterMP, getMechanicalJumpBoosterMP, getMediumRangeModifier, getMisc, getMisc, getMiscEquipment, getMissionRoles, getMixedTechAdvancement, getModel, getMotiveSideMod, getMovedBackwards, getMovementBeforeSkidPSRModifier, getMovementMode, getMovementModeAsString, getMPBoosters, getMPBoosters, getMpUsedLastRound, getMulId, getNC3NextUUIDAsString, getNCrew, getNeuralInterfaceMode, getNewRoundNovaNetworkString, getNextSensor, getNMarines, getNPassenger, getNumberOfCriticalSlots, getNumberOfCriticalSlots, getNumberOfCriticalSlots, getNumberOfCriticalSlots, getNumberOfShields, getOArmor, getOArmor, getOArmor, getObsoleteQuirkValue, getObsoleteRepairModifier, getObsoleteResaleModifier, getObsoleteYear, getObsoleteYearForModifiers, getObsoleteYears, getOccupiedCoords, getOccupiedHex, getOffBoardDirection, getOffBoardDistance, getOInternal, getOInternal, getOmniAdvancement, getOmniAdvancement, getOriginalBuildYear, getOriginalChassis, getOriginalJumpMP, getOriginalJumpMP, getOriginalModel, getOriginalNovaC3NetId, getOriginalRunMP, getOriginalUnitFileUUID, getOriginalWalkMP, getOwner, getOwnerId, getPartialRepairs, getPassedThrough, getPassedThroughBoardId, getPassedThroughFacing, getPassengerCapacityWithoutBayCrew, getPatchworkArmorAdvancement, getPendingVariableRangeTargetingMode, getPickedUpMekWarriors, getPickupLocationMap, getPlayerPickedPassThrough, getPodMountedTroopCarryingSpace, getPosition, getPowerAmplifierWeight, getPriorPosition, getProductionDate, getProductionDate, getProductionDateRange, getPrototypeDate, getPrototypeDate, getPrototypeRangeDate, getPublished, getPublishedSources, getQuirkIniBonus, getQuirkList, getQuirks, getRecoveryTurn, getReintroductionDate, getReintroductionDate, getRemovalCondition, getRetreatedDirection, getRole, getRunHeat, getRunMP, getRunMPasString, getRunMPWithoutMASC, getSearchlightOverride, getSecondaryFacing, getSecondaryPositions, getSelfDestructedThisTurn, getSelfDestructing, getSelfDestructInitiated, getSensorCheck, getSensorContacts, getSensors, getShortName, getShortNameRaw, getShortRangeModifier, getSource, getSources, getSpotTargetId, getSprintHeat, getSprintMPWithOneMASC, getSprintMPWithoutMASC, getStandingHeat, getStartingAnyNWx, getStartingAnyNWx, getStartingAnyNWy, getStartingAnyNWy, getStartingAnySEx, getStartingAnySEx, getStartingAnySEy, getStartingAnySEy, getStartingOffset, getStartingOffset, getStartingPos, getStartingPos, getStartingWidth, getStartingWidth, getStaticTechLevel, getStrength, getStructuralTechRating, getStructureTechLevel, getStructureType, getSubEntities, getSuperCharger, getSuperchargerTarget, getSuperchargerTurns, getSwarmAttackerId, getSwarmTargetId, getTaggedBy, getTargetBay, getTargetedBySwarm, getTargetType, getTaserFeedBackRounds, getTaserInterference, getTaserInterferenceHeat, getTaserInterferenceRounds, getTaserShutdownRounds, getTCPInitiativeBonus, getTechBase, getTechBaseDescription, getTechBaseDescriptions, getTechFaction, getTechLevel, getTechLevelYear, getTechLevelYears, getTechRating, getTilesetModeString, getTMTracker, getTonnage, getTotalAmmoOfType, getTotalArmor, getTotalInternal, getTotalMunitionsOfType, getTotalOArmor, getTotalOInternal, getTotalWeaponList, getTowedBy, getTowing, getTractor, getTraitorId, getTransferLocation, getTransportBays, getTransportId, getTransports, getTroopCarryingSpace, getTrooperAtLocation, getTsempEffect, getTsempHitsThisTurn, getUnitFileUUID, getUnitNumber, getUnitsUnloadableFromBays, getUnitsUnloadableFromNonBays, getUnloadableUnits, getUnused, getUnused, getUnusedString, getUnusedString, getUseManualBV, getValidBraceLocations, getValidHalfWeightPickupLocations, getVariableRangeTargetingMode, getVariableRangeTargetingModifier, getVector, getVectors, getVelocity, getVibroClaws, getWalkHeat, getWalkMP, getWeapon, getWeaponBayList, getWeaponFiringHeight, getWeaponFiringPosition, getWeaponGroupList, getWeaponList, getWeaponListWithHHW, getWeapons, getWeaponSortOrder, getWeight, getWeightClass, getWeightClassName, getWhoCanDetect, getWhoCanSee, getYear, hasAbility, hasAbility, hasActivatedRadicalHS, hasActiveBlueShield, hasActiveDNI, hasActiveECCM, hasActiveECM, hasActiveECM, hasActiveEiCockpit, hasActiveNovaCEWS, hasAimModeTargComp, hasAnyC3System, hasAnyTypeNarcPodsAttached, hasArcFired, hasArmoredChassis, hasArtillery, hasBadLegs, hasBAP, hasBAP, hasBARArmor, hasBattleArmorHandles, hasBoobyTrap, hasBoostedC3, hasC3, hasC3i, hasC3M, hasC3MM, hasC3S, hasCase, hasCASEII, hasCASEII, hasDamagedRHS, hasDetectedEntity, hasDisplacementAttack, hasDNICockpitMod, hasDNIImplant, hasDNIInducedHardToPilot, hasDroneOs, hasECM, hasEiCockpit, hasEmbeddedIcon, hasEMPInterferenceHeat, hasEngine, hasEntityScopedPreEndDeclaration, hasETypeFlag, hasExternalSearchlight, hasFallen, hasFiredTsemp, hasFiringSolutionFor, hasFleeZone, hasFlotationHull, hasFunctionalArmAES, hasFunctionalLegAES, hasGhostTargetEquipment, hasGhostTargets, hasHardenedArmor, hasHarJelIn, hashCode, hasHierarchicalC3, hasHipCrit, hasINarcPodsAttached, hasInfernoAmmo, hasLegActuatorCrit, hasLinkedMGA, hasLoweredShield, hasLoweredShield, hasMinesweeper, hasMisc, hasMisc, hasMisc, hasModularArmor, hasModularArmor, hasMulId, hasNarcPodsAttached, hasNavalC3, hasNhC3, hasNoDefenseShield, hasNovaCEWS, hasObsoleteQuirk, hasOccupiedHex, hasOriginalBuildYear, hasPatchworkArmor, hasQuirk, hasRaisedShield, hasRaisedShield, hasRearArmor, hasRHSWentUp, hasSCM, hasSearchlight, hasSeenEntity, hasSensorContactFor, hasShield, hasStealth, hasSystem, hasTAG, hasTargComp, hasTCPAimedShotCapability, hasUMU, hasUndamagedCriticalSlots, hasUnloadedUnitsFromBays, hasUsedRHSLastTurn, hasVariableRangeTargeting, hasViableWeapons, hasVibroblades, hasWorkingMisc, hasWorkingMisc, hasWorkingMisc, hasWorkingMisc, hasWorkingRadicalHS, hasWorkingSCM, hasWorkingSystem, height, hitAllCriticalSlots, incrementInfantryCombatTurnCount, incrementMASCAndSuperchargerLevels, initializeArmor, initializeInternal, initMilitary, initTechAdvancement, isActive, isActive, isActiveOption, isAeroLandedOnGroundMap, isAeroSensorDestroyed, isAirborne, isAirborneAeroOnGroundMap, isAirborneVTOLorWIGE, isAssaultDropInProgress, isAttackingThisTurn, isBATaserShutdown, isBoardable, isBoardProhibited, isBoardProhibited, isBoobyTrapInitiated, isBracing, isC3CompanyCommander, isC3IndependentMaster, isCanon, isCapitalFighter, isCapitalFighter, isCapitalScale, isCaptured, isCarcass, isCarefulStand, isChainWhipGrappled, isChameleonShieldActive, isChameleonShieldOn, isCharging, isClan, isClanArmor, isClearingMinefield, isClearingWoods, isClimbing, isCommander, isConvertingNow, isDangling, isDeployed, isDesignValid, isDestroyed, isDetectedByEnemy, isDone, isDoomed, isDropping, isEiShutdown, isElevationValid, isEligibleForArtyAutoHitHexes, isEligibleForFiring, isEligibleForInfantryVsInfantry, isEligibleForMovement, isEligibleForOffboard, isEligibleForPhysical, isEligibleForPreEndDeclarations, isEligibleForTargetingPhase, isEnemyOf, isEvading, isEverSeenByEnemy, isFindingClub, isFiredTsempThisTurn, isFirefighter, isGhostTargetCapable, isGrappleAttacker, isGrappledThisRound, isGyroDestroyed, isHardenedArmorDamaged, isHidden, isHullDown, isIlluminated, isImmobile, isImpEcmAffected, isINarcedBy, isINarcedWith, isInBuilding, isInDemolishableStructureHex, isInfantryCombatAttacker, isInfantryCombatWantsWithdrawal, isIntroLevel, isInvulnerable, isJumpingWithMechanicalBoosters, isLargeCraft, isLayingMines, isLoadableThisTurn, isLocationBad, isLocationBlownOff, isLocationBlownOffThisPhase, isLocationDeadly, isLocationDeadly, isLocationDoomed, isLocationProhibited, isLocationProhibited, isLocationProhibited, isLocationProhibited, isLocationTrulyDestroyed, isMakingDfa, isMakingVTOLGroundAttack, isManualShutdown, isMASCUsed, isMilitary, isMixedTech, isNarcedBy, isNaval, isNeuralInterfaceEnabled, isNeuralInterfaceFullTracking, isNightwalker, isNOE, isNonCanonBySource, isNonCanonBySource, isNotCrewedEntityType, isNuclearHardened, isNullSigActive, isNullSigOn, isObsoleteInYear, isOffBoard, isOffBoardObserved, isOmni, isOnAtmosphericGroundMap, isPartOfFighterSquadron, isPendingAbandon, isPodMountedTransport, isPowerReverse, isPrimitive, isProne, isPushing, isRamming, isReckless, isSalvage, isSelectableThisTurn, isSensorReturn, isShutDown, isShutDownThisPhase, isSpaceborne, isSpotting, isStalled, isStartupThisPhase, isStuck, isSufferingEMI, isSuperchargerUsed, isSuperHeavy, isSurfaceNaval, isTargetable, isTargetOfDisplacementAttack, isTransported, isTrapped, isUncrewed, isUnderwater, isUnjammingRAC, isUnloadedThisTurn, isUnofficial, isUsingManAce, isUsingSearchlight, isVisibleToEnemy, isVoidSigActive, isVoidSigOn, isWeaponBlockedAt, isWeaponBlockedByTowing, isWeaponOrderChanged, isWeaponValidForPhase, itemOppositeTech, joinLocationAbbr, load, load, load, load, loadAllWeapons, loadDefaultCustomWeaponOrder, loadedUnitsHaveActiveECM, loadQuirks, loadWeapon, loadWeapon, loadWeaponWithSameAmmo, loadWeaponWithSameAmmo, locationHasCase, locationIsLeg, madePointblankShot, maxGroundObjectTonnage, modifyPhysicalDamageForMeleeSpecialist, needsRollToStand, newPhase, newRoundNovaNetSwitch, newRoundVariableRangeSwitch, nextConversionMode, onSameC3NetworkAs, onSameC3NetworkAs, ownerHasDemolitionCharge, passedOver, passedThrough, passedThroughPrevious, passedWithin, performManualShutdown, performManualStartup, pickUp, pickupCarryableObject, postProcessFacingChange, processPickupStep, processPickupStepEntity, recalculateTechAdvancement, recordedTechLevel, recover, refreshLocations, regenerateUnitFileUUID, relHeight, reloadEmptyWeapons, removeAllINarcPods, removeAllTransporters, removeCriticalSlots, removeFiringSolution, removeINarcPod, removeMisc, removePartialCoverHits, removeSensorContact, removeTowedUnit, removeTransporter, resetBayDoors, resetBays, resetBombAttacks, resetCoolantFailureAmount, resetFiringArcs, resetPickedUpMekWarriors, resetTransporter, restore, rollMovementInBuilding, scmCritStateCount, setAbandonmentAnnouncedRound, setAlreadyTwisted, setAltitude, setArcFired, setArmor, setArmor, setArmor, setArmorTechLevel, setArmorTechLevel, setArmorTechRating, setArmorTechRating, setArmorTonnage, setArmorType, setArmorType, setArmorType, setArmsFlipped, setArmsFlipped, setASEWAffected, setAssaultDropInProgress, setBARRating, setBARRating, setBaseChassisFireConWeight, setBATaserShutdown, setBloodStalkerTarget, setBoardId, setBoobyTrapInitiated, setBraceLocation, setC3ecmAffected, setC3iNextUUIDAsString, setC3Master, setC3Master, setC3MasterIsUUIDAsString, setC3NetId, setC3NetId, setC3NetIdSelf, setC3UUID, setC3UUIDAsString, setCamouflage, setCanon, setCanUnstickByJumping, setCaptured, setCarcass, setCarefulStand, setCarriedObjects, setChassis, setClanChassisName, setClearingMinefield, setClearingWoods, setClimbing, setClimbingLevelsChosen, setClimbMode, setCommander, setConsecutiveRHSUses, setConversionMode, setConvertingNow, setCrew, setCritical, setCustomWeaponOrder, setCustomWeaponOrder, setDangling, setDeployed, setDeployRound, setDesignValid, setDestroyed, setDetectedByEnemy, setDisplacementAttack, setDisplayName, setDone, setDoomed, setDuplicateMarker, setEiShutdown, setElevation, setEMI, setEMPInterference, setEMPShutdownRounds, setEngine, setEngineTechRating, setEngineTechRating, setEvading, setEverSeenByEnemy, setExternalId, setExternalIdAsString, setExternalSearchlight, setFallen, setFindingClub, setFiredTsempThisTurn, setFleeZone, setForceGeneratorAvailability, setForceId, setForceString, setGame, setGameOptions, setGrappled, setGrappledThisRound, setGrappleSide, setHardenedArmorDamaged, setHasDamagedRHS, setHasFiredTsemp, setHidden, setHiddenActivationPhase, setIcon, setId, setIGame, setIlluminated, setImpLastTurn, setInfantryCombatAttacker, setInfantryCombatTargetId, setInfantryCombatTurnCount, setInfantryCombatWantsWithdrawal, setInitialBV, setInternal, setInternal, setInvalidSourceBuildReasons, setIsJumpingNow, setJumpingWithMechanicalBoosters, setLandedAssaultDrop, setLastTarget, setLastTargetDisplayName, setLayingMines, setLoadedKeepers, setLoadedThisTurn, setLocationBlownOff, setLocationBlownOffThisPhase, setLocationStatus, setLocationStatus, setMadePointblankShot, setMagneticPulseHit, setManualBV, setManualShutdown, setMASCUsed, setMissionRoles, setMixedTech, setModel, setMovedBackwards, setMovementMode, setMulId, setNC3NextUUIDAsString, setNCrew, setNeverDeployed, setNewRoundNovaNetworkString, setNextSensor, setNMarines, setNPassenger, setOffBoard, setOriginalBuildYear, setOriginalJumpMP, setOriginalWalkMP, setOwner, setOwnerId, setPassedThrough, setPassedThroughBoardId, setPassedThroughFacing, setPendingAbandon, setPendingVariableRangeTargetingMode, setPlayerPickedPassThrough, setPosition, setPosition, setPowerReverse, setProne, setPublished, setPublishedSources, setQuirks, setRamming, setRapidFire, setReckless, setRecoveryTurn, setRemovalCondition, setRetreatedDirection, setSalvage, setSearchlightOverride, setSearchlightState, setSecondaryFacing, setSelfDestructedThisTurn, setSelfDestructing, setSelfDestructInitiated, setShutDown, setShutDownThisPhase, setSource, setSources, setSpotTargetId, setSpotting, setStartingAnyNWx, setStartingAnyNWy, setStartingAnySEx, setStartingAnySEy, setStartingOffset, setStartingPos, setStartingWidth, setStartupThisPhase, setStruck, setStructuralTechRating, setStructuralTechRating, setStructureTechLevel, setStructureType, setStructureType, setStuck, setSuperchargerUsed, setSwarmAttackerId, setSwarmTargetId, setTaggedBy, setTargetBay, setTaserFeedback, setTaserInterference, setTaserShutdownRounds, setTechFaction, setTechLevel, setTowedBy, setTowing, setTractor, setTraitorId, setTransportId, setTsempEffect, setTurnInterrupted, setUnitFileUUID, setUnitNumber, setUnitRole, setUnjammingRAC, setUnloaded, setUsedRHSLastTurn, setUsedSearchlight, setUseManualBV, setVariableRangeTargetingMode, setVectors, setVisibleToEnemy, setWeaponHit, setWeaponOrderChanged, setWeaponSortOrder, setWeight, setWhoCanDetect, setWhoCanSee, setWigeLiftoffHover, setYear, shouldDeploy, shouldOffBoardDeploy, shouldUseEdge, sideTable, sideTable, sideTable, sideTable, sideTableRam, sideTableRam, slotNumber, specificName, statusToString, statusToString, statusToString, storeOriginalUnitData, storeSavedUnitData, taserShutdown, toggleConversionMode, toString, towUnit, turnWasInterrupted, unload, updateBays, updateDuplicateMarkerAfterDelete, usedSearchlight, usedTag, usesWeaponBays, wasLoadedThisTurn, wasNeverDeployed, wasStruck, weaponFired, weaponFiredFrom, whichBay, wigeLiftoffHover

Methods inherited from class megamek.common.turns.TurnOrdered

clearInitiative, generateTurnOrder, getAeroTurns, getDropshipTurns, getEvenTurns, getInitCompensationBonus, getInitiative, getJumpshipTurns, getMultiTurns, getNormalTurns, getOtherTurns, getSmallCraftTurns, getSpaceStationTurns, getTeleMissileTurns, getWarshipTurns, incrementAeroTurns, incrementDropshipTurns, incrementEvenTurns, incrementJumpshipTurns, incrementMultiTurns, incrementOtherTurns, incrementSmallCraftTurns, incrementSpaceStationTurns, incrementTeleMissileTurns, incrementWarshipTurns, resetAeroTurns, resetDropshipTurns, resetEvenTurns, resetInitiativeCompensation, resetJumpshipTurns, resetMultiTurns, resetOtherTurns, resetSmallCraftTurns, resetSpaceStationTurns, resetTeleMissileTurns, resetWarshipTurns, rollInitAndResolveTies, rollInitAndResolveTies, rollInitiative, rollInitiative, setInitCompensationBonus, setInitiative

Methods inherited from class java.lang.Object

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

Methods inherited from interface megamek.common.units.BTObject

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

Methods inherited from interface megamek.common.interfaces.CombatRole

hasRole

Methods inherited from interface megamek.common.interfaces.ForceAssignable

partOfForce

Methods inherited from interface megamek.common.units.Fortifiable

advanceFortifyRound, beginFortify, cancelFortify, getFortifyStage, getFortifyTotalStages, getShortName, isFortifyExtendedThisRound, isFortifying, isFortifyOnFinalStage

Methods inherited from interface megamek.common.equipment.ICarryable

getCarriedObjectDamageAllocation, targetForArmHitToHitCarriedObject

Methods inherited from interface megamek.common.game.InGameObject

hasOwner

Methods inherited from interface megamek.common.interfaces.ITechnology

calcEraAvailability, calcEraAvailability, calcYearAvailability, calcYearAvailability, calcYearAvailability, findMinimumRulesLevel, findMinimumRulesLevel, getAdvancedRange, getAdvancedRange, getCodeFromIOAbbr, getCodeFromMMAbbr, getCommonDate, getEraAvailabilityName, getEraAvailabilityName, getExperimentalRange, getExperimentalRange, getExtinctionDate, getExtinctionRange, getFullRatingName, getFullRatingName, getIntroductionDate, getProductionDate, getPrototypeDate, getReintroductionDate, getSimpleLevel, getSimpleLevel, getSimpleLevel, getStandardRange, getStandardRange, getTechLevel, getTechLevel, getTechRatingName, isAvailableIn, isAvailableIn, isAvailableIn, isExtinct, isExtinct, isExtinct, isLegal, isLegal

Methods inherited from interface megamek.common.units.RubbleClearer

bankRubbleClearTurn, beginClearingRubble, cancelClearingRubble, isClearingRubble

Methods inherited from interface megamek.common.units.Targetable

isBomber, isBuildingEntityOrGunEmplacement, isHexBeingBombed, isOnBoard, tracksHeat

Methods inherited from interface megamek.common.equipment.Transporter

alwaysDamageCargoIfTransportHit, canTow, getCarryables, getNameForRecordSheets, getNumberLoadedThisTurn, getNumberUnloadedThisTurn, getTransporterType, hardpointCost, setEntity

Field Details

m_bHasNoTurret

protected boolean m_bHasNoTurret

m_bTurretLocked

protected boolean m_bTurretLocked

m_bTurretJammed

protected boolean m_bTurretJammed

m_bTurretEverJammed

protected boolean m_bTurretEverJammed

m_bHasNoDualTurret

protected boolean m_bHasNoDualTurret

m_bDualTurretLocked

protected boolean m_bDualTurretLocked

m_bDualTurretJammed

protected boolean m_bDualTurretJammed

m_bDualTurretEverJammed

protected boolean m_bDualTurretEverJammed

motivePenalty

protected int motivePenalty

motiveDamage

protected int motiveDamage

engineHit

protected boolean engineHit

LOC_BODY

public static final int LOC_BODY

See Also:

• Constant Field Values

LOC_FRONT

public static final int LOC_FRONT

See Also:

• Constant Field Values

LOC_RIGHT

public static final int LOC_RIGHT

See Also:

• Constant Field Values

LOC_LEFT

public static final int LOC_LEFT

See Also:

• Constant Field Values

LOC_REAR

public static final int LOC_REAR

See Also:

• Constant Field Values

LOC_TURRET

public static final int LOC_TURRET

for dual turret tanks, this is the rear turret

See Also:

• Constant Field Values

LOC_TURRET_2

public static final int LOC_TURRET_2

for dual turret tanks, this is the front turret

See Also:

• Constant Field Values

CRIT_NONE

public static final int CRIT_NONE

See Also:

• Constant Field Values

CRIT_DRIVER

public static final int CRIT_DRIVER

See Also:

• Constant Field Values

CRIT_WEAPON_JAM

public static final int CRIT_WEAPON_JAM

See Also:

• Constant Field Values

CRIT_WEAPON_DESTROYED

public static final int CRIT_WEAPON_DESTROYED

See Also:

• Constant Field Values

CRIT_STABILIZER

public static final int CRIT_STABILIZER

See Also:

• Constant Field Values

CRIT_SENSOR

public static final int CRIT_SENSOR

See Also:

• Constant Field Values

CRIT_COMMANDER

public static final int CRIT_COMMANDER

See Also:

• Constant Field Values

CRIT_CREW_KILLED

public static final int CRIT_CREW_KILLED

See Also:

• Constant Field Values

CRIT_CREW_STUNNED

public static final int CRIT_CREW_STUNNED

See Also:

• Constant Field Values

CRIT_CARGO

public static final int CRIT_CARGO

See Also:

• Constant Field Values

CRIT_ENGINE

public static final int CRIT_ENGINE

See Also:

• Constant Field Values

CRIT_FUEL_TANK

public static final int CRIT_FUEL_TANK

See Also:

• Constant Field Values

CRIT_AMMO

public static final int CRIT_AMMO

See Also:

• Constant Field Values

CRIT_TURRET_JAM

public static final int CRIT_TURRET_JAM

See Also:

• Constant Field Values

CRIT_TURRET_LOCK

public static final int CRIT_TURRET_LOCK

See Also:

• Constant Field Values

CRIT_TURRET_DESTROYED

public static final int CRIT_TURRET_DESTROYED

See Also:

• Constant Field Values

CRIT_SENSOR_MAX

public static final int CRIT_SENSOR_MAX

See Also:

• Constant Field Values

SIDE_LOC_MAPPING

protected static final Map<Integer,Integer> SIDE_LOC_MAPPING

hasSponsons

protected boolean hasSponsons

hasPintle

protected boolean hasPintle

BASE_CHASSIS_TURRET_WT_UNASSIGNED

public static final int BASE_CHASSIS_TURRET_WT_UNASSIGNED

Keeps track of the base weight of the turret for omni tanks.

See Also:

• Constant Field Values

Constructor Details

Tank

public Tank()

Method Details

canEjectCrew

public boolean canEjectCrew()

A vehicle crew can abandon where the game's options allow vehicle crews to leave at all.

Overrides:

canEjectCrew in class Entity

getUnitType

public int getUnitType()

Specified by:

getUnitType in class Entity

See Also:

• UnitType

getLocationAbbreviations

public String[] getLocationAbbreviations()

Specified by:

getLocationAbbreviations in class Entity

getLocationNames

public String[] getLocationNames()

Specified by:

getLocationNames in class Entity

getLocTurret

public int getLocTurret()

getLocTurret2

public int getLocTurret2()

defaultCrewType

public CrewType defaultCrewType()

Overrides:

defaultCrewType in class Entity

getPotCrit

public int getPotCrit()

setPotCrit

public void setPotCrit(int crit)

getOverThresh

@Deprecated(since="0.51.0",
            forRemoval=true)
public boolean getOverThresh()

Deprecated, for removal: This API element is subject to removal in a future version.

setOverThresh

@Deprecated(since="0.51.0",
            forRemoval=true)
public void setOverThresh(boolean tf)

Deprecated, for removal: This API element is subject to removal in a future version.

hasNoTurret

public boolean hasNoTurret()

hasNoDualTurret

public boolean hasNoDualTurret()

getTurretCount

public int getTurretCount()

setHasNoTurret

public void setHasNoTurret(boolean b)

setHasNoDualTurret

public void setHasNoDualTurret(boolean b)

getMotiveDamage

public int getMotiveDamage()

setMotiveDamage

public void setMotiveDamage(int d)

getMotivePenalty

public int getMotivePenalty()

setMotivePenalty

public void setMotivePenalty(int p)

getConstructionTechAdvancement

public TechAdvancement getConstructionTechAdvancement()

Description copied from class: Entity

return - the base construction option tech advancement

Specified by:

getConstructionTechAdvancement in class Entity

getDualTurretTA

public static TechAdvancement getDualTurretTA()

addSystemTechAdvancement

protected void addSystemTechAdvancement(CompositeTechLevel techLevel)

Description copied from class: Entity

Incorporate dates for components that are not in the equipment list, such as engines and structure.

Overrides:

addSystemTechAdvancement in class Entity

getWalkMP

public int getWalkMP(MPCalculationSetting mpCalculationSetting)

Overrides:

getWalkMP in class Entity

isEligibleForPavementOrRoadBonus

public boolean isEligibleForPavementOrRoadBonus()

Description copied from class: Entity

Tanks and certain other units can get a +1 bonus to MP if their move is entirely on pavement.

Overrides:

isEligibleForPavementOrRoadBonus in class Entity

Returns:

true if the Entity gets a movement bonus on pavement

hasFrontMountedSaw

public boolean hasFrontMountedSaw()

Description copied from class: Entity

Checks if this entity has a front-mounted chainsaw or dual saw.

Per TM pp.241-243, a front-mounted saw on a vehicle can be used in a modified charge attack. By default, entities do not have front-mounted saws; only vehicles (Tank subclass) can have them.

Overrides:

hasFrontMountedSaw in class Entity

Returns:

true if this entity has a working front-mounted chainsaw or dual saw

hasWorkingBulldozer

public boolean hasWorkingBulldozer()

Description copied from class: Entity

Checks if this entity has a working bulldozer in any location.

Per TacOps, a vehicle equipped with a bulldozer may clear rubble hexes and takes half the usual damage (rounded down) when it charges. By default, entities cannot mount a bulldozer; only vehicles (Tank subclass) can.

Overrides:

hasWorkingBulldozer in class Entity

Returns:

true if this entity has a working bulldozer

hasFrontMountedBulldozer

public boolean hasFrontMountedBulldozer()

Description copied from class: Entity

Checks if this entity has a working front-mounted bulldozer.

Per TacOps, a front-mounted bulldozer doubles the damage dealt to a building hex when the vehicle charges it. By default, entities do not have a front-mounted bulldozer; only vehicles (Tank subclass) can mount one.

Overrides:

hasFrontMountedBulldozer in class Entity

Returns:

true if this entity has a working front-mounted bulldozer

hasRearMountedBulldozer

public boolean hasRearMountedBulldozer()

Description copied from class: Entity

Checks if this entity has a working rear-mounted bulldozer.

Per TacOps, a bulldozer may be mounted on the front or rear; a rear-mounted blade (as on the Reverse Buffel) engages rubble while the vehicle backs into it. By default, entities do not have a rear-mounted bulldozer; only vehicles (Tank subclass) can mount one.

Overrides:

hasRearMountedBulldozer in class Entity

Returns:

true if this entity has a working rear-mounted bulldozer

hasWorkingBackhoe

public boolean hasWorkingBackhoe()

Description copied from class: Entity

Checks if this entity has a working backhoe.

A backhoe provides fieldworks (fortification) ability and, under the unofficial rule, can clear rubble more slowly than a bulldozer. By default, entities do not have a backhoe; vehicles and Meks can mount one.

Overrides:

hasWorkingBackhoe in class Entity

Returns:

true if this entity has a working backhoe

isTurretLocked

public boolean isTurretLocked(int turret)

isTurretJammed

public boolean isTurretJammed(int turret)

locations

public int locations()

Returns the number of locations in the entity

Specified by:

locations in class Entity

getBodyLocation

public int getBodyLocation()

Description copied from class: Entity

Determines where to place equipment that does not require a specific location. What this means varies by Entity type.

Overrides:

getBodyLocation in class Entity

Returns:

The location to place equipment that is not required to be assigned a location, defaulting to Entity.LOC_NONE for unit types that do not have such a location.

canChangeSecondaryFacing

public boolean canChangeSecondaryFacing()

Description copied from class: Entity

Can this entity change secondary facing at all?

Specified by:

canChangeSecondaryFacing in class Entity

isValidSecondaryFacing

public boolean isValidSecondaryFacing(int n)

Description copied from class: Entity

Can this entity torso/turret twist the given direction?

Specified by:

isValidSecondaryFacing in class Entity

clipSecondaryFacing

public int clipSecondaryFacing(int n)

Description copied from class: Entity

Returns the closest valid secondary facing to the given direction.

Specified by:

clipSecondaryFacing in class Entity

Returns:

the closest valid secondary facing.

setSecondaryFacing

public void setSecondaryFacing(int sec_facing)

Overrides:

setSecondaryFacing in class Entity

setFacing

public void setFacing(int facing)

Description copied from class: Entity

Sets the primary facing.

Overrides:

setFacing in class Entity

getDualTurretFacing

public int getDualTurretFacing()

setDualTurretOffset

public void setDualTurretOffset(int offset)

isStabiliserHit

public boolean isStabiliserHit(int loc)

setStabiliserHit

public void setStabiliserHit(int loc)

clearStabiliserHit

public void clearStabiliserHit(int loc)

getSensorHits

public int getSensorHits()

setSensorHits

public void setSensorHits(int hits)

isDriverHit

public boolean isDriverHit()

setDriverHit

public void setDriverHit(boolean hit)

isCommanderHit

public boolean isCommanderHit()

setCommanderHit

public void setCommanderHit(boolean hit)

isUsingConsoleCommander

public boolean isUsingConsoleCommander()

setUsingConsoleCommander

public void setUsingConsoleCommander(boolean b)

getExtraCrewSeats

public int getExtraCrewSeats()

Returns:

Additional seats beyond the minimum crew requirements

setExtraCrewSeats

public void setExtraCrewSeats(int seats)

isDriverHitPS

public boolean isDriverHitPS()

setDriverHitPS

public void setDriverHitPS(boolean hit)

isCommanderHitPS

public boolean isCommanderHitPS()

setCommanderHitPS

public void setCommanderHitPS(boolean hit)

isCrewHitPS

public boolean isCrewHitPS()

setCrewHitPS

public void setCrewHitPS(boolean hit)

isMovementHit

public boolean isMovementHit()

Determines whether the unit is considered to have suffered a movement hit.

A unit is considered to have a movement hit if:

• It is not a trailer (its original walking movement points is greater than 0), and
• It is flagged as immobile, or
• It is a VTOL unit and its rotor is destroyed, or
• Its motive damage is greater than or equal to its original walking movement points.

Returns:

true if the unit qualifies as having a movement hit according to these criteria; false otherwise.

See Also:

• applyMovementDamage()

isMovementHitPending

public boolean isMovementHitPending()

immobilize

public void immobilize()

Marks this tank for immobilization, most likely from a related motive system hit. To actually immobilize it, applyDamage() must also be invoked; until then, isMovementHitPending() will return true after this but neither isMovementHit() nor Entity.isImmobile() will have been updated yet (because the tank is technically not immobile just yet until damage is actually resolved).

isImmobile

public boolean isImmobile(boolean checkCrew)

Description copied from class: Entity

Returns true if the target is considered immobile (-4 to hit) as a target and also if it is considered immobile or temporarily or permanently immbolized for active movement. Overriding methods should check the status of the unit (shutdown, damage) and - only if checkCrew is true - also the status of the crew (unconscious).

Overrides:

isImmobile in class Entity

Parameters:

checkCrew - If false, ignore the fitness of the crew when determining if the entity is immobile.

Returns:

True if the target is considered immobile as a target and unable to move actively.

isPermanentlyImmobilized

public boolean isPermanentlyImmobilized(boolean checkCrew)

Whether this unit is irreversibly immobilized for the rest of the game. Tanks have some additional criteria.

Overrides:

isPermanentlyImmobilized in class Entity

Returns:

true if unit is permanently immobile

isImmobileForJump

public boolean isImmobileForJump()

Per BT Forums CVs with working engines and Jump Jets should still have the option to jump during the movement phase, even if reduced to 0 MP by motive hits, or rolling 12 on the Motive System Damage table.

Overrides:

isImmobileForJump in class Entity

hasCommandConsoleBonus

public boolean hasCommandConsoleBonus()

Description copied from class: Entity

Units with a cockpit command console provide an initiative bonus to their side, provided that the commander is not currently functioning as pilot, the unit has advanced fire control, and the unit is heavy or assault weight class.

Overrides:

hasCommandConsoleBonus in class Entity

Returns:

Whether the Entity qualifies for initiative bonus from cockpit command console.

isLocationProhibited

public boolean isLocationProhibited(Coords c,
 int testBoardId,
 int currElevation)

Tanks have all sorts of prohibited terrain.

Overrides:

isLocationProhibited in class Entity

Parameters:

c - The position to test

testBoardId - The board to test

currElevation - The elevation or altitude to test

Returns:

True when the location is illegal to be in for this unit, regardless of elevation

See Also:

• Entity.isLocationDeadly(Coords)

isLocationProhibitedWiGE

public boolean isLocationProhibitedWiGE(Coords c,
 int currElevation)

lockTurret

public void lockTurret(int turret)

jamTurret

public void jamTurret(int turret)

unjamTurret

public void unjamTurret(int turret)

isTurretEverJammed

public boolean isTurretEverJammed(int turret)

getStunnedTurns

public int getStunnedTurns()

setStunnedTurns

public void setStunnedTurns(int turns)

stunCrew

public void stunCrew()

applyDamage

public void applyDamage()

Description copied from class: Entity

Applies any damage that the entity has suffered. When anything gets hit it is simply marked as "hit" but does not stop working until this is called.

Overrides:

applyDamage in class Entity

applyMovementDamage

public void applyMovementDamage()

Applies movement damage to the Tank.

isEligibleFor

public boolean isEligibleFor(GamePhase phase)

Description copied from class: Entity

Determines if an entity is eligible for a phase.

Overrides:

isEligibleFor in class Entity

newRound

public void newRound(int roundNumber)

Description copied from class: Entity

Start a new round

Specified by:

newRound in interface RoundUpdated

Overrides:

newRound in class Entity

Parameters:

roundNumber - the int number of the new round

setDugIn

public void setDugIn(int stage)

Specified by:

setDugIn in interface Fortifiable

Parameters:

stage - the dug-in stage to set

getDugIn

public int getDugIn()

Specified by:

getDugIn in interface Fortifiable

Returns:

the current dug-in stage (Fortifiable.DUG_IN_NONE or one of the DUG_IN_FORTIFYING_* stages).

getFortifyState

public FortifyState getFortifyState()

Specified by:

getFortifyState in interface Fortifiable

Returns:

the per-unit fortification damage tracker.

currentFortifyHealthSignature

public int currentFortifyHealthSignature()

Specified by:

currentFortifyHealthSignature in interface Fortifiable

Returns:

the health signature used to detect damage between fortifying turns: total armor plus internal structure. Any armor or structural damage between turns lowers this value and marks the turn as interrupted.

getRubbleClearTarget

@Nullable
public Coords getRubbleClearTarget()

Specified by:

getRubbleClearTarget in interface RubbleClearer

Returns:

the rubble hex this unit is clearing, or null if it is not clearing rubble

setRubbleClearTarget

public void setRubbleClearTarget(@Nullable
 Coords target)

Specified by:

setRubbleClearTarget in interface RubbleClearer

Parameters:

target - the rubble hex being cleared, or null to stop clearing

getRubbleClearTurnsCompleted

public int getRubbleClearTurnsCompleted()

Specified by:

getRubbleClearTurnsCompleted in interface RubbleClearer

Returns:

the number of turns of clearing banked so far

setRubbleClearTurnsCompleted

public void setRubbleClearTurnsCompleted(int turns)

Specified by:

setRubbleClearTurnsCompleted in interface RubbleClearer

Parameters:

turns - the number of turns of clearing banked so far

getRubbleClearTurnsRequired

public int getRubbleClearTurnsRequired()

Specified by:

getRubbleClearTurnsRequired in interface RubbleClearer

Returns:

the total number of turns this rubble hex needs to be cleared

setRubbleClearTurnsRequired

public void setRubbleClearTurnsRequired(int turns)

Specified by:

setRubbleClearTurnsRequired in interface RubbleClearer

Parameters:

turns - the total number of turns the clearing takes

getMovementString

public String getMovementString(EntityMovementType movementType)

Returns the name of the type of movement used. This is tank-specific.

Specified by:

getMovementString in class Entity

getMovementAbbr

public String getMovementAbbr(EntityMovementType movementType)

Returns the name of the type of movement used. This is tank-specific.

Specified by:

getMovementAbbr in class Entity

firstArmorIndex

public int firstArmorIndex()

Overrides:

firstArmorIndex in class Entity

Returns:

The index of the first armored location (skipping vehicle body, et al.)

getWeaponArc

public int getWeaponArc(int weaponNumber)

Returns the Compute.ARC that the weapon fires into.

Specified by:

getWeaponArc in class Entity

Parameters:

weaponNumber - integer equipment number, index from equipment list

Returns:

arc the specified weapon is in

isSecondaryArcWeapon

public boolean isSecondaryArcWeapon(int weaponId)

Returns true if this weapon fires into the secondary facing arc. If false, assume it fires into the primary.

Specified by:

isSecondaryArcWeapon in class Entity

rollHitLocation

public HitData rollHitLocation(int table,
 int side,
 int aimedLocation,
 AimingMode aimingMode,
 int cover)

Rolls up a hit location

Specified by:

rollHitLocation in class Entity

rollHitLocation

public HitData rollHitLocation(int table,
 int side)

Description copied from class: Entity

Rolls up a hit location

Specified by:

rollHitLocation in class Entity

getTransferLocation

public HitData getTransferLocation(HitData hit)

Gets the location that excess damage transfers to

Specified by:

getTransferLocation in class Entity

addEntityBonuses

public PilotingRollData addEntityBonuses(PilotingRollData prd)

Description copied from class: Entity

Add in any piloting skill mods

Specified by:

addEntityBonuses in class Entity

usesTurnMode

public boolean usesTurnMode()

Description copied from class: Entity

Only check for satisfied turn mode for Tanks or QuadVees in vehicle mode, or LAMs in AirMek mode. Except for LAMs, check whether advanced vehicle ground movement is enabled.

Overrides:

usesTurnMode in class Entity

Returns:

True if this Entity must make a driving check for turning too sharply.

victoryReport

public Vector<Report> victoryReport()

Description copied from class: Entity

Generates a vector containing reports on all useful information about this entity.

Specified by:

victoryReport in class Entity

getNoOfSlots

public int[] getNoOfSlots()

Specified by:

getNoOfSlots in class Entity

getRunMP

public int getRunMP(MPCalculationSetting mpCalculationSetting)

Overrides:

getRunMP in class Entity

getSprintMP

public int getSprintMP()

Description copied from class: Entity

Returns this entity's sprinting MP, modified for all its current circumstances such as gravity and damage. See MPCalculationSetting.STANDARD. For units that can't sprint, this is equal to the modified run/flank MP.

Overrides:

getSprintMP in class Entity

Returns:

This entity's modified sprinting MP

getSprintMP

public int getSprintMP(MPCalculationSetting mpCalculationSetting)

Description copied from class: Entity

Returns this entity's sprinting MP, modified according to the given setting. For units that can't sprint, this is equal to the modified run/flank MP.

Overrides:

getSprintMP in class Entity

Returns:

This entity's modified sprinting MP

getRunningGravityLimit

public int getRunningGravityLimit()

Description copied from class: Entity

get the gravity limit for ground movement

Overrides:

getRunningGravityLimit in class Entity

autoSetInternal

public void autoSetInternal()

Description copied from class: Entity

Sets the internal structure for every location to appropriate undamaged values for the unit and location.

Specified by:

autoSetInternal in class Entity

getMaxElevationDown

public int getMaxElevationDown(int currElevation)

Description copied from class: Entity

Returns the maximum number of downward elevation changes a unit can make. For some units (namely, WiGEs), this can depend upon their current elevation (since elevation determines if the WiGEs is using WiGE movement or not).

Overrides:

getMaxElevationDown in class Entity

isRepairable

public boolean isRepairable()

Determine if the unit can be repaired, or only harvested for spares.

Overrides:

isRepairable in class Entity

Returns:

A boolean that is true if the unit can be repaired (given enough time and parts); if this value is false, the unit is only a source of spares.

See Also:

• Entity.isSalvage()

canCharge

public boolean canCharge()

Overrides:

canCharge in class Entity

Returns:

Whether this type of unit can perform charges

canDFA

public boolean canDFA()

Overrides:

canDFA in class Entity

Returns:

Whether this type of unit can perform DFA attacks

getSuspensionFactor

public int getSuspensionFactor()

Returns:

suspension factor of vehicle

getSuspensionFactor

public static int getSuspensionFactor(EntityMovementMode movementMode,
 double weight)

Static method to calculate suspension factor without needing a vehicle

getCost

public double getCost(CalculationReport calcReport,
 boolean ignoreAmmo)

Description copied from class: Entity

Calculates and returns the C-bill cost of the unit. The parameter ignoreAmmo can be used to include or exclude ("dry cost") the cost of ammunition on the unit. A report for the cost calculation will be written to the given calcReport.

Specified by:

getCost in class Entity

Parameters:

calcReport - A CalculationReport to write the report for the cost calculation to

ignoreAmmo - When true, the cost of ammo on the unit will be excluded from the cost

Returns:

The cost in C-Bills of the 'Mek in question.

getPriceMultiplier

public double getPriceMultiplier()

Description copied from class: Entity

Returns a multiplier that combines multiplicative construction cost modifiers for this Entity.

This includes only modifiers that apply to an Entity's final, total cost (e.g. - the 1.25x modifier for being an omni-unit, or the 32.0x for being an aerodyne DropShip). It does NOT include multipliers that only apply to a sub-part of the unit (e.g. the weight based multiplier that applies to a vehicle's internal structure cost).

This allows MekHQ to scale the price of a Unit's Parts in a more appropriate manner.

Defaults to 1.0

Overrides:

getPriceMultiplier in class Entity

implicitClanCASE

public int implicitClanCASE()

Description copied from class: Entity

Used to for cost calculations. Though the TM rules allow a Clan unit to be designed without CASE, MM assumes that CASE is present in any location that has explosive equipment.

Overrides:

implicitClanCASE in class Entity

Returns:

The number of locations protected by Clan CASE beyond what is explicitly mounted.

doomedInVacuum

public boolean doomedInVacuum()

Overrides:

doomedInVacuum in class Entity

Returns:

True when this unit will not survive vacuum conditions.

hasEnvironmentalSealing

public boolean hasEnvironmentalSealing()

Overrides:

hasEnvironmentalSealing in class Entity

Returns:

True if this unit has Environmental Sealing

isLargeVehicleForHullDown

public boolean isLargeVehicleForHullDown()

Large Vehicles (Large Support Vehicles and super-heavy combat vehicles) are too big to take advantage of the cover offered by a fortified ("infantry-built") hex, and so cannot go hull-down in one. TO:AR p.19.

Returns:

True if this vehicle is a Large Vehicle for the purposes of the hull-down rules.

isHullDownCapable

public boolean isHullDownCapable()

Whether this vehicle type can use hull-down at all, independent of its current hex. Large Vehicles cannot use the cover, and naval, hydrofoil, and submarine (water-based) vehicles cannot dig in / hull down since hull-down requires a fortified land hex (TO:AR p.19).

Returns:

true if this vehicle may ever go hull-down

canGoHullDown

public boolean canGoHullDown()

Checks to see if a Tank is capable of going hull-down. This is true if hull-down rules are enabled, the Tank is in a fortified hex, and the Tank is a hull-down-capable type (not a Large Vehicle or a water-based vehicle).

Overrides:

canGoHullDown in class Entity

Returns:

True if hull-down is enabled and the Tank is in a fortified hex.

setOnFire

public void setOnFire(boolean inferno)

isOnFire

public boolean isOnFire()

isInfernoFire

public boolean isInfernoFire()

isLocationBurning

@Deprecated(since="0.51.0",
            forRemoval=true)
public boolean isLocationBurning(int location)

Deprecated, for removal: This API element is subject to removal in a future version.

extinguishLocation

public void extinguishLocation(int location)

extinguishAll

public void extinguishAll()

extinguish all inferno fire on this Tank

addMovementDamage

public void addMovementDamage(int level)

adds minor, moderate or heavy movement system damage

Parameters:

level - a int representing minor damage (1), moderate damage (2), heavy damage (3), or immobilized (4)

hasMinorMovementDamage

public boolean hasMinorMovementDamage()

hasModerateMovementDamage

public boolean hasModerateMovementDamage()

hasHeavyMovementDamage

public boolean hasHeavyMovementDamage()

addEquipment

public void addEquipment(Mounted<?> mounted,
 int loc,
 boolean rearMounted)
                  throws LocationFullException

Description copied from class: Entity

Adds the given mounted equipment to the unit in the given location, possibly rear-facing depending on the given parameter. This method adds the mounted to the right equipment lists, updates the unit's tech level and adds one-shot ammo where necessary. Overriding methods may perform more tasks. This method, by default, does *NOT* create crit slots, update or add linkages nor handle secondary locations. Overrides for unit types may however do that.

Overrides:

addEquipment in class Entity

Parameters:

mounted - The new equipment

loc - The location; may be Entity.LOC_NONE

rearMounted - True to make the equipment rear-facing

Throws:

LocationFullException - When the location is full

getCriticalEffect

public int getCriticalEffect(int roll,
 int loc,
 boolean damagedByFire)

get the type of critical caused by a critical roll, taking account of existing damage

Parameters:

roll - the final dice roll

loc - the hit location

damagedByFire - whether or not the critical was caused by fire, which is distinct from damage for unofficial thresholding purposes.

Returns:

a critical type

setOmni

public void setOmni(boolean omni)

OmniVehicles have handles for Battle Armor squads to latch onto. Please note, this method should only be called during this Tank's construction.

Overrides Entity#setOmni(boolean)

Overrides:

setOmni in class Entity

setBAGrabBars

public void setBAGrabBars()

setTrailerHitches

public void setTrailerHitches()

Add a transporter for each trailer hitch the unit is equipped with, with a maximum of one each in the front and the rear. Any tractor that does not have an explicit hitch installed as equipment will get a rear-facing transporter.

hasTrailerHitchTransporter

protected boolean hasTrailerHitchTransporter()

Check to see if the unit has a trailer hitch transporter already We need this to prevent duplicate transporters being created

addIntrinsicTransporters

public void addIntrinsicTransporters()

Some entities will always have certain transporters. This method is overloaded to support that.

Overrides:

addIntrinsicTransporters in class Entity

canSpot

public boolean canSpot()

Tanks can't spot when stunned.

Overrides:

canSpot in class Entity

Returns:

true, if the entity is eligible to spot

canUnjamWeapon

public boolean canUnjamWeapon()

Convenience function that determines if this tank can issue an "unjam weapon" command.

Returns:

True if there are any jammed weapons and the crew isn't stunned

canClearTurret

public boolean canClearTurret()

Convenience function that determines if this tank can issue a "clear turret" command.

Returns:

True if there are any jammed turrets and the crew isn't stunned

addJammedWeapon

public void addJammedWeapon(Mounted<?> weapon)

Adds the provided weapon as a weapon that is jammed via the vehicle "weapon malfunction" critical hit

Parameters:

weapon - Weapon that suffered a "Weapon Malfunction" crit and should be jammed

getJammedWeapons

public ArrayList<Mounted<?>> getJammedWeapons()

All weapons that a vehicle could use "unjam weapon" for

Returns:

all weapons that are jammed via the vehicle "weapon malfunction" critical hit

resetJammedWeapons

public void resetJammedWeapons()

Resets the list of weapons a vehicle has jammed via "weapon malfunction" crits to empty

engineHit

public void engineHit()

apply the effects of an "engine hit" crit

engineFix

public void engineFix()

isEngineHit

public boolean isEngineHit()

getTotalCommGearTons

public int getTotalCommGearTons()

Overrides:

getTotalCommGearTons in class Entity

Returns:

the total tonnage of communications gear in this entity

getHQIniBonus

public int getHQIniBonus()

Overrides:

getHQIniBonus in class Entity

Returns:

the initiative bonus this Entity grants for HQ

hasArmoredEngine

public boolean hasArmoredEngine()

Overrides:

hasArmoredEngine in class Entity

getForwardArc

public int getForwardArc()

see Entity.getForwardArc()

Overrides:

getForwardArc in class Entity

getRearArc

public int getRearArc()

see Entity.getRearArc()

Overrides:

getRearArc in class Entity

hasMovementDamage

@Deprecated(since="0.51.0",
            forRemoval=true)
public boolean hasMovementDamage()

Deprecated, for removal: This API element is subject to removal in a future version.

resetMovementDamage

public void resetMovementDamage()

unlockTurret

public void unlockTurret()

isStealthActive

public boolean isStealthActive()

Determine if this unit has an active and working stealth system. (stealth can be active and not working when under ECCM)

Subclasses are encouraged to override this method.

Overrides:

isStealthActive in class Entity

Returns:

true if this unit has a stealth system that is currently active, false if there is no stealth system or if it is inactive.

isStealthOn

public boolean isStealthOn()

Determine if this unit has an active and working stealth system. (stealth can be active and not working when under ECCM)

Subclasses are encouraged to override this method.

Overrides:

isStealthOn in class Entity

Returns:

true if this unit has a stealth system that is currently active, false if there is no stealth system or if it is inactive.

getTotalSlots

public int getTotalSlots()

get the total amount of item slots available for this tank

getFreeSlots

public int getFreeSlots()

get the free item slots for this tank

setArmorType

public void setArmorType(int armType)

Overrides:

setArmorType in class Entity

setArmorType

public void setArmorType(int armType,
 boolean addMount)

hasArmedMASC

public boolean hasArmedMASC()

Checks if a mek has an armed MASC system. Note that the mek will have to exceed its normal run to actually engage the MASC system

getRunMPasString

public String getRunMPasString(boolean gameState)

Returns this entity's running/flank mp as a string.

Overrides:

getRunMPasString in class Entity

Parameters:

gameState - Set this to true to include information about the current state of equipment like MASC.

Returns:

A string like 9(15) if gameState is false or there is no current Game, or a string like 9(15) MASC:0(3+) otherwise.

getStealthModifier

public TargetRoll getStealthModifier(int range,
 Entity ae)

Determine the stealth modifier for firing at this unit from the given range. If the value supplied for range is not one of the Entity class range constants, an IllegalArgumentException will be thrown.

Subclasses are encouraged to override this method.

Overrides:

getStealthModifier in class Entity

Parameters:

range - - an int value that must match one of the Compute class range constants.

ae - - entity making the attack

Returns:

a TargetRoll value that contains the stealth modifier for the given range.

getEngineHits

public int getEngineHits()

Specified by:

getEngineHits in class Entity

getLocationDamage

public String getLocationDamage(int loc)

Overrides:

getLocationDamage in class Entity

isCrippled

public boolean isCrippled()

Description copied from class: Entity

Returns TRUE if the entity meets the requirements for crippling damage as detailed in TW pg 258.

Specified by:

isCrippled in class Entity

Returns:

boolean

isCrippled

public boolean isCrippled(boolean checkCrew)

Description copied from class: Entity

Returns TRUE if the entity meets the requirements for crippling damage as detailed in TW pg 258. Excepting dead or non-existing crew issues

Specified by:

isCrippled in class Entity

Returns:

boolean

isDmgHeavy

public boolean isDmgHeavy()

Description copied from class: Entity

Returns TRUE if the entity has been heavily damaged.

Specified by:

isDmgHeavy in class Entity

Returns:

boolean

isDmgModerate

public boolean isDmgModerate()

Description copied from class: Entity

Returns TRUE if the entity has been moderately damaged.

Specified by:

isDmgModerate in class Entity

Returns:

boolean

isDmgLight

public boolean isDmgLight()

Description copied from class: Entity

Returns TRUE if the entity has been lightly damaged.

Specified by:

isDmgLight in class Entity

Returns:

boolean

getFuelTonnage

public double getFuelTonnage()

Returns the mass of the fuel, which is used for calculating operating range. For combat vehicles this is considered part of the engine weight. For support vehicles it is in addition to the engine weight.

Returns:

fuel tonnage

setFuelTonnage

public void setFuelTonnage(double fuel)

Sets the fuel mass for support vehicles. Has no effect on combat vehicles.

Parameters:

fuel - The mass of the fuel in tons

operatingRange

public int operatingRange()

Calculates the operating range of the vehicle based on engine type and fuel mass. Vehicles that do not require fuel report an operating range of Integer.MAX_VALUE.

Returns:

The vehicle's operating range in km

fuelTonnagePer100km

public double fuelTonnagePer100km()

Calculates fuel mass based on engine type and mass. Engines that do not require allocating fuel mass return a value of 0.0.

Returns:

The fuel mass required for every 100 km of vehicle range.

getICEFuelType

public FuelType getICEFuelType()

The type of fuel for internal combustion engines. This has no meaning for other engine types.

Returns:

The ICE fuel type

setICEFuelType

public void setICEFuelType(FuelType fuelType)

setHullDown

public void setHullDown(boolean down)

Tanks go Hull Down slightly differently, this method accounts for this

Overrides:

setHullDown in class Entity

See Also:

• Entity.setHullDown(boolean)

isBackedIntoHullDown

public boolean isBackedIntoHullDown()

Returns True if this tank moved backwards before going Hull Down

getEntityType

public long getEntityType()

Specified by:

getEntityType in class Entity

isEjectionPossible

public boolean isEjectionPossible()

Overrides:

isEjectionPossible in class Entity

getBaseChassisTurretWeight

public double getBaseChassisTurretWeight()

Used for omni vehicles, which must set the weight of turrets the base chassis, limiting the amount of pod space in the turret.

Returns:

The weight of the primary turret

setBaseChassisTurretWeight

public void setBaseChassisTurretWeight(double baseChassisTurretWeight)

Sets the fixed weight of the primary turret on a dual-turret OmniVehicle.

Parameters:

baseChassisTurretWeight - The weight of the turret

getBaseChassisTurret2Weight

public double getBaseChassisTurret2Weight()

Used for omni vehicles, which must set the weight of turrets the base chassis, limiting the amount of pod space in the turret.

Returns:

The weight of the second turret

setBaseChassisTurret2Weight

public void setBaseChassisTurret2Weight(double baseChassisTurret2Weight)

Sets the fixed weight of the second turret on a dual-turret OmniVehicle.

Parameters:

baseChassisTurret2Weight - The weight of the turret

getBaseChassisSponsonPintleWeight

public double getBaseChassisSponsonPintleWeight()

Used for omni vehicles, which must set the weight of sponson or pintle mounts in the base chassis, limiting the amount of pod space in the turret(s).

Returns:

The weight of any pintle mounts (small support vee) or sponson mounts (combat vee and M/L support vee)

setBaseChassisSponsonPintleWeight

public void setBaseChassisSponsonPintleWeight(double baseChassisSponsonPintleWeight)

Sets the fixed weight of any pintle (small SV) or sponson (CV, M/L SV) turrets on an OmniVehicle.

Parameters:

baseChassisSponsonPintleWeight - The weight of the sponson/pintle turrets.

hasNoControlSystems

public boolean hasNoControlSystems()

setHasNoControlSystems

public void setHasNoControlSystems(boolean hasNoControlSystems)

getSpriteDrawPriority

public int getSpriteDrawPriority()

Used to determine the draw priority of different Entity subclasses. This allows different unit types to always be draw above/below other types.

Overrides:

getSpriteDrawPriority in class Entity

isTrailer

public boolean isTrailer()

Used to determine if this vehicle can be towed by a tractor

Overrides:

isTrailer in class Entity

Returns:

Whether the unit is constructed as a trailer

setTrailer

public void setTrailer(boolean trailer)

Marks whether the tank is constructed as a trailer. This has no effect on support vehicles, which determine trailer status by the trailer chassis modification.

Parameters:

trailer - Whether the tank is constructed as a trailer.

isTractor

public boolean isTractor()

Used to determine if this vehicle can be the engine/tractor for a bunch of trailers

Overrides:

isTractor in class Entity

isCombatVehicle

public boolean isCombatVehicle()

Description copied from interface: BTObject

Returns true when this object is a ground Combat Vehicle, including VTOL but not including Support Vehicles, or of type CV for Alpha Strike. Returns false for any type of unit group even if it is of the right type.

Specified by:

isCombatVehicle in interface BTObject

Returns:

True when this is a ground Combat Vehicle (not including Support Vehicle)

getsAutoExternalSearchlight

public boolean getsAutoExternalSearchlight()

Overrides:

getsAutoExternalSearchlight in class Entity

Returns:

True for unit types that have an automatic external searchlight (Meks and Tanks).

getGenericBattleValue

public int getGenericBattleValue()

Description copied from class: Entity

Calculates a "generic" Battle Value that is based on the average of all units of this type and tonnage. The purpose of this generic Battle Value is to allow a comparison of this unit's actual BV to that for units of its class. This can be used to balance forces without respect to unit or pilot quality.

The generic BV values are calculated by a statistical elasticity model based on all data from the MegaMek database.

Specified by:

getGenericBattleValue in class Entity

Returns:

The generic Battle value for this unit based on its tonnage and type

isSideLocation

public boolean isSideLocation(int location)

Parameters:

location - The location to check

Returns:

True when the given location is a side location, i.e. left, right or, on superheavy units, front or rear left/right.

isCarryableObject

public boolean isCarryableObject()

Description copied from interface: BTObject

For future reference. Returns true when this object is a battlefield object (such as a crate) that can be picked up and carried by some types of units.

Specified by:

isCarryableObject in interface BTObject

Specified by:

isCarryableObject in interface ICarryable

Overrides:

isCarryableObject in class Entity

Returns:

True when this is a carryable battlefield object.

getRecoveryTime

public int getRecoveryTime()

Description copied from class: Entity

Returns the recovery time for this entity in minutes.

This method provides the base recovery time required for this entity type. The recovery time represents the duration needed to recover, repair, or prepare the entity after deployment or damage.

Subclasses should override this method to provide entity-specific recovery times based on their type, weight class, or other relevant characteristics.

Manual Reference: CamOps pg 214

Overrides:

getRecoveryTime in class Entity

Returns:

The recovery time in minutes. The default implementation returns 60 minutes.

canPerformGroundSalvageOperations

public boolean canPerformGroundSalvageOperations()

Description copied from class: Entity

Determines whether salvage operations can be performed on the ground.

The default implementation returns false, indicating that salvage operations are not permitted. Subclasses should override this method to provide specific logic for determining salvage eligibility based on scenario conditions, campaign settings, or other relevant factors.

Overrides:

canPerformGroundSalvageOperations in class Entity

Returns:

true if salvage operations can be performed, false otherwise. The default implementation always returns false.

canAbandon

public boolean canAbandon()

Returns true if this vehicle can be abandoned by its crew. Per TacOps, vehicles can be abandoned during the End Phase. Crew size (1 per 15 tons) is defined in TM p.103 and is available regardless of optional rules.

Note: Naval vessels (surface ships, hydrofoils, submarines) are currently excluded. A future PR will address naval vessel abandonment once Large Naval Craft are implemented.

Returns:

true if this vehicle can be abandoned

canAnnounceAbandon

public boolean canAnnounceAbandon()

Description copied from class: Entity

Checks whether this unit can announce abandonment of its crew in the End Phase. Abandonment is declared in the PREEND_DECLARATIONS phase. The base implementation returns false; unit types that support abandonment (Meks, vehicles, and escape pods) override this.

Overrides:

canAnnounceAbandon in class Entity

Returns:

true if this unit can announce crew abandonment

isAbandoned

public boolean isAbandoned()

Returns true if this vehicle has been abandoned - the crew has exited but the vehicle itself is not destroyed.

Overrides:

isAbandoned in class Entity

Returns:

true if this vehicle is crewless but intact

hasCombatVehicleEscapePod

public boolean hasCombatVehicleEscapePod()

Returns true if this vehicle has a Combat Vehicle Escape Pod installed.

Returns:

true if this vehicle has a CVEP

hasUndamagedCombatVehicleEscapePod

public boolean hasUndamagedCombatVehicleEscapePod()

Returns true if this vehicle has an undamaged Combat Vehicle Escape Pod. Per TO:AUE p.121, the CVEP is treated as a weapon item and can be damaged by critical hits to the rear location.

Returns:

true if this vehicle has an undamaged CVEP

canLaunchEscapePod

public boolean canLaunchEscapePod()

Returns true if the crew can launch the Combat Vehicle Escape Pod this turn. Per TO:AUE p.121, the crew may choose to use the CVEP during the Movement Phase if the system has not been previously damaged.

Returns:

true if the CVEP can be launched

isChassisFamiliarityEligible

public boolean isChassisFamiliarityEligible()

Description copied from class: Entity

Returns whether this unit is a chassis-familiarity-eligible type for MekHQ's Familiarity system

Overrides:

isChassisFamiliarityEligible in class Entity

Returns:

true if familiarity is tracked for this unit