Interface l_Group

Version

2.9.29.27468

interface l_Group {
    Category: {
        AIRPLANE: number;
        GROUND: number;
        HELICOPTER: number;
        SHIP: number;
        TRAIN: number;
    };
    className_: string;
    parentClass_: { className_: string };
    activate(): void;
    destroy(): void;
    embarking(...arguments_: unknown[]): unknown;
    enableEmission(enabled: boolean): void;
    getByName(name: string): l_Group | undefined;
    getCategory(): number;
    getCategoryEx(): number;
    getCoalition(): number;
    getController(): l_Controller;
    getID(): number;
    getInitialSize(): number;
    getName(): string;
    getSize(): number;
    getUnit(index: number): l_Unit | undefined;
    getUnits(): l_Unit[];
    isExist(): boolean;
    markGroup(...arguments_: unknown[]): unknown;
    tonumber(...args: any[]): unknown;
}

Hierarchy (View Summary)

_Group
- l_Group

Properties

className_

className_: string

parentClass_

parentClass_: { className_: string }

Methods

activate

activate(): void
Activates a late-activation group and inserts its units into the simulation.

Returns void
Nothing.
Example
```
`Group.getByName("Reinforcements")?.activate();`
```
See
https://wiki.hoggitworld.com/view/DCS_func_activate
Overrides _Group.activate
- Defined in Group.ts:27

destroy

destroy(): void
Destroys the group and all of its units.

Returns void
Nothing.
Example
```
`Group.getByName("Convoy")?.destroy();`
```
See
https://wiki.hoggitworld.com/view/DCS_func_destroy
Overrides _Group.destroy
- Defined in Group.ts:36

embarking

embarking(...arguments_: unknown[]): unknown
TODO: troop-embarkation payload is an undocumented engine-native structure. This explicit override prevents an any[] API.
Parameters
- ...arguments_: unknown[]
Returns unknown
Overrides _Group.embarking
- Defined in Group.ts:15

enableEmission

enableEmission(enabled: boolean): void
Enables or disables supported sensor emissions for the group.
Parameters
- enabled: boolean
  Desired emission state.
Returns void
Nothing.
Example
```
`group.enableEmission(false);`
```
See
https://wiki.hoggitworld.com/view/DCS_func_enableEmission
Overrides _Group.enableEmission
- Defined in Group.ts:46

getByName

getByName(name: string): l_Group | undefined
Looks up a group by its exact mission name. The function can return groups configured for late activation, and returns nil when no matching group is known to the mission.
Parameters
- name: string
  Exact Mission Editor or dynamically assigned group name.
Returns l_Group | undefined
Matching group object, or undefined when not found.
Example
```
const group = Group.getByName("Springfield 1");
if (!group) env.warning("Springfield 1 was not found");
```
No Self

See
https://wiki.hoggitworld.com/view/DCS_func_getByName
Overrides _Group.getByName
- Defined in Group.ts:190

getCategory

getCategory(): number
Returns the group's platform category, such as airplane, helicopter, ground, or ship.

Returns number
Category identifier from Group.Category.
Example
```
const group = Group.getByName("Convoy");
if (group?.getCategory() === Group.Category.GROUND) env.info("Ground group");
```
See
https://wiki.hoggitworld.com/view/DCS_func_getCategory
Overrides _Group.getCategory
- Defined in Group.ts:114

getCategoryEx

getCategoryEx(): number
Returns the engine's extended group category.

Returns number
Example
```
`const category = group.getCategoryEx();`
```
Overrides _Group.getCategoryEx
- Defined in Group.ts:11

getCoalition

getCoalition(): number
Returns the coalition that currently owns the group. Compare the result with coalition.side.NEUTRAL, RED, or BLUE rather than relying on the underlying numeric values.

Returns number
Coalition identifier from coalition.side.
Example
```
const group = Group.getByName("Springfield 1");
if (group?.getCoalition() === coalition.side.BLUE) {
	env.info("Springfield 1 belongs to blue");
}
```
See
https://wiki.hoggitworld.com/view/DCS_func_getCoalition
Overrides _Group.getCoalition
- Defined in Group.ts:98

getController

getController(): l_Controller
Returns the AI controller used to assign tasks and commands to the group. Ships and ground units are controlled at group level; aircraft may also expose unit-level controllers.

Returns l_Controller
Group controller.
Example
```
const group = Group.getByName("CAP");
if (group) group.getController().setOnOff(true);
```
See
https://wiki.hoggitworld.com/view/DCS_func_getController
Overrides _Group.getController
- Defined in Group.ts:207

