Package megamek.common.units

Class AbstractBuildingEntity

java.lang.Object

megamek.common.turns.TurnOrdered

megamek.common.units.Entity

megamek.common.units.AbstractBuildingEntity

All Implemented Interfaces:

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

Direct Known Subclasses:

BuildingEntity, MobileStructure

public abstract class AbstractBuildingEntity
extends Entity
implements IBuilding

AbstractBuildingEntity represents a non-terrain building (e.g., a moving fortress). This is the common implementation of the Mobile Structure rules from TO:AUE and Advanced Building rules from TO:AUE.
It contains a Building (which stores data in relative coordinates) and handles translation between board coordinates and the Building's relative coordinate space. Unlike BuildingTerrain, the translation is dynamic based on Entity's current position/facing.

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 String[]	HIT_LOCATION_NAMES

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.IBuilding

FORTRESS, GUN_EMPLACEMENT, HANGAR, STANDARD, UNKNOWN

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
AbstractBuildingEntity(BuildingType type, int bldgClass)

Method Summary

Modifier and Type	Method	Description
void	addDemolitionCharge(int playerId, int damage, Coords pos)	Demolition charges anchor to an absolute board hex, which only works for structures that cannot move.
PilotingRollData	addEntityBonuses(PilotingRollData roll)	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	autoSetInternal()	Sets the internal structure for every location to appropriate undamaged values for the unit and location.
CubeCoords	boardToRelative(Coords boardCoords)	Convert board coordinates to relative CubeCoordinates.
boolean	canChangeSecondaryFacing()	Can this entity change secondary facing at all?
boolean	canCharge()
boolean	canFlee(Coords position)	Returns true when this unit can flee from the given position in its current state.
boolean	canGoDown()
boolean	canGoDown(int assumed, Coords coords, int boardId)	is it possible to go down, or are we landed/just above the water/treeline? assuming passed elevation.
boolean	canReinforceInfantryVsInfantry()	Determines if this entity can reinforce ongoing infantry vs infantry combat.
int	clipSecondaryFacing(int dir)	Returns the closest valid secondary facing to the given direction.
void	collapseBasement(Coords coords, Board board, Vector<Report> vPhaseReport)
void	collapseFloorsOnHex(Coords coords, int numLevelsToCollapse)
Map<CubeCoords,Coords>	computeLayoutForPositionAndFacing(Coords testPosition, int testFacing)	Deprecated, for removal: This API element is subject to removal in a future version.
CrewType	defaultCrewType()
int	getArmor(int loc, boolean rear)	Returns the amount of armor in the location specified, or IArmorState.ARMOR_NA, or IArmorState.ARMOR_DESTROYED.
int	getArmor(Coords coords)
int	getArmorTechLevel(int loc)
int	getArmorType(int loc)
BasementType	getBasement(Coords coords)
boolean	getBasementCollapsed(Coords coords)	Get the building basement, per TacOps rules.
int	getBldgClass()	Get the building class, per TacOps rules.
int	getBoardFacing()	Get the facing/rotation of this building in board space.
Coords	getBoardOrigin()	Get the board coordinates of this building's origin (where relative 0,0 maps to).
BuildingType	getBuildingType()	Get the construction type of the building.
int	getCollapsedHexCount()
Enumeration<Coords>	getCoords()	Get the coordinates that the building occupies.
List<Coords>	getCoordsList()	Returns a list of this Building's coords.
double	getCost(CalculationReport calcReport, boolean ignoreAmmo)	Calculates and returns the C-bill cost of the unit.
int	getCurrentCF(Coords coords)	Get the current construction factor of the building hex at the passed coords.
List<DemolitionCharge>	getDemolitionCharges()
int	getEngineHits()
long	getEntityType()
int	getHeight(Coords coords)	Get the height (BLDG_ELEV) of the building hex at the passed coords.
Building	getInternalBuilding()	Get the internal Building instance that stores data in relative coordinates.
int	getInternalForReal(int loc)
String[]	getLocationAbbreviations()
String[]	getLocationNames()
String	getName()	Get the name of this building.
int	getNCrew()	Calculate building crew based on Advanced Building Minimum Crew Table (TO:AUE).
int[]	getNoOfSlots()
int	getOriginalHexCount()
int	getPhaseCF(Coords coords)	Get the construction factor of the building hex at the passed coords at the start of the current phase.
int	getTotalCommGearTons()
HitData	getTransferLocation(HitData hit)	Gets the location that excess damage transfers to.
List<Integer>	getValidFacingsAt(Coords testPosition, int testElevation, int testBoardId)	Returns all valid facings for this building at the given position and elevation.
int	getWeaponArc(int weaponNumber)	Returns the Rules.ARC that the weapon, specified by number, fires into.
int	getWeaponFiringHeight(WeaponMounted weapon)	What height is this weapon physically firing from?
Coords	getWeaponFiringPosition(WeaponMounted weapon)	What Coords is this weapon physically firing from?
boolean	hasCFIn(Coords coords)	Determines if the coord exist in the currentCF has.
boolean	hasStealth()
boolean	isBoardable()	Determines if this entity can be boarded by infantry for interior combat.
boolean	isBurning(Coords coords)	Determine if this building is on fire.
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	isLocationProhibited(Coords testPosition, int testBoardId, int testElevation)	Returns true when the given location cannot legally be entered or deployed into by this unit at the given elevation or altitude.
boolean	isNuclearHardened()	Checks if the unit is hardened against nuclear strikes.
boolean	isPositionAndFacingValid(Coords testPosition, int testFacing, int testElevation, int testBoardId)	Checks if all hexes of this building would be valid at the given position and facing WITHOUT modifying the entity's state.
boolean	isRepairable()	Determine if the unit can be repaired, or only harvested for spares.
boolean	isSalvage()	Buildings are salvageable unless they have completely collapsed.
boolean	isSecondaryArcWeapon(int weaponId)	Returns true if this weapon fires into the secondary facing arc.
boolean	isTargetable()	Returns true if this entity is targetable for attacks.
boolean	isValidSecondaryFacing(int dir)	Can this entity torso/turret twist the given direction?
int	locations()	Returns the number of locations in the entity
void	refreshAdditionalLocations()
void	refreshLocations()
Coords	relativeToBoard(CubeCoords relativeCoords)	Convert relative CubeCoordinates to board coordinates.
void	removeDemolitionCharge(DemolitionCharge charge)
void	removeHex(Coords coords)	Remove one building hex from the building
boolean	rollBasement(Coords coords, Board board, Vector<Report> vPhaseReport)	Roll what kind of basement this building has
HitData	rollHitLocation(int table, int side)	Rolls up a hit location
HitData	rollHitLocation(int table, int side, int aimedLocation, AimingMode aimingMode, int cover)	Rolls the to-hit number
void	setArmor(int a, Coords coords)
void	setBasement(Coords coords, BasementType basement)
void	setBasementCollapsed(Coords coords, boolean collapsed)
void	setBurning(boolean onFire, Coords coords)	Set the flag that indicates that this building is on fire.
void	setCurrentCF(int cf, Coords coords)	Set the current construction factor of the building hex.
void	setDemolitionCharges(List<DemolitionCharge> charges)
void	setFacing(int facing)	Sets the primary facing.
void	setHeight(int h, Coords coords)	Set the height of a specific building hex.
void	setInternal(int val, int loc)	Override to keep entity internal and building CF synchronized.
void	setPhaseCF(int cf, Coords coords)	Set the construction factor of the building hex for the start of the next phase.
void	setPosition(Coords position)	Override setPosition to populate the relativeLayout map when the entity is placed.
void	setPosition(Coords position, boolean gameUpdate)	Sets the current position of this entity on the board.
int	sideTable(Coords src)
void	updateBuildingEntityHexes(int boardId, TWGameManager gameManager)	Once a building entity has set its position, we need to update the board itself and share that with the clients
Vector<Report>	victoryReport()	Calculates a "generic" Battle Value that is based on the average of all units of this type and tonnage.

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, addIntrinsicTransporters, addKill, addOffBoardObserver, addPassedThrough, addPilotingModifierForTerrain, addPilotingModifierForTerrain, addPilotingModifierForTerrain, addPilotingModifierForTerrain, addRoofRack, addSensorContact, addSystemTechAdvancement, addTargetedBySwarm, addTechComponent, addTowedUnit, addTransporter, addTransporter, addTsempHitThisTurn, addWeaponGroup, antiTSMVulnerable, applyDamage, applyGravityEffectsOnMP, applyMagneticPulse, armorStringFor, assignAMS, assignTMAMS, assignWeaponQuirk, attachINarcPod, attachNarcPod, braceLocation, C3MasterIs, calcElevation, calcElevation, calculateBattleValue, calculateBattleValue, calculateBattleValue, calculateBattleValue, calculateFreeC3MNodes, calculateFreeC3Nodes, canActivateBloodStalker, canAnnounceAbandon, canAssaultDrop, canAssist, canBePickedUp, canBrace, canDFA, canEjectCrew, canEscape, canFall, canFall, canFireWeapon, canFlee, canFleeFrom, canFleeInState, canFlipArms, canGoHullDown, canGoUp, canHide, canInitiateInfantryVsInfantryCombat, canLayDemolitionCharges, canLayMine, canLoad, canLoad, canLoad, canonUnitWithInvalidBuild, canPerformGroundSalvageOperations, canPerformSpaceSalvageOperations, canPickupCarryableObject, canPickupGroundObject, canRam, canShutdownEi, canSpot, 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, doomedInVacuum, doomedOnGround, dropCarriedObject, dropCarriedObject, dropGroundObjects, elevationOccupied, elevationOccupied, endOfTurnCargoInteraction, entityIsQuad, equals, extendBlade, factionTechLevel, findTargetedDisplacement, firstArmorIndex, 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, getArmoredComponentTechAdvancement, getArmorForReal, getArmorForReal, getArmorRemainingPercent, getArmorString, getArmorString, getArmorTechRating, 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, getBodyLocation, 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, getConstructionTechAdvancement, 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, getForwardArc, getFreeC3iUUID, getFreeNC3UUID, getFullChassis, getGame, getGaveKillCredit, getGenericBattleValue, 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, getHQIniBonus, getIcon, getId, getImpLastTurn, getImpMpReduction, getImpToHitModifier, getINarcPodsAttached, getIndividualWeaponList, getInfantryCombatTargetId, getInfantryCombatTurnCount, getInitialBV, getInternal, getInternal, getInternalBombLoadout, 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, getLocationDamage, getLocationFromAbbr, getLocationName, getLocationName, getLocationStatus, getLongRangeModifier, getLOSRangeModifier, getMagneticPulseRounds, getManualBV, getMASC, getMASCTarget, getMASCTurns, getMaxElevationChange, getMaxElevationDown, getMaxElevationDown, getMaxWeaponRange, getMaxWeaponRange, getMechanicalJumpBoosterMP, getMechanicalJumpBoosterMP, getMediumRangeModifier, getMisc, getMisc, getMiscEquipment, getMissionRoles, getMixedTechAdvancement, getModel, getMotiveSideMod, getMovedBackwards, getMovementAbbr, getMovementBeforeSkidPSRModifier, getMovementMode, getMovementModeAsString, getMovementString, getMPBoosters, getMPBoosters, getMpUsedLastRound, getMulId, getNC3NextUUIDAsString, 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, getPriceMultiplier, getPriorPosition, getProductionDate, getProductionDate, getProductionDateRange, getPrototypeDate, getPrototypeDate, getPrototypeRangeDate, getPublished, getPublishedSources, getQuirkIniBonus, getQuirkList, getQuirks, getRearArc, getRecoveryTime, getRecoveryTurn, getReintroductionDate, getReintroductionDate, getRemovalCondition, getRetreatedDirection, getRole, getRunHeat, getRunMP, getRunMP, getRunMPasString, getRunMPasString, getRunMPWithoutMASC, getRunningGravityLimit, getsAutoExternalSearchlight, getSearchlightOverride, getSecondaryFacing, getSecondaryPositions, getSelfDestructedThisTurn, getSelfDestructing, getSelfDestructInitiated, getSensorCheck, getSensorContacts, getSensors, getShortName, getShortNameRaw, getShortRangeModifier, getSource, getSources, getSpotTargetId, getSprintHeat, getSprintMP, getSprintMP, getSprintMPWithOneMASC, getSprintMPWithoutMASC, getSpriteDrawPriority, getStandingHeat, getStartingAnyNWx, getStartingAnyNWx, getStartingAnyNWy, getStartingAnyNWy, getStartingAnySEx, getStartingAnySEx, getStartingAnySEy, getStartingAnySEy, getStartingOffset, getStartingOffset, getStartingPos, getStartingPos, getStartingWidth, getStartingWidth, getStaticTechLevel, getStealthModifier, 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, getUnitType, getUnloadableUnits, getUnused, getUnused, getUnusedString, getUnusedString, getUseManualBV, getValidBraceLocations, getValidHalfWeightPickupLocations, getVariableRangeTargetingMode, getVariableRangeTargetingModifier, getVector, getVectors, getVelocity, getVibroClaws, getWalkHeat, getWalkMP, getWalkMP, getWeapon, getWeaponBayList, 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, hasArmoredEngine, hasArtillery, hasBadLegs, hasBAP, hasBAP, hasBARArmor, hasBattleArmorHandles, hasBoobyTrap, hasBoostedC3, hasC3, hasC3i, hasC3M, hasC3MM, hasC3S, hasCase, hasCASEII, hasCASEII, hasCommandConsoleBonus, hasDamagedRHS, hasDetectedEntity, hasDisplacementAttack, hasDNICockpitMod, hasDNIImplant, hasDNIInducedHardToPilot, hasDroneOs, hasECM, hasEiCockpit, hasEmbeddedIcon, hasEMPInterferenceHeat, hasEngine, hasEntityScopedPreEndDeclaration, hasEnvironmentalSealing, hasETypeFlag, hasExternalSearchlight, hasFallen, hasFiredTsemp, hasFiringSolutionFor, hasFleeZone, hasFlotationHull, hasFrontMountedBulldozer, hasFrontMountedSaw, 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, hasRearMountedBulldozer, hasRHSWentUp, hasSCM, hasSearchlight, hasSeenEntity, hasSensorContactFor, hasShield, hasSystem, hasTAG, hasTargComp, hasTCPAimedShotCapability, hasUMU, hasUndamagedCriticalSlots, hasUnloadedUnitsFromBays, hasUsedRHSLastTurn, hasVariableRangeTargeting, hasViableWeapons, hasVibroblades, hasWorkingBackhoe, hasWorkingBulldozer, hasWorkingMisc, hasWorkingMisc, hasWorkingMisc, hasWorkingMisc, hasWorkingRadicalHS, hasWorkingSCM, hasWorkingSystem, height, hitAllCriticalSlots, implicitClanCASE, incrementInfantryCombatTurnCount, incrementMASCAndSuperchargerLevels, initializeArmor, initializeInternal, initMilitary, initTechAdvancement, isAbandoned, isActive, isActive, isActiveOption, isAeroLandedOnGroundMap, isAeroSensorDestroyed, isAirborne, isAirborneAeroOnGroundMap, isAirborneVTOLorWIGE, isAssaultDropInProgress, isAttackingThisTurn, isBATaserShutdown, isBoardProhibited, isBoardProhibited, isBoobyTrapInitiated, isBracing, isC3CompanyCommander, isC3IndependentMaster, isCanon, isCapitalFighter, isCapitalFighter, isCapitalScale, isCaptured, isCarcass, isCarefulStand, isCarryableObject, isChainWhipGrappled, isChameleonShieldActive, isChameleonShieldOn, isCharging, isChassisFamiliarityEligible, isClan, isClanArmor, isClearingMinefield, isClearingWoods, isClimbing, isCommander, isConvertingNow, isDangling, isDeployed, isDesignValid, isDestroyed, isDetectedByEnemy, isDone, isDoomed, isDropping, isEiShutdown, isEjectionPossible, isElevationValid, isEligibleFor, isEligibleForArtyAutoHitHexes, isEligibleForFiring, isEligibleForInfantryVsInfantry, isEligibleForMovement, isEligibleForOffboard, isEligibleForPavementOrRoadBonus, isEligibleForPhysical, isEligibleForPreEndDeclarations, isEligibleForTargetingPhase, isEnemyOf, isEvading, isEverSeenByEnemy, isFindingClub, isFiredTsempThisTurn, isFirefighter, isGhostTargetCapable, isGrappleAttacker, isGrappledThisRound, isGyroDestroyed, isHardenedArmorDamaged, isHidden, isHullDown, isIlluminated, isImmobile, isImmobile, isImmobileForJump, 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, isNullSigActive, isNullSigOn, isObsoleteInYear, isOffBoard, isOffBoardObserved, isOmni, isOnAtmosphericGroundMap, isPartOfFighterSquadron, isPendingAbandon, isPermanentlyImmobilized, isPodMountedTransport, isPowerReverse, isPrimitive, isProne, isPushing, isRamming, isReckless, isSelectableThisTurn, isSensorReturn, isShutDown, isShutDownThisPhase, isSpaceborne, isSpotting, isStalled, isStartupThisPhase, isStealthActive, isStealthOn, isStuck, isSufferingEMI, isSuperchargerUsed, isSuperHeavy, isSurfaceNaval, isTargetOfDisplacementAttack, isTractor, isTrailer, 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, newRound, newRoundNovaNetSwitch, newRoundVariableRangeSwitch, nextConversionMode, onSameC3NetworkAs, onSameC3NetworkAs, ownerHasDemolitionCharge, passedOver, passedThrough, passedThroughPrevious, passedWithin, performManualShutdown, performManualStartup, pickUp, pickupCarryableObject, postProcessFacingChange, processPickupStep, processPickupStepEntity, recalculateTechAdvancement, recordedTechLevel, recover, 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, 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, setHullDown, setIcon, setId, setIGame, setIlluminated, setImpLastTurn, setInfantryCombatAttacker, setInfantryCombatTargetId, setInfantryCombatTurnCount, setInfantryCombatWantsWithdrawal, setInitialBV, 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, setOmni, setOriginalBuildYear, setOriginalJumpMP, setOriginalWalkMP, setOwner, setOwnerId, setPassedThrough, setPassedThroughBoardId, setPassedThroughFacing, setPendingAbandon, setPendingVariableRangeTargetingMode, setPlayerPickedPassThrough, setPowerReverse, setProne, setPublished, setPublishedSources, setQuirks, setRamming, setRapidFire, setReckless, setRecoveryTurn, setRemovalCondition, setRetreatedDirection, setSalvage, setSearchlightOverride, setSearchlightState, setSecondaryFacing, 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, sideTableRam, sideTableRam, slotNumber, specificName, statusToString, statusToString, statusToString, storeOriginalUnitData, storeSavedUnitData, taserShutdown, toggleConversionMode, toString, towUnit, turnWasInterrupted, unload, updateBays, updateDuplicateMarkerAfterDelete, usedSearchlight, usedTag, usesTurnMode, 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, isCombatVehicle, 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.IBuilding

