Package megamek.common.loaders

Class MULParser

java.lang.Object

megamek.common.loaders.MULParser

public class MULParser
extends Object

Class for reading in and parsing MUL XML files. The MUL xsl is defined in the docs' directory.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ATTR_ADVANTAGES
static final String	ATTR_ALTITUDE
static final String	ATTR_ARMOR_DIVISOR
static final String	ATTR_ARMOR_ENC
static final String	ATTR_ARMOR_HIT
static final String	ATTR_ARMOR_NAME
static final String	ATTR_ARTILLERY
static final String	ATTR_AUTO_EJECT
static final String	ATTR_AVIONICS
static final String	ATTR_BA_APM_MOUNT_NUM
static final String	ATTR_BA_APM_TYPE_NAME
static final String	ATTR_BA_MEA_MOUNT_LOC
static final String	ATTR_BA_MEA_TYPE_NAME
static final String	ATTR_C3_MASTER_IS
static final String	ATTR_C3UUID
static final String	ATTR_CAMO_CATEGORY
static final String	ATTR_CAMO_FILENAME
static final String	ATTR_CAMO_OVERLAY_COLOR
static final String	ATTR_CAMO_OVERLAY_DIRECTION
static final String	ATTR_CAMO_OVERLAY_STYLE
static final String	ATTR_CAMO_ROTATION
static final String	ATTR_CAMO_SCALE
static final String	ATTR_CAPACITY
static final String	ATTR_CAT_PORTRAIT
static final String	ATTR_CHASSIS	The names of attributes generally associated with Entity tags
static final String	ATTR_CIC
static final String	ATTR_CLAN_PILOT
static final String	ATTR_COMMAND_B
static final String	ATTR_COMMANDER
static final String	ATTR_COND_EJECT_AMMO
static final String	ATTR_COND_EJECT_CT_DEST
static final String	ATTR_COND_EJECT_ENGINE
static final String	ATTR_COND_EJECT_HEAD_SHOT
static final String	ATTR_CREW_TYPE
static final String	ATTR_DAMAGE
static final String	ATTR_DAMAGE_TAKEN
static final String	ATTR_DEPLOYMENT
static final String	ATTR_DEPLOYMENT_ZONE
static final String	ATTR_DEPLOYMENT_ZONE_ANY_NWX
static final String	ATTR_DEPLOYMENT_ZONE_ANY_NWY
static final String	ATTR_DEPLOYMENT_ZONE_ANY_SEX
static final String	ATTR_DEPLOYMENT_ZONE_ANY_SEY
static final String	ATTR_DEPLOYMENT_ZONE_OFFSET
static final String	ATTR_DEPLOYMENT_ZONE_WIDTH
static final String	ATTR_DEST_ARMOR
static final String	ATTR_DESTROY_CHECK	The current (damage-lowered) Destroy Check of a Battlefield Support Asset.
static final String	ATTR_DIC_DISABLED
static final String	ATTR_DIRECTION
static final String	ATTR_DISPOSABLE_WEAPON
static final String	ATTR_DISPOSABLE_WEAPON_FIRED
static final String	ATTR_DOCKING_COLLAR
static final String	ATTR_DRIVER
static final String	ATTR_EDGE
static final String	ATTR_EI_IMPLANTS
static final String	ATTR_EI_MODE
static final String	ATTR_EJECTED
static final String	ATTR_ELEVATION
static final String	ATTR_ENGINE
static final String	ATTR_ENTITY_FORM	Distinguishes alternate entity forms that can share the same chassis/model name.
static final String	ATTR_EXT_ID
static final String	ATTR_FATIGUE
static final String	ATTR_FCS
static final String	ATTR_FILE_PORTRAIT
static final String	ATTR_FILENAME
static final String	ATTR_FORCE
static final String	ATTR_GEAR
static final String	ATTR_GENDER
static final String	ATTR_GUNNERY
static final String	ATTR_GUNNERY_AERO
static final String	ATTR_GUNNERY_AERO_B
static final String	ATTR_GUNNERY_AERO_L
static final String	ATTR_GUNNERY_AERO_M
static final String	ATTR_GUNNERY_B
static final String	ATTR_GUNNERY_L
static final String	ATTR_GUNNERY_M
static final String	ATTR_HIDDEN
static final String	ATTR_HITS
static final String	ATTR_ID
static final String	ATTR_IMPLANTS
static final String	ATTR_INDEX
static final String	ATTR_INF_SPEC
static final String	ATTR_INF_SQUAD_NUM
static final String	ATTR_INFERNO
static final String	ATTR_INIT_B
static final String	ATTR_INTEGRITY
static final String	ATTR_INTERNAL
static final String	ATTR_IS_DESTROYED
static final String	ATTR_IS_HIT
static final String	ATTR_IS_MISSING
static final String	ATTR_IS_REAR
static final String	ATTR_IS_REPAIRABLE
static final String	ATTR_IS_TURRETED
static final String	ATTR_KF_BOOM
static final String	ATTR_KILLED
static final String	ATTR_KILLER
static final String	ATTR_LEFT
static final String	ATTR_LEFT_THRUST
static final String	ATTR_LIFE_SUPPORT
static final String	ATTR_LINK
static final String	ATTR_LOAD
static final String	ATTR_MODEL
static final String	ATTR_MUNITION
static final String	ATTR_NAME	The names of the attributes recognized by this parser.
static final String	ATTR_NEVER_DEPLOYED
static final String	ATTR_NICK
static final String	ATTR_NUMBER
static final String	ATTR_OFFBOARD
static final String	ATTR_OFFBOARD_DIRECTION
static final String	ATTR_OFFBOARD_DISTANCE
static final String	ATTR_PENALTY
static final String	ATTR_PICKUP_ID
static final String	ATTR_PILOTING
static final String	ATTR_PILOTING_AERO
static final String	ATTR_POINTS
static final String	ATTR_PROSTHETIC_ENHANCEMENT_1
static final String	ATTR_PROSTHETIC_ENHANCEMENT_1_COUNT
static final String	ATTR_PROSTHETIC_ENHANCEMENT_2
static final String	ATTR_PROSTHETIC_ENHANCEMENT_2_COUNT
static final String	ATTR_QUIRKS
static final String	ATTR_RFMG
static final String	ATTR_RIGHT_THRUST
static final String	ATTR_SENSORS
static final String	ATTR_SHOTS
static final String	ATTR_SINK
static final String	ATTR_SIZE
static final String	ATTR_SLOT
static final String	ATTR_SNEAK_CAMO
static final String	ATTR_SNEAK_ECM
static final String	ATTR_SNEAK_IR
static final String	ATTR_SPACESUIT
static final String	ATTR_STANDARD
static final String	ATTR_TOUGH
static final String	ATTR_TROOPER_MISS
static final String	ATTR_TYPE
static final String	ATTR_UNIT_FILE_UUID	The unit-file UUID.
static final String	ATTR_VELOCITY
static final String	ATTR_WEAPONS_BAY_INDEX
static final String	ELE_AERO_CRIT
static final String	ELE_ALLIES
static final String	ELE_ARMOR
static final String	ELE_BA_APM
static final String	ELE_BA_MEA
static final String	ELE_BAY
static final String	ELE_BAY_DAMAGE
static final String	ELE_BAY_DOORS
static final String	ELE_BLOWN_OFF
static final String	ELE_BOMB
static final String	ELE_BOMBS
static final String	ELE_BREACH
static final String	ELE_C3I
static final String	ELE_C3I_LINK
static final String	ELE_CONSTRUCTION_DATA
static final String	ELE_CONVEYANCE
static final String	ELE_CREW
static final String	ELE_CREWMEMBER
static final String	ELE_DEVASTATED
static final String	ELE_DROP_CRIT
static final String	ELE_ENTITY
static final String	ELE_ESCAPE_CRAFT
static final String	ELE_ESCAPE_CREW
static final String	ELE_ESCAPE_PASSENGERS
static final String	ELE_FORCE
static final String	ELE_FUEL
static final String	ELE_GAME
static final String	ELE_HEAT
static final String	ELE_KF
static final String	ELE_KILL
static final String	ELE_KILLS
static final String	ELE_LOADED
static final String	ELE_LOCATION
static final String	ELE_MOTIVE
static final String	ELE_NC3
static final String	ELE_NC3LINK
static final String	ELE_ORIG_MEN
static final String	ELE_ORIG_PODS
static final String	ELE_PILOT
static final String	ELE_RECORD	The names of the various elements recognized by this parser.
static final String	ELE_RETREATED
static final String	ELE_SAIL
static final String	ELE_SALVAGE
static final String	ELE_SHIP
static final String	ELE_SI
static final String	ELE_SLOT
static final String	ELE_STABILIZER
static final String	ELE_SURVIVORS
static final String	ELE_TANK_CRIT
static final String	ELE_TOWED_UNIT
static final String	ELE_TOWED_UNITS
static final String	ELE_TURRET_LOCK
static final String	ELE_UNIT
static final String	VALUE_BATTLEFIELD_SUPPORT_ASSET
static final String	VALUE_CONSOLE
static final String	VALUE_DEAD	Special values recognized by this parser.
static final String	VALUE_DESTROYED
static final String	VALUE_EMPTY
static final String	VALUE_HIT
static final String	VALUE_INTERNAL
static final String	VALUE_NA
static final String	VALUE_NONE
static final String	VALUE_REAR
static final String	VALUE_SQUADRON
static final String	VALUE_SYSTEM
static final String	VERSION

