Interface l_StaticObject

Version

2.9.29.27468

interface l_StaticObject {
    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;
    };
    chooseCargo(...arguments_: unknown[]): unknown;
    destroy(): void;
    getAttributes(): Record<string, boolean> | undefined;
    getByName(name: string): l_StaticObject | undefined;
    getCargoDisplayName(): string | undefined;
    getCargoWeight(): number;
    getCategory(): number;
    getCoalition(): number;
    getCountry(): number;
    getDesc(): StaticObjectDesc;
    getDescByName(typeName: string): StaticObjectDesc | undefined;
    getDrawArgumentValue(argument: number): number;
    getForcesName(): string;
    getID(): number;
    getLife(): 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)

_StaticObject
- l_StaticObject

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

chooseCargo

chooseCargo(...arguments_: unknown[]): unknown
TODO: cargo-selection UI payload is engine-native and undocumented in the installed Lua sources.
Parameters
- ...arguments_: unknown[]
Returns unknown
Overrides _StaticObject.chooseCargo
- Defined in StaticObject.ts:63

destroy

destroy(): void
Removes the static object.

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

getAttributes

getAttributes(): Record<string, boolean> | undefined
Returns all database attributes assigned to this type. Some static-object descriptors omit the attributes table.

Returns Record<string, boolean> | undefined
Attribute membership flags, or undefined when the descriptor has none.
Example
```
`const attributes = object.getAttributes() ?? {};`
```
See
- %DCS_INSTALL_DIR%/Scripts/ScriptingSystem.lua:106
- https://wiki.hoggitworld.com/view/DCS_func_getAttributes
- Defined in StaticObject.ts:80

getByName

getByName(name: string): l_StaticObject | undefined
Looks up a static object by its exact Mission Editor or dynamically assigned name. Static-object names must be unique within the mission.
Parameters
- name: string
  Exact static-object name.
Returns l_StaticObject | undefined
Matching object, or undefined when no object has that name.
Example
```
const depot = StaticObject.getByName("Ammo depot");
if (!depot) env.warning("Ammo depot was not found");
```
No Self

See
https://wiki.hoggitworld.com/view/DCS_func_getByName
Overrides _StaticObject.getByName
- Defined in StaticObject.ts:225

getCargoDisplayName

getCargoDisplayName(): string | undefined
Returns the display name used for a cargo static. Non-cargo static objects can return nothing.

Returns string | undefined
Cargo display name, or undefined when the object is not cargo.
Example
```
`const cargoName = object.getCargoDisplayName(); if (cargoName) env.info(cargoName);`
```
See
https://wiki.hoggitworld.com/view/DCS_func_getCargoDisplayName
Overrides _StaticObject.getCargoDisplayName
- Defined in StaticObject.ts:173

getCargoWeight

getCargoWeight(): number
Returns cargo mass in kilograms.

Returns number
Cargo mass.
Example
```
`const massKg = cargo.getCargoWeight();`
```
See
https://wiki.hoggitworld.com/view/DCS_func_getCargoWeight
Overrides _StaticObject.getCargoWeight
- Defined in StaticObject.ts:182

getCategory

getCategory(): number
Returns the broad object category.

Returns number
Value from Object.Category.
Example
```
`const category = object.getCategory();`
```
See
https://wiki.hoggitworld.com/view/DCS_func_getCategory
- Defined in StaticObject.ts:88

getCoalition

getCoalition(): number
Returns the coalition that owns the static object.

Returns number
Coalition identifier from coalition.side.
Example
```
const depot = StaticObject.getByName("Ammo depot");
if (depot?.getCoalition() === coalition.side.RED) env.info("Red depot");
```
See
https://wiki.hoggitworld.com/view/DCS_func_getCoalition
Overrides _StaticObject.getCoalition
- Defined in StaticObject.ts:286

getCountry

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

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

getDesc

getDesc(): StaticObjectDesc
Returns database metadata describing the static object's type.

Returns StaticObjectDesc
Static-object descriptor.
Example
```
const desc = StaticObject.getByName("Ammo depot")?.getDesc();
if (desc) env.info(`${desc.displayName}: ${desc.life} life`);
```
See
https://wiki.hoggitworld.com/view/DCS_func_getDesc
Overrides _StaticObject.getDesc
- Defined in StaticObject.ts:301

getDescByName

