BIS fnc groupVehicles: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Generated by BIS_fnc_exportFunctionsToWiki)
 
m (Some wiki formatting)
 
(31 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{{RV|type=function


{{Function|= Comments
|game1= arma3
____________________________________________________________________________________________
|version1= 0.76


| arma3 |= Game name
|gr1= Vehicles


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


| <pre>/*
|s1= [target, assignedVeh] call [[BIS_fnc_groupVehicles]]


Description:
|p1= target: [[Object]] or [[Group]] - the unit or group to check, if unit is given it is group is then used
Returns all vehicles a group possesses, assigned vehicles can be included


Parameter(s):
|p2= assignedVeh: [[Boolean]] - if assigned vehicles should also be returned (vehicles that unit's may not be inside of but assigned to)
_this select 0: GROUP or OBJECT - The unit or group to check, if unit is given it's group is then used
_this select 1: BOOLEAN - If assigned vehicles should also be returned (vehicles that unit's may not be inside of but assigned to)
Returns:
ARRAY - List of all vehicles in control/assigned to the group, empty if group has none
*/
//Parameters
</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
____________________________________________________________________________________________


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


|p1= |= Parameter 1
|x1= <sqf>[group player, true] call BIS_fnc_groupVehicles;</sqf>
 
| |= Return value
____________________________________________________________________________________________
 
|x1= <code></code> |=
____________________________________________________________________________________________
 
| |= See also


|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"