Package megamek.common.alphaStrike

Enum Class BattleForceSUA

java.lang.Object

java.lang.Enum<BattleForceSUA>

megamek.common.alphaStrike.BattleForceSUA

All Implemented Interfaces:

Serializable, Comparable<BattleForceSUA>, Constable

public enum BattleForceSUA
extends Enum<BattleForceSUA>

This enum contains AlphaStrike, BattleForce and (some - WIP) Strategic BattleForce Special Unit Abilities (SUAs) and some utility methods for them.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ABA
AC
AC3
AECM
AERODYNESC
AFC
AM
AMP
AMS
ARM
ARS
ARTAC
ARTAIS
ARTBA
ARTCM12
ARTCM5
ARTCM7
ARTCM9
ARTLT
ARTLTC
ARTS
ARTSC
ARTT
ARTTC
AT
ATAC
ATMO
ATxD
BAR
BFC
BH
BHJ
BHJ2
BHJ3
BIM
BOMB
BRA
BRID
BT
BTAS
C3BSM
C3BSS
C3EM
C3I
C3M
C3RS
C3S
CAP
CAR
CASE
CASEII
CASEP
CK
CKxD
CNARC
COM
CR
CRW
CT
CTxD
D
DB
DCC
DJ
DN
DRO
DT
DUN
ECM
ECS
EE
ENE
ENG
ES
FC
FD
FF
FLK
FR
FUEL
GLD
HELI
HJ
HPG
HT
HTC
IATM
IF
INARC
IRA
IT
ITSM
JAM
JMPS
JMPW
KF
LAM
LEAD
LECM
LF
LG
LMAS
LPRB
LRM
LTAG
MAG
MAS
MASH
MCS
MDS
MEC
MEL
MFB
MHQ
MSL
MSW
MT
MTAS
MTN
MTxD
NC3
NOVA
OMNI
ORO
OVL
PAR
PL
PNT
PRB
PT
PTxD
QUAD
QV
RAIL
RAMS
RBT
RCA
RCN
REAR
REL
RFA
RHS
RSD
SAW
SBF_OMNI
SCAP
SCR
SDCS
SDS
SEAL
SHLD
SLG
SNARC
SOA
SPC
SRCH
SRM
ST
STD
STL
STxD
SUBS
SUBW
TAG
TCP
TELE
TOR
TRI
TRN
TSEMP
TSEMPO
TSI
TSM
TSMX
TUR
UCS
UMU
UNKNOWN
VLG
VR
VRT
VSTOL
VTH
VTHxD
VTM
VTMxD
VTS
VTSxD
WAT
XMEC

Method Summary