Constructor Summary

Constructors

Constructor	Description
MULParser(File file, GameOptions options)	This is the standard MULParser constructor for a file.
MULParser(InputStream is, GameOptions options)	This is provided for unit testing only, and should not be part of general parsing.
MULParser(Element element, GameOptions options)	This is the standard MULParser constructor for a single element.

Method Summary

Modifier and Type	Method	Description
Vector<Entity>	getAllies()	Returns a list of all the allied Entity's parsed from the input, should be called after parse.
Vector<Entity>	getDevastated()	Returns a list of all the devastated Entity's parsed from the input, should be called after parse.
Vector<Entity>	getEntities()	Returns a list of all the Entity's parsed from the input, should be called after parse.
Version	getFileVersion()
Hashtable<String,String>	getKills()	Returns the kills hashtable
Vector<Crew>	getPilots()	Returns a list of all the Pilots parsed from the input, should be called after parse.
Vector<Entity>	getRetreated()	Returns a list of all the enemy retreated entities parsed from the input, should be called after parse.
Vector<Entity>	getSalvage()	Returns a list of all the salvaged Entity's parsed from the input, should be called after parse.
Vector<Entity>	getSurvivors()	Returns a list of all the salvaged Entity's parsed from the input, should be called after parse.
String	getWarningMessage()	Get the warning message from the last parse.
boolean	hasWarningMessage()	Determine if unexpected XML entities were encountered during parsing.
boolean	isNewerVersion()
boolean	isOlderVersion()