getAbsorption, getBoardId, getDamageFromScale, getDamageReductionFromOutside, getDamageToScale, getId, getInfDmgFromInside, isIn, setBoardId

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.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

HIT_LOCATION_NAMES

public static final String[] HIT_LOCATION_NAMES

Constructor Details

AbstractBuildingEntity

public AbstractBuildingEntity(BuildingType type,
 int bldgClass)

Method Details

defaultCrewType

public CrewType defaultCrewType()

Overrides:

defaultCrewType in class Entity

getBoardOrigin

public Coords getBoardOrigin()

Description copied from interface: IBuilding

Get the board coordinates of this building's origin (where relative 0,0 maps to). For BuildingTerrain: the static placement coords For AbstractBuildingEntity: the entity's current position

Specified by:

getBoardOrigin in interface IBuilding

Returns:

the board coordinates of the origin, or null if not placed

getBoardFacing

public int getBoardFacing()

Description copied from interface: IBuilding

Get the facing/rotation of this building in board space. 0 = north, 1-5 = clockwise rotation

Specified by:

getBoardFacing in interface IBuilding

Returns:

the facing (0-5)

getInternalBuilding

public Building getInternalBuilding()

Description copied from interface: IBuilding

Get the internal Building instance that stores data in relative coordinates. Building returns itself; BuildingTerrain/BuildingEntity override to return wrapped instance.

