BIS fnc groupVehicles: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (template:command argument fix)
m (Some wiki formatting)
 
(27 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Function|= Comments
{{RV|type=function
____________________________________________________________________________________________


| arma 3 |= Game name
|game1= arma3
|version1= 0.76


|0.76|= Game version
|gr1= Vehicles
____________________________________________________________________________________________


| Returns all vehicles a group possesses, assigned vehicles can be included.|DESCRIPTION=
|descr= Returns all vehicles a group possesses, assigned vehicles can be included.
____________________________________________________________________________________________


| [target, assignedVeh] call [[BIS_fnc_groupVehicles]] |SYNTAX=
|s1= [target, assignedVeh] call [[BIS_fnc_groupVehicles]]
____________________________________________________________________________________________


|p1= target: [[Object]] or [[Group]] - The unit or group to check, if unit is given it's group is then used|= Parameter 1
|p1= target: [[Object]] or [[Group]] - the unit or group to check, if unit is given it is group is then used
|p2= assignedVeh: [[Boolean]] - If assigned vehicles should also be returned (vehicles that unit's may not be inside of but assigned to)|= Parameter 2
____________________________________________________________________________________________


| [[Array]] - List of all vehicles in control/assigned to the group, empty if group has none|RETURNVALUE=
|p2= assignedVeh: [[Boolean]] - if assigned vehicles should also be returned (vehicles that unit's may not be inside of but assigned to)
____________________________________________________________________________________________


|x1= <code>[ [[group]] [[player]], [[true]] ] [[call]] [[BIS_fnc_groupVehicles]];</code> |=
|r1= [[Array]] - list of all vehicles in control/assigned to the group, empty if group has none
____________________________________________________________________________________________


| [[group]], [[createVehicle]] |SEEALSO=
|x1= <sqf>[group player, true] call BIS_fnc_groupVehicles;</sqf>
 
|seealso= [[group]] [[createVehicle]]
}}
}}
<h3 style="display:none">Notes</h3>
<dl class="command_description">
<!-- Note Section BEGIN -->
<!-- Note Section END -->
</dl>
<h3 style="display:none">Bottom Section</h3>
[[Category:Function Group: Misc|{{uc:groupVehicles}}]]
[[Category:Functions|{{uc:groupVehicles}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:groupVehicles}}]]

Latest revision as of 13:50, 13 July 2022

Arma 3 logo black.png0.76
Hover & click on the images for description

Description

Description:
Returns all vehicles a group possesses, assigned vehicles can be included.
Execution:
call
Groups:
Vehicles

Syntax

Syntax:
[target, assignedVeh] call BIS_fnc_groupVehicles
Parameters:
target: Object or Group - the unit or group to check, if unit is given it is group is then used
assignedVeh: Boolean - if assigned vehicles should also be returned (vehicles that unit's may not be inside of but assigned to)
Return Value:
Array - list of all vehicles in control/assigned to the group, empty if group has none

Examples

Example 1:
[group player, true] call BIS_fnc_groupVehicles;

Additional Information

See also:
group createVehicle

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
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_groupVehicles&oldid=327945"