Methods inherited from class java.lang.Object

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

Field Details

VERSION

public static final String VERSION

See Also:

• Constant Field Values

ELE_RECORD

public static final String ELE_RECORD

The names of the various elements recognized by this parser.

See Also:

• Constant Field Values

ELE_SURVIVORS

public static final String ELE_SURVIVORS

See Also:

• Constant Field Values

ELE_ALLIES

public static final String ELE_ALLIES

See Also:

• Constant Field Values

ELE_SALVAGE

public static final String ELE_SALVAGE

See Also:

• Constant Field Values

ELE_RETREATED

public static final String ELE_RETREATED

See Also:

• Constant Field Values

ELE_DEVASTATED

public static final String ELE_DEVASTATED

See Also:

• Constant Field Values

ELE_UNIT

public static final String ELE_UNIT

See Also:

• Constant Field Values

ELE_ENTITY

public static final String ELE_ENTITY

See Also:

• Constant Field Values

ELE_PILOT

public static final String ELE_PILOT

See Also:

• Constant Field Values

ELE_CREW

public static final String ELE_CREW

See Also:

• Constant Field Values

ELE_CREWMEMBER

public static final String ELE_CREWMEMBER

See Also:

• Constant Field Values

ELE_KILLS

public static final String ELE_KILLS

See Also:

• Constant Field Values

ELE_KILL

public static final String ELE_KILL

See Also:

• Constant Field Values

ELE_LOCATION

public static final String ELE_LOCATION

See Also:

• Constant Field Values

ELE_ARMOR

public static final String ELE_ARMOR

See Also:

• Constant Field Values

ELE_SLOT

public static final String ELE_SLOT

See Also:

• Constant Field Values

ELE_MOTIVE

public static final String ELE_MOTIVE

See Also:

• Constant Field Values

ELE_TURRET_LOCK

public static final String ELE_TURRET_LOCK

See Also:

• Constant Field Values

ELE_SI

public static final String ELE_SI

See Also:

• Constant Field Values

ELE_HEAT

public static final String ELE_HEAT

See Also:

• Constant Field Values

ELE_FUEL

public static final String ELE_FUEL

See Also:

• Constant Field Values

ELE_KF

public static final String ELE_KF

See Also:

• Constant Field Values

ELE_SAIL

public static final String ELE_SAIL

See Also:

• Constant Field Values

ELE_AERO_CRIT

public static final String ELE_AERO_CRIT

See Also:

• Constant Field Values

ELE_DROP_CRIT

public static final String ELE_DROP_CRIT

See Also:

• Constant Field Values

ELE_TANK_CRIT

public static final String ELE_TANK_CRIT

See Also:

• Constant Field Values

ELE_STABILIZER

public static final String ELE_STABILIZER

See Also:

• Constant Field Values

ELE_BREACH

public static final String ELE_BREACH

See Also:

• Constant Field Values

ELE_BLOWN_OFF

public static final String ELE_BLOWN_OFF

See Also:

• Constant Field Values

ELE_C3I

public static final String ELE_C3I

See Also:

• Constant Field Values

ELE_C3I_LINK

public static final String ELE_C3I_LINK

See Also:

• Constant Field Values

ELE_NC3

public static final String ELE_NC3

See Also:

• Constant Field Values

ELE_NC3LINK

public static final String ELE_NC3LINK

See Also:

• Constant Field Values

ELE_ESCAPE_CRAFT

public static final String ELE_ESCAPE_CRAFT

See Also:

• Constant Field Values

ELE_ESCAPE_CREW

public static final String ELE_ESCAPE_CREW

See Also:

• Constant Field Values

ELE_ESCAPE_PASSENGERS

public static final String ELE_ESCAPE_PASSENGERS

See Also:

• Constant Field Values

ELE_ORIG_PODS

public static final String ELE_ORIG_PODS

See Also:

• Constant Field Values

ELE_ORIG_MEN

public static final String ELE_ORIG_MEN

See Also:

• Constant Field Values

ELE_CONVEYANCE

public static final String ELE_CONVEYANCE

See Also:

• Constant Field Values

ELE_TOWED_UNITS

public static final String ELE_TOWED_UNITS

See Also:

• Constant Field Values

ELE_TOWED_UNIT

public static final String ELE_TOWED_UNIT

See Also:

• Constant Field Values

ELE_GAME

public static final String ELE_GAME

See Also:

• Constant Field Values

ELE_FORCE

public static final String ELE_FORCE

See Also:

• Constant Field Values

ELE_BAY

public static final String ELE_BAY

See Also:

• Constant Field Values

ELE_BAY_DOORS

public static final String ELE_BAY_DOORS

See Also:

• Constant Field Values

ELE_BAY_DAMAGE

public static final String ELE_BAY_DAMAGE

See Also:

• Constant Field Values

ELE_BOMBS

public static final String ELE_BOMBS

See Also:

• Constant Field Values

ELE_BOMB

public static final String ELE_BOMB

See Also:

• Constant Field Values

ELE_BA_MEA

public static final String ELE_BA_MEA

See Also:

• Constant Field Values

ELE_BA_APM

public static final String ELE_BA_APM

See Also:

• Constant Field Values

ELE_LOADED

public static final String ELE_LOADED

See Also:

• Constant Field Values

ELE_SHIP

public static final String ELE_SHIP

See Also:

• Constant Field Values

ELE_CONSTRUCTION_DATA

public static final String ELE_CONSTRUCTION_DATA

See Also:

• Constant Field Values

ATTR_CHASSIS

public static final String ATTR_CHASSIS

The names of attributes generally associated with Entity tags

See Also:

• Constant Field Values

ATTR_MODEL

public static final String ATTR_MODEL

See Also:

• Constant Field Values

ATTR_CAMO_CATEGORY

public static final String ATTR_CAMO_CATEGORY

See Also:

• Constant Field Values

ATTR_CAMO_FILENAME

public static final String ATTR_CAMO_FILENAME

See Also:

• Constant Field Values

ATTR_CAMO_ROTATION

public static final String ATTR_CAMO_ROTATION

See Also:

• Constant Field Values

ATTR_CAMO_SCALE

public static final String ATTR_CAMO_SCALE

See Also:

• Constant Field Values

ATTR_CAMO_OVERLAY_STYLE

public static final String ATTR_CAMO_OVERLAY_STYLE

See Also:

• Constant Field Values

ATTR_CAMO_OVERLAY_DIRECTION

public static final String ATTR_CAMO_OVERLAY_DIRECTION

See Also:

• Constant Field Values

ATTR_CAMO_OVERLAY_COLOR

public static final String ATTR_CAMO_OVERLAY_COLOR

See Also:

• Constant Field Values

ATTR_NAME

public static final String ATTR_NAME

The names of the attributes recognized by this parser. Not every attribute is valid for every element.

See Also:

• Constant Field Values

ATTR_SIZE

public static final String ATTR_SIZE

See Also:

• Constant Field Values

ATTR_EXT_ID

public static final String ATTR_EXT_ID

See Also:

• Constant Field Values

ATTR_PICKUP_ID

public static final String ATTR_PICKUP_ID

See Also:

• Constant Field Values

ATTR_CLAN_PILOT

public static final String ATTR_CLAN_PILOT

See Also:

• Constant Field Values

ATTR_NICK

public static final String ATTR_NICK

See Also:

• Constant Field Values

ATTR_GENDER

public static final String ATTR_GENDER

See Also:

• Constant Field Values

ATTR_CAT_PORTRAIT

public static final String ATTR_CAT_PORTRAIT

See Also:

• Constant Field Values

ATTR_FILE_PORTRAIT

public static final String ATTR_FILE_PORTRAIT

See Also:

• Constant Field Values

ATTR_GUNNERY

public static final String ATTR_GUNNERY

See Also:

• Constant Field Values

ATTR_GUNNERY_L

public static final String ATTR_GUNNERY_L

See Also:

• Constant Field Values