Specified by:

getInternalBuilding in interface IBuilding

Returns:

the internal Building instance

boardToRelative

@Nullable
public CubeCoords boardToRelative(@Nullable
 Coords boardCoords)

Description copied from interface: IBuilding

Convert board coordinates to relative CubeCoordinates. Default: convert board Coords to CubeCoords. BuildingTerrain/BuildingEntity override to translate using their coord maps.

Specified by:

boardToRelative in interface IBuilding

Parameters:

boardCoords - the board coordinates

Returns:

the relative CubeCoordinates

relativeToBoard

public Coords relativeToBoard(CubeCoords relativeCoords)

Description copied from interface: IBuilding

Convert relative CubeCoordinates to board coordinates. Default: convert CubeCoords to offset Coords. BuildingTerrain/BuildingEntity override to translate using their coord maps.

Specified by:

relativeToBoard in interface IBuilding

Parameters:

relativeCoords - the relative CubeCoordinates

Returns:

the board coordinates

getWeaponFiringPosition

public Coords getWeaponFiringPosition(WeaponMounted weapon)

Description copied from class: Entity

What Coords is this weapon physically firing from?

Overrides:

getWeaponFiringPosition in class Entity

Parameters:

weapon - WeaponMounted

Returns:

Coords

getWeaponFiringHeight

