Interface l_Controller

Version

2.9.29.27468

interface l_Controller {
    className_: string;
    Detection: {
        DLINK: number;
        IRST: number;
        OPTIC: number;
        RADAR: number;
        RWR: number;
        VISUAL: number;
    };
    parentClass_: { className_: string };
    getDetectedTargets(...detectionMethods: number[]): DetectedTarget[];
    hasTask(): boolean;
    isTargetDetected(
        target: l_Object,
        ...detectionMethods: number[],
    ): LuaMultiReturn<
        [boolean, boolean, number, boolean, boolean, l_Vec3, l_Vec3],
    >;
    knowTarget(object: l_Object, type: boolean, distance: boolean): boolean;
    popTask(): void;
    pushTask(task: ControllerAction): void;
    resetTask(): void;
    setAltitude(
        altitude: number,
        keep?: boolean,
        altitudeType?: "BARO" | "RADIO",
    ): void;
    setCommand(command: ControllerAction): void;
    setOnOff(value: boolean): void;
    setOption(
        optionId: number,
        optionValue: string | number | boolean,
    ): boolean;
    setSpeed(speed: number, keep?: boolean): void;
    setTask(task: ControllerAction): void;
    tonumber(...args: any[]): unknown;
}

Hierarchy (View Summary)

_Controller
- l_Controller

Index

Properties

className_ Detection parentClass_

Methods

getDetectedTargets hasTask isTargetDetected knowTarget popTask pushTask resetTask setAltitude setCommand setOnOff setOption setSpeed setTask tonumber

Properties

className_

className_: string

Detection

Detection: {
    DLINK: number;
    IRST: number;
    OPTIC: number;
    RADAR: number;
    RWR: number;
    VISUAL: number;
}

parentClass_

parentClass_: { className_: string }

Methods

getDetectedTargets

getDetectedTargets(...detectionMethods: number[]): DetectedTarget[]
Returns targets found by any requested method. Omitting methods checks all.
Parameters
- ...detectionMethods: number[]
  Values from Controller.Detection.
Returns DetectedTarget[]
Detected target records.
Example
```
`const targets = controller.getDetectedTargets(Controller.Detection.RADAR);`
```
See
https://wiki.hoggitworld.com/view/DCS_func_getDetectedTargets
Overrides _Controller.getDetectedTargets
- Defined in Controller.ts:29

hasTask

hasTask(): boolean
Reports whether the controller has a task.

Returns boolean
Task presence.
Example
```
`if (!controller.hasTask()) assignPatrol();`
```
See
https://wiki.hoggitworld.com/view/DCS_func_hasTask
Overrides _Controller.hasTask
- Defined in Controller.ts:38

isTargetDetected

isTargetDetected(
    target: l_Object,
    ...detectionMethods: number[],
): LuaMultiReturn<
    [boolean, boolean, number, boolean, boolean, l_Vec3, l_Vec3],
>
Checks what the controller knows about a target.
Parameters
- target: l_Object
  Target object.
- ...detectionMethods: number[]
  Values from Controller.Detection; omit to check all.
Returns LuaMultiReturn<[boolean, boolean, number, boolean, boolean, l_Vec3, l_Vec3]>
Detected, visible, last-seen time, known-type, known-distance, last position, and last velocity.
Example
```
`const [detected, visible] = controller.isTargetDetected(target);`
```
See
https://wiki.hoggitworld.com/view/DCS_func_isTargetDetected
Overrides _Controller.isTargetDetected
- Defined in Controller.ts:49

knowTarget

knowTarget(object: l_Object, type: boolean, distance: boolean): boolean
Forces a unit controller to know a target; group controllers do not support it.
Parameters
- object: l_Object
  Target to reveal.
- type: boolean
  Whether its type is revealed.
- distance: boolean
  Whether its distance is revealed.
Returns boolean
true when DCS accepts the operation.
Example
```
`const accepted = controller.knowTarget(target, true, true);`
```
See
https://wiki.hoggitworld.com/view/DCS_func_knowTarget
Overrides _Controller.knowTarget
- Defined in Controller.ts:66

popTask

popTask(): void
Removes the current task and activates the next queued task.

Returns void
Nothing.
Example
```
`controller.popTask();`
```
See
https://wiki.hoggitworld.com/view/DCS_func_popTask
Overrides _Controller.popTask
- Defined in Controller.ts:75

pushTask

pushTask(task: ControllerAction): void
Pushes a task to the front of the queue.
Parameters
- task: ControllerAction
  DCS task table.
