2.9.10.4160

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

Hierarchy (View Summary)

Properties

Category: {
    AIRPLANE: number;
    GROUND: number;
    HELICOPTER: number;
    SHIP: number;
    TRAIN: number;
}
className_: string
parentClass_: { className_: string }

Methods

  • Returns an instance of the calling class for the object of a specified name. The objects name is defined either in the mission editor or within functions that can dynamically spawn objects. All static objects and unit names must be unique. However, groups may have the same name as a unit or static object.

    This function can provide access to non activated units and groups.

    Parameters

    • name: string

    Returns undefined | l_Group

  • Returns the controller of the specified object. Ships and ground units can only be controlled at a group level.

    Airplanes and helicopters can be controlled at both a group and unit level

    Returns l_Controller

  • Returns a number which defines the unique mission id of a given object.

    Returns number

  • Returns the unit object of the specified unitIndex within the group. If the index is not valid, this function will return nil.

    Parameters

    • index: number

    Returns undefined | l_Unit