Modifier and Type	Method	Description
BattleForceSUA	getDoor()
boolean	isAnyOf(BattleForceSUA sua, BattleForceSUA... furtherSuas)	Returns true if this SUA is equal to any of the given SUAs.
boolean	isArtillery()
boolean	isArtilleryCannon()
boolean	isDoor()
boolean	isTransport()
boolean	isValidAbilityObject(Object abilityObject)
static Map<BattleForceSUA,Object>	parseAlphaStrikeFull(String special)	Tries to parse the given text for a single SUA (not a list) with its additional information, e.g.
String	toString()
boolean	usesASDamageObject()
boolean	usesASDamageVectorObject()
boolean	usesDoubleOrIntegerObject()
boolean	usesIntegerObject()
boolean	usesMapObject()
boolean	usesNoObject()
static BattleForceSUA	valueOf(String name)	Returns the enum constant of this class with the specified name.
static BattleForceSUA[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

UNKNOWN

public static final BattleForceSUA UNKNOWN

PRB

public static final BattleForceSUA PRB

AC

public static final BattleForceSUA AC

AFC

public static final BattleForceSUA AFC

AT

public static final BattleForceSUA AT

ATxD

public static final BattleForceSUA ATxD

AMP

public static final BattleForceSUA AMP

AECM

public static final BattleForceSUA AECM

AM

public static final BattleForceSUA AM

AMS

public static final BattleForceSUA AMS

ARTAIS

public static final BattleForceSUA ARTAIS

ARTAC

public static final BattleForceSUA ARTAC

ARTBA

public static final BattleForceSUA ARTBA

ARTCM5

public static final BattleForceSUA ARTCM5

ARTCM7

public static final BattleForceSUA ARTCM7

ARTCM9

public static final BattleForceSUA ARTCM9

ARTCM12

public static final BattleForceSUA ARTCM12

ARTT

public static final BattleForceSUA ARTT

ARTS

public static final BattleForceSUA ARTS

ARTLT

public static final BattleForceSUA ARTLT

ARTTC

public static final BattleForceSUA ARTTC

ARTSC

public static final BattleForceSUA ARTSC

ARTLTC

public static final BattleForceSUA ARTLTC

ARM

public static final BattleForceSUA ARM

ARS

public static final BattleForceSUA ARS

ATMO

public static final BattleForceSUA ATMO

BAR

public static final BattleForceSUA BAR

BFC

public static final BattleForceSUA BFC

BHJ

public static final BattleForceSUA BHJ

SHLD

public static final BattleForceSUA SHLD

BH

public static final BattleForceSUA BH

BOMB

public static final BattleForceSUA BOMB

BT

public static final BattleForceSUA BT

BRID

public static final BattleForceSUA BRID

C3BSS

public static final BattleForceSUA C3BSS

C3BSM

public static final BattleForceSUA C3BSM

C3EM

public static final BattleForceSUA C3EM

C3M

public static final BattleForceSUA C3M

C3RS

public static final BattleForceSUA C3RS

C3S

public static final BattleForceSUA C3S

C3I

public static final BattleForceSUA C3I

CAR

public static final BattleForceSUA CAR

CK

public static final BattleForceSUA CK

CKxD

public static final BattleForceSUA CKxD

CT

public static final BattleForceSUA CT

CTxD

public static final BattleForceSUA CTxD

CASE

public static final BattleForceSUA CASE

CASEII

public static final BattleForceSUA CASEII

D

public static final BattleForceSUA D

DRO

public static final BattleForceSUA DRO

DCC

public static final BattleForceSUA DCC

DT

public static final BattleForceSUA DT

ES

public static final BattleForceSUA ES

ECM

public static final BattleForceSUA ECM

ENE

public static final BattleForceSUA ENE

ENG

public static final BattleForceSUA ENG

FLK

public static final BattleForceSUA FLK

SEAL

public static final BattleForceSUA SEAL

XMEC

public static final BattleForceSUA XMEC

FR

public static final BattleForceSUA FR

FD

public static final BattleForceSUA FD

HT

public static final BattleForceSUA HT

HELI

public static final BattleForceSUA HELI

HPG

public static final BattleForceSUA HPG

IATM

public static final BattleForceSUA IATM

INARC

public static final BattleForceSUA INARC

IF

public static final BattleForceSUA IF

ITSM

public static final BattleForceSUA ITSM

IT

public static final BattleForceSUA IT

KF

public static final BattleForceSUA KF

LG

public static final BattleForceSUA LG

LEAD

public static final BattleForceSUA LEAD

LPRB

public static final BattleForceSUA LPRB

LECM

public static final BattleForceSUA LECM

LRM

public static final BattleForceSUA LRM

LTAG

public static final BattleForceSUA LTAG

LF

public static final BattleForceSUA LF

MAG

public static final BattleForceSUA MAG

MT

public static final BattleForceSUA MT

MTxD

public static final BattleForceSUA MTxD

MEC

public static final BattleForceSUA MEC

MEL

public static final BattleForceSUA MEL

MAS

public static final BattleForceSUA MAS

LMAS

public static final BattleForceSUA LMAS

MDS

public static final BattleForceSUA MDS

MSW

public static final BattleForceSUA MSW

MASH

public static final BattleForceSUA MASH

MFB

public static final BattleForceSUA MFB

MHQ

public static final BattleForceSUA MHQ

SNARC

public static final BattleForceSUA SNARC

CNARC

public static final BattleForceSUA CNARC

NC3

public static final BattleForceSUA NC3

ORO

public static final BattleForceSUA ORO

OMNI

public static final BattleForceSUA OMNI

PNT

public static final BattleForceSUA PNT

PT

public static final BattleForceSUA PT

PTxD

public static final BattleForceSUA PTxD

RAIL

public static final BattleForceSUA RAIL

RCN

public static final BattleForceSUA RCN

REAR

public static final BattleForceSUA REAR

REL

public static final BattleForceSUA REL

RSD

public static final BattleForceSUA RSD

SAW

public static final BattleForceSUA SAW

SCR

public static final BattleForceSUA SCR

SRCH

public static final BattleForceSUA SRCH

SRM

public static final BattleForceSUA SRM

ST

public static final BattleForceSUA ST

STxD

public static final BattleForceSUA STxD

SDS

public static final BattleForceSUA SDS

SOA

public static final BattleForceSUA SOA

SPC

public static final BattleForceSUA SPC

STL

public static final BattleForceSUA STL

SLG

public static final BattleForceSUA SLG

TAG

public static final BattleForceSUA TAG

MTAS

public static final BattleForceSUA MTAS

BTAS

public static final BattleForceSUA BTAS

TELE

public static final BattleForceSUA TELE

TSM

public static final BattleForceSUA TSM

TUR

public static final BattleForceSUA TUR

TOR

public static final BattleForceSUA TOR

UMU

public static final BattleForceSUA UMU

VRT

public static final BattleForceSUA VRT

VTM

public static final BattleForceSUA VTM

VTMxD

public static final BattleForceSUA VTMxD

VTH

public static final BattleForceSUA VTH

VTHxD

public static final BattleForceSUA VTHxD

VTS

public static final BattleForceSUA VTS

VTSxD

public static final BattleForceSUA VTSxD

VLG

public static final BattleForceSUA VLG

VSTOL

public static final BattleForceSUA VSTOL

WAT

public static final BattleForceSUA WAT

ABA

public static final BattleForceSUA ABA

BRA

public static final BattleForceSUA BRA

BHJ2

public static final BattleForceSUA BHJ2

BHJ3

public static final BattleForceSUA BHJ3

BIM

public static final BattleForceSUA BIM

DN

public static final BattleForceSUA DN

GLD

public static final BattleForceSUA GLD

IRA

public static final BattleForceSUA IRA

LAM

public static final BattleForceSUA LAM

MCS

public static final BattleForceSUA MCS

UCS

public static final BattleForceSUA UCS

NOVA

public static final BattleForceSUA NOVA

CASEP

public static final BattleForceSUA CASEP

QV

public static final BattleForceSUA QV

RHS

public static final BattleForceSUA RHS

RAMS

public static final BattleForceSUA RAMS

ECS

public static final BattleForceSUA ECS

DJ

public static final BattleForceSUA DJ

HJ

public static final BattleForceSUA HJ

RBT

public static final BattleForceSUA RBT

JAM

public static final BattleForceSUA JAM

TSEMP

public static final BattleForceSUA TSEMP

TSEMPO

public static final BattleForceSUA TSEMPO

TSI

public static final BattleForceSUA TSI

VR

public static final BattleForceSUA VR

ATAC

public static final BattleForceSUA ATAC

DB

public static final BattleForceSUA DB

PL

public static final BattleForceSUA PL

TCP

public static final BattleForceSUA TCP

SDCS

public static final BattleForceSUA SDCS

CRW

public static final BattleForceSUA CRW

CR

public static final BattleForceSUA CR

DUN

public static final BattleForceSUA DUN

EE

public static final BattleForceSUA EE

FC

public static final BattleForceSUA FC

FF

public static final BattleForceSUA FF

MTN

public static final BattleForceSUA MTN

OVL

public static final BattleForceSUA OVL

PAR

public static final BattleForceSUA PAR

TSMX

public static final BattleForceSUA TSMX

RCA

public static final BattleForceSUA RCA

RFA

public static final BattleForceSUA RFA

HTC

public static final BattleForceSUA HTC

TRN

public static final BattleForceSUA TRN

SUBS

public static final BattleForceSUA SUBS

SUBW

public static final BattleForceSUA SUBW

JMPS

public static final BattleForceSUA JMPS

JMPW

public static final BattleForceSUA JMPW

CAP

public static final BattleForceSUA CAP

SCAP

public static final BattleForceSUA SCAP

FUEL

public static final BattleForceSUA FUEL

MSL

public static final BattleForceSUA MSL

AC3

public static final BattleForceSUA AC3

COM

public static final BattleForceSUA COM

SBF_OMNI

public static final BattleForceSUA SBF_OMNI

STD

public static final BattleForceSUA STD

TRI

public static final BattleForceSUA TRI

QUAD

public static final BattleForceSUA QUAD

AERODYNESC

public static final BattleForceSUA AERODYNESC

Method Details

values

public static BattleForceSUA[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static BattleForceSUA valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

isTransport

public boolean isTransport()

Returns:

True when this SUA is an ability that may be associated with a Door value (not IT and DT!).

isDoor

public boolean isDoor()

Returns:

True when this SUA is a door ability for a transport ability.

getDoor

public BattleForceSUA getDoor()

Returns:

The Door SUA associated with this SUA. Returns UNKNOWN when this SUA is not a transport SUA.

isArtillery

public boolean isArtillery()

Returns:

True when this SUA is an artillery SUA such as ARTAIS, including artillery cannon SUAs.

isArtilleryCannon

public boolean isArtilleryCannon()

Returns:

True when this SUA is an artillery cannon SUA such as ARTSC for the Sniper Cannon.

toString

public String toString()

Overrides:

toString in class Enum<BattleForceSUA>

isAnyOf

public boolean isAnyOf(BattleForceSUA sua,
 BattleForceSUA... furtherSuas)

Returns true if this SUA is equal to any of the given SUAs.

usesIntegerObject

public boolean usesIntegerObject()

Returns:

True when this SUA uses an Integer as its value.

usesDoubleOrIntegerObject

public boolean usesDoubleOrIntegerObject()

Returns:

True when this SUA uses an Integer or Double value (the transport SUAs).

usesASDamageObject

public boolean usesASDamageObject()

Returns:

True when this SUA uses an ASDamage as its value (only IF).

usesASDamageVectorObject

public boolean usesASDamageVectorObject()

Returns:

True when this SUA uses an ASDamageVector as its value, e.g. FLK.

usesMapObject

public boolean usesMapObject()

Returns:

True when this SUA uses a Map as its value (LAM and BIM).

usesNoObject

public boolean usesNoObject()

Returns:

True when this SUA is not accompanied by a value, e.g. TAG.

isValidAbilityObject

public boolean isValidAbilityObject(Object abilityObject)

Returns:

True when the given abilityObject is a valid value for this SUA. E.g. an ASDamageVector is valid for LRM.

parseAlphaStrikeFull

public static Map<BattleForceSUA,Object> parseAlphaStrikeFull(@Nullable
 String special)

Tries to parse the given text for a single SUA (not a list) with its additional information, e.g. "ECM", "SRM2/2", "ARTAIS-2" or "AT34D2". Returns a map of found SUAs linking to their value, if any, such as 2/2, 0* or 3.158. Typically the map will contain exactly one SUA. In some cases, e.g. transport SUAs, the map may have two SUAs, namely the transport (AT) and the door count (ATxD). If the SUA cannot be parsed entirely, the returned map is empty.

Parameters:

special - The text for a single SUA as formatted on the card

Returns:

The SUA(s) and their value, if any; an empty map when an error occurs during parsing