public int getWeaponFiringHeight(WeaponMounted weapon)

Description copied from class: Entity

What height is this weapon physically firing from?

Overrides:

getWeaponFiringHeight in class Entity

Parameters:

weapon - WeaponMounted

Returns:

int

setPosition

public void setPosition(Coords position)

Override setPosition to populate the relativeLayout map when the entity is placed. This establishes the mapping between the building's internal relative coordinates and their actual board coordinates.

Overrides:

setPosition in class Entity

setPosition

public void setPosition(Coords position,
 boolean gameUpdate)

Description copied from class: Entity

Sets the current position of this entity on the board.

Overrides:

setPosition in class Entity

Parameters:

position - the new position.

isLocationProhibited

public boolean isLocationProhibited(Coords testPosition,
 int testBoardId,
 int testElevation)

Returns true when the given location cannot legally be entered or deployed into by this unit at the given elevation or altitude. Also returns true when the location doesn't exist. Even when this method returns true, the location need not be deadly to the unit.

Overrides:

isLocationProhibited in class Entity

Parameters:

testPosition - The position to test

testBoardId - The board to test

testElevation - 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)

computeLayoutForPositionAndFacing

@Deprecated(since="0.51.0",
            forRemoval=true)
public Map<CubeCoords,Coords> computeLayoutForPositionAndFacing(Coords testPosition,
 int testFacing)

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

