Interface l_coalition

No Self

interface l_coalition {
    service: {
        ATC: number;
        AWACS: number;
        FAC: number;
        MAX: number;
        TANKER: number;
    };
    side: { BLUE: number; NEUTRAL: number; RED: number };
    add_dyn_group(...arguments_: unknown[]): unknown;
    addGroup(
        countryId: number,
        groupCategory: number,
        groupData: CoalitionSpawnData,
    ): l_Group;
    addRefPoint(
        coalitionId: number,
        referencePoint: CoalitionReferencePoint,
    ): void;
    addStaticObject(
        countryId: number,
        objectData: CoalitionSpawnData,
    ): l_StaticObject;
    checkChooseCargo(...arguments_: unknown[]): unknown;
    checkDescent(...arguments_: unknown[]): unknown;
    getAirbases(coalitionId: number): l_Airbase[];
    getAllDescents(...arguments_: unknown[]): unknown;
    getCountryCoalition(countryId: number): number;
    getDescentsOnBoard(...arguments_: unknown[]): unknown;
    getGroups(coalitionId: number, groupCategory?: number): l_Group[];
    getMainRefPoint(coalitionId: number): CoalitionReferencePoint | undefined;
    getPlayers(coalitionId: number): l_Unit[];
    getRefPoints(coalitionId: number): CoalitionReferencePoint[] | undefined;
    getServiceProviders(coalitionId: number, service: number): l_Unit[];
    getStaticObjects(coalitionId: number): l_StaticObject[];
    remove_dyn_group(...arguments_: unknown[]): unknown;
}

Hierarchy (View Summary)

_coalition
- l_coalition

Properties

service

service: {
    ATC: number;
    AWACS: number;
    FAC: number;
    MAX: number;
    TANKER: number;
}

side

side: { BLUE: number; NEUTRAL: number; RED: number }

Methods

add_dyn_group

add_dyn_group(...arguments_: unknown[]): unknown
TODO: dynamic-group UI helper exported by DCS; installed Lua sources do not expose its stable payload contract. Prefer addGroup.
Parameters
- ...arguments_: unknown[]
Returns unknown
Overrides _coalition.add_dyn_group
- Defined in coalition.ts:40

addGroup

addGroup(
    countryId: number,
    groupCategory: number,
    groupData: CoalitionSpawnData,
): l_Group
Dynamically creates a group for a country. The mission-table schema depends on group category.
Parameters
- countryId: number
  Value from country.id.
- groupCategory: number
  Value from Group.Category.
- groupData: CoalitionSpawnData
  Mission-format group data.
Returns l_Group
Created group.
Example
```
`const group = coalition.addGroup(country.id.USA, Group.Category.GROUND, groupData);`
```
See
https://wiki.hoggitworld.com/view/DCS_func_addGroup
Overrides _coalition.addGroup
- Defined in coalition.ts:71

addRefPoint

addRefPoint(coalitionId: number, referencePoint: CoalitionReferencePoint): void
Adds a coalition JTAC reference/navigation point. The callsign, type, and full three-dimensional point are required by DCS.
Parameters
- coalitionId: number
  Value from coalition.side.
- referencePoint: CoalitionReferencePoint
  Complete reference-point data.
Returns void
Nothing.
Example
```
`coalition.addRefPoint(coalition.side.BLUE, { callsign: 1, type: 0, point: { x: 0, y: 0, z: 0 } });`
```
See
https://wiki.hoggitworld.com/view/DCS_func_addRefPoint
Overrides _coalition.addRefPoint
- Defined in coalition.ts:86

addStaticObject

addStaticObject(
countryId: number,
objectData: CoalitionSpawnData,
): l_StaticObject
Dynamically creates a static object for a country.
Parameters
- countryId: number
  Value from country.id.
- objectData: CoalitionSpawnData
  Mission-format static-object data.
