Interface l_atmosphere

See

Authoritative executable examples

No Self

interface l_atmosphere {
    getTemperatureAndPressure(
        point: l_Vec3,
    ): LuaMultiReturn<[number, number]>;
    getWind(point: l_Vec3): l_Vec3;
    getWindWithTurbulence(point: l_Vec3): l_Vec3;
}

Hierarchy (View Summary)

_atmosphere
- l_atmosphere

Index

Methods

getTemperatureAndPressure getWind getWindWithTurbulence

Methods

getTemperatureAndPressure

getTemperatureAndPressure(point: l_Vec3): LuaMultiReturn<[number, number]>
Returns atmospheric temperature and pressure at a world point.
Parameters
- point: l_Vec3
  Sample position in local DCS coordinates and metres.
Returns LuaMultiReturn<[number, number]>
Temperature in kelvin followed by pressure in pascals.
Example
```
`const [temperature, pressure] = atmosphere.getTemperatureAndPressure({ x: 0, y: 1000, z: 0 });`
```
See
https://wiki.hoggitworld.com/view/DCS_func_getTemperatureAndPressure
Overrides _atmosphere.getTemperatureAndPressure
- Defined in atmosphere.ts:16

getWind

getWind(point: l_Vec3): l_Vec3
Returns the steady wind vector at a world point, excluding turbulence.
Parameters
- point: l_Vec3
  Sample position in local DCS coordinates and metres.
Returns l_Vec3
Wind velocity in metres per second using world axes.
Example
```
`const wind = atmosphere.getWind(unit.getPoint());`
```
See
https://wiki.hoggitworld.com/view/DCS_func_getWind
Overrides _atmosphere.getWind
- Defined in atmosphere.ts:25

getWindWithTurbulence

getWindWithTurbulence(point: l_Vec3): l_Vec3
Returns instantaneous wind including turbulence. Points at or below terrain level return a zero vector.
Parameters
- point: l_Vec3
  Sample position in local DCS coordinates and metres.
Returns l_Vec3
Wind velocity in metres per second using world axes.
Example
```
`const wind = atmosphere.getWindWithTurbulence(unit.getPoint());`
```
See
https://wiki.hoggitworld.com/view/DCS_func_getWindWithTurbulence
Overrides _atmosphere.getWindWithTurbulence
- Defined in atmosphere.ts:35