Interface l_land

See

No Self

interface l_land {
    SurfaceType: {
        LAND: number;
        ROAD: number;
        RUNWAY: number;
        SHALLOW_WATER: number;
        WATER: number;
    };
    findPathOnRoads(
        roadType: "roads" | "rails",
        x: number,
        y: number,
        destinationX: number,
        destinationY: number,
    ): l_Vec2[];
    getClosestPointOnRoads(
        roadType: "roads" | "railroads",
        x: number,
        y: number,
    ): LuaMultiReturn<[number, number]>;
    getHeight(point: l_Vec2): number;
    getIP(
        origin: l_Vec3,
        direction: l_Vec3,
        distance: number,
    ): l_Vec3 | undefined;
    getSurfaceHeightWithSeabed(point: l_Vec2): LuaMultiReturn<[number, number]>;
    getSurfaceType(point: l_Vec2): number;
    isVisible(origin: l_Vec3, destination: l_Vec3): boolean;
    profile(origin: l_Vec3, destination: l_Vec3): l_Vec3[];
}

Hierarchy (View Summary)

_land
- l_land

Index

Properties

SurfaceType

Methods

findPathOnRoads getClosestPointOnRoads getHeight getIP getSurfaceHeightWithSeabed getSurfaceType isVisible profile

Properties

SurfaceType

SurfaceType: {
    LAND: number;
    ROAD: number;
    RUNWAY: number;
    SHALLOW_WATER: number;
    WATER: number;
}

Methods

findPathOnRoads

findPathOnRoads(
    roadType: "roads" | "rails",
    x: number,
    y: number,
    destinationX: number,
    destinationY: number,
): l_Vec2[]
Finds a route through the map road or rail network. DCS currently expects "rails" for rail routes, unlike getClosestPointOnRoads.
Parameters
- roadType: "roads" | "rails"
  Network to follow.
- x: number
  Start X/north coordinate.
- y: number
  Start Y/east coordinate.
- destinationX: number
  Destination X/north.
- destinationY: number
  Destination Y/east.
Returns l_Vec2[]
Ordered route points.
Example
```
`const route = land.findPathOnRoads("roads", 0, 0, 10000, 10000);`
```
See
https://wiki.hoggitworld.com/view/DCS_func_findPathOnRoads
Overrides _land.findPathOnRoads
- Defined in land.ts:21

getClosestPointOnRoads

getClosestPointOnRoads(
    roadType: "roads" | "railroads",
    x: number,
    y: number,
): LuaMultiReturn<[number, number]>
Returns the X and Y values of a coordinate on the nearest road from the given point. NOTE that this function does not use vec2 or vec3. It uses individual values representing a vec2 for x and y.

Valid road type values: 'roads' and 'railroads'
Parameters
- roadType: "roads" | "railroads"
  Network to search: paved/unpaved roads or railways.
- x: number
  Local X/north coordinate in metres.
- y: number
  Local Y/east ground-plane coordinate (world Z) in metres.
Returns LuaMultiReturn<[number, number]>
X/north and Y/east coordinates of the nearest network point.
See
https://wiki.hoggitworld.com/view/DCS_func_getClosestPointOnRoads
Example
```
const [roadX, roadY] = land.getClosestPointOnRoads("roads", 1000, 2000);
```
Overrides _land.getClosestPointOnRoads
- Defined in land.ts:60

getHeight

getHeight(point: l_Vec2): number
Returns the distance from sea level (y-axis) of a given vec2 point.
Parameters
- point: l_Vec2
  Ground-plane coordinate where x is north and y is east.
Returns number
Terrain elevation above sea level in metres.
See
https://wiki.hoggitworld.com/view/DCS_func_getHeight
Example
```
const elevation = land.getHeight({ x: 1000, y: 2000 });
env.info(`Terrain elevation: ${elevation} m`);
```
Overrides _land.getHeight
- Defined in land.ts:41

getIP

getIP(origin: l_Vec3, direction: l_Vec3, distance: number): l_Vec3 | undefined
Traces a ray against terrain.
Parameters
- origin: l_Vec3
  Ray origin.
- direction: l_Vec3
  Normalized direction.
- distance: number
  Maximum trace distance in metres.
Returns l_Vec3 | undefined
Intersection point, or undefined when no terrain is hit.
Example
```
`const impact = land.getIP(weapon.getPoint(), weapon.getPosition().x, 20000);`
```
See
https://wiki.hoggitworld.com/view/DCS_func_getIP
Overrides _land.getIP
- Defined in land.ts:76

getSurfaceHeightWithSeabed

getSurfaceHeightWithSeabed(point: l_Vec2): LuaMultiReturn<[number, number]>
Returns surface elevation and water depth, both positive.
Parameters
- point: l_Vec2
  Ground-plane coordinate.
Returns LuaMultiReturn<[number, number]>
Surface elevation then seabed depth in metres.
Example
```
`const [elevation, depth] = land.getSurfaceHeightWithSeabed(point);`
```
See
https://wiki.hoggitworld.com/view/DCS_func_getSurfaceHeightWithSeabed
Overrides _land.getSurfaceHeightWithSeabed
- Defined in land.ts:90

getSurfaceType

getSurfaceType(point: l_Vec2): number
Returns the terrain classification at a point.
Parameters
- point: l_Vec2
  Ground-plane coordinate.
Returns number
Value from land.SurfaceType.
Example
```
`const isWater = land.getSurfaceType(point) === land.SurfaceType.WATER;`
```
See
https://wiki.hoggitworld.com/view/DCS_func_getSurfaceType
Overrides _land.getSurfaceType
- Defined in land.ts:100

isVisible

isVisible(origin: l_Vec3, destination: l_Vec3): boolean
Tests terrain-only line of sight. Buildings and other objects do not block this trace.
Parameters
- origin: l_Vec3
  Start point; offset ground objects upward to avoid clipping terrain.
- destination: l_Vec3
  End point.
Returns boolean
true when terrain does not obstruct the line.
Example
```
`const visible = land.isVisible(observer, target);`
```
See
https://wiki.hoggitworld.com/view/DCS_func_isVisible
Overrides _land.isVisible
- Defined in land.ts:111

profile

profile(origin: l_Vec3, destination: l_Vec3): l_Vec3[]
Samples the terrain profile between two points.
Parameters
- origin: l_Vec3
  Start point.
- destination: l_Vec3
  End point.
Returns l_Vec3[]
Ordered terrain-profile points.
Example
```
`const profile = land.profile(start, finish);`
```
See
https://wiki.hoggitworld.com/view/DCS_func_profile
Overrides _land.profile
- Defined in land.ts:122

Interface l_land

See

No Self

Hierarchy (View Summary)

Index

Properties

Methods

Properties

SurfaceType

Methods

findPathOnRoads

Parameters

Returns l_Vec2[]

Example

See

getClosestPointOnRoads

Parameters

Returns LuaMultiReturn<[number, number]>

See

Example

getHeight

Parameters

Returns number

See

Example

getIP

Parameters

Returns l_Vec3 | undefined

Example

See

getSurfaceHeightWithSeabed

Parameters

Returns LuaMultiReturn<[number, number]>

Example

See

getSurfaceType

Parameters

Returns number

Example

See

isVisible

Parameters

Returns boolean

Example

See

profile

Parameters

Returns l_Vec3[]

Example

See

Settings

On This Page