ATTR_GUNNERY_M

public static final String ATTR_GUNNERY_M

See Also:

• Constant Field Values

ATTR_GUNNERY_B

public static final String ATTR_GUNNERY_B

See Also:

• Constant Field Values

ATTR_PILOTING

public static final String ATTR_PILOTING

See Also:

• Constant Field Values

ATTR_ARTILLERY

public static final String ATTR_ARTILLERY

See Also:

• Constant Field Values

ATTR_TOUGH

public static final String ATTR_TOUGH

See Also:

• Constant Field Values

ATTR_FATIGUE

public static final String ATTR_FATIGUE

See Also:

• Constant Field Values

ATTR_INIT_B

public static final String ATTR_INIT_B

See Also:

• Constant Field Values

ATTR_COMMAND_B

public static final String ATTR_COMMAND_B

See Also:

• Constant Field Values

ATTR_HITS

public static final String ATTR_HITS

See Also:

• Constant Field Values

ATTR_ADVANTAGES

public static final String ATTR_ADVANTAGES

See Also:

• Constant Field Values

ATTR_EDGE

public static final String ATTR_EDGE

See Also:

• Constant Field Values

ATTR_IMPLANTS

public static final String ATTR_IMPLANTS

See Also:

• Constant Field Values

ATTR_EI_IMPLANTS

public static final String ATTR_EI_IMPLANTS

See Also:

• Constant Field Values

ATTR_EI_MODE

public static final String ATTR_EI_MODE

See Also:

• Constant Field Values

ATTR_PROSTHETIC_ENHANCEMENT_1

public static final String ATTR_PROSTHETIC_ENHANCEMENT_1

See Also:

• Constant Field Values

ATTR_PROSTHETIC_ENHANCEMENT_1_COUNT

public static final String ATTR_PROSTHETIC_ENHANCEMENT_1_COUNT

See Also:

• Constant Field Values

ATTR_PROSTHETIC_ENHANCEMENT_2

public static final String ATTR_PROSTHETIC_ENHANCEMENT_2

See Also:

• Constant Field Values

ATTR_PROSTHETIC_ENHANCEMENT_2_COUNT

public static final String ATTR_PROSTHETIC_ENHANCEMENT_2_COUNT

See Also:

• Constant Field Values

ATTR_QUIRKS

public static final String ATTR_QUIRKS

See Also:

• Constant Field Values

ATTR_TROOPER_MISS

public static final String ATTR_TROOPER_MISS

See Also:

• Constant Field Values

ATTR_DRIVER

public static final String ATTR_DRIVER

See Also:

• Constant Field Values

ATTR_COMMANDER

public static final String ATTR_COMMANDER

See Also:

• Constant Field Values

ATTR_OFFBOARD

public static final String ATTR_OFFBOARD

See Also:

• Constant Field Values

ATTR_OFFBOARD_DISTANCE

public static final String ATTR_OFFBOARD_DISTANCE

See Also:

• Constant Field Values

ATTR_OFFBOARD_DIRECTION

public static final String ATTR_OFFBOARD_DIRECTION

See Also:

• Constant Field Values

ATTR_HIDDEN

public static final String ATTR_HIDDEN

See Also:

• Constant Field Values

ATTR_DEPLOYMENT

public static final String ATTR_DEPLOYMENT

See Also:

• Constant Field Values

ATTR_DEPLOYMENT_ZONE

public static final String ATTR_DEPLOYMENT_ZONE

See Also:

• Constant Field Values

ATTR_DEPLOYMENT_ZONE_WIDTH

public static final String ATTR_DEPLOYMENT_ZONE_WIDTH

See Also:

• Constant Field Values

ATTR_DEPLOYMENT_ZONE_OFFSET

public static final String ATTR_DEPLOYMENT_ZONE_OFFSET

See Also:

• Constant Field Values

ATTR_DEPLOYMENT_ZONE_ANY_NWX

public static final String ATTR_DEPLOYMENT_ZONE_ANY_NWX

See Also:

• Constant Field Values

ATTR_DEPLOYMENT_ZONE_ANY_NWY

public static final String ATTR_DEPLOYMENT_ZONE_ANY_NWY

See Also:

• Constant Field Values

ATTR_DEPLOYMENT_ZONE_ANY_SEX

public static final String ATTR_DEPLOYMENT_ZONE_ANY_SEX

See Also:

• Constant Field Values

ATTR_DEPLOYMENT_ZONE_ANY_SEY

public static final String ATTR_DEPLOYMENT_ZONE_ANY_SEY

See Also:

• Constant Field Values

ATTR_NEVER_DEPLOYED

public static final String ATTR_NEVER_DEPLOYED

See Also:

• Constant Field Values

ATTR_UNIT_FILE_UUID

public static final String ATTR_UNIT_FILE_UUID

