Package megamek.common.loaders

Class BLKFile

java.lang.Object

megamek.common.loaders.BLKFile

Direct Known Subclasses:

BLKAeroSpaceFighterFile, BLKBattleArmorFile, BLKConvFighterFile, BLKDropshipFile, BLKFixedWingSupportFile, BLKGunEmplacementFile, BLKHandheldWeaponFile, BLKInfantryFile, BLKJumpshipFile, BLKLargeSupportTankFile, BLKMekFile, BLKProtoMekFile, BLKSmallCraftFile, BLKSpaceStationFile, BLKStructureFile, BLKSupportTankFile, BLKSupportVTOLFile, BLKTankFile, BLKVTOLFile, BLKWarshipFile

public class BLKFile
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BLKFile.ParsedBayInfo	Class that holds data relating to transport bays and functionality to parse .blk file transport bay entries

Field Summary

Fields

Modifier and Type	Field	Description
static final int	BATTERY
static final int	COMPACT
static final int	EXTERNAL
static final int	FISSION
static final int	FUELCELL
static final int	FUSION
static final int	ICE
static final int	LIGHT
static final int	MAGLEV
static final int	NONE
static final int	SOLAR
static final int	STEAM
static final String	UNIT_FILE_UUID
static final int	XL
static final int	XXL

Constructor Summary

Constructors

Constructor	Description
BLKFile()

Method Summary

Modifier and Type	Method	Description
protected void	addTransports(Entity e)
void	checkManualBV(Entity e)
int	defaultAeroVGLFacing(int location, boolean rearFacing)
protected int	defaultVGLFacing(int location, boolean rear)	If a vehicular grenade launcher does not have a facing provided, assign a default facing.
static void	encode(File file, Entity t)
static void	encode(String fileName, Entity t)
static BuildingBlock	getBlock(Entity t)
protected EquipmentType	getEquipmentType(Entity entity, String equipmentName)
boolean	isMine()
protected void	loadEquipment(Entity t, String sName, int nLoc)
protected void	loadInvalidSourceBuildReasons(Entity entity)
protected void	loadQuirks(Entity entity)
protected void	loadSlotlessEquipment(Entity t)	Loads slotless equipment (equipment at LOC_NONE) such as cockpit modifications.
protected void	loadSVArmor(Entity sv)
protected void	resetCrew(Entity entity)
protected void	setArmorTechLevelFromDataFile(Entity entity)	Sets the armor tech level for the entity based on the data file.
protected void	setBasicEntityData(Entity entity)
void	setFluff(Entity e)
void	setTechLevel(Entity e)

Methods inherited from class java.lang.Object

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

Field Details

UNIT_FILE_UUID

public static final String UNIT_FILE_UUID

See Also:

• Constant Field Values

FUSION

public static final int FUSION

See Also:

• Constant Field Values

ICE

public static final int ICE

See Also:

• Constant Field Values

XL

public static final int XL

See Also:

• Constant Field Values

XXL

public static final int XXL

See Also:

• Constant Field Values

LIGHT

public static final int LIGHT

See Also:

• Constant Field Values

COMPACT

public static final int COMPACT

See Also:

• Constant Field Values

FUELCELL

public static final int FUELCELL

See Also:

• Constant Field Values

FISSION

public static final int FISSION

See Also:

• Constant Field Values

NONE

public static final int NONE

See Also:

• Constant Field Values

MAGLEV

public static final int MAGLEV

See Also:

• Constant Field Values

STEAM

public static final int STEAM

See Also:

• Constant Field Values

BATTERY

public static final int BATTERY

See Also:

• Constant Field Values

SOLAR

public static final int SOLAR

See Also:

• Constant Field Values

EXTERNAL

public static final int EXTERNAL

See Also:

• Constant Field Values

Constructor Details

BLKFile

public BLKFile()

Method Details

defaultVGLFacing

protected int defaultVGLFacing(int location,
 boolean rear)

If a vehicular grenade launcher does not have a facing provided, assign a default facing. The vehicle location determines this. For ProtoMeks the only legal location is the torso, but it may be mounted rear-facing.

Parameters:

location - The location where the VGL is mounted.

rear - Whether the VGL is rear-facing.

Returns:

The facing to assign to the VGL.

setBasicEntityData

protected void setBasicEntityData(Entity entity)
                           throws EntityLoadingException

Throws:

EntityLoadingException

loadInvalidSourceBuildReasons

protected void loadInvalidSourceBuildReasons(Entity entity)

loadQuirks

protected void loadQuirks(Entity entity)
                   throws EntityLoadingException

Throws:

EntityLoadingException

defaultAeroVGLFacing

public int defaultAeroVGLFacing(int location,
 boolean rearFacing)

getEquipmentType

protected EquipmentType getEquipmentType(Entity entity,
 String equipmentName)

loadEquipment

protected void loadEquipment(Entity t,
 String sName,
 int nLoc)
                      throws EntityLoadingException

Throws:

EntityLoadingException

loadSlotlessEquipment

protected void loadSlotlessEquipment(Entity t)
                              throws EntityLoadingException

Loads slotless equipment (equipment at LOC_NONE) such as cockpit modifications. This equipment has no location but still needs to be saved and loaded.

Parameters:

t - the entity to load equipment into

Throws:

EntityLoadingException - if the equipment cannot be loaded

loadSVArmor

protected void loadSVArmor(Entity sv)
                    throws EntityLoadingException

Throws:

EntityLoadingException

isMine

public boolean isMine()

setFluff

public void setFluff(Entity e)

checkManualBV

public void checkManualBV(Entity e)

setTechLevel

public void setTechLevel(Entity e)
                  throws EntityLoadingException

Throws:

EntityLoadingException

getBlock

public static BuildingBlock getBlock(Entity t)
                              throws EntitySavingException

Throws:

EntitySavingException

encode

public static void encode(String fileName,
 Entity t)
                   throws EntitySavingException

Throws:

EntitySavingException

encode

public static void encode(File file,
 Entity t)
                   throws EntitySavingException

Throws:

EntitySavingException

addTransports

protected void addTransports(Entity e)
                      throws EntityLoadingException

Throws:

EntityLoadingException

setArmorTechLevelFromDataFile

protected void setArmorTechLevelFromDataFile(Entity entity)

Sets the armor tech level for the entity based on the data file. The file should have "armor_tech_level", but it was changed from "armor_tech". And if this isn't found for some reason, it'll fall back and use the entity's tech base to determine this.

Parameters:

entity - entity that should have its armor tech level set based on the data file

resetCrew

protected void resetCrew(Entity entity)