getDescByName(typeName: string): StaticObjectDesc | undefined
Returns descriptor data for a static type without requiring an instance.
Parameters
- typeName: string
  Internal DCS type name.
Returns StaticObjectDesc | undefined
Descriptor, or undefined when unknown.
Example
```
`const desc = StaticObject.getDescByName("ammo_cargo");`
```
No Self

See
https://wiki.hoggitworld.com/view/DCS_func_getDescByName
Overrides _StaticObject.getDescByName
- Defined in StaticObject.ts:140

getDrawArgumentValue

getDrawArgumentValue(argument: number): number
Returns a model draw argument in its normalized range.
Parameters
- argument: number
  Draw-argument index.
Returns number
Current value.
Example
```
`const value = object.getDrawArgumentValue(0);`
```
See
https://wiki.hoggitworld.com/view/DCS_func_getDrawArgumentValue
Overrides _StaticObject.getDrawArgumentValue
- Defined in StaticObject.ts:192

getForcesName

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

Returns string
Example
```
`const name = cargo.getForcesName();`
```
Overrides _StaticObject.getForcesName
- Defined in StaticObject.ts:59

getID

getID(): number
Returns the static object's runtime mission identifier.

Returns number
Numeric runtime object ID.
Example
```
const object = StaticObject.getByName("Ammo depot");
if (object) env.info(`Static ID: ${object.getID()}`);
```
See
https://wiki.hoggitworld.com/view/DCS_func_getID
Overrides _StaticObject.getID
- Defined in StaticObject.ts:155

getLife

getLife(): number
Returns current life (hit points). Values below 1 are generally destroyed.

Returns number
Current life.
Example
```
`if (object.getLife() < 1) env.info("Destroyed");`
```
See
https://wiki.hoggitworld.com/view/DCS_func_getLife
Overrides _StaticObject.getLife
- Defined in StaticObject.ts:164

getName

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

Returns string
Static-object name.
Example
```
const name = StaticObject.getByName("Ammo depot")?.getName();
if (name) env.info(name);
```
See
https://wiki.hoggitworld.com/view/DCS_func_getName
Overrides _StaticObject.getName
- Defined in StaticObject.ts:207

getPoint

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

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

getPosition

getPosition(): l_Position3
Returns the object's position and orientation matrix in local world space. The p member is the point; x, y, and z are orientation unit vectors.

Returns l_Position3
Position and orientation matrix.
Example
```
const position = StaticObject.getByName("Ammo depot")?.getPosition();
if (position) env.info(`Heading vector: ${position.x.x}, ${position.x.z}`);
```
See
https://wiki.hoggitworld.com/view/DCS_func_getPosition
- Defined in StaticObject.ts:271

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 _StaticObject.getTypeName
- Defined in StaticObject.ts:96

getVelocity

getVelocity(): l_Vec3
Returns velocity in world axes.

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

hasAttribute

hasAttribute(attribute: string): boolean
Tests a database attribute.
Parameters
- attribute: string
  Attribute name.
Returns boolean
Whether it is present.
Example
```
`const cargo = object.hasAttribute("Cargos");`
```
See
https://wiki.hoggitworld.com/view/DCS_func_hasAttribute
- Defined in StaticObject.ts:113

inAir

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

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

isExist

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

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

tonumber

tonumber(...args: any[]): unknown
Parameters
- ...args: any[]
Returns unknown
Inherited from _StaticObject.tonumber
- Defined in exports/StaticObject.export.ts:101

Interface l_StaticObject

Version

Hierarchy (View Summary)

Index

Properties

Methods

Properties

className_

parentClass_

Methods

chooseCargo

Parameters

Returns unknown

destroy

Returns void

Example

See

getAttributes

Returns Record<string, boolean> | undefined

Example

See

getByName

Parameters

Returns l_StaticObject | undefined

Example

No Self

See

getCargoDisplayName

Returns string | undefined

Example

See

getCargoWeight

Returns number

Example

See

getCategory

Returns number

Example

See

getCoalition

Returns number

Example

See

getCountry

Returns number

Example

See

getDesc

Returns StaticObjectDesc

Example

See

getDescByName

Parameters

Returns StaticObjectDesc | undefined

Example

No Self

See

getDrawArgumentValue

Parameters

Returns number

Example

See

getForcesName

Returns string

Example

getID

Returns number

Example

See

getLife

Returns number

Example

See

getName

Returns string

Example

See

getPoint

Returns l_Vec3

Example