Returns l_StaticObject
Created static object.
Example
```
`const object = coalition.addStaticObject(country.id.USA, objectData);`
```
See
https://wiki.hoggitworld.com/view/DCS_func_addStaticObject
Overrides _coalition.addStaticObject
- Defined in coalition.ts:100

checkChooseCargo

checkChooseCargo(...arguments_: unknown[]): unknown
TODO: cargo-choice validation uses an engine-native payload absent from installed scripting documentation.
Parameters
- ...arguments_: unknown[]
Returns unknown
Overrides _coalition.checkChooseCargo
- Defined in coalition.ts:48

checkDescent

checkDescent(...arguments_: unknown[]): unknown
TODO: troop-descent validation uses an engine-native payload absent from installed scripting documentation.
Parameters
- ...arguments_: unknown[]
Returns unknown
Overrides _coalition.checkDescent
- Defined in coalition.ts:52

getAirbases

getAirbases(coalitionId: number): l_Airbase[]
Returns airbase-like objects assigned to a coalition. Results may include map airfields, FARPs, and ships that expose airbase services.
Parameters
- coalitionId: number
  Coalition identifier whose airbases should be returned.
Returns l_Airbase[]
Airbases currently assigned to the coalition.
Example
```
for (const airbase of coalition.getAirbases(coalition.side.BLUE)) {
	env.info(`${airbase.getName()} is blue`);
}
```
See
https://wiki.hoggitworld.com/view/DCS_func_getAirbases
Overrides _coalition.getAirbases
- Defined in coalition.ts:143

getAllDescents

getAllDescents(...arguments_: unknown[]): unknown
TODO: returned descent records have an unpublished, version-dependent engine schema.
Parameters
- ...arguments_: unknown[]
Returns unknown
Overrides _coalition.getAllDescents
- Defined in coalition.ts:56

getCountryCoalition

getCountryCoalition(countryId: number): number
Maps a country to its current coalition.
Parameters
- countryId: number
  Value from country.id.
Returns number
Value from coalition.side.
Example
```
`const side = coalition.getCountryCoalition(country.id.USA);`
```
See
https://wiki.hoggitworld.com/view/DCS_func_getCountryCoalition
Overrides _coalition.getCountryCoalition
- Defined in coalition.ts:211

getDescentsOnBoard

getDescentsOnBoard(...arguments_: unknown[]): unknown
TODO: returned onboard-descent records have an unpublished, version-dependent engine schema.
Parameters
- ...arguments_: unknown[]
Returns unknown
Overrides _coalition.getDescentsOnBoard
- Defined in coalition.ts:60

getGroups

getGroups(coalitionId: number, groupCategory?: number): l_Group[]
Returns groups belonging to a coalition. Supplying groupCategory restricts the result to that category; omitting it returns groups from all categories. Category values are defined by Group.Category.
Parameters
- coalitionId: number
  Coalition identifier, normally coalition.side.RED, BLUE, or NEUTRAL.
- OptionalgroupCategory: number
  Optional group category such as Group.Category.AIRPLANE or GROUND.
Returns l_Group[]
Group objects currently belonging to the requested coalition and category.
Example
```
const blueAircraft = coalition.getGroups(
	coalition.side.BLUE,
	Group.Category.AIRPLANE,
);
for (const group of blueAircraft) env.info(group.getName());
```
See
https://wiki.hoggitworld.com/view/DCS_func_getGroups
Overrides _coalition.getGroups
- Defined in coalition.ts:125

getMainRefPoint

getMainRefPoint(coalitionId: number): CoalitionReferencePoint | undefined
Returns the coalition's primary reference point.
Parameters
- coalitionId: number
  Value from coalition.side.
Returns CoalitionReferencePoint | undefined
Main reference point, or undefined when none exists.
Example
```
`const bullseye = coalition.getMainRefPoint(coalition.side.BLUE);`
```
See
https://wiki.hoggitworld.com/view/DCS_func_getMainRefPoint
Overrides _coalition.getMainRefPoint
- Defined in coalition.ts:201