Returns void
Nothing.
Example
```
`controller.pushTask({ id: "Orbit", params: {} });`
```
See
https://wiki.hoggitworld.com/view/DCS_func_pushTask
Overrides _Controller.pushTask
- Defined in Controller.ts:85

resetTask

resetTask(): void
Clears the active task and task queue.

Returns void
Nothing.
Example
```
`controller.resetTask();`
```
See
https://wiki.hoggitworld.com/view/DCS_func_resetTask
Overrides _Controller.resetTask
- Defined in Controller.ts:94

setAltitude

setAltitude(
    altitude: number,
    keep?: boolean,
    altitudeType?: "BARO" | "RADIO",
): void
Commands an aircraft altitude.
Parameters
- altitude: number
  Metres.
- Optionalkeep: boolean
  Preserve it across waypoints.
- OptionalaltitudeType: "BARO" | "RADIO"
  "BARO" for MSL or "RADIO" for AGL.
Returns void
Nothing.
Example
```
`controller.setAltitude(1000, true, "RADIO");`
```
See
https://wiki.hoggitworld.com/view/DCS_func_setAltitude
Overrides _Controller.setAltitude
- Defined in Controller.ts:106

setCommand

setCommand(command: ControllerAction): void
Executes an instantaneous command without replacing the active task.
Parameters
- command: ControllerAction
  DCS command table.
Returns void
Nothing.
Example
```
`controller.setCommand({ id: "StopRoute", params: { value: true } });`
```
See
https://wiki.hoggitworld.com/view/DCS_func_setCommand
Overrides _Controller.setCommand
- Defined in Controller.ts:120

setOnOff

setOnOff(value: boolean): void
Enables/disables ground or naval AI. Disabled AI cannot move, fire, or detect.
Parameters
- value: boolean
  Desired state.
Returns void
Nothing.
Example
```
`controller.setOnOff(false);`
```
See
https://wiki.hoggitworld.com/view/DCS_func_setOnOff
Overrides _Controller.setOnOff
- Defined in Controller.ts:130

setOption

setOption(optionId: number, optionValue: string | number | boolean): boolean
Sets an option from the applicable AI.Option table.
Parameters
- optionId: number
  Option ID.
- optionValue: string | number | boolean
  Option value.
Returns boolean
true when DCS accepts the option.
Example
```
`const accepted = controller.setOption(AI.Option.Air.id.ROE, AI.Option.Air.val.ROE.WEAPON_HOLD);`
```
See
https://wiki.hoggitworld.com/view/DCS_func_setOption
Overrides _Controller.setOption
- Defined in Controller.ts:141

setSpeed

setSpeed(speed: number, keep?: boolean): void
Commands speed in metres per second.
Parameters
- speed: number
  Desired speed.
- Optionalkeep: boolean
  Preserve it across waypoints.
Returns void
Nothing.
Example
```
`controller.setSpeed(125, true);`
```
See
https://wiki.hoggitworld.com/view/DCS_func_setSpeed
Overrides _Controller.setSpeed
- Defined in Controller.ts:155

setTask

setTask(task: ControllerAction): void
Replaces the active task and clears the queue.
Parameters
- task: ControllerAction
  DCS task table.
Returns void
Nothing.
Example
```
`controller.setTask({ id: "Hold", params: {} });`
```
See
https://wiki.hoggitworld.com/view/DCS_func_setTask
Overrides _Controller.setTask
- Defined in Controller.ts:165

tonumber

tonumber(...args: any[]): unknown
Parameters
- ...args: any[]
Returns unknown
Inherited from _Controller.tonumber
- Defined in exports/Controller.export.ts:30

Interface l_Controller

Version

Hierarchy (View Summary)

Index

Properties

Methods

Properties

className_

Detection

parentClass_

Methods

getDetectedTargets

Parameters

Returns DetectedTarget[]

Example

See

hasTask

Returns boolean

Example

See

isTargetDetected

Parameters

Returns LuaMultiReturn<[boolean, boolean, number, boolean, boolean, l_Vec3, l_Vec3]>

Example

See

knowTarget

Parameters

Returns boolean

Example

See

popTask

Returns void

Example

See

pushTask

Parameters

Returns void

Example

See

resetTask

Returns void

Example

See

setAltitude

Parameters

Returns void

Example

See

setCommand

Parameters

Returns void

Example

See

setOnOff

Parameters

Returns void

Example

See

setOption

Parameters

Returns boolean

Example

See

setSpeed

Parameters

Returns void

Example

See

setTask

Parameters

Returns void

Example

See

tonumber

Parameters

Returns unknown

Settings

On This Page