Interface l_Airbase

Version

2.9.29.27468

interface l_Airbase {
    Category: { AIRDROME: number; HELIPAD: number; SHIP: number };
    className_: string;
    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;
    };
    autoCapture(enabled: boolean): void;
    autoCaptureIsOn(): boolean;
    destroy(): void;
    getAttributes(): Record<string, boolean>;
    getByName(name: string): l_Airbase | undefined;
    getCallsign(): string;
    getCategory(): number;
    getCategoryEx(): number;
    getCoalition(): number;
    getCommunicator(): unknown;
    getCountry(): number;
    getDesc(): AirbaseDesc;
    getDescByName(typeName: string): AirbaseDesc | undefined;
    getDispatcherTowerPos(): { pos: l_Vec3 } | undefined;
    getForcesName(): string;
    getID(): string | number;
    getLife(): number;
    getName(): string;
    getNearest(point: l_Vec3, coalitionId: number): l_Airbase | undefined;
    getParking(available?: boolean): AirbaseParkingSpot[];
    getPoint(): l_Vec3;
    getPosition(): l_Position3;
    getRadioSilentMode(): boolean;
    getRunways(): AirbaseRunway[];
    getTypeName(): string;
    getUnit(): l_Unit | undefined;
    getVelocity(): l_Vec3;
    getWarehouse(): l_Warehouse;
    getWorldID(): number;
    hasAttribute(attribute: string): boolean;
    inAir(): boolean;
    isExist(): boolean;
    setCoalition(coalitionId: number): void;
    setRadioSilentMode(enabled: boolean): void;
    tonumber(...args: any[]): unknown;
}

Hierarchy (View Summary)

_Airbase
- l_Airbase

Properties

className_

className_: string

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;
}

Methods

autoCapture

autoCapture(enabled: boolean): void
Enables automatic coalition capture for the airbase.
Parameters
- enabled: boolean
  Desired capture behavior.
Returns void
Nothing.
Example
```
`base.autoCapture(true);`
```
See
https://wiki.hoggitworld.com/view/DCS_func_autoCapture
Overrides _Airbase.autoCapture
- Defined in Airbase.ts:156

autoCaptureIsOn

autoCaptureIsOn(): boolean
Reports whether automatic coalition capture is enabled.

Returns boolean
Auto-capture state.
Example
```
`const capturable = base.autoCaptureIsOn();`
```
See
https://wiki.hoggitworld.com/view/DCS_func_autoCaptureIsOn
Overrides _Airbase.autoCaptureIsOn
- Defined in Airbase.ts:165

destroy

destroy(): void
Removes the airbase object from the mission when DCS permits it.

Returns void
Nothing.
Example
```
`if (base.isExist()) base.destroy();`
```
See
https://wiki.hoggitworld.com/view/DCS_func_destroy
- Defined in Airbase.ts:89

getAttributes

getAttributes(): Record<string, boolean>
Returns all database attributes assigned to the airbase.

Returns Record<string, boolean>
Attribute membership flags.
Example
```
`const attributes = base.getAttributes();`
```
See
https://wiki.hoggitworld.com/view/DCS_func_getAttributes
- Defined in Airbase.ts:97

getByName

getByName(name: string): l_Airbase | undefined
Looks up an airbase, FARP, or airbase-capable ship by its exact name.
Parameters
- name: string
  Exact airbase name.
Returns l_Airbase | undefined
Matching airbase object, or undefined when not found.
Example
```
const batumi = Airbase.getByName("Batumi");
if (!batumi) env.warning("Batumi is unavailable");
```
No Self

See
https://wiki.hoggitworld.com/view/DCS_func_getByName
Overrides _Airbase.getByName
- Defined in Airbase.ts:372

getCallsign

getCallsign(): string
Returns the localized airbase callsign.

Returns string
Callsign.
Example
```
`env.info(base.getCallsign());`
```
See
https://wiki.hoggitworld.com/view/DCS_func_getCallsign
Overrides _Airbase.getCallsign
- Defined in Airbase.ts:185

getCategory

getCategory(): number
Returns the inherited broad object category. Use getCategoryEx() to distinguish airdromes, helipads/FARPs, and ships.