Computes what the relative layout would be for a hypothetical position and facing WITHOUT modifying the entity's actual position or facing. This is a pure calculation method with no side effects.

Parameters:

testPosition - The position to test

testFacing - The facing to test (0-5)

Returns:

Map of relative CubeCoords to their board Coords at the given position/facing

isPositionAndFacingValid

public boolean isPositionAndFacingValid(Coords testPosition,
 int testFacing,
 int testElevation,
 int testBoardId)

Checks if all hexes of this building would be valid at the given position and facing WITHOUT modifying the entity's state. This is a pure calculation method.

Parameters:

testPosition - The position to test

testFacing - The facing to test (0-5)

testElevation - The elevation to test

testBoardId - The board ID to test

Returns:

true if all building hexes would be valid at this position/facing

getValidFacingsAt

public List<Integer> getValidFacingsAt(Coords testPosition,
 int testElevation,
 int testBoardId)

Returns all valid facings for this building at the given position and elevation. Does NOT modify the entity's facing - this is a pure calculation method.

Parameters:

testPosition - The position to test

testElevation - The elevation to test

testBoardId - The board ID to test

Returns:

List of valid facings (0-5), or empty list if none valid

locations

public int locations()

Returns the number of locations in the entity

Specified by:

locations in class Entity

refreshAdditionalLocations

