Banner Image

Module Utilities.Enums

Utilities Enumerators.

An enumerator is a variable that holds a constant value. Enumerators are very useful because they make the code easier to read and to change in general.

For example, instead of using the same value at multiple different places in your code, you should use a variable set to that value. If, for whatever reason, the value needs to be changed, you only have to change the variable once and do not have to search through you code and reset every value by hand.

Another big advantage is that the LDT intellisense "knows" the enumerators. So you can use the autocompletion feature and do not have to keep all the values in your head or look them up in the docs.

DCS itself provides a lot of enumerators for various things. See Enumerators on Hoggit.

Other Moose classes also have enumerators. For example, the AIRBASE class has enumerators for airbase names.

Global(s)

Global ENUMS

Because ENUMS are just better practice.

#ENUMS ENUMS

Because ENUMS are just better practice.

The ENUMS class adds some handy variables, which help you to make your code better and more general.

Type(s)

Fields and Methods inherited from ENUMS.AlarmState Description

ENUMS.AlarmState.Auto

AI will automatically switch alarm states based on the presence of threats. The AI kind of cheats in this regard.

ENUMS.AlarmState.Green

Group is not combat ready. Sensors are stowed if possible.

ENUMS.AlarmState.Red

Group is combat ready and actively searching for targets. Some groups like infantry will not move in this state.

Fields and Methods inherited from ENUMS.Formation Description

ENUMS.Formation.FixedWing

ENUMS.Formation.RotaryWing

ENUMS.Formation.Vehicle

Fields and Methods inherited from ENUMS.FormationOld Description

ENUMS.FormationOld.FixedWing

ENUMS.FormationOld.RotaryWing

Fields and Methods inherited from ENUMS.Link16Power Description

ENUMS.Link16Power.high

ENUMS.Link16Power.low

ENUMS.Link16Power.medium

ENUMS.Link16Power.none

Fields and Methods inherited from ENUMS.MissionTask Description

ENUMS.MissionTask.AFAC

Forward Air Controller Air. Can perform the tasks: Attack Group, Attack Unit, FAC assign group, Bombing, Attack Map Object.

ENUMS.MissionTask.ANTISHIPSTRIKE

Naval ops. Can perform the tasks: Attack Group, Attack Unit.

ENUMS.MissionTask.AWACS

AWACS.

ENUMS.MissionTask.CAP

Combat Air Patrol.

ENUMS.MissionTask.CAS

Close Air Support.

ENUMS.MissionTask.ESCORT

Escort another group.

ENUMS.MissionTask.FIGHTERSWEEP

Fighter sweep.

ENUMS.MissionTask.GROUNDATTACK

Ground attack.

ENUMS.MissionTask.GROUNDESCORT

Ground escort another group.

ENUMS.MissionTask.INTERCEPT

Intercept.

ENUMS.MissionTask.NOTHING

No special task. Group can perform the minimal tasks: Orbit, Refuelling, Follow and Aerobatics.

ENUMS.MissionTask.PINPOINTSTRIKE

Pinpoint strike.

ENUMS.MissionTask.RECONNAISSANCE

Reconnaissance mission.

ENUMS.MissionTask.REFUELING

Refueling mission.

ENUMS.MissionTask.RUNWAYATTACK

Attack the runway of an airdrome.

ENUMS.MissionTask.SEAD

Suppression of Enemy Air Defenses.

ENUMS.MissionTask.TRANSPORT

Troop transport.

Fields and Methods inherited from ENUMS.ROE Description

ENUMS.ROE.OpenFire

[AIR, GROUND, NAVAL] AI will engage only targets specified in its taskings.

ENUMS.ROE.OpenFireWeaponFree

[AIR] AI will engage any enemy group it detects, but will prioritize targets specified in the groups tasking.

ENUMS.ROE.ReturnFire

[AIR, GROUND, NAVAL] AI will only engage threats that shoot first.

ENUMS.ROE.WeaponFree

[AIR] AI will engage any enemy group it detects. Target prioritization is based based on the threat of the target.

ENUMS.ROE.WeaponHold