The unit-file UUID. Written for every unit that has one and used as the primary lookup on load (the chassis and model remain for backwards-compatibility and readability). It is essential for Battlefield Support Assets, which share a name with their base unit.

See Also:

• Constant Field Values

ATTR_ENTITY_FORM

public static final String ATTR_ENTITY_FORM

Distinguishes alternate entity forms that can share the same chassis/model name.

See Also:

• Constant Field Values

ATTR_DESTROY_CHECK

public static final String ATTR_DESTROY_CHECK

The current (damage-lowered) Destroy Check of a Battlefield Support Asset.

See Also:

• Constant Field Values

ATTR_VELOCITY

public static final String ATTR_VELOCITY

See Also:

• Constant Field Values

ATTR_ALTITUDE

public static final String ATTR_ALTITUDE

See Also:

• Constant Field Values

ATTR_ELEVATION

public static final String ATTR_ELEVATION

See Also:

• Constant Field Values

ATTR_AUTO_EJECT

public static final String ATTR_AUTO_EJECT

See Also:

• Constant Field Values

ATTR_COND_EJECT_AMMO

public static final String ATTR_COND_EJECT_AMMO

See Also:

• Constant Field Values

ATTR_COND_EJECT_ENGINE

public static final String ATTR_COND_EJECT_ENGINE

See Also:

• Constant Field Values

ATTR_COND_EJECT_CT_DEST

public static final String ATTR_COND_EJECT_CT_DEST

See Also:

• Constant Field Values

ATTR_COND_EJECT_HEAD_SHOT

public static final String ATTR_COND_EJECT_HEAD_SHOT

See Also:

• Constant Field Values

ATTR_DIC_DISABLED

public static final String ATTR_DIC_DISABLED

See Also:

• Constant Field Values

ATTR_EJECTED

public static final String ATTR_EJECTED

See Also:

• Constant Field Values

ATTR_INDEX

public static final String ATTR_INDEX

See Also:

• Constant Field Values

ATTR_IS_DESTROYED

public static final String ATTR_IS_DESTROYED

See Also:

• Constant Field Values

ATTR_IS_REPAIRABLE

public static final String ATTR_IS_REPAIRABLE

See Also:

• Constant Field Values

ATTR_ARMOR_HIT

public static final String ATTR_ARMOR_HIT

See Also:

• Constant Field Values

ATTR_POINTS

public static final String ATTR_POINTS

See Also:

• Constant Field Values

ATTR_TYPE

public static final String ATTR_TYPE

See Also:

• Constant Field Values

ATTR_SHOTS

public static final String ATTR_SHOTS

See Also:

• Constant Field Values

ATTR_CAPACITY

public static final String ATTR_CAPACITY

See Also:

• Constant Field Values

ATTR_IS_HIT

public static final String ATTR_IS_HIT

See Also:

• Constant Field Values

ATTR_MUNITION

public static final String ATTR_MUNITION

See Also:

• Constant Field Values

ATTR_STANDARD

public static final String ATTR_STANDARD

See Also:

• Constant Field Values

ATTR_INFERNO

public static final String ATTR_INFERNO

See Also:

• Constant Field Values

ATTR_DIRECTION

public static final String ATTR_DIRECTION

See Also:

• Constant Field Values

ATTR_INTEGRITY

public static final String ATTR_INTEGRITY

See Also:

• Constant Field Values

ATTR_SINK

public static final String ATTR_SINK

See Also:

• Constant Field Values

ATTR_LEFT

public static final String ATTR_LEFT

See Also:

• Constant Field Values

ATTR_AVIONICS

public static final String ATTR_AVIONICS

See Also:

• Constant Field Values

ATTR_SENSORS

public static final String ATTR_SENSORS

See Also:

• Constant Field Values

ATTR_ENGINE

public static final String ATTR_ENGINE

See Also:

• Constant Field Values

ATTR_FCS

public static final String ATTR_FCS

See Also:

• Constant Field Values

ATTR_CIC

public static final String ATTR_CIC

See Also:

• Constant Field Values

ATTR_LEFT_THRUST

public static final String ATTR_LEFT_THRUST

See Also:

• Constant Field Values

ATTR_RIGHT_THRUST

public static final String ATTR_RIGHT_THRUST

See Also:

• Constant Field Values

ATTR_LIFE_SUPPORT

public static final String ATTR_LIFE_SUPPORT

See Also:

• Constant Field Values

ATTR_GEAR

public static final String ATTR_GEAR

See Also:

• Constant Field Values

ATTR_DOCKING_COLLAR

public static final String ATTR_DOCKING_COLLAR

See Also:

• Constant Field Values

ATTR_KF_BOOM

public static final String ATTR_KF_BOOM

See Also:

• Constant Field Values

