flyInHeight: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\[\[Category:[ _]?Scripting[ _]Commands[ _]Take[ _]On[ _]Helicopters(\|.*)?\]\]" to "{{GameCategory|tkoh|Scripting Commands}}")
m (Fix)
 
(20 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Command|Comments=
{{RV|type=command
____________________________________________________________________________________________


| ofp |Game name=
|game1= ofp
|version1= 1.00


|1.00|Game version=
|game2= ofpe
|version2= 1.00


|arg= local |Multiplayer Arguments=
|game3= arma1
|version3= 1.00


|eff= global |Multiplayer Effects=
|game4= arma2
|version4= 1.00


|gr1= Object Manipulation |GROUP1=
|game5= arma2oa
____________________________________________________________________________________________
|version5= 1.50


| Sets the flying altitude for aircraft relatively to the ground surface. Avoid too low altitudes, as helicopters and planes won't evade trees and obstacles on the ground. The default flying altitude is 100 meters. |DESCRIPTION=
|game6= tkoh
____________________________________________________________________________________________
|version6= 1.00


| aircraft [[flyInHeight]] altitude |SYNTAX=
|game7= arma3
|version7= 0.50


|p1= aircraft: [[Object]] |PARAMETER1=
|arg= local


|p2= altitude: [[Number]] - flying altitude in meters |PARAMETER2=
|eff= global


| [[Nothing]] |RETURNVALUE=
|gr1= Object Manipulation
____________________________________________________________________________________________
 
|x1= <code>_helicopter [[flyInHeight]] 40;</code> |EXAMPLE1=
____________________________________________________________________________________________


| [[flyInHeightASL]], [[swimInDepth]] |SEEALSO=
|descr= Sets the flying altitude for aircraft relatively to the ground surface. Avoid too low altitudes, as helicopters and planes won't evade trees and obstacles on the ground. The default flying altitude is 100 meters.
{{Feature|informative|Height measurement is relative to the pilot and can be approximated with <sqf inline>ASLToAGL eyePos driver _aircraft;</sqf>.}}
 
|s1= aircraft [[flyInHeight]] altitude
 
|p1= aircraft: [[Object]]
 
|p2= altitude: [[Number]] - flying altitude in meters
 
|r1= [[Nothing]]
 
|s2= aircraft [[flyInHeight]] [altitude, forced]
 
|s2since= arma3 2.14
 
|p21= aircraft: [[Object]]
 
|p22= altitude: [[Number]] - flying altitude in meters
 
|p23= forced: [[Boolean]] - [[true]] to force altitude in all cases, [[false]] to behave like main syntax
 
|r2= [[Nothing]]
 
|x1= <sqf>_helicopter flyInHeight 40;</sqf>
 
|x2= <sqf>
// for altitudes below 10m
_helicopter flyInHeight 5; // helicopter will land
_helicopter flyInHeight [5, true]; // helicopter will hover at 5m altitude
 
// on a landed helicopter
_helicopter flyInHeight 50; // helicopter will not move until a waypoint is added
_helicopter flyInHeight [50, true]; // helicopter will start to rise immediately
</sqf>
 
|seealso= [[flyInHeightASL]]
}}
}}


<h3 style="display:none">Notes</h3>
{{Note
<dl class="command_description">
|user= Hardrock
<!-- Note Section BEGIN -->
|timestamp= 20060804125000
<dd class="notedate">Posted on August 4, 2006 - 10:50
|text= ''Notes from before the conversion:''<br>
<dt class="note">[[User:Hardrock|hardrock]]
<dd class="note">''Notes from before the conversion:''<br>
From {{GVI|ofp|1.80}} - [[flyInHeight]] now affects not only helicopters, but also planes.
From {{GVI|ofp|1.80}} - [[flyInHeight]] now affects not only helicopters, but also planes.
<dd class="notedate">Posted on August 4, 2006 - 12:18
}}
<dt class="note">[[User:UNN|UNN]]
<dd class="note">A plane's flyInHeight is restricted to a minimum of 20 meters.
<dd class="notedate">Posted on December 15, 2008 - 19:04
<dt class="note">[[User:Kronzky|Kronzky]]
<dd class="note">A [[flyInHeight]] of 0 will keep the chopper pinned to the ground, even when the engines have been started.
<dd class="notedate">Posted on 00:53, 11 April 2009 (CEST)
<dt class="note">[[User:Jtgibson|Jtgibson]]
<dd class="note">If a helo has no waypoints, it will assume a low hover without regard to this setting.
<!-- Note Section END -->
</dl>


