Difference between revisions of "DCS func getWind"

Latest revision as of 06:50, 17 March 2022

Envrioment:	Mission Scripting

Function:	getWind	Added with: 1.2.6

Member Of:	atmosphere
Syntax:	vec3 atmosphere.getWind(table vec3 )
Description:	Returns a velocity vector of the wind at a specified point

Return Value:	vec3
Return Example:	{ ["y"] = 0, ["x"] = 2.1700058188484, ["z"] = 3.058223998561, }

Examples:	The following stores the wind values at an interval of 500m starting at 0 ASL over a given point. local point = trigger.misc.getZone('z').point local windOverPoint = {} for i = 0, 20 do point.y = i * 500 windOverPoint[i+1] = atmosphere.getWind(point ) end
Related Functions:	atmospherefunctions: getWind, getWindWithTurbulence, getTemperatureAndPressure
Notes:	Returns wind values of 0 when the point is below or directly on ground level.

@@ Line 3: / Line 3: @@
 |fName= getWind
-|vNum= 1.2.0
+|vNum= 1.2.6
 |par1= [[DCS_singleton_atmosphere|atmosphere]]
@@ Line 17: / Line 17: @@
 |rtnType= vec3
-|rtnExample= vec3
+|rtnExample= { ["y"] = 0, ["x"] = 2.1700058188484, ["z"] = 3.058223998561, }
 |reqType1= table
@@ Line 37: / Line 37: @@
 [[DCS_singleton_atmosphere|'''atmospherefunctions:''']] {{listOfAtmoFuncs}}
-|examples=
+|examples=   The following stores the wind values at an interval of 500m starting at 0 ASL over a given point.
-|notes=
+    local point = trigger.misc.getZone('z').point
+    local windOverPoint = {}
+    for i = 0, 20 do
+        point.y = i * 500
+        windOverPoint[i+1] = atmosphere.getWind(point )
+    end
+|notes= Returns wind values of 0 when the point is below or directly on ground level.
 }}
 [[Category:Singleton Functions|getWind]]
+[[Category:Game Patch 1.2.6|getWind]]