emptyPositions: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\[\[Category:[ _]?Scripting[ _]Commands[ _]Arma[ _]2(\|.*)\]\]" to "{{GameCategory|arma2|Scripting Commands}}")
No edit summary
 
(39 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{Command|Comments=
{{RV|type=command
____________________________________________________________________________________________


| arma1 |Game name=
|game1= arma1
|version1= 1.00


|1.00|Game version=
|game2= arma2
|version2= 1.00


|gr1= Object Manipulation |GROUP1=
|game3= arma2oa
|version3= 1.50


|gr2= Unit Control |GROUP2=
|game4= tkoh
____________________________________________________________________________________________
|version4= 1.00


| Returns the number of given positions in the vehicle.
|game5= arma3
|version5= 0.50


Positions can be ''"Commander", "Driver", "Gunner"'' or ''"Cargo"'' |DESCRIPTION=
|gr1= Object Manipulation
____________________________________________________________________________________________


| [[Number]] <nowiki>=</nowiki> vehicle '''emptyPositions ''' position |SYNTAX=
|gr2= Unit Control


|p1= vehicle: [[Object]] |PARAMETER1=
|descr= Returns the number of given empty positions in the vehicle.
{{Feature|informative|To return the actual units in the vehicle use [[fullCrew]]. However if only the number is desired, use [[emptyPositions]] because it is faster.}}


|p2= position: [[String]] |PARAMETER2=
|s1= vehicle [[emptyPositions]] position


| [[Number]] |RETURNVALUE=
|p1= vehicle: [[Object]]
____________________________________________________________________________________________
 
|x1= <code>_freeCargoPositions = [[vehicle]] [[player]] [[emptyPositions]] "cargo";</code> |EXAMPLE1=
____________________________________________________________________________________________


| [[moveInDriver]], [[moveInTurret]], [[moveInCommander]], [[moveInGunner]], [[moveInCargo]], [[getCargoIndex]]|SEEALSO=
|p2= position: [[String]] - can be one of:
{{Columns|2|
* {{hl|"Commander"}}
* {{hl|"Driver"}}
* {{hl|"Gunner"}}
* {{hl|"Cargo"}} - all cargo positions, FFV or not
* {{GVI|arma3|2.10|size= 0.75}} {{hl|""}} - all empty positions
* {{GVI|arma3|2.10|size= 0.75}} {{hl|"CargoNoFFV"}} - non-FFV cargo
* {{GVI|arma3|2.10|size= 0.75}} {{hl|"CargoFFV"}} - FFV cargo
* {{GVI|arma3|2.14|size= 0.75}} {{hl|"Turret"}} - empty turrets (no FFV turrets, they are included in "CargoFFV")
}}


}}
|r1= [[Number]]


<h3 style="display:none">Notes</h3>
|x1= <sqf>_freeCargoAndFFVPositions = vehicle player emptyPositions "Cargo";</sqf>
<dl class="command_description">
<!-- Note Section BEGIN -->


<!-- Note Section END -->
|x2= <sqf>_freeCargoOnlyPositions = vehicle player emptyPositions "CargoNoFFV";</sqf>
</dl>


<h3 style="display:none">Bottom Section</h3>
|seealso= [[moveInDriver]] [[moveInTurret]] [[moveInCommander]] [[moveInGunner]] [[moveInCargo]] [[getCargoIndex]]
}}


[[Category:Scripting Commands|EMPTYPOSITIONS]]
{{Note
{{GameCategory|arma1|Scripting Commands}}
|user= DreadedEntity
{{GameCategory|arma2|Scripting Commands}}
|timestamp= 20220320000854
{{GameCategory|arma3|Scripting Commands}}
|text= '''emptyPositions''' combines both turret and cargo in its output. If you must know the true count of either, you will have to use [[fullCrew]] (tested on several vehicles)
{{GameCategory|tkoh|Scripting Commands}}
<br>I have not found a way to test for copilot in helicopters
}}

Latest revision as of 20:16, 12 February 2023

Logo A1 black.png1.00Logo A2.png1.00A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.50
Hover & click on the images for description

Description

Description:
Returns the number of given empty positions in the vehicle.
ⓘ
To return the actual units in the vehicle use fullCrew. However if only the number is desired, use emptyPositions because it is faster.
Groups:
Object ManipulationUnit Control

Syntax

Syntax:
vehicle emptyPositions position
Parameters:
vehicle: Object
position: String - can be one of:
  • "Commander"
  • "Driver"
  • "Gunner"
  • "Cargo" - all cargo positions, FFV or not
  • Arma 3 logo black.png2.10 "" - all empty positions
  • Arma 3 logo black.png2.10 "CargoNoFFV" - non-FFV cargo
  • Arma 3 logo black.png2.10 "CargoFFV" - FFV cargo
  • Arma 3 logo black.png2.14 "Turret" - empty turrets (no FFV turrets, they are included in "CargoFFV")
Return Value:
Number

Examples

Example 1:
_freeCargoAndFFVPositions = vehicle player emptyPositions "Cargo";
Example 2:
_freeCargoOnlyPositions = vehicle player emptyPositions "CargoNoFFV";

Additional Information

See also:
moveInDriver moveInTurret moveInCommander moveInGunner moveInCargo getCargoIndex

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
DreadedEntity - c
Posted on Mar 20, 2022 - 00:08 (UTC)
emptyPositions combines both turret and cargo in its output. If you must know the true count of either, you will have to use fullCrew (tested on several vehicles)
I have not found a way to test for copilot in helicopters
Retrieved from "https://community.bistudio.com/wiki?title=emptyPositions&oldid=337586"