ATTR_WEAPONS_BAY_INDEX

public static final String ATTR_WEAPONS_BAY_INDEX

See Also:

• Constant Field Values

ATTR_DAMAGE

public static final String ATTR_DAMAGE

See Also:

• Constant Field Values

ATTR_PENALTY

public static final String ATTR_PENALTY

See Also:

• Constant Field Values

ATTR_C3_MASTER_IS

public static final String ATTR_C3_MASTER_IS

See Also:

• Constant Field Values

ATTR_C3UUID

public static final String ATTR_C3UUID

See Also:

• Constant Field Values

ATTR_LOAD

public static final String ATTR_LOAD

See Also:

• Constant Field Values

ATTR_INTERNAL

public static final String ATTR_INTERNAL

See Also:

• Constant Field Values

ATTR_BA_APM_MOUNT_NUM

public static final String ATTR_BA_APM_MOUNT_NUM

See Also:

• Constant Field Values

ATTR_BA_APM_TYPE_NAME

public static final String ATTR_BA_APM_TYPE_NAME

See Also:

• Constant Field Values

ATTR_BA_MEA_MOUNT_LOC

public static final String ATTR_BA_MEA_MOUNT_LOC

See Also:

• Constant Field Values

ATTR_BA_MEA_TYPE_NAME

public static final String ATTR_BA_MEA_TYPE_NAME

See Also:

• Constant Field Values

ATTR_KILLED

public static final String ATTR_KILLED

See Also:

• Constant Field Values

ATTR_KILLER

public static final String ATTR_KILLER

See Also:

• Constant Field Values

ATTR_DAMAGE_TAKEN

public static final String ATTR_DAMAGE_TAKEN

See Also:

• Constant Field Values

ATTR_ARMOR_NAME

public static final String ATTR_ARMOR_NAME

See Also:

• Constant Field Values

ATTR_ARMOR_DIVISOR

public static final String ATTR_ARMOR_DIVISOR

See Also:

• Constant Field Values

ATTR_ARMOR_ENC

public static final String ATTR_ARMOR_ENC

See Also:

• Constant Field Values

ATTR_DEST_ARMOR

public static final String ATTR_DEST_ARMOR

See Also:

• Constant Field Values

ATTR_SPACESUIT

public static final String ATTR_SPACESUIT

See Also:

• Constant Field Values

ATTR_SNEAK_CAMO

public static final String ATTR_SNEAK_CAMO

See Also:

• Constant Field Values

ATTR_SNEAK_IR

public static final String ATTR_SNEAK_IR

See Also:

• Constant Field Values

ATTR_SNEAK_ECM

public static final String ATTR_SNEAK_ECM

See Also:

• Constant Field Values

ATTR_INF_SPEC

public static final String ATTR_INF_SPEC

See Also:

• Constant Field Values

ATTR_DISPOSABLE_WEAPON

public static final String ATTR_DISPOSABLE_WEAPON

See Also:

• Constant Field Values

ATTR_DISPOSABLE_WEAPON_FIRED

public static final String ATTR_DISPOSABLE_WEAPON_FIRED

See Also:

• Constant Field Values

ATTR_INF_SQUAD_NUM

public static final String ATTR_INF_SQUAD_NUM

See Also:

• Constant Field Values

ATTR_RFMG

public static final String ATTR_RFMG

See Also:

• Constant Field Values

ATTR_LINK

public static final String ATTR_LINK

See Also:

• Constant Field Values

ATTR_ID

public static final String ATTR_ID

See Also:

• Constant Field Values

ATTR_NUMBER

public static final String ATTR_NUMBER

See Also:

• Constant Field Values

ATTR_FORCE

public static final String ATTR_FORCE

See Also:

• Constant Field Values

ATTR_SLOT

public static final String ATTR_SLOT

See Also:

• Constant Field Values

ATTR_IS_REAR

public static final String ATTR_IS_REAR

See Also:

• Constant Field Values

ATTR_IS_TURRETED

public static final String ATTR_IS_TURRETED

See Also:

• Constant Field Values

ATTR_IS_MISSING

public static final String ATTR_IS_MISSING

See Also:

• Constant Field Values

ATTR_GUNNERY_AERO

public static final String ATTR_GUNNERY_AERO

See Also:

• Constant Field Values

ATTR_GUNNERY_AERO_L

public static final String ATTR_GUNNERY_AERO_L

See Also:

• Constant Field Values

ATTR_GUNNERY_AERO_M

public static final String ATTR_GUNNERY_AERO_M

See Also:

• Constant Field Values

ATTR_GUNNERY_AERO_B

public static final String ATTR_GUNNERY_AERO_B

See Also:

• Constant Field Values

ATTR_PILOTING_AERO

public static final String ATTR_PILOTING_AERO

See Also:

• Constant Field Values