public void refreshAdditionalLocations()

setFacing

public void setFacing(int facing)

Sets the primary facing.

Overrides:

setFacing in class Entity

canChangeSecondaryFacing

public boolean canChangeSecondaryFacing()

Can this entity change secondary facing at all?

Specified by:

canChangeSecondaryFacing in class Entity

isValidSecondaryFacing

public boolean isValidSecondaryFacing(int dir)

Can this entity torso/turret twist the given direction?

Specified by:

isValidSecondaryFacing in class Entity

clipSecondaryFacing

public int clipSecondaryFacing(int dir)

Returns the closest valid secondary facing to the given direction.

Specified by:

clipSecondaryFacing in class Entity

Returns:

the closest valid secondary facing.

getLocationNames

public String[] getLocationNames()

Specified by:

getLocationNames in class Entity

getLocationAbbreviations

public String[] getLocationAbbreviations()

Specified by:

getLocationAbbreviations in class Entity

sideTable

public int sideTable(Coords src)

Specified by:

sideTable in interface Targetable

Overrides:

sideTable in class Entity

Returns:

side hit from location

rollHitLocation

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

Rolls the to-hit number

Specified by:

rollHitLocation in class Entity

rollHitLocation

public HitData rollHitLocation(int table,
 int side)

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. That is, one location inwards.

Specified by:

getTransferLocation in class Entity

autoSetInternal

public void autoSetInternal()

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

Specified by:

autoSetInternal in class Entity

getWeaponArc

public int getWeaponArc(int weaponNumber)

Returns the Rules.ARC that the weapon, specified by number, 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

getNoOfSlots

public int[] getNoOfSlots()

Specified by:

getNoOfSlots in class Entity

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

victoryReport

public Vector<Report> victoryReport()

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.

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

Specified by:

victoryReport in class Entity

addEntityBonuses

public PilotingRollData addEntityBonuses(PilotingRollData roll)

Add in any piloting skill mods

Specified by:

addEntityBonuses in class Entity

isRepairable

public boolean isRepairable()

Description copied from class: Entity

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()

isTargetable

public boolean isTargetable()

Description copied from class: Entity

Returns true if this entity is targetable for attacks. A unit is targetable if it is not destroyed, not doomed, deployed, not off board, not being transported, and not captured.

Overrides:

isTargetable in class Entity

canCharge

public boolean canCharge()

Overrides:

canCharge in class Entity

Returns:

Whether this type of unit can perform charges

canFlee

public boolean canFlee(Coords position)

Description copied from class: Entity

Returns true when this unit can flee from the given position in its current state. This requires the unit to have mobility and be in control as well as the position being eligible for fleeing. When no special flee area is set by a scenario, the latter will typically be true when the position is at the edge of its board. A null position as well as offboard units are considered to be eligible for fleeing.

Overrides:

canFlee in class Entity

Returns:

True when the unit can flee from the given position, given its current status

canGoDown

public boolean canGoDown()

Overrides:

canGoDown in class Entity

canGoDown

public boolean canGoDown(int assumed,
 Coords coords,
 int boardId)

Description copied from class: Entity

is it possible to go down, or are we landed/just above the water/treeline? assuming passed elevation.

Overrides:

canGoDown in class Entity

getCost

public double getCost(CalculationReport calcReport,
 boolean ignoreAmmo)

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.

isNuclearHardened

public boolean isNuclearHardened()

Description copied from class: Entity

Checks if the unit is hardened against nuclear strikes.

Overrides:

isNuclearHardened in class Entity

Returns:

true if this is a hardened unit.

getTotalCommGearTons

public int getTotalCommGearTons()

Overrides:

getTotalCommGearTons in class Entity

Returns:

the total tonnage of communications gear in this entity

getEngineHits

public int getEngineHits()

Specified by:

getEngineHits in class Entity

isSalvage

public boolean isSalvage()

Buildings are salvageable unless they have completely collapsed. A building has completely collapsed when all hexes have 0 CF.

Overrides:

isSalvage in class Entity

Returns:

A boolean that is true if the unit has salvageable components; if this value is false the unit is utterly destroyed.

See Also:

• Entity.isRepairable()

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)

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()

Returns TRUE if the entity has been heavily damaged.

Specified by:

isDmgHeavy in class Entity

Returns:

