landAt: Difference between revisions

Revision as of 16:12, 1 January 2025

1.08

Hover & click on the images for description

Description

Description:

Order an AI airplane to land at a given airport. ID is the number to identify which map airport you want the airplane to land at. See Arma: Airport IDs for more information. See also land.

1.68 it is possible to also make the airplane land at a dynamic airport object (e.g. aircraft carrier, makeshift runway...) – see Example 2
2.18 it is also possible to make a helicopter land at a specific helipad.

ⓘ

Since

2.20 landAt command has been extended. Helicopter can now be landed not only on a helipad but also at arbitary position, provided that it is empty and can accomodate the helicopter. In "Land" landing mode the helicopter lands permanently, while in "GetIn" and "GetOut" landing mode the helicopter performs a short touch down before going to the next waypoint. In order to make helicopter wait, the 'waitTime' param can be used. Landing mode "None" cancels both, the landing in progress and waiting in progress.
Waiting time is available in landAt getter variant. When helicopter is landing, the time shown is the set time for wating, however when helicopter is landed, this time start counting down to 0, after which helicopter will take off if it has a waypoint to go to.

Groups:

Unit Control Roads and Airports

Syntax 1

Syntax:: plane landAt ID
Parameters:: plane: Object - a plane
: ID: Number - Airport ID
Return Value:: Nothing

1.68

Syntax 2

Syntax:: plane landAt airportObject
Parameters:: plane: Object
: airportObject: Object
Return Value:: Nothing

2.18

Syntax 3

Syntax:: heli landAt [position, mode, waitTime]
Parameters:: heli: Object - Helicopter/VTOL aircraft
: position: Object - a helipad object of helipad type (can be an invisible helipad) or since 2.20 Array - PositionWorld to land at.
: mode: String - one of "None", "Get In", "Get Out", "Land" and since 2.20 also "GetIn", "GetOut".
since 2.20: mode (Optional): Number - time to wait after touch down in "GetIn"/"GetOut" mode before taking off to the next waipoint.
Return Value:: Boolean - Returns true if landing command was processed successfully, false if failed.

2.20

Syntax 4

Syntax:

landAt heli

Parameters:

heli: Object - Helicopter/VTOL aircraft

Return Value:

Array - in format [landMode, landResult, landPosition, waitTime] where

landMode: String - one of the following: "None", "Land", "GetIn", "GetOut" or "".
landResult: String - one of the following: "Found", "NotFound", "NotReady" or "".
landPosition: Array - in format PositionWorld - land position or [0,0,0].
waitTime: Number - before heli is landed - wait time set for "GetIn"/"GetOut" mode, after heli is landed - remaining time before take off to the next waypoint.

Examples

Example 1:: _plane1 landAt 1;
Example 2:: _dynamicAirport1 = "DynamicAirport_01_F" createVehicle position player; _plane1 landAt _dynamicAirport1;
Example 3:: _hpad = "Land_HelipadEmpty_F" createVehicle [0,0,0]; _hpad setPosASL _pos; heli landAt [_hpad, "LAND"];

Additional Information

See also:: Arma: Airport IDs land setAirportSide assignToAirport allAirports

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

@@ Line 24: / Line 24: @@
 |gr2= Roads and Airports
-|descr= Order an AI airplane to land at a given airport. '''ID''' is the number to identify which map airport you want the airplane to land at. See [[Arma: Airport IDs]] for more information.
+|descr= Order an AI airplane to land at a given airport. '''ID''' is the number to identify which map airport you want the airplane to land at. See [[Arma: Airport IDs]] for more information. See also [[land]].
 {{Feature|arma3|
 * {{GVI|arma3|1.68|size= 0.75}} it is possible to also make the airplane land at a [[Arma 3: Dynamic Airport Configuration|dynamic airport]] [[object]] (e.g. aircraft carrier, makeshift runway...) – see {{Link|#Example 2}}
 * {{GVI|arma3|2.18|size= 0.75}} it is also possible to make a helicopter land at a specific helipad.
 }}
-{{Feature|informative|To make a '''helicopter''' land, see the [[land]] command.}}
+{{Feature|informative| Since {{GVI|arma3|2.20|size= 0.75}} [[landAt]] command has been extended. Helicopter can now be landed not only on a helipad but also at arbitary position, provided that it is empty and can accomodate the helicopter. In "Land" landing mode the helicopter lands permanently, while in "GetIn" and "GetOut" landing mode the helicopter performs a short touch down before going to the next waypoint. In order to make helicopter wait, the 'waitTime' param can be used. Landing mode "None" cancels both, the landing in progress and waiting in progress. <br> Waiting time is available in [[landAt]] getter variant. When helicopter is landing, the time shown is the set time for wating, however when helicopter is landed, this time start counting down to 0, after which helicopter will take off if it has a waypoint to go to.}}
 |s1= plane [[landAt]] ID
@@ Line 49: / Line 49: @@
 |r2= [[Nothing]]
-|s3= heli [[landAt]] [heliPad, mode]
+|s3= heli [[landAt]] [position, mode, waitTime]
 |s3since= arma3 2.18
@@ Line 55: / Line 55: @@
 |p41= heli: [[Object]] - Helicopter/VTOL aircraft
-|p42= heliPad: [[Object]] - A helipad object (can be an invisible helipad)
+|p42= position: [[Object]] - a helipad object of helipad type (can be an invisible helipad) or since {{GVI|arma3|2.20|size= 0.75}} [[Array]] - [[PositionWorld]] to land at.
-|p43= mode: [[String]] - Landing mode. See the [[land]] command
+|p43= mode: [[String]] - one of "None", "Get In", "Get Out", "Land" and since {{GVI|arma3|2.20|size= 0.75}} also "GetIn", "GetOut".
+|p44= mode (Optional): [[Number]] - time to wait after touch down in "GetIn"/"GetOut" mode before taking off to the next waipoint.
+|p44since= arma3 2.20
-|r3= [[Boolean]] - Returns [[true]] if landing command was issued successfully. [[false]] if failed.
+|r3= [[Boolean]] - Returns [[true]] if landing command was processed successfully, [[false]] if failed.
 |s4= [[landAt]] heli
@@ Line 65: / Line 67: @@
 |s4since= arma3 2.20
-|p51= heli: [[Object]] - Helicopter/VTOL aircraft
+|p61= heli: [[Object]] - Helicopter/VTOL aircraft
-|r4= [[Array]] - in format [landMode, landResult, landPosition] where
+|r4= [[Array]] - in format [landMode, landResult, landPosition, waitTime] where
-* landMode: [[String]] - one of the following: "None", "Land", "GetIn", "GetOut" or "". This is not the same as [[land]] command mode, even if values match.
+* landMode: [[String]] - one of the following: "None", "Land", "GetIn", "GetOut" or "".
 * landResult: [[String]] - one of the following: "Found", "NotFound", "NotReady" or "".
 * landPosition: [[Array]] - in format [[PositionWorld]] - land position or [0,0,0].
+* waitTime: [[Number]] - before heli is landed - wait time set for "GetIn"/"GetOut" mode, after heli is landed - remaining time before take off to the next waypoint.
 |x1= <sqf>_plane1 landAt 1;</sqf>