unitTurret: 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}}")
mNo edit summary
 
(31 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Command|Comments=
{{RV|type=command
____________________________________________________________________________________________


| arma3 |Game name=
|game1= arma3
|version1= 2.00


|2.00|Game version=
|gr1= Turrets


|gr1= Turrets |GROUP1=
|descr= Returns the turret path the given vehicle's gunner is in.
____________________________________________________________________________________________
To get the turret's unit see [[turretUnit]].


| Returns the turret path the given vehicle's gunner is in. <tt>[-1]</tt> is returned if gunner is driver. When unit is not in any of vehicle's turret, empty array <tt>[]</tt> is returned. To get unit in turret see [[turretUnit]] |DESCRIPTION=
|s1= vehicle [[unitTurret]] gunner
____________________________________________________________________________________________


| vehicle [[unitTurret]] gunner |SYNTAX=
|p1= vehicle: [[Object]]


|p1= vehicle: [[Object]] |PARAMETER1=
|p2= gunner: [[Object]]


|p2= gunner: [[Object]] |PARAMETER2=
|r1= [[Array]] format [[Turret Path]]
- {{hl|[-1]}} is returned if the [[gunner]] is also the [[driver]].
When no units are in any of vehicle's turret, empty array {{hl|[]}} is returned.


|p3= |PARAMETER3=  
|x1= <sqf>_vehicle unitTurret _gunner;</sqf>


| [[Array]] - turret path |RETURNVALUE=  
|x2= <sqf>vehicle player unitTurret player;</sqf>


 
|seealso= [[turretUnit]] [[driver]] [[gunner]] [[commander]] [[effectiveCommander]] [[currentPilot]] [[moveInTurret]] [[assignAsTurret]] [[assignedVehicleRole]] [[lockedTurret]] [[isTurnedOut]]
|x1= <code>_vehicle [[unitTurret]] _gunner;</code>|EXAMPLE1=
|x2= <code>[[vehicle]] [[player]] [[unitTurret]] [[player]];</code>|EXAMPLE2=
 
____________________________________________________________________________________________
 
| [[turretUnit]], [[driver]], [[gunner]], [[commander]], [[effectiveCommander]], [[currentPilot]], [[moveInTurret]], [[assignAsTurret]], [[assignedVehicleRole]], [[lockedTurret]], [[isTurnedOut]] |SEEALSO=
 
|  |MPBEHAVIOUR=
____________________________________________________________________________________________
}}
}}
<h3 style='display:none'>Notes</h3>
<dl class='command_description'>
<!-- Note Section BEGIN -->
<!-- Note Section END -->
</dl>
<h3 style='display:none'>Bottom Section</h3>
{{GameCategory|arma2|Scripting Commands}}
{{GameCategory|arma3|Scripting Commands}}
{{GameCategory|tkoh|Scripting Commands}}
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]

Latest revision as of 10:10, 28 September 2023

Hover & click on the images for description

Description

Description:
Returns the turret path the given vehicle's gunner is in. To get the turret's unit see turretUnit.
Groups:
Turrets

Syntax

Syntax:
vehicle unitTurret gunner
Parameters:
vehicle: Object
gunner: Object
Return Value:
Array format Turret Path - [-1] is returned if the gunner is also the driver. When no units are in any of vehicle's turret, empty array [] is returned.

Examples

Example 1:
_vehicle unitTurret _gunner;
Example 2:
vehicle player unitTurret player;

Additional Information

See also:
turretUnit driver gunner commander effectiveCommander currentPilot moveInTurret assignAsTurret assignedVehicleRole lockedTurret isTurnedOut

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