[AIR, GROUND, NAVAL] AI will hold fire under all circumstances.

Fields and Methods inherited from ENUMS.ROT Description

ENUMS.ROT.AllowAbortMission

If a threat is deemed severe enough the AI will abort its mission and return to base.

ENUMS.ROT.BypassAndEscape

AI will attempt to avoid enemy threat zones all together. This includes attempting to fly above or around threats.

ENUMS.ROT.EvadeFire

AI will react by performing defensive maneuvers against incoming threats. AI will also use passive defense.

ENUMS.ROT.NoReaction

No defensive actions will take place to counter threats.

ENUMS.ROT.PassiveDefense

AI will use jammers and other countermeasures in an attempt to defeat the threat. AI will not attempt a maneuver to defeat a threat.

Fields and Methods inherited from ENUMS.ReportingName Description

ENUMS.ReportingName.NATO

Fields and Methods inherited from ENUMS.Storage Description

ENUMS.Storage.weapons

Fields and Methods inherited from ENUMS.WeaponType Description

ENUMS.WeaponType.AAM

Air-to-Air missiles.

ENUMS.WeaponType.Any

Combinations.

ENUMS.WeaponType.Bomb

Bombs.

ENUMS.WeaponType.Gun

Guns.

ENUMS.WeaponType.Missile

Missiles.

ENUMS.WeaponType.Rocket

Rocket.

ENUMS.WeaponType.Torpedo

Torpedos.

Alarm state.

Field(s)

#number ENUMS.AlarmState.Auto

AI will automatically switch alarm states based on the presence of threats. The AI kind of cheats in this regard.

#number ENUMS.AlarmState.Green

Group is not combat ready. Sensors are stowed if possible.

#number ENUMS.AlarmState.Red

Group is combat ready and actively searching for targets. Some groups like infantry will not move in this state.

Function(s)

Formations (new).

See the Formations on hoggit wiki.

Field(s)

Function(s)

Formations (old).

The old format is a simplified version of the new formation enums, which allow more sophisticated settings. See the Formations on hoggit wiki.

Field(s)

Function(s)

ISO (639-1) 2-letter Language Codes.

See the Wikipedia.

Field(s)

Function(s)

Enums for Link16 transmit power

Field(s)

Function(s)

Mission tasks.

Field(s)

#string ENUMS.MissionTask.AFAC

Forward Air Controller Air. Can perform the tasks: Attack Group, Attack Unit, FAC assign group, Bombing, Attack Map Object.

#string ENUMS.MissionTask.ANTISHIPSTRIKE

Naval ops. Can perform the tasks: Attack Group, Attack Unit.

#string ENUMS.MissionTask.AWACS

AWACS.

#string ENUMS.MissionTask.CAP

Combat Air Patrol.

#string ENUMS.MissionTask.CAS

Close Air Support.

#string ENUMS.MissionTask.ESCORT

Escort another group.

#string ENUMS.MissionTask.FIGHTERSWEEP

Fighter sweep.

#string ENUMS.MissionTask.GROUNDATTACK

Ground attack.

#string ENUMS.MissionTask.GROUNDESCORT

Ground escort another group.

#string ENUMS.MissionTask.INTERCEPT

Intercept.

#string ENUMS.MissionTask.NOTHING

No special task. Group can perform the minimal tasks: Orbit, Refuelling, Follow and Aerobatics.

#string ENUMS.MissionTask.PINPOINTSTRIKE

Pinpoint strike.

#string ENUMS.MissionTask.RECONNAISSANCE

Reconnaissance mission.

#string ENUMS.MissionTask.REFUELING

Refueling mission.

#string ENUMS.MissionTask.RUNWAYATTACK

Attack the runway of an airdrome.

#string ENUMS.MissionTask.SEAD

Suppression of Enemy Air Defenses.

#string ENUMS.MissionTask.TRANSPORT

Troop transport.

Function(s)

Morse Code.

See the Wikipedia.

  • Short pulse "*"
  • Long pulse "-"

Pulses are separated by a blank character " ".

Field(s)