ATTR_CREW_TYPE

public static final String ATTR_CREW_TYPE

See Also:

• Constant Field Values

ATTR_FILENAME

public static final String ATTR_FILENAME

See Also:

• Constant Field Values

VALUE_DEAD

public static final String VALUE_DEAD

Special values recognized by this parser.

See Also:

• Constant Field Values

VALUE_NA

public static final String VALUE_NA

See Also:

• Constant Field Values

VALUE_DESTROYED

public static final String VALUE_DESTROYED

See Also:

• Constant Field Values

VALUE_REAR

public static final String VALUE_REAR

See Also:

• Constant Field Values

VALUE_INTERNAL

public static final String VALUE_INTERNAL

See Also:

• Constant Field Values

VALUE_EMPTY

public static final String VALUE_EMPTY

See Also:

• Constant Field Values

VALUE_SYSTEM

public static final String VALUE_SYSTEM

See Also:

• Constant Field Values

VALUE_NONE

public static final String VALUE_NONE

See Also:

• Constant Field Values

VALUE_HIT

public static final String VALUE_HIT

See Also:

• Constant Field Values

VALUE_CONSOLE

public static final String VALUE_CONSOLE

See Also:

• Constant Field Values

VALUE_SQUADRON

public static final String VALUE_SQUADRON

See Also:

• Constant Field Values

VALUE_BATTLEFIELD_SUPPORT_ASSET

public static final String VALUE_BATTLEFIELD_SUPPORT_ASSET

See Also:

• Constant Field Values

Constructor Details

MULParser

public MULParser(@Nullable
 File file,
 @Nullable
 GameOptions options)
          throws Exception

This is the standard MULParser constructor for a file. It initializes the values to parse with, then parses the file using the provided options. The options may be null in cases when the crew is not to be loaded as part of the MUL.

Parameters:

file - the file to parse, or null if there isn't anything to parse

options - the game options to parse the MUL with, which may be null (only to be used when the crew is not to be loaded, as no saved optional Crew-based values are loaded).

Throws:

Exception - if there is an issue with parsing the file

MULParser

public MULParser(InputStream is,
 @Nullable
 GameOptions options)
          throws Exception

This is provided for unit testing only, and should not be part of general parsing.

Parameters:

is - the input stream to parse from

options - the game options to parse the MUL with, which may be null (only to be used when the crew is not to be loaded, as no saved optional Crew-based values are loaded).

Throws:

Exception

MULParser

public MULParser(Element element,
 @Nullable
 GameOptions options)

This is the standard MULParser constructor for a single element. It initializes the values to parse with, then parses the element using the provided options. The options may be null in cases when the crew is not to be loaded as part of the MUL.

Parameters:

element - the element to parse

options - the game options to parse the MUL with, which may be null (only to be used when the crew is not to be loaded, as no saved optional Crew-based values are loaded).

Method Details

hasWarningMessage

public boolean hasWarningMessage()

Determine if unexpected XML entities were encountered during parsing.

Returns:

true if a non-fatal warning occurred.

getWarningMessage

public String getWarningMessage()

Get the warning message from the last parse.

Returns:

The String warning message from the last parse. If there is no warning message, then an null value is returned.

getFileVersion

@Nullable
public Version getFileVersion()

Returns:

the MegaMek version this MUL was saved in, or null if the file did not carry a parseable version

isNewerVersion

public boolean isNewerVersion()

Returns:

true if the MUL was saved in a MegaMek version newer than the one currently running. Such a file is never loaded, so getEntities() and the other result accessors will be empty.

isOlderVersion

public boolean isOlderVersion()

Returns:

true if the MUL was saved in an older MegaMek version than the one currently running, or does not carry a parseable version. The file is still parsed, but correct behavior is not guaranteed.

getEntities

public Vector<Entity> getEntities()

Returns a list of all the Entity's parsed from the input, should be called after parse. This is for entities that we want to be loaded into the chat lounge, so functional

getSurvivors

public Vector<Entity> getSurvivors()

Returns a list of all the salvaged Entity's parsed from the input, should be called after parse.

getAllies

public Vector<Entity> getAllies()

Returns a list of all the allied Entity's parsed from the input, should be called after parse.

getSalvage

public Vector<Entity> getSalvage()

Returns a list of all the salvaged Entity's parsed from the input, should be called after parse.

getRetreated

public Vector<Entity> getRetreated()

Returns a list of all the enemy retreated entities parsed from the input, should be called after parse.

getDevastated

public Vector<Entity> getDevastated()

Returns a list of all the devastated Entity's parsed from the input, should be called after parse.

getPilots

public Vector<Crew> getPilots()

Returns a list of all the Pilots parsed from the input, should be called after parse.

getKills

public Hashtable<String,String> getKills()

Returns the kills hashtable