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. |
Type(s)
Fields and Methods inherited from ENUMS | Description |
---|---|
Fields and Methods inherited from ENUMS.AlarmState | Description |
---|---|
AI will automatically switch alarm states based on the presence of threats. The AI kind of cheats in this regard. |
|
Group is not combat ready. Sensors are stowed if possible. |
|
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.FARPObjectTypeNamesAndShape | Description |
---|---|
Fields and Methods inherited from ENUMS.FARPType | Description |
---|---|
Fields and Methods inherited from ENUMS.Formation | Description |
---|---|
Fields and Methods inherited from ENUMS.FormationOld | Description |
---|---|
Fields and Methods inherited from ENUMS.ISOLang | Description |
---|---|
Fields and Methods inherited from ENUMS.Link16Power | Description |
---|---|
Fields and Methods inherited from ENUMS.MissionTask | Description |
---|---|
Forward Air Controller Air. Can perform the tasks: Attack Group, Attack Unit, FAC assign group, Bombing, Attack Map Object. |
|
Naval ops. Can perform the tasks: Attack Group, Attack Unit. |
|
AWACS. |
|
Combat Air Patrol. |
|
Close Air Support. |
|
Escort another group. |
|
Fighter sweep. |
|
Ground attack. |
|
Ground escort another group. |
|
Intercept. |
|
No special task. Group can perform the minimal tasks: Orbit, Refuelling, Follow and Aerobatics. |
|
Pinpoint strike. |
|
Reconnaissance mission. |
|
Refueling mission. |
|
Attack the runway of an airdrome. |
|
Suppression of Enemy Air Defenses. |
|
Troop transport. |
Fields and Methods inherited from ENUMS.Morse | Description |
---|---|
Fields and Methods inherited from ENUMS.Phonetic | Description |
---|---|
Fields and Methods inherited from ENUMS.ROE | Description |
---|---|
[AIR, GROUND, NAVAL] AI will engage only targets specified in its taskings. |
|
[AIR] AI will engage any enemy group it detects, but will prioritize targets specified in the groups tasking. |
|
[AIR, GROUND, NAVAL] AI will only engage threats that shoot first. |
|
[AIR] AI will engage any enemy group it detects. Target prioritization is based based on the threat of the target. |
|
[AIR, GROUND, NAVAL] AI will hold fire under all circumstances. |
Fields and Methods inherited from ENUMS.ROT | Description |
---|---|
If a threat is deemed severe enough the AI will abort its mission and return to base. |
|
AI will attempt to avoid enemy threat zones all together. This includes attempting to fly above or around threats. |
|
AI will react by performing defensive maneuvers against incoming threats. AI will also use passive defense. |
|
No defensive actions will take place to counter threats. |
|
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 |
---|---|
Fields and Methods inherited from ENUMS.Storage | Description |
---|---|
Fields and Methods inherited from ENUMS.WeaponFlag | Description |
---|---|
Even More Genral |
|
Combinations Bombs |
|
Guns |
|
Fields and Methods inherited from ENUMS.WeaponType | Description |
---|---|
Air-to-Air missiles. |
|
Combinations. |
|
Bombs. |
|
Guns. |
|
Missiles. |
|
Rocket. |
|
Torpedos. |
Field(s)
Function(s)
Alarm state.
Field(s)
AI will automatically switch alarm states based on the presence of threats. The AI kind of cheats in this regard.
Group is not combat ready. Sensors are stowed if possible.
Group is combat ready and actively searching for targets. Some groups like infantry will not move in this state.
Function(s)
Field(s)
Function(s)
Field(s)
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)
Forward Air Controller Air. Can perform the tasks: Attack Group, Attack Unit, FAC assign group, Bombing, Attack Map Object.
Naval ops. Can perform the tasks: Attack Group, Attack Unit.
AWACS.
Combat Air Patrol.
Close Air Support.
Escort another group.
Fighter sweep.
Ground attack.
Ground escort another group.
Intercept.
No special task. Group can perform the minimal tasks: Orbit, Refuelling, Follow and Aerobatics.
Pinpoint strike.
Reconnaissance mission.
Refueling mission.
Attack the runway of an airdrome.
Suppression of Enemy Air Defenses.
Troop transport.
Function(s)
Morse Code.
See the Wikipedia.
- Short pulse "*"
- Long pulse "-"
Pulses are separated by a blank character " ".
Field(s)
Function(s)
Phonetic Alphabet (NATO).
See the Wikipedia.
Field(s)
Function(s)
Rules of Engagement.
Field(s)
[AIR, GROUND, NAVAL] AI will engage only targets specified in its taskings.
[AIR] AI will engage any enemy group it detects, but will prioritize targets specified in the groups tasking.
[AIR, GROUND, NAVAL] AI will only engage threats that shoot first.
[AIR] AI will engage any enemy group it detects. Target prioritization is based based on the threat of the target.
[AIR, GROUND, NAVAL] AI will hold fire under all circumstances.
Function(s)
Reaction On Threat.
Field(s)
If a threat is deemed severe enough the AI will abort its mission and return to base.
AI will attempt to avoid enemy threat zones all together. This includes attempting to fly above or around threats.
AI will react by performing defensive maneuvers against incoming threats. AI will also use passive defense.
No defensive actions will take place to counter threats.
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)
Air-To-Surface Missiles
Even More Genral
Guns
Bombs
Rockets
Air-To-Air Missiles
Function(s)
Weapon types by category.
See the Weapon Flag enumerator on hoggit wiki.
Field(s)
Air-to-Air missiles.
Combinations.
Bombs.
Guns.
Missiles.
Rocket.
Torpedos.