Returns number
Category identifier from Object.Category.
Example
```
const base = Airbase.getByName("Batumi");
if (base?.getCategory() === Object.Category.BASE) env.info("Airbase object");
```
See
https://wiki.hoggitworld.com/view/DCS_func_getCategory
Overrides _Airbase.getCategory
- Defined in Airbase.ts:329

getCategoryEx

getCategoryEx(): number
Returns whether the airbase is an airdrome, helipad/FARP, or ship.

Returns number
Value from Airbase.Category.
Example
```
`const isAirfield = base.getCategoryEx() === Airbase.Category.AIRDROME;`
```
See
https://wiki.hoggitworld.com/view/DCS_func_getCategoryEx
Overrides _Airbase.getCategoryEx
- Defined in Airbase.ts:338

getCoalition

getCoalition(): number
Returns the coalition currently controlling the airbase. A capturable base can change coalition during a mission.

Returns number
Coalition identifier from coalition.side.
Example
```
const base = Airbase.getByName("Batumi");
if (base?.getCoalition() === coalition.side.BLUE) env.info("Batumi is blue");
```
See
https://wiki.hoggitworld.com/view/DCS_func_getCoalition
Overrides _Airbase.getCoalition
- Defined in Airbase.ts:313

getCommunicator

getCommunicator(): unknown
TODO: native engine communicator object is exported but its userdata API is not present in installed Lua sources.

Returns unknown
Overrides _Airbase.getCommunicator
- Defined in Airbase.ts:81

getCountry

getCountry(): number
Returns the country assigned to the airbase object.

Returns number
Country identifier from country.id.
Example
```
const countryId = Airbase.getByName("Batumi")?.getCountry();
if (countryId !== undefined) env.info(`Country ID: ${countryId}`);
```
See
https://wiki.hoggitworld.com/view/DCS_func_getCountry
Overrides _Airbase.getCountry
- Defined in Airbase.ts:387

getDesc

getDesc(): AirbaseDesc
Returns database metadata describing the airbase object. Descriptor values describe the type rather than its changing runtime state.

Returns AirbaseDesc
Airbase descriptor.
Example
```
const desc = Airbase.getByName("Batumi")?.getDesc();
if (desc) env.info(`${desc.displayName}: ${desc.life} life`);
```
See
https://wiki.hoggitworld.com/view/DCS_func_getDesc
Overrides _Airbase.getDesc
- Defined in Airbase.ts:403

getDescByName

getDescByName(typeName: string): AirbaseDesc | undefined
Returns an airbase descriptor without requiring an instance in the mission. This is a static function on the global Airbase table; do not call it on an l_Airbase instance.
Parameters
- typeName: string
  Internal airbase type name.
Returns AirbaseDesc | undefined
Descriptor, or undefined when unknown.
Example
```
`const desc = Airbase.getDescByName("Batumi");`
```
No Self

See
https://wiki.hoggitworld.com/view/DCS_func_getDescByName
Overrides _Airbase.getDescByName
- Defined in Airbase.ts:176

getDispatcherTowerPos

getDispatcherTowerPos(): { pos: l_Vec3 } | undefined
Returns the dispatcher/tower position record.

Returns { pos: l_Vec3 } | undefined
Tower position, or undefined when unavailable.
Example
```
`const tower = base.getDispatcherTowerPos()?.pos;`
```
See
https://wiki.hoggitworld.com/view/DCS_func_getDispatcherTowerPos
Overrides _Airbase.getDispatcherTowerPos
- Defined in Airbase.ts:222

getForcesName

getForcesName(): string
Returns the force/localization name used by engine UI systems.

Returns string
Example
```
`const name = base.getForcesName();`
```
Overrides _Airbase.getForcesName
- Defined in Airbase.ts:77

getID

getID(): string | number
Returns the airbase identifier. Map aerodromes use numeric IDs, while ships and helipads may use strings. IDs are unique within an airbase category; different categories can contain overlapping values.