getID

getID(): number
Returns the group's runtime mission identifier. The ID is suitable for APIs such as trigger.action.addOtherCommandForGroup, but should not be treated as a stable identifier across separate mission runs.

Returns number
Numeric runtime group ID.
Example
```
const group = Group.getByName("Springfield 1");
if (group) env.info(`Group ID: ${group.getID()}`);
```
See
https://wiki.hoggitworld.com/view/DCS_func_getID
Overrides _Group.getID
- Defined in Group.ts:63

getInitialSize

getInitialSize(): number
Returns the number of units with which the group was created. Unlike getSize, this does not fall as units are destroyed.

Returns number
Initial unit count.
Example
```
`const losses = group.getInitialSize() - group.getSize();`
```
See
https://wiki.hoggitworld.com/view/DCS_func_getInitialSize
Overrides _Group.getInitialSize
- Defined in Group.ts:139

getName

getName(): string
Returns the group's mission name as assigned in the Mission Editor or when the group was spawned dynamically.

Returns string
Group name.
Example
```
const name = Group.getByName("Springfield 1")?.getName();
if (name) env.info(name);
```
See
https://wiki.hoggitworld.com/view/DCS_func_getName
Overrides _Group.getName
- Defined in Group.ts:79

getSize

getSize(): number
Returns the number of units currently present in the group. The value falls as units are destroyed and may therefore be lower than the initial size.

Returns number
Current unit count.
Example
```
const group = Group.getByName("Convoy");
if (group) env.info(`${group.getSize()} vehicles remain`);
```
See
https://wiki.hoggitworld.com/view/DCS_func_getSize
Overrides _Group.getSize
- Defined in Group.ts:130

getUnit

getUnit(index: number): l_Unit | undefined
Returns the unit at a one-based Lua group index. DCS returns nil when the index is outside the group's current range.
Parameters
- index: number
  One-based unit index between 1 and getSize().
Returns l_Unit | undefined
Unit at the requested index, or undefined when it does not exist.
Example
```
const lead = Group.getByName("Springfield 1")?.getUnit(1);
if (lead) env.info(`Lead unit: ${lead.getName()}`);
```
See
https://wiki.hoggitworld.com/view/DCS_func_getUnit
Overrides _Group.getUnit
- Defined in Group.ts:171

getUnits

getUnits(): l_Unit[]
Returns the group's surviving units in their current group order.

Returns l_Unit[]
Array of unit objects. An empty array indicates no remaining units.
Example
```
const group = Group.getByName("Convoy");
for (const unit of group?.getUnits() ?? []) env.info(unit.getName());
```
See
https://wiki.hoggitworld.com/view/DCS_func_getUnits
Overrides _Group.getUnits
- Defined in Group.ts:154

isExist

isExist(): boolean
Reports whether the group still exists.

Returns boolean
Existence state.
Example
```
`if (group.isExist()) env.info(group.getName());`
```
See
https://wiki.hoggitworld.com/view/DCS_func_isExist
Overrides _Group.isExist
- Defined in Group.ts:216

markGroup

markGroup(...arguments_: unknown[]): unknown
TODO: engine-native group marking contract is absent from installed Lua sources and Hoggit.
Parameters
- ...arguments_: unknown[]
Returns unknown
Overrides _Group.markGroup
- Defined in Group.ts:19

tonumber

tonumber(...args: any[]): unknown
Parameters
- ...args: any[]
Returns unknown
Inherited from _Group.tonumber
- Defined in exports/Group.export.ts:33

Interface l_Group

Version

Hierarchy (View Summary)

Index

Properties

Methods

Properties

Category

className_

parentClass_

Methods

activate

Returns void

Example

See

destroy

Returns void

Example

See

embarking

Parameters

Returns unknown

enableEmission

Parameters

Returns void

Example

See

getByName

Parameters

Returns l_Group | undefined

Example

No Self

See

getCategory

Returns number

Example

See

getCategoryEx

Returns number

Example

getCoalition

Returns number

Example

See

getController

Returns l_Controller

Example

See

getID

Returns number

Example

See

getInitialSize

Returns number

Example

See

getName

Returns string

Example

See

getSize

Returns number

Example

See

getUnit

Parameters

Returns l_Unit | undefined

Example

See

getUnits

Returns l_Unit[]

Example

See

isExist

Returns boolean

Example

See

markGroup

Parameters

Returns unknown