#string ENUMS.Morse.
#string ENUMS.Morse.A
#string ENUMS.Morse.B
#string ENUMS.Morse.C
#string ENUMS.Morse.D
#string ENUMS.Morse.E
#string ENUMS.Morse.F
#string ENUMS.Morse.G
#string ENUMS.Morse.H
#string ENUMS.Morse.I
#string ENUMS.Morse.J
#string ENUMS.Morse.K
#string ENUMS.Morse.L
#string ENUMS.Morse.M
#string ENUMS.Morse.N
#string ENUMS.Morse.N0
#string ENUMS.Morse.N1
#string ENUMS.Morse.N2
#string ENUMS.Morse.N3
#string ENUMS.Morse.N4
#string ENUMS.Morse.N5
#string ENUMS.Morse.N6
#string ENUMS.Morse.N7
#string ENUMS.Morse.N8
#string ENUMS.Morse.N9
#string ENUMS.Morse.O
#string ENUMS.Morse.P
#string ENUMS.Morse.Q
#string ENUMS.Morse.R
#string ENUMS.Morse.S
#string ENUMS.Morse.T
#string ENUMS.Morse.U
#string ENUMS.Morse.V
#string ENUMS.Morse.W
#string ENUMS.Morse.X
#string ENUMS.Morse.Y
#string ENUMS.Morse.Z

Function(s)

Phonetic Alphabet (NATO).

See the Wikipedia.

Field(s)

Function(s)

Rules of Engagement.

Field(s)

#number ENUMS.ROE.OpenFire

[AIR, GROUND, NAVAL] AI will engage only targets specified in its taskings.

#number ENUMS.ROE.OpenFireWeaponFree

[AIR] AI will engage any enemy group it detects, but will prioritize targets specified in the groups tasking.

#number ENUMS.ROE.ReturnFire

[AIR, GROUND, NAVAL] AI will only engage threats that shoot first.

#number ENUMS.ROE.WeaponFree

[AIR] AI will engage any enemy group it detects. Target prioritization is based based on the threat of the target.

#number ENUMS.ROE.WeaponHold

[AIR, GROUND, NAVAL] AI will hold fire under all circumstances.

Function(s)

Reaction On Threat.

Field(s)

#number ENUMS.ROT.AllowAbortMission

If a threat is deemed severe enough the AI will abort its mission and return to base.

#number ENUMS.ROT.BypassAndEscape

AI will attempt to avoid enemy threat zones all together. This includes attempting to fly above or around threats.

#number ENUMS.ROT.EvadeFire

AI will react by performing defensive maneuvers against incoming threats. AI will also use passive defense.

#number ENUMS.ROT.NoReaction

No defensive actions will take place to counter threats.

#number ENUMS.ROT.PassiveDefense

AI will use jammers and other countermeasures in an attempt to defeat the threat. AI will not attempt a maneuver to defeat a threat.

Function(s)

Reporting Names (NATO).

See the Wikipedia. DCS known aircraft types

Field(s)

Function(s)

Enums for the STORAGE class for stores - which need to be in ""

Field(s)

Function(s)

Weapon types.

See the Weapon Flag enumerotor on hoggit wiki.

Field(s)

#number ENUMS.WeaponFlag.AntiRadarMissile

Air-To-Surface Missiles

#number ENUMS.WeaponFlag.Auto

Even More Genral

#number ENUMS.WeaponFlag.GuidedBomb

Combinations

Bombs

#number ENUMS.WeaponFlag.LGB

Bombs

#number ENUMS.WeaponFlag.SRAM

Air-To-Air Missiles

Function(s)

Weapon types by category.

See the Weapon Flag enumerator on hoggit wiki.

Field(s)

#table ENUMS.WeaponType.AAM

Air-to-Air missiles.

#table ENUMS.WeaponType.Any

Combinations.

#table ENUMS.WeaponType.Bomb

Bombs.

#table ENUMS.WeaponType.Gun

Guns.

#table ENUMS.WeaponType.Missile

Missiles.

#table ENUMS.WeaponType.Rocket

Rocket.

#table ENUMS.WeaponType.Torpedo

Torpedos.

Function(s)