Returns string | number
Numeric aerodrome ID or string ship/helipad ID.
Example
```
const base = Airbase.getByName("Batumi");
if (base) env.info(`Airbase ID: ${base.getID()}`);
```
See
https://wiki.hoggitworld.com/view/DCS_func_getID
Overrides _Airbase.getID
- Defined in Airbase.ts:267

getLife

getLife(): number
Returns current airbase hit points.

Returns number
Example
```
`const life = base.getLife();`
```
See
https://wiki.hoggitworld.com/view/DCS_func_getLife
Overrides _Airbase.getLife
- Defined in Airbase.ts:57

getName

getName(): string
Returns the airbase's mission-visible name.

Returns string
Airbase name.
Example
```
for (const base of world.getAirbases()) env.info(base.getName());
```
See
https://wiki.hoggitworld.com/view/DCS_func_getName
Overrides _Airbase.getName
- Defined in Airbase.ts:297

getNearest

getNearest(point: l_Vec3, coalitionId: number): l_Airbase | undefined
Finds the nearest airbase belonging to coalitionId. This is a static function on Airbase.
Parameters
- point: l_Vec3
- coalitionId: number
Returns l_Airbase | undefined
No Self
Example
```
`const nearest = Airbase.getNearest(point, coalition.side.BLUE);`
```
See
%DCS_INSTALL_DIR%/Scripts/GeneratedTasks/modules/one_plane_airborn_4sq_blue.lua:486
Overrides _Airbase.getNearest
- Defined in Airbase.ts:65

getParking

getParking(available?: boolean): AirbaseParkingSpot[]
Returns all parking positions, or only presently available positions.
Parameters
- Optionalavailable: boolean
  When true, filter out occupied/unavailable spots.
Returns AirbaseParkingSpot[]
Parking records.
Example
```
`const freeParking = base.getParking(true);`
```
See
https://wiki.hoggitworld.com/view/DCS_func_getParking
Overrides _Airbase.getParking
- Defined in Airbase.ts:204

getPoint

getPoint(): l_Vec3
Returns the airbase reference point in local DCS world coordinates. For a moving ship, the point follows the ship.

Returns l_Vec3
Position in metres using DCS's X/north, Y/up, Z/east axes.
Example
```
const point = Airbase.getByName("Batumi")?.getPoint();
if (point) env.info(`Batumi elevation: ${point.y} m`);
```
See
https://wiki.hoggitworld.com/view/DCS_func_getPoint
- Defined in Airbase.ts:283

getPosition

getPosition(): l_Position3
Returns the airbase transform.

Returns l_Position3
Position and orientation axes.
Example
```
`const transform = base.getPosition();`
```
See
https://wiki.hoggitworld.com/view/DCS_func_getPosition
- Defined in Airbase.ts:105

getRadioSilentMode

getRadioSilentMode(): boolean
Reports whether the airbase radio is in silent mode.

Returns boolean
Radio-silent state.
Example
```
`const silent = base.getRadioSilentMode();`
```
See
https://wiki.hoggitworld.com/view/DCS_func_getRadioSilentMode
Overrides _Airbase.getRadioSilentMode
- Defined in Airbase.ts:231

getRunways

getRunways(): AirbaseRunway[]
Returns runway geometry and identifiers.

Returns AirbaseRunway[]
Runway records.
Example
```
`for (const runway of base.getRunways()) env.info(`${runway.Name}`);`
```
See
https://wiki.hoggitworld.com/view/DCS_func_getRunways
Overrides _Airbase.getRunways
- Defined in Airbase.ts:213

getTypeName

getTypeName(): string
Returns the internal DCS database type name.

Returns string
Type name.
Example
```
`env.info(base.getTypeName());`
```
See
https://wiki.hoggitworld.com/view/DCS_func_getTypeName
Overrides _Airbase.getTypeName
- Defined in Airbase.ts:146

getUnit

getUnit(): l_Unit | undefined
Returns the unit represented by a ship airbase; land airbases normally return undefined.

Returns l_Unit | undefined
Associated ship unit when applicable.
Example
```
`const carrier = base.getUnit();`
```
See
https://wiki.hoggitworld.com/view/DCS_func_getUnit
Overrides _Airbase.getUnit
- Defined in Airbase.ts:194

getVelocity