getPlayers

getPlayers(coalitionId: number): l_Unit[]
Returns player-controlled units currently spawned for a coalition. Combined Arms-controlled units may be omitted.
Parameters
- coalitionId: number
  Value from coalition.side.
Returns l_Unit[]
Player units.
Example
```
`const bluePlayers = coalition.getPlayers(coalition.side.BLUE);`
```
See
https://wiki.hoggitworld.com/view/DCS_func_getPlayers
Overrides _coalition.getPlayers
- Defined in coalition.ts:170

getRefPoints

getRefPoints(coalitionId: number): CoalitionReferencePoint[] | undefined
Returns all reference points belonging to a coalition. Missions without reference points can return nothing.
Parameters
- coalitionId: number
  Value from coalition.side.
Returns CoalitionReferencePoint[] | undefined
Reference-point records, or undefined when none are configured.
Example
```
`const points = coalition.getRefPoints(coalition.side.BLUE) ?? [];`
```
See
https://wiki.hoggitworld.com/view/DCS_func_getRefPoints
Overrides _coalition.getRefPoints
- Defined in coalition.ts:191

getServiceProviders

getServiceProviders(coalitionId: number, service: number): l_Unit[]
Returns units providing a coalition service such as tanker, AWACS, or FAC.
Parameters
- coalitionId: number
  Value from coalition.side.
- service: number
  Value from coalition.service.
Returns l_Unit[]
Service-provider units.
Example
```
`const tankers = coalition.getServiceProviders(coalition.side.BLUE, coalition.service.TANKER);`
```
See
https://wiki.hoggitworld.com/view/DCS_func_getServiceProviders
Overrides _coalition.getServiceProviders
- Defined in coalition.ts:181

getStaticObjects

getStaticObjects(coalitionId: number): l_StaticObject[]
Returns static objects belonging to a coalition. This does not return active unit objects or scenery objects.
Parameters
- coalitionId: number
  Coalition identifier whose static objects should be returned.
Returns l_StaticObject[]
Static objects currently assigned to the coalition.
Example
```
const redStatics = coalition.getStaticObjects(coalition.side.RED);
for (const object of redStatics) env.info(object.getName());
```
See
https://wiki.hoggitworld.com/view/DCS_func_getStaticObjects
Overrides _coalition.getStaticObjects
- Defined in coalition.ts:160

remove_dyn_group

remove_dyn_group(...arguments_: unknown[]): unknown
TODO: removes a group through an engine-native dynamic-spawn identifier whose type is not published. Prefer Group.destroy when an object is available.
Parameters
- ...arguments_: unknown[]
Returns unknown
Overrides _coalition.remove_dyn_group
- Defined in coalition.ts:44

Interface l_coalition

No Self

Hierarchy (View Summary)

Index

Properties

Methods

Properties

service

side

Methods

add_dyn_group

Parameters

Returns unknown

addGroup

Parameters

Returns l_Group

Example

See

addRefPoint

Parameters

Returns void

Example

See

addStaticObject

Parameters

Returns l_StaticObject

Example

See

checkChooseCargo

Parameters

Returns unknown

checkDescent

Parameters

Returns unknown

getAirbases

Parameters

Returns l_Airbase[]

Example

See

getAllDescents

Parameters

Returns unknown

getCountryCoalition

Parameters

Returns number

Example

See

getDescentsOnBoard

Parameters

Returns unknown

getGroups

Parameters

Returns l_Group[]

Example

See

getMainRefPoint

Parameters

Returns CoalitionReferencePoint | undefined

Example

See

getPlayers

Parameters

Returns l_Unit[]

Example

See

getRefPoints

Parameters

Returns CoalitionReferencePoint[] | undefined

Example

See

getServiceProviders

Parameters

Returns l_Unit[]

Example

See

getStaticObjects

Parameters

Returns l_StaticObject[]

Example

See