DCS World Typescript
    Preparing search index...

    Interface l_Unit

    2.9.29.27468

    interface l_Unit {
        Category: {
            AIRPLANE: number;
            GROUND_UNIT: number;
            HELICOPTER: number;
            SHIP: number;
            STRUCTURE: number;
        };
        className_: string;
        OpticType: { IR: number; LLTV: number; TV: number };
        parentClass_: {
            Category: {
                BASE: number;
                CARGO: number;
                SCENERY: number;
                STATIC: number;
                UNIT: number;
                VOID: number;
                WEAPON: number;
            };
            className_: string;
            database_: {
                Batumi: {
                    _origin: string;
                    attributes: { Airfields: boolean };
                    category: number;
                    displayName: string;
                    life: number;
                    typeName: string;
                };
                "Leopard-2": {
                    _origin: string;
                    attributes: {
                        All: boolean;
                        "AntiAir Armed Vehicles": boolean;
                        "Armed ground units": boolean;
                        "Armed vehicles": boolean;
                        "Armored vehicles": boolean;
                        "Ground Units": boolean;
                        "Ground Units Non Airdefence": boolean;
                        "Ground vehicles": boolean;
                        HeavyArmoredUnits: boolean;
                        "Modern Tanks": boolean;
                        Tanks: boolean;
                        Vehicles: boolean;
                    };
                    box: {
                        max: { x: number; y: number; z: number };
                        min: { x: number; y: number; z: number };
                    };
                    category: number;
                    displayName: string;
                    Kmax: number;
                    life: number;
                    massEmpty: number;
                    maxSlopeAngle: number;
                    RCS: number;
                    riverCrossing: boolean;
                    speedMax: number;
                    speedMaxOffRoad: number;
                    typeName: string;
                };
                getCategoryEx(...args: any[]): unknown;
            };
            parentClass_: { className_: string };
            cancelChoosingCargo(...args: any[]): unknown;
            destroy(...args: any[]): unknown;
            getAttributes(...args: any[]): unknown;
            getCategory(...args: any[]): unknown;
            getName(...args: any[]): unknown;
            getPoint(...args: any[]): unknown;
            getPosition(...args: any[]): unknown;
            getTypeName(...args: any[]): unknown;
            getVelocity(...args: any[]): unknown;
            hasAttribute(...args: any[]): unknown;
            inAir(...args: any[]): unknown;
            isExist(...args: any[]): unknown;
            tonumber(...args: any[]): unknown;
        };
        RadarType: { AS: number; SS: number };
        RefuelingSystem: { BOOM_AND_RECEPTACLE: number; PROBE_AND_DROGUE: number };
        SensorType: { IRST: number; OPTIC: number; RADAR: number; RWR: number };
        canShipLanding(): boolean | undefined;
        checkOpenRamp(): boolean;
        destroy(): void;
        disembarking(...arguments_: unknown[]): unknown;
        enableEmission(enabled: boolean): void;
        getAirbase(): l_Airbase | undefined;
        getAmmo(): UnitAmmoItem[] | undefined;
        getAttributes(): Record<string, boolean>;
        getByName(name: string): l_Unit | undefined;
        getCallsign(): string;
        getCargosOnBoard(): l_StaticObject[] | undefined;
        getCategory(): number;
        getCategoryEx(): number;
        getCoalition(): number;
        getCommunicator(): unknown;
        getController(): l_Controller;
        getCountry(): number;
        getDesc(): UnitDesc;
        getDescByName(typeName: string): UnitDesc | undefined;
        getDescentCapacity(): number;
        getDescentOnBoard(): unknown;
        getDrawArgumentValue(argument: number): number;
        getForcesName(): string;
        getFuel(): number;
        getFuelLowState(): number;
        getGroup(): l_Group | undefined;
        getID(): string | number;
        getLife(): number;
        getLife0(): number;
        getName(): string;
        getNearestCargos(): l_StaticObject[] | undefined;
        getNearestCargosForAircraft(): l_StaticObject[] | undefined;
        getNumber(): number;
        getObjectID(): number;
        getPlayerName(): string | undefined;
        getPoint(): l_Vec3;
        getPosition(): l_Position3;
        getRadar(): LuaMultiReturn<[boolean, l_Object | undefined]>;
        getSeats(): unknown[] | undefined;
        getSensors(): UnitSensors | undefined;
        getTypeName(): string;
        getVelocity(): l_Vec3;
        hasAttribute(attribute: string): boolean;
        hasCarrier(): boolean | undefined;
        hasSensors(sensorType?: number, ...subtypes: number[]): boolean;
        inAir(): boolean;
        isActive(): boolean;
        isAlive(): boolean;
        isBroken(): boolean;
        isDead(): boolean;
        isEffective(): boolean;
        isExist(): boolean;
        LoadOnBoard(...arguments_: unknown[]): unknown;
        markDisembarkingTask(...arguments_: unknown[]): unknown;
        OldCarrierMenuShow(...arguments_: unknown[]): unknown;
        openRamp(): void;
        tonumber(...args: any[]): unknown;
        UnloadCargo(...arguments_: unknown[]): unknown;
        vtolableLA(...arguments_: unknown[]): unknown;
    }

    Hierarchy (View Summary)

    Index
    Category className_ OpticType parentClass_ RadarType RefuelingSystem SensorType
    canShipLanding checkOpenRamp destroy disembarking enableEmission getAirbase getAmmo getAttributes getByName getCallsign getCargosOnBoard getCategory getCategoryEx getCoalition getCommunicator getController getCountry getDesc getDescByName getDescentCapacity getDescentOnBoard getDrawArgumentValue getForcesName getFuel getFuelLowState getGroup getID getLife getLife0 getName getNearestCargos getNearestCargosForAircraft getNumber getObjectID getPlayerName getPoint getPosition getRadar getSeats getSensors getTypeName getVelocity hasAttribute hasCarrier hasSensors inAir isActive isAlive isBroken isDead isEffective isExist LoadOnBoard markDisembarkingTask OldCarrierMenuShow openRamp tonumber UnloadCargo vtolableLA
    Category: {
        AIRPLANE: number;
        GROUND_UNIT: number;
        HELICOPTER: number;
        SHIP: number;
        STRUCTURE: number;
    }

    className_

    className_: string
    OpticType: { IR: number; LLTV: number; TV: number }

    parentClass_

    parentClass_: {
        Category: {
            BASE: number;
            CARGO: number;
            SCENERY: number;
            STATIC: number;
            UNIT: number;
            VOID: number;
            WEAPON: number;
        };
        className_: string;
        database_: {
            Batumi: {
                _origin: string;
                attributes: { Airfields: boolean };
                category: number;
                displayName: string;
                life: number;
                typeName: string;
            };
            "Leopard-2": {
                _origin: string;
                attributes: {
                    All: boolean;
                    "AntiAir Armed Vehicles": boolean;
                    "Armed ground units": boolean;
                    "Armed vehicles": boolean;
                    "Armored vehicles": boolean;
                    "Ground Units": boolean;
                    "Ground Units Non Airdefence": boolean;
                    "Ground vehicles": boolean;
                    HeavyArmoredUnits: boolean;
                    "Modern Tanks": boolean;
                    Tanks: boolean;
                    Vehicles: boolean;
                };
                box: {
                    max: { x: number; y: number; z: number };
                    min: { x: number; y: number; z: number };
                };
                category: number;
                displayName: string;
                Kmax: number;
                life: number;
                massEmpty: number;
                maxSlopeAngle: number;
                RCS: number;
                riverCrossing: boolean;
                speedMax: number;
                speedMaxOffRoad: number;
                typeName: string;
            };
            getCategoryEx(...args: any[]): unknown;
        };
        parentClass_: { className_: string };
        cancelChoosingCargo(...args: any[]): unknown;
        destroy(...args: any[]): unknown;
        getAttributes(...args: any[]): unknown;
        getCategory(...args: any[]): unknown;
        getName(...args: any[]): unknown;
        getPoint(...args: any[]): unknown;
        getPosition(...args: any[]): unknown;
        getTypeName(...args: any[]): unknown;
        getVelocity(...args: any[]): unknown;
        hasAttribute(...args: any[]): unknown;
        inAir(...args: any[]): unknown;
        isExist(...args: any[]): unknown;
        tonumber(...args: any[]): unknown;
    }
    RadarType: { AS: number; SS: number }
    RefuelingSystem: { BOOM_AND_RECEPTACLE: number; PROBE_AND_DROGUE: number }
    SensorType: { IRST: number; OPTIC: number; RADAR: number; RWR: number }

    • Reports whether this unit can perform a ship landing; unsupported unit types return nothing.

      Returns boolean | undefined

      `const allowed = unit.canShipLanding();`

    • Reports whether the unit's cargo ramp is open.

      Returns boolean

      `const open = unit.checkOpenRamp();`

    • TODO: disembarkation task payload is engine-native and absent from installed Lua sources.

      Parameters

      • ...arguments_: unknown[]

      Returns unknown

    • Returns the airbase currently associated with the unit, when any.

      Returns l_Airbase | undefined

      `const base = unit.getAirbase();`

    • Looks up a unit by its exact mission name. DCS may return late-activated units before activation; use isActive() when runtime activation matters.

      Parameters

      • name: string

        Exact Mission Editor or dynamically assigned unit name.

      Returns l_Unit | undefined

      Matching unit, or undefined when not found.

      `const lead = Unit.getByName("Springfield 1-1");`

      https://wiki.hoggitworld.com/view/DCS_func_getByName

    • Returns the inherited broad object category. For a unit this is normally Object.Category.UNIT; use getCategoryEx() or getDesc().category for airplane, helicopter, ground, ship, and structure categories.

      Returns number

      Category identifier from Object.Category.

      `const isUnitObject = unit.getCategory() === Object.Category.UNIT;`

      https://wiki.hoggitworld.com/view/DCS_func_getCategory

    • TODO: engine-native communicator userdata has no published scripting shape.

      Returns unknown

    • Returns one loaded troop/descent record. Its schema is engine-native.

      Returns unknown

      `const descent = unit.getDescentOnBoard();`

    • Returns the force/localization name used by engine UI systems.

      Returns string

      `const name = unit.getForcesName();`

    • Returns fuel as a fraction of maximum internal capacity. External tanks can make the result greater than 1; ground units and ships normally return 1.

      Returns number

      Remaining fuel fraction, where 1 is full internal fuel.

      `env.info(`Fuel: ${unit.getFuel() * 100}%`);`

      https://wiki.hoggitworld.com/view/DCS_func_getFuel

    • Returns the engine's low-fuel state code. DCS 2.9.29 exposes a number.

      Returns number

      `const lowFuelState = unit.getFuelLowState();`

    • Returns the unit's current life (hit-point) value. Values below 1 are generally considered dead. Aircraft subsystem damage is more detailed than this aggregate value, and burning ground/ship units may report 0 before their final explosion.

      Returns number

      Current life value.

      `const damage = 1 - unit.getLife() / unit.getLife0();`

      https://wiki.hoggitworld.com/view/DCS_func_getLife

    • Returns the unit type's initial life value from its descriptor. This value does not change as the unit takes damage and can be compared with getLife() to calculate the remaining fraction.

      Returns number

      Initial life value for the unit type.

      const unit = Unit.getByName("Target");
      if (unit) {
      	const remainingFraction = unit.getLife() / unit.getLife0();
      	env.info(`Life remaining: ${remainingFraction * 100}%`);
      }

    • Returns whether a radar is operating and the object it is tracking. When no object is tracked, Lua still returns the radar state but the second value is nil.

      Returns LuaMultiReturn<[boolean, l_Object | undefined]>

      Radar-on state and tracked object, when present.

      `const [radarOn, target] = unit.getRadar(); if (radarOn && target) env.info(target.getName());`

      https://wiki.hoggitworld.com/view/DCS_func_getRadar

    • Returns seat metadata for multi-seat aircraft. Schema varies by module.

      Returns unknown[] | undefined

      `const seats = unit.getSeats();`

    • Reports whether this unit has a carrier/transport association; unsupported unit types return nothing.

      Returns boolean | undefined

      `const carried = unit.hasCarrier();`

    • Checks for any sensor, or a sensor type and optional subtype values.

      Parameters

      • OptionalsensorType: number

        Value from Unit.SensorType; omit to test for any sensor.

      • ...subtypes: number[]

        Optic/radar subtype values.

      Returns boolean

      Whether a matching sensor exists.

      `const hasRadar = unit.hasSensors(Unit.SensorType.RADAR);`

      https://wiki.hoggitworld.com/view/DCS_func_hasSensors

    • Reports whether the unit is alive according to the engine damage state.

      Returns boolean

      `if (unit.isAlive()) env.info(unit.getName());`

    • Reports whether damage has broken the unit.

      Returns boolean

      `const broken = unit.isBroken();`

    • Reports whether the unit is dead according to the engine damage state.

      Returns boolean

      `const dead = unit.isDead();`

    • Reports whether the unit remains operationally effective.

      Returns boolean

      `const effective = unit.isEffective();`

    • TODO: transport loading contract is engine-native and absent from installed Lua sources.

      Parameters

      • ...arguments_: unknown[]

      Returns unknown

    • TODO: disembarkation marker payload is engine-native and absent from installed Lua sources.

      Parameters

      • ...arguments_: unknown[]

      Returns unknown

    • TODO: legacy carrier-menu contract is engine-native and absent from installed Lua sources.

      Parameters

      • ...arguments_: unknown[]

      Returns unknown

    • Opens the unit's cargo ramp.

      Returns void

      `unit.openRamp();`

    • TODO: transport unloading contract is engine-native and absent from installed Lua sources.

      Parameters

      • ...arguments_: unknown[]

      Returns unknown

    • Returns VTOL landing-area information. TODO: the native return schema is not exposed by installed Lua sources.

      Parameters

      • ...arguments_: unknown[]

      Returns unknown

    Settings
    Member Visibility

    On This Page
    Properties
    Methods