getVelocity(): l_Vec3
Returns airbase velocity in world axes.

Returns l_Vec3
Metres per second.
Example
```
`const velocity = base.getVelocity();`
```
See
https://wiki.hoggitworld.com/view/DCS_func_getVelocity
- Defined in Airbase.ts:113

getWarehouse

getWarehouse(): l_Warehouse
Returns the warehouse associated with the airbase. Use it to inspect or modify aircraft, weapon, and fuel stocks when warehouse logistics are in use.

Returns l_Warehouse
Airbase warehouse object.
Example
```
const base = Airbase.getByName("Batumi");
const inventory = base?.getWarehouse().getInventory();
if (inventory) env.info(`Jet fuel: ${inventory.liquids[LiquidType.JETFUEL]}`);
```
See
https://wiki.hoggitworld.com/view/DCS_func_getWarehouse
Overrides _Airbase.getWarehouse
- Defined in Airbase.ts:355

getWorldID

getWorldID(): number
Returns the engine world identifier used by lower-level GUI/mission systems.

Returns number
Example
```
`const id = base.getWorldID();`
```
Overrides _Airbase.getWorldID
- Defined in Airbase.ts:71

hasAttribute

hasAttribute(attribute: string): boolean
Tests a database attribute.
Parameters
- attribute: string
  Attribute name.
Returns boolean
Whether it is present.
Example
```
`const carrier = base.hasAttribute("AircraftCarrier");`
```
See
https://wiki.hoggitworld.com/view/DCS_func_hasAttribute
- Defined in Airbase.ts:122

inAir

inAir(): boolean
Reports whether the airbase is airborne, principally for ship airbases.

Returns boolean
In-air state.
Example
```
`const airborne = base.inAir();`
```
See
https://wiki.hoggitworld.com/view/DCS_func_inAir
- Defined in Airbase.ts:130

isExist

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

Returns boolean
Existence state.
Example
```
`if (base.isExist()) env.info(base.getName());`
```
See
https://wiki.hoggitworld.com/view/DCS_func_isExist
- Defined in Airbase.ts:138

setCoalition

setCoalition(coalitionId: number): void
Changes the coalition controlling the airbase.
Parameters
- coalitionId: number
  Value from coalition.side.
Returns void
Nothing.
Example
```
`base.setCoalition(coalition.side.BLUE);`
```
See
https://wiki.hoggitworld.com/view/DCS_func_setCoalition
Overrides _Airbase.setCoalition
- Defined in Airbase.ts:251

setRadioSilentMode

setRadioSilentMode(enabled: boolean): void
Enables or disables airbase radio-silent mode.
Parameters
- enabled: boolean
  Desired state.
Returns void
Nothing.
Example
```
`base.setRadioSilentMode(true);`
```
See
https://wiki.hoggitworld.com/view/DCS_func_setRadioSilentMode
Overrides _Airbase.setRadioSilentMode
- Defined in Airbase.ts:241

tonumber

tonumber(...args: any[]): unknown
Parameters
- ...args: any[]
Returns unknown
Inherited from _Airbase.tonumber
- Defined in exports/Airbase.export.ts:118

Interface l_Airbase

Version

Hierarchy (View Summary)

Index

Properties

Methods

Properties

Category

className_

parentClass_

Methods

autoCapture

Parameters

Returns void

Example

See

autoCaptureIsOn

Returns boolean

Example

See

destroy

Returns void

Example

See

getAttributes

Returns Record<string, boolean>

Example

See

getByName

Parameters

Returns l_Airbase | undefined

Example

No Self

See

getCallsign

Returns string

Example

See

getCategory

Returns number

Example

See

getCategoryEx

Returns number

Example

See

getCoalition

Returns number

Example

See

getCommunicator

Returns unknown

getCountry

Returns number

Example

See

getDesc

Returns AirbaseDesc

Example

See

getDescByName

Parameters

Returns AirbaseDesc | undefined

Example

No Self

See

getDispatcherTowerPos

Returns { pos: l_Vec3 } | undefined

Example

See

getForcesName

Returns string

Example

getID

Returns string | number

Example

See

getLife

Returns number

Example