DCS World Typescript
    Preparing search index...

    Interface l_terrain

    Native terrain services exposed to GUI, Mission Editor, hook, and mod scripts.

    Authoritative executable examples

    interface l_terrain {
        convertLatLonToMeters(
            latitude: number,
            longitude: number,
        ): LuaMultiReturn<[number, number]>;
        convertMetersToLatLon(
            x: number,
            y: number,
        ): LuaMultiReturn<[number, number]>;
        convertMGRStoMeters(mgrs: string): LuaMultiReturn<[number, number]>;
        Create(...arguments_: unknown[]): unknown;
        FindNearestPoint(
            x: number,
            y: number,
            radius: number,
        ): LuaMultiReturn<[number, number]>;
        FindOptimalPath(
            x1: number,
            y1: number,
            x2: number,
            y2: number,
        ): TerrainPoint[];
        findPathOnRoads(
            roadType: "roads" | "railroads",
            x1: number,
            y1: number,
            x2: number,
            y2: number,
        ): TerrainPoint[];
        getBeacons(): Record<string, unknown>[];
        getClosestPointOnRoads(
            roadType: "roads" | "railroads",
            x: number,
            y: number,
        ): LuaMultiReturn<[number, number]>;
        getClosestValidPoint(
            surfaceType: TerrainSurfaceType,
            x: number,
            y: number,
        ): LuaMultiReturn<[number, number]>;
        getCrossParam(...arguments_: unknown[]): unknown;
        GetHeight(x: number, y: number): number;
        GetMGRScoordinates(x: number, y: number): string;
        getObjectPosition(objectId: unknown): LuaMultiReturn<[number, number]>;
        getObjectsAtMapPoint(x: number, y: number): unknown[];
        getRadio(): unknown;
        getRunwayHeading(roadnet: unknown): number;
        getRunwayList(roadnet: unknown): Record<string, unknown>[];
        GetSeasons(): unknown[];
        getStandList(
            roadnet: unknown,
            fields?: string[],
        ): Record<string, unknown>[];
        GetSurfaceHeightWithSeabed(
            x: number,
            y: number,
        ): LuaMultiReturn<[number, number]>;
        GetSurfaceType(x: number, y: number): TerrainSurfaceType;
        getTechSkinByDate(day: number, month: number): string;
        getTempratureRangeByDate(
            day: number,
            month: number,
        ): LuaMultiReturn<[number, number]>;
        GetTerrainConfig<T = unknown>(key: string): T;
        getTerrainShpare(...arguments_: unknown[]): unknown;
        Init(configFile: string, reason: unknown, date: unknown): boolean;
        InitLight(configFile: string, reason: unknown, date: unknown): boolean;
        isVisible(
            x1: number,
            altitude1: number,
            y1: number,
            x2: number,
            altitude2: number,
            y2: number,
        ): boolean;
        Release(): void;
    }
    Index
    convertLatLonToMeters convertMetersToLatLon convertMGRStoMeters Create FindNearestPoint FindOptimalPath findPathOnRoads getBeacons getClosestPointOnRoads getClosestValidPoint getCrossParam GetHeight GetMGRScoordinates getObjectPosition getObjectsAtMapPoint getRadio getRunwayHeading getRunwayList GetSeasons getStandList GetSurfaceHeightWithSeabed GetSurfaceType getTechSkinByDate getTempratureRangeByDate GetTerrainConfig getTerrainShpare Init InitLight isVisible Release

    • Converts decimal latitude/longitude to local terrain metres.

      Parameters

      • latitude: number
      • longitude: number

      Returns LuaMultiReturn<[number, number]>

      `const [x, y] = terrain.convertLatLonToMeters(41.6103, 41.5997);`

      %DCS_INSTALL_DIR%/dxgui/bind/NewMapView.lua:329

    • Converts local terrain metres to decimal latitude/longitude.

      Parameters

      • x: number
      • y: number

      Returns LuaMultiReturn<[number, number]>

      `const [lat, lon] = terrain.convertMetersToLatLon(x, y);`

      %DCS_INSTALL_DIR%/dxgui/bind/NewMapView.lua:329

    • Converts a DCS-formatted MGRS coordinate to local metres.

      Parameters

      • mgrs: string

      Returns LuaMultiReturn<[number, number]>

      `const [x, y] = terrain.convertMGRStoMeters("38T KM 12345 67890");`

      %DCS_INSTALL_DIR%/MissionEditor/modules/me_setCoordPanel.lua:168

    • TODO: native constructor exported by this DCS build; no installed Lua callsite or public schema exposes its contract.

      Parameters

      • ...arguments_: unknown[]

      Returns unknown

    • Finds the nearest navigable point within radius metres.

      Parameters

      • x: number
      • y: number
      • radius: number

      Returns LuaMultiReturn<[number, number]>

      `const [roadX, roadY] = terrain.FindNearestPoint(x, y, 40000);`

      %DCS_INSTALL_DIR%/MissionEditor/modules/me_mission.lua:6490

    • Finds an optimal cross-country path.

      Parameters

      • x1: number
      • y1: number
      • x2: number
      • y2: number

      Returns TerrainPoint[]

      Ordered ground-plane points.

      `const path = terrain.FindOptimalPath(x1, y1, x2, y2);`

      %DCS_INSTALL_DIR%/MissionEditor/modules/me_mission.lua:6469

    • Finds a route following the requested road network.

      Parameters

      • roadType: "roads" | "railroads"
      • x1: number
      • y1: number
      • x2: number
      • y2: number

      Returns TerrainPoint[]

      `const path = terrain.findPathOnRoads("roads", x1, y1, x2, y2);`

      %DCS_INSTALL_DIR%/MissionEditor/modules/me_mission.lua:6467

    • Returns theatre beacon records. Their fields vary by beacon type and module.

      Returns Record<string, unknown>[]

      `const beacons = terrain.getBeacons();`

      %DCS_INSTALL_DIR%/Scripts/UI/DTC_manager/DTC_manager_PanelCommon.lua:540

    • Finds the closest point on a road or railroad network.

      Parameters

      • roadType: "roads" | "railroads"
      • x: number
      • y: number

      Returns LuaMultiReturn<[number, number]>

      `const [roadX, roadY] = terrain.getClosestPointOnRoads("roads", x, y);`

      %DCS_INSTALL_DIR%/MissionEditor/modules/me_mission.lua:6488

    • Finds the closest point with the requested surface classification.

      Parameters

      Returns LuaMultiReturn<[number, number]>

      `const [landX, landY] = terrain.getClosestValidPoint("land", x, y);`

      %DCS_INSTALL_DIR%/MissionEditor/modules/me_vehicle.lua:1794

    • TODO: native cross-section helper exported by this DCS build; no installed Lua callsite proves its contract.

      Parameters

      • ...arguments_: unknown[]

      Returns unknown

    • Returns terrain elevation above sea level in metres.

      Parameters

      • x: number
      • y: number

      Returns number

      `const elevation = terrain.GetHeight(x, y);`

    • Converts local metres to a formatted MGRS coordinate.

      Parameters

      • x: number
      • y: number

      Returns string

      `const mgrs = terrain.GetMGRScoordinates(x, y);`

      %DCS_INSTALL_DIR%/Scripts/UI/coords_info.lua:133

    • Resolves a terrain object identifier to local X/Y metres.

      Parameters

      • objectId: unknown

      Returns LuaMultiReturn<[number, number]>

      `const [x, y] = terrain.getObjectPosition(objectId);`

      %DCS_INSTALL_DIR%/MissionEditor/modules/Mission/AirdromeData.lua:76

    • Returns object identifiers located at a map point.

      Parameters

      • x: number
      • y: number

      Returns unknown[]

      `const objects = terrain.getObjectsAtMapPoint(x, y);`

      %DCS_INSTALL_DIR%/MissionEditor/modules/me_contextMenu.lua:118

    • Returns theatre radio metadata. Its nested schema is theatre-defined.

      Returns unknown

      `const radio = terrain.getRadio();`

      %DCS_INSTALL_DIR%/Scripts/UI/BriefingDialog.lua:384

    • Returns the primary runway heading in radians for an airdrome roadnet.

      Parameters

      • roadnet: unknown

      Returns number

      `const heading = terrain.getRunwayHeading(airdrome.roadnet);`

      %DCS_INSTALL_DIR%/MissionEditor/modules/Mission/AirdromeData.lua:130

    • Returns runway records for an airdrome roadnet.

      Parameters

      • roadnet: unknown

      Returns Record<string, unknown>[]

      `const runways = terrain.getRunwayList(airdrome.roadnet);`

      %DCS_INSTALL_DIR%/MissionEditor/modules/Mission/BeaconData.lua:259

    • Returns season descriptors supported by the active theatre.

      Returns unknown[]

      `const seasons = terrain.GetSeasons();`

      %DCS_INSTALL_DIR%/MissionEditor/modules/me_simple_generator_dialog.lua:201

    • Returns parking stands, optionally projecting named stand fields.

      Parameters

      • roadnet: unknown
      • Optionalfields: string[]

      Returns Record<string, unknown>[]

      `const stands = terrain.getStandList(airdrome.roadnet, ["SHELTER", "WIDTH"]);`

      %DCS_INSTALL_DIR%/MissionEditor/modules/me_parking.lua:26

    • Returns surface elevation and seabed depth in metres.

      Parameters

      • x: number
      • y: number

      Returns LuaMultiReturn<[number, number]>

      `const [height, depth] = terrain.GetSurfaceHeightWithSeabed(x, y);`

      %DCS_INSTALL_DIR%/MissionEditor/modules/me_map_window.lua:1114

    • Classifies the terrain surface at a point.

      Parameters

      • x: number
      • y: number

      Returns TerrainSurfaceType

      `const surface = terrain.GetSurfaceType(x, y);`

      %DCS_INSTALL_DIR%/Scripts/UI/InstantActionGenerator/InstantActionEditor.lua:1216

    • Returns the technical-texture season for a calendar day/month.

      Parameters

      • day: number
      • month: number

      Returns string

      `const season = terrain.getTechSkinByDate(15, 6);`

      %DCS_INSTALL_DIR%/MissionEditor/modules/me_static.lua:1911

    • Returns the theatre's minimum and maximum temperature for a calendar day/month.

      Parameters

      • day: number
      • month: number

      Returns LuaMultiReturn<[number, number]>

      `const [minimum, maximum] = terrain.getTempratureRangeByDate(15, 6);`

    • Reads a named value from the active theatre configuration. The value type depends on key.

      Type Parameters

      • T = unknown

      Parameters

      • key: string

      Returns T

      `const theatre = terrain.GetTerrainConfig<string>("id");`

      %DCS_INSTALL_DIR%/MissionEditor/modules/me_terrainDATA.lua:20

    • TODO: misspelled native shape helper exported by this DCS build; no installed Lua callsite proves its contract.

      Parameters

      • ...arguments_: unknown[]

      Returns unknown

    • Initializes the full native terrain service. This changes global GUI terrain state.

      Parameters

      • configFile: string
      • reason: unknown
      • date: unknown

      Returns boolean

      %DCS_INSTALL_DIR%/MissionEditor/modules/me_map_window.lua:862

    • Initializes the lightweight terrain service. This changes global GUI terrain state.

      Parameters

      • configFile: string
      • reason: unknown
      • date: unknown

      Returns boolean

      %DCS_INSTALL_DIR%/MissionEditor/modules/me_simple_generator_dialog.lua:179

    • Tests line of sight between two terrain points with explicit altitudes.

      Parameters

      • x1: number
      • altitude1: number
      • y1: number
      • x2: number
      • altitude2: number
      • y2: number

      Returns boolean

      `const visible = terrain.isVisible(x1, altitude1, y1, x2, altitude2, y2);`

      %DCS_INSTALL_DIR%/MissionEditor/modules/me_utilities.lua:1292

    • Releases the active native terrain service.

      Returns void

      %DCS_INSTALL_DIR%/MissionEditor/modules/me_map_window.lua:755

    Settings
    Member Visibility

    On This Page
    Methods