boolean

isDmgModerate

public boolean isDmgModerate()

Returns TRUE if the entity has been moderately damaged.

Specified by:

isDmgModerate in class Entity

Returns:

boolean

isDmgLight

public boolean isDmgLight()

Returns TRUE if the entity has been lightly damaged.

Specified by:

isDmgLight in class Entity

Returns:

boolean

getArmorType

public int getArmorType(int loc)

Overrides:

getArmorType in class Entity

getArmorTechLevel

public int getArmorTechLevel(int loc)

Overrides:

getArmorTechLevel in class Entity

hasStealth

public boolean hasStealth()

Overrides:

hasStealth in class Entity

Returns:

True if this unit has working stealth armor (not patchwork armor).

getEntityType

public long getEntityType()

Specified by:

getEntityType in class Entity

getInternalForReal

public int getInternalForReal(int loc)

Overrides:

getInternalForReal in class Entity

getArmor

public int getArmor(int loc,
 boolean rear)

Returns the amount of armor in the location specified, or IArmorState.ARMOR_NA, or IArmorState.ARMOR_DESTROYED.

Overrides:

getArmor in class Entity

setInternal

public void setInternal(int val,
 int loc)

Override to keep entity internal and building CF synchronized.

Overrides:

setInternal in class Entity

hasCFIn

public boolean hasCFIn(Coords coords)

Description copied from interface: IBuilding

Determines if the coord exist in the currentCF has.

Specified by:

hasCFIn in interface IBuilding

Parameters:

coords - - the Coords being examined.

Returns:

true if the building has CF at the coordinates. false otherwise.

getCoords

public Enumeration<Coords> getCoords()

Description copied from interface: IBuilding

Get the coordinates that the building occupies.

Specified by:

getCoords in interface IBuilding

Returns:

an Enumeration of the Coord objects.

getCoordsList

public List<Coords> getCoordsList()

Description copied from interface: IBuilding

Returns a list of this Building's coords. The list is unmodifiable.

Specified by:

getCoordsList in interface IBuilding

getBuildingType

public BuildingType getBuildingType()

Description copied from interface: IBuilding

Get the construction type of the building. This value will be one of the values defined in megamek.common.enums.BuildingType

Specified by:

getBuildingType in interface IBuilding

Returns:

the int code of the building's construction type.

getBldgClass

public int getBldgClass()

Description copied from interface: IBuilding

Get the building class, per TacOps rules.

Specified by:

getBldgClass in interface IBuilding

Returns:

the int code of the building's classification.

getBasementCollapsed

public boolean getBasementCollapsed(Coords coords)

Description copied from interface: IBuilding

Get the building basement, per TacOps rules.

Specified by:

getBasementCollapsed in interface IBuilding

Returns:

the int code of the building basement type.

collapseBasement

public void collapseBasement(Coords coords,
 Board board,
 Vector<Report> vPhaseReport)

Specified by:

collapseBasement in interface IBuilding

rollBasement

public boolean rollBasement(Coords coords,
 Board board,
 Vector<Report> vPhaseReport)

Description copied from interface: IBuilding

Roll what kind of basement this building has

Specified by:

rollBasement in interface IBuilding

Parameters:

coords - the Coords of the building to roll for

vPhaseReport - the Report Vector containing the phase report

Returns:

a boolean indicating weather the hex and building was changed or not

getCurrentCF

public int getCurrentCF(Coords coords)

Description copied from interface: IBuilding

Get the current construction factor of the building hex at the passed coords. Any damage immediately updates this value.

Specified by:

getCurrentCF in interface IBuilding

Parameters:

coords - the Coords of the hex in question

Returns:

the int value of the building hex's current construction factor. This value will be greater than or equal to zero.

getPhaseCF

public int getPhaseCF(Coords coords)

Description copied from interface: IBuilding

Get the construction factor of the building hex at the passed coords at the start of the current phase. Damage that is received during the phase is applied at the end of the phase.

Specified by:

getPhaseCF in interface IBuilding

Parameters:

coords - the Coords of the hex in question

Returns:

the int value of the building's construction factor at the start of this phase. This value will be greater than or equal to zero.

getArmor

public int getArmor(Coords coords)

Specified by:

getArmor in interface IBuilding

setCurrentCF

public void setCurrentCF(int cf,
 Coords coords)

Description copied from interface: IBuilding

Set the current construction factor of the building hex. Call this method immediately when the building sustains any damage.

Specified by:

setCurrentCF in interface IBuilding

Parameters:

cf - the int value of the building hex's current construction factor. This value must be greater than or equal to zero.

coords - the Coords of the hex in question

setPhaseCF

public void setPhaseCF(int cf,
 Coords coords)

Description copied from interface: IBuilding

Set the construction factor of the building hex for the start of the next phase. Call this method at the end of the phase to apply damage sustained by the building during the phase.

Specified by:

setPhaseCF in interface IBuilding

Parameters:

cf - the int value of the building hex's current construction factor. This value must be greater than or equal to zero.

coords - the Coords of the hex in question

setArmor

public void setArmor(int a,
 Coords coords)

Specified by:

setArmor in interface IBuilding

getHeight

public int getHeight(Coords coords)

Description copied from interface: IBuilding

Get the height (BLDG_ELEV) of the building hex at the passed coords.

Specified by:

getHeight in interface IBuilding

Parameters:

coords - the Coords of the hex in question

Returns:

the int value of the building hex's height. This value will be 0 if the hex is destroyed.

setHeight

public void setHeight(int h,
 Coords coords)

Description copied from interface: IBuilding

Set the height of a specific building hex. Call this method when a hex is destroyed (set to 0).

Specified by:

setHeight in interface IBuilding

Parameters:

h - the int value of the building hex's height. This value must be greater than or equal to zero.

coords - the Coords of the hex in question

getName

public String getName()

Description copied from interface: IBuilding

Get the name of this building.

Specified by:

getName in interface IBuilding

Returns:

the String name of this building.

isBurning

public boolean isBurning(Coords coords)

Description copied from interface: IBuilding

Determine if this building is on fire.

Specified by:

isBurning in interface IBuilding

Returns:

true if the building is on fire.

setBurning

public void setBurning(boolean onFire,
 Coords coords)

Description copied from interface: IBuilding

Set the flag that indicates that this building is on fire.

Specified by:

setBurning in interface IBuilding

Parameters:

onFire - - a boolean value that indicates whether this building is on fire.

addDemolitionCharge

public void addDemolitionCharge(int playerId,
 int damage,
 Coords pos)

Demolition charges anchor to an absolute board hex, which only works for structures that cannot move. BuildingEntity overrides this with a real implementation; MobileStructure must provide its own (or remain unsupported) if mobile structures are ever ruled to be valid demolition targets.

Specified by:

addDemolitionCharge in interface IBuilding

Throws:

UnsupportedOperationException - always; subclasses that support demolition charges must override

removeDemolitionCharge

public void removeDemolitionCharge(DemolitionCharge charge)

Specified by:

removeDemolitionCharge in interface IBuilding

getDemolitionCharges

public List<DemolitionCharge> getDemolitionCharges()

Specified by:

getDemolitionCharges in interface IBuilding

setDemolitionCharges

public void setDemolitionCharges(List<DemolitionCharge> charges)

Specified by:

setDemolitionCharges in interface IBuilding

removeHex

public void removeHex(Coords coords)

Description copied from interface: IBuilding

Remove one building hex from the building

Specified by:

removeHex in interface IBuilding

Parameters:

coords - - the Coords of the hex to be removed

getOriginalHexCount

public int getOriginalHexCount()

Specified by:

getOriginalHexCount in interface IBuilding

getCollapsedHexCount

public int getCollapsedHexCount()

Specified by:

getCollapsedHexCount in interface IBuilding

getBasement

public BasementType getBasement(Coords coords)

Specified by:

getBasement in interface IBuilding

setBasement

public void setBasement(Coords coords,
 BasementType basement)

Specified by:

setBasement in interface IBuilding

setBasementCollapsed

public void setBasementCollapsed(Coords coords,
 boolean collapsed)

Specified by:

setBasementCollapsed in interface IBuilding

updateBuildingEntityHexes

public void updateBuildingEntityHexes(int boardId,
 TWGameManager gameManager)

Once a building entity has set its position, we need to update the board itself and share that with the clients

refreshLocations

public void refreshLocations()

Overrides:

refreshLocations in class Entity

collapseFloorsOnHex

public void collapseFloorsOnHex(Coords coords,
 int numLevelsToCollapse)

Parameters:

coords - Board Coords that contain this building and are collapsing

numLevelsToCollapse - number of floors to collapse, from the top

getNCrew

public int getNCrew()

Calculate building crew based on Advanced Building Minimum Crew Table (TO:AUE). Crew = Non-Gunners + Gunners + Officers

Overrides:

getNCrew in class Entity

Returns:

total crew count

isBoardable

public boolean isBoardable()

Description copied from class: Entity

Determines if this entity can be boarded by infantry for interior combat. Used for TO:AR p. 167 Infantry vs Infantry combat eligibility as a target for initiation. This will eventually include dropships, large naval vessels, and other boardable entities.

Overrides:

isBoardable in class Entity

Returns:

true if infantry can board this entity to initiate interior combat

canReinforceInfantryVsInfantry

public boolean canReinforceInfantryVsInfantry()

Description copied from class: Entity

Determines if this entity can reinforce ongoing infantry vs infantry combat. Default implementation returns false. Infantry units override this.

Overrides:

canReinforceInfantryVsInfantry in class Entity

Returns:

true if this entity can reinforce infantry vs infantry combat