<h3 style="display:none">Bottom Section</h3>
{{Note
|user= UNN
|timestamp= 20060804141800
|text= A plane's [[flyInHeight]] is restricted to a minimum of 20 meters.
}}
 
{{Note
|user= Kronzky
|timestamp= 20081216013400
|text= A [[flyInHeight]] of 0 will keep the chopper pinned to the ground, even when the engines have been started.
}}


[[Category:Scripting Commands|FLYINHEIGHT]]
{{Note
[[Category:Scripting Commands OFP 1.99|{{uc:{{PAGENAME}}}}]]
|user= Jtgibson
[[Category:Scripting Commands OFP 1.96|FLYINHEIGHT]]
|timestamp= 20090411005300
[[Category:Scripting Commands OFP 1.46|FLYINHEIGHT]]
|text= If a helo has no waypoints, it will assume a low hover without regard to this setting.
{{GameCategory|arma1|Scripting Commands}}
{{Feature|important|This comment does not apply to the {{Link|#Syntax 2|alternative syntax}}.}}
{{GameCategory|arma2|Scripting Commands}}
|game= arma1
{{GameCategory|arma3|Scripting Commands}}
|version= 1.00
{{GameCategory|tkoh|Scripting Commands}}
}}

Latest revision as of 17:57, 10 October 2023

Hover & click on the images for description

Description

Description:
Sets the flying altitude for aircraft relatively to the ground surface. Avoid too low altitudes, as helicopters and planes won't evade trees and obstacles on the ground. The default flying altitude is 100 meters.
Height measurement is relative to the pilot and can be approximated with ASLToAGL eyePos driver _aircraft;.
Groups:
Object Manipulation

Syntax

Syntax:
aircraft flyInHeight altitude
Parameters:
aircraft: Object
altitude: Number - flying altitude in meters
Return Value:
Nothing

Alternative Syntax

Syntax:
aircraft flyInHeight [altitude, forced]
Parameters:
aircraft: Object
altitude: Number - flying altitude in meters
forced: Boolean - true to force altitude in all cases, false to behave like main syntax
Return Value:
Nothing

Examples

Example 1:
_helicopter flyInHeight 40;
Example 2:
// for altitudes below 10m _helicopter flyInHeight 5; // helicopter will land _helicopter flyInHeight [5, true]; // helicopter will hover at 5m altitude // on a landed helicopter _helicopter flyInHeight 50; // helicopter will not move until a waypoint is added _helicopter flyInHeight [50, true]; // helicopter will start to rise immediately

Additional Information

See also:
flyInHeightASL

Notes

Report bugs on the Feedback Tracker and/or discuss them on the Arma Discord or on the Forums.
Only post proven facts here! Add Note
Hardrock - c
Posted on Aug 04, 2006 - 12:50 (UTC)
Notes from before the conversion:
From Logo A0.png1.80 - flyInHeight now affects not only helicopters, but also planes.
UNN - c
Posted on Aug 04, 2006 - 14:18 (UTC)
A plane's flyInHeight is restricted to a minimum of 20 meters.
Kronzky - c
Posted on Dec 16, 2008 - 01:34 (UTC)
A flyInHeight of 0 will keep the chopper pinned to the ground, even when the engines have been started.
Jtgibson - c
Posted on Apr 11, 2009 - 00:53 (UTC)

If a helo has no waypoints, it will assume a low hover without regard to this setting.

This comment does not apply to the alternative syntax.