Package megamek.common.bays

Class CargoBay

java.lang.Object

megamek.common.bays.Bay

megamek.common.bays.CargoBay

All Implemented Interfaces:

Serializable, Transporter, ITechnology, InfantryTransporter

public final class CargoBay
extends Bay
implements InfantryTransporter

Represents a volume of space set aside for carrying general cargo aboard large spacecraft and mobile structures.

See Also:

• Serialized Form

Field Summary

Fields inherited from class megamek.common.bays.Bay

bayNumber, currentDoors, currentSpace, damage, doors, doorsNext, FACING_PREFIX, FIELD_SEPARATOR, game, loadedThisTurn, minDoors, recoverySlots, totalSpace, troops, unloadedThisTurn, UNSET_BAY

Fields inherited from interface megamek.common.interfaces.ITechnology

DATE_ES, DATE_NONE, DATE_PS

Constructor Summary

Constructors

Constructor	Description
CargoBay(double space, int doors, int bayNumber)	Create a space for the given tonnage of troops.

Method Summary

Modifier and Type	Method	Description
boolean	canLoad(Entity unit)	Determines if this object can accept the given unit.
boolean	canUnloadUnits()
String	getTransporterType()
String	getUnusedString(boolean showRecovery)	Return a string that identifies the unused capacity of this transporter.
boolean	isCargo()
double	spaceForUnit(Entity unit)	Most bay types track space by individual units.
String	toString()	Updated toString() and helpers to normalize bay string output To match new 6-field format: type:space(current or total):doors:bayNumber:infantryType:facing:status bitmap See BLKFile.java:BLKFile constants

Methods inherited from class megamek.common.bays.Bay

artsTechAdvancement, bayString, bayString, bayString, destroyDoor, destroyDoorNext, getBaseAvailability, getBayDamage, getBayNumber, getCapacity, getCargoMpReduction, getCommonDate, getCost, getCurrentDoors, getDefaultSlotDescription, getDoors, getDoorsNext, getDroppableUnits, getExteriorUnitAt, getExternalUnits, getExtinctionDate, getExtinctionDate, getFacing, getIntroductionDate, getIntroductionDate, getLaunchableUnits, getLoadedUnitIds, getLoadedUnits, getMinDoors, getNumberLoadedThisTurn, getNumberUnloadedThisTurn, getPersonnel, getProductionDate, getProductionDate, getPrototypeDate, getPrototypeDate, getReintroductionDate, getReintroductionDate, getSafeLaunchRate, getStaticTechLevel, getTechAdvancement, getTechBase, getTechRating, getTroops, getUnloadableUnits, getUnused, getUnusedSlots, getUnusedString, getWeight, isClan, isMixedTech, isQuarters, isWeaponBlockedAt, load, numDoorsString, resetCounts, resetDoors, resetTransporter, restoreAllDoors, restoreDoor, setBayDamage, setCurrentDoors, setCurrentSpace, setDoors, setDoorsNext, setFacing, setGame, techAdvancement, unload

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface megamek.common.units.InfantryTransporter

getCurrentDoors, getDroppableUnits, getLoadedUnits, getUnused, getUnusedSlots, load

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, getExtinctionRange, getFullRatingName, getFullRatingName, getIntroductionDate, getProductionDate, getPrototypeDate, getReintroductionDate, getSimpleLevel, getSimpleLevel, getSimpleLevel, getStandardRange, getStandardRange, getTechLevel, getTechLevel, getTechRatingName, isAvailableIn, isAvailableIn, isAvailableIn, isExtinct, isExtinct, isExtinct, isIntroLevel, isLegal, isLegal, isUnofficial

Methods inherited from interface megamek.common.equipment.Transporter

alwaysDamageCargoIfTransportHit, canPickupGroundObject, canTow, getCarryables, getNameForRecordSheets, hardpointCost, setEntity

Constructor Details

CargoBay

public CargoBay(double space,
 int doors,
 int bayNumber)

Create a space for the given tonnage of troops. For this class, only the weight of the troops (and their equipment) are considered; if you'd like to think that they are stacked like lumber, be my guest.

Parameters:

space - The weight of troops (in tons) this space can carry.

Method Details

canLoad

public boolean canLoad(Entity unit)

Description copied from interface: Transporter

Determines if this object can accept the given unit. The unit may not be of the appropriate type or there may be no room for the unit.

Specified by:

canLoad in interface InfantryTransporter

Specified by:

canLoad in interface Transporter

Overrides:

canLoad in class Bay

Parameters:

unit - - the Entity to be loaded.

Returns:

true if the unit can be loaded, false otherwise.

canUnloadUnits

public boolean canUnloadUnits()

Overrides:

canUnloadUnits in class Bay

Returns:

True when further doors are available to unload units this turn. This method checks only the state of bay doors, not if it has units left to unload or the status of those.

spaceForUnit

public double spaceForUnit(Entity unit)

Description copied from class: Bay

Most bay types track space by individual units. Infantry bays have variable space requirements and must track by cubicle tonnage.

Specified by:

spaceForUnit in interface InfantryTransporter

Overrides:

spaceForUnit in class Bay

Parameters:

unit - The unit to load/unload.

Returns:

The amount of bay space taken up by the unit.

getUnusedString

public String getUnusedString(boolean showRecovery)

Description copied from class: Bay

Return a string that identifies the unused capacity of this transporter.

Overrides:

getUnusedString in class Bay

Returns:

A String meant for a human.

getTransporterType

public String getTransporterType()

Specified by:

getTransporterType in interface InfantryTransporter

Specified by:

getTransporterType in interface Transporter

toString

public String toString()

Description copied from class: Bay

Updated toString() and helpers to normalize bay string output To match new 6-field format: type:space(current or total):doors:bayNumber:infantryType:facing:status bitmap See BLKFile.java:BLKFile constants

Overrides:

toString in class Bay

isCargo

public boolean isCargo()

Overrides:

isCargo in class Bay

Returns:

true if this bay represents cargo capacity rather than unit transport or crew quarters.