Interface l_Object

Version

2.9.29.27468

interface l_Object {
    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(...arguments_: unknown[]): unknown;
    destroy(): void;
    getAttributes(): Record<string, unknown> | undefined;
    getCategory(): number;
    getName(): string;
    getPoint(): l_Vec3;
    getPosition(): l_Position3;
    getTypeName(): string;
    getVelocity(): l_Vec3;
    hasAttribute(attribute: string): boolean;
    inAir(): boolean;
    isExist(): boolean;
    tonumber(...args: any[]): unknown;
}

Hierarchy (View Summary)

_Object
- l_Object

Index

Properties

Category className_ database_ parentClass_

Methods

cancelChoosingCargo destroy getAttributes getCategory getName getPoint getPosition getTypeName getVelocity hasAttribute inAir isExist tonumber

Properties

className_

className_: string

database_

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_

parentClass_: { className_: string }

Methods

cancelChoosingCargo

cancelChoosingCargo(...arguments_: unknown[]): unknown
TODO: cargo-selection cancellation is engine-native and its parameter/return contract is not exposed by installed scripts.
Parameters
- ...arguments_: unknown[]
Returns unknown
Overrides _Object.cancelChoosingCargo
- Defined in Object.ts:8

destroy

destroy(): void
Removes the object from the mission. Once destroyed, the object reference must not be used for further operations.

Returns void
Nothing.
Example
```
`if (object.isExist()) object.destroy();`
```
See
https://wiki.hoggitworld.com/view/DCS_func_destroy
Overrides _Object.destroy
- Defined in Object.ts:16

getAttributes

getAttributes(): Record<string, unknown> | undefined
Returns the attributes table directly from the object's descriptor. DCS returns nil when the descriptor has no attributes table.

Returns Record<string, unknown> | undefined
Attribute-name map, or undefined when the object has no attributes.
Example
```
const unit = Unit.getByName("Target");
const attributes = unit?.getAttributes();
if (attributes?.["Ground Units"] === true) {
	env.info("Target is a ground unit");
}
```
See
%DCS_INSTALL_DIR%/Scripts/ScriptingSystem.lua:106
Overrides _Object.getAttributes
- Defined in Object.ts:119

getCategory

getCategory(): number
Returns the object's broad category identifier, such as unit, weapon, static object, airbase, or scenery.

Returns number
Numeric category from Object.Category.
Example
```
const unit = Unit.getByName("Target");
if (unit) env.info(`Object category: ${unit.getCategory()}`);
```
See
https://wiki.hoggitworld.com/view/DCS_func_getCategory
Overrides _Object.getCategory
- Defined in Object.ts:135

getName

getName(): string
Returns the object's exact mission name.

Returns string
Object name.
Example
```
`env.info(object.getName());`
```
See
https://wiki.hoggitworld.com/view/DCS_func_getName
Overrides _Object.getName
- Defined in Object.ts:25

getPoint

getPoint(): l_Vec3
Returns the object's origin in local world coordinates.

Returns l_Vec3
Position in metres.
Example
```
`const altitude = object.getPoint().y;`
```
See
https://wiki.hoggitworld.com/view/DCS_func_getPoint
Overrides _Object.getPoint
- Defined in Object.ts:34

getPosition

getPosition(): l_Position3
Returns position and orientation; p is position and x/y/z are unit axes.

Returns l_Position3
World transform.
Example
```
`const forward = object.getPosition().x;`
```
See
https://wiki.hoggitworld.com/view/DCS_func_getPosition
Overrides _Object.getPosition
- Defined in Object.ts:43

getTypeName

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

Returns string
Type name.
Example
```
`env.info(object.getTypeName());`
```
See
https://wiki.hoggitworld.com/view/DCS_func_getTypeName
Overrides _Object.getTypeName
- Defined in Object.ts:52

getVelocity

getVelocity(): l_Vec3
Returns world-axis velocity in metres per second.

Returns l_Vec3
Velocity vector.
Example
```
`const velocity = object.getVelocity();`
```
See
https://wiki.hoggitworld.com/view/DCS_func_getVelocity
Overrides _Object.getVelocity
- Defined in Object.ts:61

hasAttribute

hasAttribute(attribute: string): boolean
Tests whether the object's descriptor contains an attribute whose value is exactly true. Attribute names are DCS database strings such as "Air", "Ground Units", or "Ships".
Parameters
- attribute: string
  DCS database attribute name to test.
Returns boolean
true only when the descriptor contains that attribute with the value true.
Example
```
const unit = Unit.getByName("Target");
if (unit?.hasAttribute("Air Defence")) {
	env.info("Target is an air-defence unit");
}
```
See
- %DCS_INSTALL_DIR%/Scripts/ScriptingSystem.lua:99
- https://wiki.hoggitworld.com/view/DCS_func_hasAttribute
Overrides _Object.hasAttribute
- Defined in Object.ts:100

inAir

inAir(): boolean
Reports whether the object is airborne.

Returns boolean
In-air state.
Example
```
`if (object.inAir()) env.info("Airborne");`
```
See
https://wiki.hoggitworld.com/view/DCS_func_inAir
Overrides _Object.inAir
- Defined in Object.ts:70

isExist

isExist(): boolean
Reports whether the object still exists in the simulation.

Returns boolean
Existence state.
Example
```
`if (!object.isExist()) return;`
```
See
https://wiki.hoggitworld.com/view/DCS_func_isExist
Overrides _Object.isExist
- Defined in Object.ts:79

tonumber

tonumber(...args: any[]): unknown
Parameters
- ...args: any[]
Returns unknown
Inherited from _Object.tonumber
- Defined in exports/Object.export.ts:83

Interface l_Object

Version

Hierarchy (View Summary)

Index

Properties

Methods

Properties

Category

className_

database_

parentClass_

Methods

cancelChoosingCargo

Parameters

Returns unknown

destroy

Returns void

Example

See

getAttributes

Returns Record<string, unknown> | undefined

Example

See

getCategory

Returns number

Example

See

getName

Returns string

Example

See

getPoint

Returns l_Vec3

Example

See

getPosition

Returns l_Position3

Example

See

getTypeName

Returns string

Example

See

getVelocity

Returns l_Vec3

Example

See

hasAttribute

Parameters

Returns boolean

Example

See

inAir

Returns boolean

Example

See

isExist

Returns boolean

Example

See

tonumber

Parameters

Returns unknown

Settings

On This Page