DCS World Typescript
    Preparing search index...

    Interface l_DCS

    2.9.1.48335

    Authoritative executable examples

    interface l_DCS {
        dModeFinish: number;
        dModeInit: number;
        dModePostStart: number;
        dModeStart: number;
        dModeStop: number;
        dModeUser: number;
        dModeWork: number;
        S_EVENT_AI_ABORT_MISSION: number;
        S_EVENT_BASE_CAPTURED: number;
        S_EVENT_BDA: number;
        S_EVENT_BIRTH: number;
        S_EVENT_CRASH: number;
        S_EVENT_DAYNIGHT: number;
        S_EVENT_DEAD: number;
        S_EVENT_DETAILED_FAILURE: number;
        S_EVENT_DISCARD_CHAIR_AFTER_EJECTION: number;
        S_EVENT_EJECTION: number;
        S_EVENT_EMERGENCY_LANDING: number;
        S_EVENT_ENGINE_SHUTDOWN: number;
        S_EVENT_ENGINE_STARTUP: number;
        S_EVENT_FLIGHT_TIME: number;
        S_EVENT_GROUP_CHANGE_OPTION: number;
        S_EVENT_HIT: number;
        S_EVENT_HUMAN_AIRCRAFT_REPAIR_FINISH: number;
        S_EVENT_HUMAN_AIRCRAFT_REPAIR_START: number;
        S_EVENT_HUMAN_FAILURE: number;
        S_EVENT_INVALID: number;
        S_EVENT_KILL: number;
        S_EVENT_LAND: number;
        S_EVENT_LANDING_AFTER_EJECTION: number;
        S_EVENT_LANDING_QUALITY_MARK: number;
        S_EVENT_MAC_EXTRA_SCORE: number;
        S_EVENT_MAC_LMS_RESTART: number;
        S_EVENT_MARK_ADDED: number;
        S_EVENT_MARK_CHANGE: number;
        S_EVENT_MARK_REMOVED: number;
        S_EVENT_MAX: number;
        S_EVENT_MISSION_END: number;
        S_EVENT_MISSION_RESTART: number;
        S_EVENT_MISSION_START: number;
        S_EVENT_MISSION_WINNER: number;
        S_EVENT_PARATROOPER_LENDING: number;
        S_EVENT_PILOT_DEAD: number;
        S_EVENT_PLAYER_CAPTURE_AIRFIELD: number;
        S_EVENT_PLAYER_COMMENT: number;
        S_EVENT_PLAYER_ENTER_UNIT: number;
        S_EVENT_PLAYER_LEAVE_UNIT: number;
        S_EVENT_PLAYER_SELF_KILL_PILOT: number;
        S_EVENT_REFUELING: number;
        S_EVENT_REFUELING_STOP: number;
        S_EVENT_RUNWAY_TAKEOFF: number;
        S_EVENT_RUNWAY_TOUCH: number;
        S_EVENT_SCORE: number;
        S_EVENT_SHOOTING_END: number;
        S_EVENT_SHOOTING_START: number;
        S_EVENT_SHOT: number;
        S_EVENT_SIMULATION_FREEZE: number;
        S_EVENT_SIMULATION_START: number;
        S_EVENT_SIMULATION_UNFREEZE: number;
        S_EVENT_TAKEOFF: number;
        S_EVENT_TOOK_CONTROL: number;
        S_EVENT_TRIGGER_ZONE: number;
        S_EVENT_UNIT_CREATE_TASK: number;
        S_EVENT_UNIT_DELETE_TASK: number;
        S_EVENT_UNIT_LOST: number;
        S_EVENT_UNIT_TASK_COMPLETE: number;
        S_EVENT_UNIT_TASK_STAGE: number;
        S_EVENT_WEAPON_ADD: number;
        S_EVENT_WEAPON_DROP: number;
        S_EVENT_WEAPON_REARM: number;
        UNIT_CALLSIGN: number;
        UNIT_CATEGORY: number;
        UNIT_COALITION: number;
        UNIT_COUNTRY_ID: number;
        UNIT_GROUP_MISSION_ID: number;
        UNIT_GROUPCATEGORY: number;
        UNIT_GROUPNAME: number;
        UNIT_HIDDEN: number;
        UNIT_INVISIBLE_MAP_ICON: number;
        UNIT_INVISIBLE_MAP_LABEL: number;
        UNIT_MISSION_ID: number;
        UNIT_NAME: number;
        UNIT_PLAYER_NAME: number;
        UNIT_ROLE: number;
        UNIT_RUNTIME_ID: number;
        UNIT_TASK: number;
        UNIT_TYPE: number;
        activateGroup(groupId: number): void;
        activateSteamOverlayToStore(productId: string): void;
        add_dyn_group(definition: unknown): unknown;
        checkMultiplayerSpawnConflict(definition: unknown): unknown;
        conquestCoalitionsScore(): Record<string, number>;
        create_client_aircraft(...arguments_: unknown[]): unknown;
        dispatchAnalogAction(actionId: number, value: number): void;
        dispatchDigitalAction(actionId: number, value: number | boolean): void;
        enter_with_dyngroup(...arguments_: unknown[]): unknown;
        enumMissionPersistenceData(
            visitor: (this: void, record: unknown) => void,
        ): void;
        exitProcess(): void;
        exportToMiz(fileName: string): boolean | undefined;
        getAchievementsUiInfo(): unknown;
        getAircraftAmountInAirportWarehouse(
            airportId: number,
            aircraftType: string,
        ): number;
        getAirdromesCoalition(): Record<number, number>;
        getAirdromesState(): Record<number, unknown>;
        getAirTankerID(): number | undefined;
        getATCradiosData(): unknown[];
        getAvailableCoalitions(): Record<number, DCSAvailableCoalition>;
        getAvailableSlots(coalitionId: number): DCSAvailableSlot[] | undefined;
        getConfigValue(path: string): unknown;
        getConquestAirbaseState(airbaseId: number): unknown;
        getCurrentFOV(): number;
        getCurrentMission(): Record<string, unknown>;
        getDefaultFOV(): number;
        getDynamicSpawnSettings(): Record<string, unknown>;
        getFarpsAndCarriersMissionData(): unknown[];
        getGameDuration(): number;
        getGamePattern(): string | number;
        getGeneratedParams(): Record<string, unknown>;
        getHumanUnitInputName(unitId: string | number): string | undefined;
        getInputNameByUnitType(unitType: string): string | undefined;
        getInputProfiles(): unknown[];
        getInstalledTheatres(): string[];
        getLocalizedStrings(keys: unknown): unknown;
        getLogHistory(from: number): LuaMultiReturn<[DCSLogEntry[], number]>;
        getMainPilot(): string | number | undefined;
        getManualPath(moduleId: string): string | undefined;
        getMaxFPS(): number;
        getMissionDescription(): string;
        getMissionFilename(): string | undefined;
        getMissionLoaded(): boolean;
        getMissionName(): string;
        getMissionOptions(): Record<string, unknown>;
        getMissionPersistenceData(key: string): unknown;
        getMissionResourcesDialogData(): unknown;
        getMissionResult(side: "red" | "blue"): number;
        getMissionTheatre(): string;
        getModelNameByShapeTableIndex(index: number): string | undefined;
        getModelTime(): number;
        getMoonAzimuthElevationPhase(
            date: unknown,
        ): LuaMultiReturn<[number, number, number]>;
        getObjectLiveriesNames(typeName: string): string[];
        getPause(): boolean;
        getPilotAchievements(): unknown[];
        getPilotsSummaryStatistics(): unknown[];
        getPilotStatistics(pilotId?: string | number): unknown;
        getPlayerBriefing(): string;
        getPlayerCoalition(): number;
        getPlayerUnit(): string | number | undefined;
        getPlayerUnitType(): string | undefined;
        getRealTime(): number;
        getServerStartTime(): number;
        getServerStartTimeRemain(): number;
        getSimulatorMode(): string | number;
        getSunAzimuthElevation(
            ...arguments_: unknown[],
        ): LuaMultiReturn<[number, number]>;
        getSunriseSunsetSecond(
            ...arguments_: unknown[],
        ): LuaMultiReturn<[number, number]>;
        getTaintedCategories(): string[];
        getTaintedFiles(): unknown[];
        getTheatreID(): number;
        getUnitPositionByObjectId(objectId: number): unknown;
        getUnitProperty(
            missionId: number,
            propertyId: number,
        ): string | number | boolean | undefined;
        getUnitType(missionId: number): string;
        getUnitTypeAttribute(typeId: string, attribute: string): unknown;
        getUserOptions(): Record<string, unknown>;
        hasMultipleSlots(unitId: string | number): boolean;
        HMD_isActive(): boolean;
        isHumanSeatAvailable(unitId: string | number, seatId?: number): boolean;
        isMetricSystem(): boolean;
        isMultiplayer(): boolean;
        isRoleAvailable(unitId: string | number, role: unknown): boolean;
        isServer(): boolean;
        isSlotFlyable(unitId: string | number): boolean;
        isSteamVersion(): boolean;
        isSupercarrierRoleAvailable(
            unitId: string | number,
            role: unknown,
        ): boolean;
        isTrackPlaying(): boolean;
        LMSGetRemainingTimeBeforeZoneShrink(): number;
        LMSRestart(): void;
        LMSSetWaitForMinimalPlayers(wait: boolean): void;
        lockAllKeyboardInput(): void;
        lockAllMouseInput(): void;
        lockKeyboardInput(key: unknown): void;
        lockMouseInput(button: unknown): void;
        MACSavePSData(data: unknown): unknown;
        makeScreenShot(name: string): void;
        onShowDialog(...arguments_: unknown[]): unknown;
        onShowStatusBar(visible: boolean): void;
        onUserLogin(...arguments_: unknown[]): unknown;
        openHomePage(): void;
        preloadCockpit(unitType: string): boolean | undefined;
        RCD_selectMenuItem(...arguments_: unknown[]): unknown;
        refreshPilotStatistics(): void;
        reloadOptions(): void;
        reloadUserScripts(): void;
        restartMission(): void;
        saveMissionTo(fileName: string): boolean | undefined;
        selfKillPilot(): void;
        sendRCD_Callback(...arguments_: unknown[]): unknown;
        setBoardNumResourcesDialogData(boardNumber: string | number): void;
        setCameraToAirdrome(airdromeId: number): void;
        setCurrentFOV(fieldOfView: number): void;
        setDebriefingShow(visible: boolean): void;
        setDefaultFOV(fieldOfView: number): void;
        setLiveryNameResourcesDialogData(liveryName: string): void;
        setMainPilot(pilotId: string | number): void;
        setMaxFPS(framesPerSecond: number): void;
        setMissionResourcesDialogData(data: unknown): void;
        setNeedRestartApplication(required: boolean): void;
        setPause(paused: boolean): void;
        setPlayerCoalition(coalitionId: number): void;
        setPlayerUnit(unitId: string | number): void;
        setScreenShotExt(extension: string): void;
        setUserCallbacks(
            callbacks: Record<
                string,
                ((this: void, ...args: unknown[]) => unknown)
                | undefined,
            >,
        ): void;
        setViewPause(paused: boolean): void;
        setViewRearm(...arguments_: unknown[]): unknown;
        setViewRearmAnimationTime(seconds: number): void;
        setViewRearmPositionType(positionType: number): void;
        spawnPlayer(...arguments_: unknown[]): unknown;
        startMission(fileName: string): boolean | undefined;
        stopMission(): void;
        takeTrackControl(): void;
        toggleDTC(): void;
        UIDeclutterOnOff(enabled: boolean): void;
        UIRequestOverlayWidgetPosition(...arguments_: unknown[]): unknown;
        unlockKeyboardInput(): void;
        unlockMouseInput(): void;
        unsetViewRearm(): void;
        updaterOperation(operation: string, ...arguments_: unknown[]): unknown;
        writeDebriefing(text: string): void;
    }

    Hierarchy

    • DCSConstants
      • l_DCS
    Index
    dModeFinish dModeInit dModePostStart dModeStart dModeStop dModeUser dModeWork S_EVENT_AI_ABORT_MISSION S_EVENT_BASE_CAPTURED S_EVENT_BDA S_EVENT_BIRTH S_EVENT_CRASH S_EVENT_DAYNIGHT S_EVENT_DEAD S_EVENT_DETAILED_FAILURE S_EVENT_DISCARD_CHAIR_AFTER_EJECTION S_EVENT_EJECTION S_EVENT_EMERGENCY_LANDING S_EVENT_ENGINE_SHUTDOWN S_EVENT_ENGINE_STARTUP S_EVENT_FLIGHT_TIME S_EVENT_GROUP_CHANGE_OPTION S_EVENT_HIT S_EVENT_HUMAN_AIRCRAFT_REPAIR_FINISH S_EVENT_HUMAN_AIRCRAFT_REPAIR_START S_EVENT_HUMAN_FAILURE S_EVENT_INVALID S_EVENT_KILL S_EVENT_LAND S_EVENT_LANDING_AFTER_EJECTION S_EVENT_LANDING_QUALITY_MARK S_EVENT_MAC_EXTRA_SCORE S_EVENT_MAC_LMS_RESTART S_EVENT_MARK_ADDED S_EVENT_MARK_CHANGE S_EVENT_MARK_REMOVED S_EVENT_MAX S_EVENT_MISSION_END S_EVENT_MISSION_RESTART S_EVENT_MISSION_START S_EVENT_MISSION_WINNER S_EVENT_PARATROOPER_LENDING S_EVENT_PILOT_DEAD S_EVENT_PLAYER_CAPTURE_AIRFIELD S_EVENT_PLAYER_COMMENT S_EVENT_PLAYER_ENTER_UNIT S_EVENT_PLAYER_LEAVE_UNIT S_EVENT_PLAYER_SELF_KILL_PILOT S_EVENT_REFUELING S_EVENT_REFUELING_STOP S_EVENT_RUNWAY_TAKEOFF S_EVENT_RUNWAY_TOUCH S_EVENT_SCORE S_EVENT_SHOOTING_END S_EVENT_SHOOTING_START S_EVENT_SHOT S_EVENT_SIMULATION_FREEZE S_EVENT_SIMULATION_START S_EVENT_SIMULATION_UNFREEZE S_EVENT_TAKEOFF S_EVENT_TOOK_CONTROL S_EVENT_TRIGGER_ZONE S_EVENT_UNIT_CREATE_TASK S_EVENT_UNIT_DELETE_TASK S_EVENT_UNIT_LOST S_EVENT_UNIT_TASK_COMPLETE S_EVENT_UNIT_TASK_STAGE S_EVENT_WEAPON_ADD S_EVENT_WEAPON_DROP S_EVENT_WEAPON_REARM UNIT_CALLSIGN UNIT_CATEGORY UNIT_COALITION UNIT_COUNTRY_ID UNIT_GROUP_MISSION_ID UNIT_GROUPCATEGORY UNIT_GROUPNAME UNIT_HIDDEN UNIT_INVISIBLE_MAP_ICON UNIT_INVISIBLE_MAP_LABEL UNIT_MISSION_ID UNIT_NAME UNIT_PLAYER_NAME UNIT_ROLE UNIT_RUNTIME_ID UNIT_TASK UNIT_TYPE
    activateGroup activateSteamOverlayToStore add_dyn_group checkMultiplayerSpawnConflict conquestCoalitionsScore create_client_aircraft dispatchAnalogAction dispatchDigitalAction enter_with_dyngroup enumMissionPersistenceData exitProcess exportToMiz getAchievementsUiInfo getAircraftAmountInAirportWarehouse getAirdromesCoalition getAirdromesState getAirTankerID getATCradiosData getAvailableCoalitions getAvailableSlots getConfigValue getConquestAirbaseState getCurrentFOV getCurrentMission getDefaultFOV getDynamicSpawnSettings getFarpsAndCarriersMissionData getGameDuration getGamePattern getGeneratedParams getHumanUnitInputName getInputNameByUnitType getInputProfiles getInstalledTheatres getLocalizedStrings getLogHistory getMainPilot getManualPath getMaxFPS getMissionDescription getMissionFilename getMissionLoaded getMissionName getMissionOptions getMissionPersistenceData getMissionResourcesDialogData getMissionResult getMissionTheatre getModelNameByShapeTableIndex getModelTime getMoonAzimuthElevationPhase getObjectLiveriesNames getPause getPilotAchievements getPilotsSummaryStatistics getPilotStatistics getPlayerBriefing getPlayerCoalition getPlayerUnit getPlayerUnitType getRealTime getServerStartTime getServerStartTimeRemain getSimulatorMode getSunAzimuthElevation getSunriseSunsetSecond getTaintedCategories getTaintedFiles getTheatreID getUnitPositionByObjectId getUnitProperty getUnitType getUnitTypeAttribute getUserOptions hasMultipleSlots HMD_isActive isHumanSeatAvailable isMetricSystem isMultiplayer isRoleAvailable isServer isSlotFlyable isSteamVersion isSupercarrierRoleAvailable isTrackPlaying LMSGetRemainingTimeBeforeZoneShrink LMSRestart LMSSetWaitForMinimalPlayers lockAllKeyboardInput lockAllMouseInput lockKeyboardInput lockMouseInput MACSavePSData makeScreenShot onShowDialog onShowStatusBar onUserLogin openHomePage preloadCockpit RCD_selectMenuItem refreshPilotStatistics reloadOptions reloadUserScripts restartMission saveMissionTo selfKillPilot sendRCD_Callback setBoardNumResourcesDialogData setCameraToAirdrome setCurrentFOV setDebriefingShow setDefaultFOV setLiveryNameResourcesDialogData setMainPilot setMaxFPS setMissionResourcesDialogData setNeedRestartApplication setPause setPlayerCoalition setPlayerUnit setScreenShotExt setUserCallbacks setViewPause setViewRearm setViewRearmAnimationTime setViewRearmPositionType spawnPlayer startMission stopMission takeTrackControl toggleDTC UIDeclutterOnOff UIRequestOverlayWidgetPosition unlockKeyboardInput unlockMouseInput unsetViewRearm updaterOperation writeDebriefing
    dModeFinish: number
    dModeInit: number
    dModePostStart: number
    dModeStart: number
    dModeStop: number
    dModeUser: number
    dModeWork: number
    S_EVENT_AI_ABORT_MISSION: number
    S_EVENT_BASE_CAPTURED: number
    S_EVENT_BDA: number
    S_EVENT_BIRTH: number
    S_EVENT_CRASH: number
    S_EVENT_DAYNIGHT: number
    S_EVENT_DEAD: number
    S_EVENT_DETAILED_FAILURE: number
    S_EVENT_DISCARD_CHAIR_AFTER_EJECTION: number
    S_EVENT_EJECTION: number
    S_EVENT_EMERGENCY_LANDING: number
    S_EVENT_ENGINE_SHUTDOWN: number
    S_EVENT_ENGINE_STARTUP: number
    S_EVENT_FLIGHT_TIME: number
    S_EVENT_GROUP_CHANGE_OPTION: number
    S_EVENT_HIT: number
    S_EVENT_HUMAN_AIRCRAFT_REPAIR_FINISH: number
    S_EVENT_HUMAN_AIRCRAFT_REPAIR_START: number
    S_EVENT_HUMAN_FAILURE: number
    S_EVENT_INVALID: number
    S_EVENT_KILL: number
    S_EVENT_LAND: number
    S_EVENT_LANDING_AFTER_EJECTION: number
    S_EVENT_LANDING_QUALITY_MARK: number
    S_EVENT_MAC_EXTRA_SCORE: number
    S_EVENT_MAC_LMS_RESTART: number
    S_EVENT_MARK_ADDED: number
    S_EVENT_MARK_CHANGE: number
    S_EVENT_MARK_REMOVED: number
    S_EVENT_MAX: number
    S_EVENT_MISSION_END: number
    S_EVENT_MISSION_RESTART: number
    S_EVENT_MISSION_START: number
    S_EVENT_MISSION_WINNER: number
    S_EVENT_PARATROOPER_LENDING: number
    S_EVENT_PILOT_DEAD: number
    S_EVENT_PLAYER_CAPTURE_AIRFIELD: number
    S_EVENT_PLAYER_COMMENT: number
    S_EVENT_PLAYER_ENTER_UNIT: number
    S_EVENT_PLAYER_LEAVE_UNIT: number
    S_EVENT_PLAYER_SELF_KILL_PILOT: number
    S_EVENT_REFUELING: number
    S_EVENT_REFUELING_STOP: number
    S_EVENT_RUNWAY_TAKEOFF: number
    S_EVENT_RUNWAY_TOUCH: number
    S_EVENT_SCORE: number
    S_EVENT_SHOOTING_END: number
    S_EVENT_SHOOTING_START: number
    S_EVENT_SHOT: number
    S_EVENT_SIMULATION_FREEZE: number
    S_EVENT_SIMULATION_START: number
    S_EVENT_SIMULATION_UNFREEZE: number
    S_EVENT_TAKEOFF: number
    S_EVENT_TOOK_CONTROL: number
    S_EVENT_TRIGGER_ZONE: number
    S_EVENT_UNIT_CREATE_TASK: number
    S_EVENT_UNIT_DELETE_TASK: number
    S_EVENT_UNIT_LOST: number
    S_EVENT_UNIT_TASK_COMPLETE: number
    S_EVENT_UNIT_TASK_STAGE: number
    S_EVENT_WEAPON_ADD: number
    S_EVENT_WEAPON_DROP: number
    S_EVENT_WEAPON_REARM: number
    UNIT_CALLSIGN: number
    UNIT_CATEGORY: number
    UNIT_COALITION: number
    UNIT_COUNTRY_ID: number
    UNIT_GROUP_MISSION_ID: number
    UNIT_GROUPCATEGORY: number
    UNIT_GROUPNAME: number
    UNIT_HIDDEN: number
    UNIT_INVISIBLE_MAP_ICON: number
    UNIT_INVISIBLE_MAP_LABEL: number
    UNIT_MISSION_ID: number
    UNIT_NAME: number
    UNIT_PLAYER_NAME: number
    UNIT_ROLE: number
    UNIT_RUNTIME_ID: number
    UNIT_TASK: number
    UNIT_TYPE: number

    • Activates a mission group by mission identifier.

      Parameters

      • groupId: number

      Returns void

      `DCS.activateGroup(groupId);`

    • Opens the Steam store overlay for a product.

      Parameters

      • productId: string

      Returns void

      `DCS.activateSteamOverlayToStore(productId);`

    • TODO: dynamic-group mission payload is version-dependent; use mission scripting coalition.addGroup where possible.

      Parameters

      • definition: unknown

      Returns unknown

    • TODO: dynamic-spawn conflict result schema is native and version-dependent.

      Parameters

      • definition: unknown

      Returns unknown

    • Returns conquest-mode coalition scores. TODO: score table keys vary with game mode.

      Returns Record<string, number>

    • TODO: client-aircraft creation payload is native and version-dependent.

      Parameters

      • ...arguments_: unknown[]

      Returns unknown

    • Dispatches an analog input action.

      Parameters

      • actionId: number

        Native input action identifier.

      • value: number

        Normalized analog value.

      Returns void

    • Dispatches a digital input action.

      Parameters

      • actionId: number

        Native input action identifier.

      • value: number | boolean

        Press/release state.

      Returns void

    • TODO: dynamic-group entry payload is a private multiplayer UI contract.

      Parameters

      • ...arguments_: unknown[]

      Returns unknown

    • Enumerates mission-persistence records through a native callback.

      Parameters

      • visitor: (this: void, record: unknown) => void

        Called for every record, as a plain Lua function (no self).

      Returns void

    • Exits the DCS process.

      Returns void

      Nothing.

      `DCS.exitProcess();`

      %DCS_INSTALL_DIR%/API/Sim_ControlAPI.md:107

    • Exports current mission data to a .miz file.

      Parameters

      • fileName: string

      Returns boolean | undefined

      `DCS.exportToMiz(fileName);`

    • Returns UI metadata for achievements.

      Returns unknown

    • Returns the aircraft stock count for an airport warehouse.

      Parameters

      • airportId: number
      • aircraftType: string

      Returns number

    • Returns airdrome coalition assignments.

      Returns Record<number, number>

    • Returns current airdrome state records.

      Returns Record<number, unknown>

    • Returns the active tanker object identifier, or nothing.

      Returns number | undefined

    • Returns ATC radio metadata. Its nested fields are theatre-defined.

      Returns unknown[]

    • Returns coalitions having available player slots.

      Returns Record<number, DCSAvailableCoalition>

      Records keyed by coalition ID.

      `const coalitions = DCS.getAvailableCoalitions();`

      %DCS_INSTALL_DIR%/API/Sim_ControlAPI.md:135

    • Returns available player slots for a coalition.

      DCS may return nothing when the requested coalition is unavailable in the current mission or UI state. Multi-seat unitId values may be strings of the form unitID_seatID.

      Parameters

      • coalitionId: number

        Coalition ID returned by getAvailableCoalitions.

      Returns DCSAvailableSlot[] | undefined

      Available slots, or undefined when the coalition is unavailable.

      const slots = DCS.getAvailableSlots(2);
      if (slots) {
      	for (const slot of slots) log.write("slots", log.INFO, slot.callsign);
      }
      • %DCS_INSTALL_DIR%/API/Sim_ControlAPI.md:142
      • %DCS_INSTALL_DIR%/Scripts/UI/BriefingDialog.lua:628

    • Reads a value from DCS configuration state.

      Parameters

      • path: string

        Configuration path.

      Returns unknown

      Stored value when present.

      `const value = DCS.getConfigValue("graphics.width");`

      %DCS_INSTALL_DIR%/API/Sim_ControlAPI.md:221

    • Returns conquest-mode state for an airbase.

      Parameters

      • airbaseId: number

      Returns unknown

    • Returns the current camera field of view in degrees.

      Returns number

      `const fov = DCS.getCurrentFOV();`

    • Returns the loaded mission table; use getMissionOptions for authoritative options.

      Returns Record<string, unknown>

      Mission data.

      `const mission = DCS.getCurrentMission();`

      %DCS_INSTALL_DIR%/API/Sim_ControlAPI.md:148

    • Returns the configured default field of view in degrees.

      Returns number

    • Returns dynamic-spawn settings. Fields are version-dependent.

      Returns Record<string, unknown>

    • Returns mission data for FARPs and carriers.

      Returns unknown[]

    • Returns elapsed game duration in seconds.

      Returns number

    • Returns the active game-pattern identifier.

      Returns string | number

    • Returns generated mission parameters.

      Returns Record<string, unknown>

    • Returns the human-readable input profile name for a unit.

      Parameters

      • unitId: string | number

      Returns string | undefined

    • Returns the input profile name for a database unit type.

      Parameters

      • unitType: string

      Returns string | undefined

    • Returns installed input-profile records.

      Returns unknown[]

    • Returns installed theatre identifiers.

      Returns string[]

      `const theatres = DCS.getInstalledTheatres();`

    • Returns localized strings requested by a private UI key set. TODO: request/result schema varies by UI caller.

      Parameters

      • keys: unknown

      Returns unknown

    • Returns log entries from an index and the next index to request.

      Parameters

      • from: number

        Starting log index.

      Returns LuaMultiReturn<[DCSLogEntry[], number]>

      Log entries and next index.

      `const [entries, next] = DCS.getLogHistory(0);`

      %DCS_INSTALL_DIR%/API/Sim_ControlAPI.md:211

    • Returns the selected main-pilot identifier.

      Returns string | number | undefined

    • Returns the path to the installed manual for a module.

      Parameters

      • moduleId: string

      Returns string | undefined

    • Returns the configured frame-rate cap.

      Returns number

    • Returns the translated mission description.

      Returns string

      Description text.

      `const briefing = DCS.getMissionDescription();`

      %DCS_INSTALL_DIR%/API/Sim_ControlAPI.md:131

    • Returns the current mission filename, or nothing on a multiplayer client.

      Returns string | undefined

      Mission path when available.

      `const filename = DCS.getMissionFilename();`

      %DCS_INSTALL_DIR%/API/Sim_ControlAPI.md:156

    • Reports whether a mission has finished loading. Warning: DCS 2.9.27-2.9.29 can ACCESS_VIOLATION when this is called with a mission loaded; the verification corpus checks only export presence.

      Returns boolean

    • Returns the current mission name.

      Returns string

      Mission name.

      `const name = DCS.getMissionName();`

      %DCS_INSTALL_DIR%/API/Sim_ControlAPI.md:152

    • Returns mission.options.

      Returns Record<string, unknown>

      Mission option table.

      `const options = DCS.getMissionOptions();`

      %DCS_INSTALL_DIR%/API/Sim_ControlAPI.md:127

    • Returns one mission-persistence record. TODO: key/value schemas are mission-defined.

      Parameters

      • key: string

      Returns unknown

    • Returns the mission-resource dialog model.

      Returns unknown

    • Returns the mission result for red or blue.

      Parameters

      • side: "red" | "blue"

        Coalition name.

      Returns number

      Result from 0 through 100.

      `const result = DCS.getMissionResult("blue");`

      %DCS_INSTALL_DIR%/API/Sim_ControlAPI.md:160

    • Returns the active mission theatre identifier.

      Returns string

    • Returns a model name for a shape-table index.

      Parameters

      • index: number

      Returns string | undefined

    • Returns current simulation model time.

      Returns number

      Seconds.

      `const modelTime = DCS.getModelTime();`

      %DCS_INSTALL_DIR%/API/Sim_ControlAPI.md:119

    • Returns moon azimuth, elevation, and phase for a date/time. TODO: date parameter is an engine-native table.

      Parameters

      • date: unknown

      Returns LuaMultiReturn<[number, number, number]>

    • Returns livery names available to an object type.

      Parameters

      • typeName: string

      Returns string[]

    • Reports whether the simulation is paused.

      Returns boolean

      Pause state.

      `const paused = DCS.getPause();`

      %DCS_INSTALL_DIR%/API/Sim_ControlAPI.md:99

    • Returns pilot-achievement records.

      Returns unknown[]

    • Returns summary statistics for all pilots.

      Returns unknown[]

    • Returns statistics for one pilot.

      Parameters

      • OptionalpilotId: string | number

      Returns unknown

    • Returns the translated player briefing.

      Returns string

    • Returns the selected player's coalition.

      Returns number

    • Returns the selected player unit mission identifier.

      Returns string | number | undefined

    • Returns the selected player unit's database type.

      Returns string | undefined

    • Returns real time since application startup.

      Returns number

      Seconds.

      `const uptime = DCS.getRealTime();`

      %DCS_INSTALL_DIR%/API/Sim_ControlAPI.md:123

    • Returns the server start time as an absolute timestamp.

      Returns number

    • Returns seconds remaining before configured server start.

      Returns number

    • Returns the simulator-mode identifier.

      Returns string | number

    • Returns sun azimuth and elevation. TODO: date/location parameter schema is native.

      Parameters

      • ...arguments_: unknown[]

      Returns LuaMultiReturn<[number, number]>

    • Returns sunrise and sunset seconds for a date/location. TODO: parameter schema is native.

      Parameters

      • ...arguments_: unknown[]

      Returns LuaMultiReturn<[number, number]>

    • Returns integrity-check taint categories.

      Returns string[]

    • Returns integrity-check tainted-file records.

      Returns unknown[]

    • Returns the numeric ID of the active theatre.

      Returns number

    • Returns position data for a runtime object ID.

      Parameters

      • objectId: number

      Returns unknown

    • Returns a unit property selected by one of the DCS.UNIT_* constants.

      Parameters

      • missionId: number

        Unit mission ID.

      • propertyId: number

        Property selector.

      Returns string | number | boolean | undefined

      Property value when available.

      `const name = DCS.getUnitProperty(12, DCS.UNIT_NAME);`

      %DCS_INSTALL_DIR%/API/Sim_ControlAPI.md:164

    • Returns a unit type ID.

      Parameters

      • missionId: number

        Unit mission ID.

      Returns string

      Database type ID.

      `const typeId = DCS.getUnitType(12);`

      %DCS_INSTALL_DIR%/API/Sim_ControlAPI.md:185

    • Reads an attribute from a database unit type.

      Parameters

      • typeId: string

        Database type ID.

      • attribute: string

        Attribute name.

      Returns unknown

      Attribute value when available.

      `const label = DCS.getUnitTypeAttribute("Ural", "DisplayName");`

      %DCS_INSTALL_DIR%/API/Sim_ControlAPI.md:189

    • Returns current user options.

      Returns Record<string, unknown>

    • Reports whether the selected unit has multiple crew slots.

      Parameters

      • unitId: string | number

      Returns boolean

    • Returns whether a head-mounted display is active.

      Returns boolean

      `const active = DCS.HMD_isActive();`

      %DCS_INSTALL_DIR%/Scripts/UI/ViewportEditor.lua

    • Reports whether a human seat is available.

      Parameters

      • unitId: string | number
      • OptionalseatId: number

      Returns boolean

    • Reports whether the UI is configured for metric units.

      Returns boolean

    • Reports whether DCS is running in multiplayer mode.

      Returns boolean

      Multiplayer state.

      `const multiplayer = DCS.isMultiplayer();`

      %DCS_INSTALL_DIR%/API/Sim_ControlAPI.md:111

    • Reports whether a role is available for a unit. TODO: role identifier values are module-defined.

      Parameters

      • unitId: string | number
      • role: unknown

      Returns boolean

    • Reports whether this instance is a server; single-player also returns true.

      Returns boolean

      Server state.

      `const server = DCS.isServer();`

      %DCS_INSTALL_DIR%/API/Sim_ControlAPI.md:115

    • Reports whether a mission slot can be flown.

      Parameters

      • unitId: string | number

      Returns boolean

    • Reports whether this is the Steam distribution.

      Returns boolean

    • Reports whether a Supercarrier role is available. TODO: role identifier values are module-defined.

      Parameters

      • unitId: string | number
      • role: unknown

      Returns boolean

    • Reports whether DCS is currently replaying a track.

      Returns boolean

    • Returns seconds remaining before the Last Man Standing zone shrinks.

      Returns number

      `const seconds = DCS.LMSGetRemainingTimeBeforeZoneShrink();`

    • Restarts the Last Man Standing game mode.

      Returns void

      Nothing.

    • Configures whether Last Man Standing waits for its minimum player count.

      Parameters

      • wait: boolean

      Returns void

    • Locks all keyboard input from the simulation UI. Pair with unlockKeyboardInput.

      Returns void

    • Locks all mouse input from the simulation UI. Pair with unlockMouseInput.

      Returns void

    • Locks one keyboard input. TODO: native key descriptor schema is UI-internal.

      Parameters

      • key: unknown

      Returns void

    • Locks one mouse input. TODO: native button descriptor schema is UI-internal.

      Parameters

      • button: unknown

      Returns void

    • TODO: Modern Air Combat pilot-statistics payload is native and not described in installed Lua sources.

      Parameters

      • data: unknown

      Returns unknown

    • Saves a screenshot with the supplied name.

      Parameters

      • name: string

        Screenshot name.

      Returns void

      Nothing.

      `DCS.makeScreenShot("mission-start");`

      %DCS_INSTALL_DIR%/API/Sim_ControlAPI.md:207

    • Notifies DCS that a dialog's visibility changed. TODO: dialog identifiers are private UI values.

      Parameters

      • ...arguments_: unknown[]

      Returns unknown

    • Notifies DCS that status-bar visibility changed.

      Parameters

      • visible: boolean

      Returns void

    • Notifies UI scripts of user login. TODO: login payload schema is private.

      Parameters

      • ...arguments_: unknown[]

      Returns unknown

    • Opens DCS's configured home page in the system browser.

      Returns void

    • Preloads a cockpit by database unit type.

      Parameters

      • unitType: string

      Returns boolean | undefined

    • TODO: radio-command-dialog menu selection payload is a private UI contract.

      Parameters

      • ...arguments_: unknown[]

      Returns unknown

    • Recomputes pilot statistics.

      Returns void

    • Reloads user option files.

      Returns void

    • Reloads hook/user scripts.

      Returns void

      %DCS_INSTALL_DIR%/API/Sim_ControlAPI.md

    • Restarts the current mission.

      Returns void

    • Saves the active mission to a .miz path.

      Parameters

      • fileName: string

      Returns boolean | undefined

    • Self-kills the active player pilot.

      Returns void

    • TODO: radio-command-dialog callback payload is UI-private.

      Parameters

      • ...arguments_: unknown[]

      Returns unknown

    • Sets the board number in the mission-resource dialog model.

      Parameters

      • boardNumber: string | number

      Returns void

    • Moves the camera to an airdrome identifier.

      Parameters

      • airdromeId: number

      Returns void

    • Sets the current camera field of view in degrees.

      Parameters

      • fieldOfView: number

      Returns void

    • Controls whether the debriefing UI is shown.

      Parameters

      • visible: boolean

      Returns void

    • Sets the default camera field of view in degrees.

      Parameters

      • fieldOfView: number

      Returns void

    • Sets the livery name in the mission-resource dialog model.

      Parameters

      • liveryName: string

      Returns void

    • Selects the main pilot identifier.

      Parameters

      • pilotId: string | number

      Returns void

    • Sets the frame-rate cap.

      Parameters

      • framesPerSecond: number

      Returns void

    • Replaces mission-resource dialog data. TODO: UI model schema is version-dependent.

      Parameters

      • data: unknown

      Returns void

    • Sets the application-restart-required flag.

      Parameters

      • required: boolean

      Returns void

    • Pauses or resumes the simulation; this is server-side only.

      Parameters

      • paused: boolean

        Desired pause state.

      Returns void

      Nothing.

      `DCS.setPause(true);`

      %DCS_INSTALL_DIR%/API/Sim_ControlAPI.md:95

    • Sets the selected player's coalition.

      Parameters

      • coalitionId: number

      Returns void

    • Sets the selected player unit.

      Parameters

      • unitId: string | number

      Returns void

    • Changes the screenshot file extension.

      Parameters

      • extension: string

      Returns void

    • Installs GameGUI callback handlers.

      DCS calls each handler as a plain Lua function with the hook's arguments, so the handlers take no self (this: void). A handler that must return several values (for example onPlayerTryConnect returning false, reason) needs an explicit LuaMultiReturn return type.

      Parameters

      • callbacks: Record<string, ((this: void, ...args: unknown[]) => unknown) | undefined>

        Callback table; omitted callbacks remain unhandled.

      Returns void

      Nothing.

      `DCS.setUserCallbacks({ onSimulationStart: () => log.info("Started") });`

      %DCS_INSTALL_DIR%/API/Sim_ControlAPI.md:201

    • Pauses or resumes external view motion.

      Parameters

      • paused: boolean

      Returns void

    • Enables the rearming view. TODO: native view payload is UI-private.

      Parameters

      • ...arguments_: unknown[]

      Returns unknown

    • Sets rearming-view animation time in seconds.

      Parameters

      • seconds: number

      Returns void

    • Sets rearming-view position mode.

      Parameters

      • positionType: number

      Returns void

    • Spawns the selected player. TODO: dynamic-spawn payload is version-dependent.

      Parameters

      • ...arguments_: unknown[]

      Returns unknown

    • Starts a mission file.

      Parameters

      • fileName: string

      Returns boolean | undefined

    • Stops the current mission.

      Returns void

      Nothing.

      `DCS.stopMission();`

      %DCS_INSTALL_DIR%/API/Sim_ControlAPI.md:103

    • Takes interactive control during track replay.

      Returns void

    • Toggles the data-transfer-cartridge UI.

      Returns void

    • Toggles UI decluttering.

      Parameters

      • enabled: boolean

      Returns void

      `DCS.UIDeclutterOnOff(true);`

    • TODO: overlay-widget positioning uses a private UI payload not defined in installed scripts.

      Parameters

      • ...arguments_: unknown[]

      Returns unknown

    • Releases keyboard-input locks.

      Returns void

    • Releases mouse-input locks.

      Returns void

    • Disables the rearming view.

      Returns void

    • Runs an updater operation. TODO: updater operation names/options are private and version-dependent.

      Parameters

      • operation: string
      • ...arguments_: unknown[]

      Returns unknown

    • Writes custom text to the mission debriefing file.

      Parameters

      • text: string

        Text to append.

      Returns void

      Nothing.

      `DCS.writeDebriefing("Mission script completed");`

      %DCS_INSTALL_DIR%/API/Sim_ControlAPI.md:197

    Settings
    Member Visibility

    On This Page
    Properties
    dModeFinishdModeInitdModePostStartdModeStartdModeStopdModeUserdModeWorkS_EVENT_AI_ABORT_MISSIONS_EVENT_BASE_CAPTUREDS_EVENT_BDAS_EVENT_BIRTHS_EVENT_CRASHS_EVENT_DAYNIGHTS_EVENT_DEADS_EVENT_DETAILED_FAILURES_EVENT_DISCARD_CHAIR_AFTER_EJECTIONS_EVENT_EJECTIONS_EVENT_EMERGENCY_LANDINGS_EVENT_ENGINE_SHUTDOWNS_EVENT_ENGINE_STARTUPS_EVENT_FLIGHT_TIMES_EVENT_GROUP_CHANGE_OPTIONS_EVENT_HITS_EVENT_HUMAN_AIRCRAFT_REPAIR_FINISHS_EVENT_HUMAN_AIRCRAFT_REPAIR_STARTS_EVENT_HUMAN_FAILURES_EVENT_INVALIDS_EVENT_KILLS_EVENT_LANDS_EVENT_LANDING_AFTER_EJECTIONS_EVENT_LANDING_QUALITY_MARKS_EVENT_MAC_EXTRA_SCORES_EVENT_MAC_LMS_RESTARTS_EVENT_MARK_ADDEDS_EVENT_MARK_CHANGES_EVENT_MARK_REMOVEDS_EVENT_MAXS_EVENT_MISSION_ENDS_EVENT_MISSION_RESTARTS_EVENT_MISSION_STARTS_EVENT_MISSION_WINNERS_EVENT_PARATROOPER_LENDINGS_EVENT_PILOT_DEADS_EVENT_PLAYER_CAPTURE_AIRFIELDS_EVENT_PLAYER_COMMENTS_EVENT_PLAYER_ENTER_UNITS_EVENT_PLAYER_LEAVE_UNITS_EVENT_PLAYER_SELF_KILL_PILOTS_EVENT_REFUELINGS_EVENT_REFUELING_STOPS_EVENT_RUNWAY_TAKEOFFS_EVENT_RUNWAY_TOUCHS_EVENT_SCORES_EVENT_SHOOTING_ENDS_EVENT_SHOOTING_STARTS_EVENT_SHOTS_EVENT_SIMULATION_FREEZES_EVENT_SIMULATION_STARTS_EVENT_SIMULATION_UNFREEZES_EVENT_TAKEOFFS_EVENT_TOOK_CONTROLS_EVENT_TRIGGER_ZONES_EVENT_UNIT_CREATE_TASKS_EVENT_UNIT_DELETE_TASKS_EVENT_UNIT_LOSTS_EVENT_UNIT_TASK_COMPLETES_EVENT_UNIT_TASK_STAGES_EVENT_WEAPON_ADDS_EVENT_WEAPON_DROPS_EVENT_WEAPON_REARMUNIT_CALLSIGNUNIT_CATEGORYUNIT_COALITIONUNIT_COUNTRY_IDUNIT_GROUP_MISSION_IDUNIT_GROUPCATEGORYUNIT_GROUPNAMEUNIT_HIDDENUNIT_INVISIBLE_MAP_ICONUNIT_INVISIBLE_MAP_LABELUNIT_MISSION_IDUNIT_NAMEUNIT_PLAYER_NAMEUNIT_ROLEUNIT_RUNTIME_IDUNIT_TASKUNIT_TYPE
    Methods
    activateGroupactivateSteamOverlayToStoreadd_dyn_groupcheckMultiplayerSpawnConflictconquestCoalitionsScorecreate_client_aircraftdispatchAnalogActiondispatchDigitalActionenter_with_dyngroupenumMissionPersistenceDataexitProcessexportToMizgetAchievementsUiInfogetAircraftAmountInAirportWarehousegetAirdromesCoalitiongetAirdromesStategetAirTankerIDgetATCradiosDatagetAvailableCoalitionsgetAvailableSlotsgetConfigValuegetConquestAirbaseStategetCurrentFOVgetCurrentMissiongetDefaultFOVgetDynamicSpawnSettingsgetFarpsAndCarriersMissionDatagetGameDurationgetGamePatterngetGeneratedParamsgetHumanUnitInputNamegetInputNameByUnitTypegetInputProfilesgetInstalledTheatresgetLocalizedStringsgetLogHistorygetMainPilotgetManualPathgetMaxFPSgetMissionDescriptiongetMissionFilenamegetMissionLoadedgetMissionNamegetMissionOptionsgetMissionPersistenceDatagetMissionResourcesDialogDatagetMissionResultgetMissionTheatregetModelNameByShapeTableIndexgetModelTimegetMoonAzimuthElevationPhasegetObjectLiveriesNamesgetPausegetPilotAchievementsgetPilotsSummaryStatisticsgetPilotStatisticsgetPlayerBriefinggetPlayerCoalitiongetPlayerUnitgetPlayerUnitTypegetRealTimegetServerStartTimegetServerStartTimeRemaingetSimulatorModegetSunAzimuthElevationgetSunriseSunsetSecondgetTaintedCategoriesgetTaintedFilesgetTheatreIDgetUnitPositionByObjectIdgetUnitPropertygetUnitTypegetUnitTypeAttributegetUserOptionshasMultipleSlotsHMD_isActiveisHumanSeatAvailableisMetricSystemisMultiplayerisRoleAvailableisServerisSlotFlyableisSteamVersionisSupercarrierRoleAvailableisTrackPlayingLMSGetRemainingTimeBeforeZoneShrinkLMSRestartLMSSetWaitForMinimalPlayerslockAllKeyboardInputlockAllMouseInputlockKeyboardInputlockMouseInputMACSavePSDatamakeScreenShotonShowDialogonShowStatusBaronUserLoginopenHomePagepreloadCockpitRCD_selectMenuItemrefreshPilotStatisticsreloadOptionsreloadUserScriptsrestartMissionsaveMissionToselfKillPilotsendRCD_CallbacksetBoardNumResourcesDialogDatasetCameraToAirdromesetCurrentFOVsetDebriefingShowsetDefaultFOVsetLiveryNameResourcesDialogDatasetMainPilotsetMaxFPSsetMissionResourcesDialogDatasetNeedRestartApplicationsetPausesetPlayerCoalitionsetPlayerUnitsetScreenShotExtsetUserCallbackssetViewPausesetViewRearmsetViewRearmAnimationTimesetViewRearmPositionTypespawnPlayerstartMissionstopMissiontakeTrackControltoggleDTCUIDeclutterOnOffUIRequestOverlayWidgetPositionunlockKeyboardInputunlockMouseInputunsetViewRearmupdaterOperationwriteDebriefing