BIS fnc groupVehicles: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " *\|= " to " ")
m (Text replacement - " *\| *([Cc]omments|COMMENTS|[Gg]ame [Nn]ame|Game [Vv]ersion|Game Version \(number surrounded by NO SPACES\)|Multiplayer Arguments \("local" or "global"\)|Multiplayer Effects \("local" or "global"\)|Multiplayer Execution \("server" o...)
Line 1: Line 1:
{{Function|Comments=
{{Function


| arma3 |Game name=
| arma3


|0.76|Game version=
|0.76


|gr1 = Vehicles |GROUP1=
|gr1 = Vehicles


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


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


|p1= target: [[Object]] or [[Group]] - The unit or group to check, if unit is given it is group is then used|PARAMETER1=
|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)|PARAMETER2=
|p2= assignedVeh: [[Boolean]] - If assigned vehicles should also be returned (vehicles that unit's may not be inside of but assigned to)


| [[Array]] - List of all vehicles in control/assigned to the group, empty if group has none|RETURNVALUE=
| [[Array]] - List of all vehicles in control/assigned to the group, empty if group has none


|x1= <code><nowiki>[</nowiki>[[group]] [[player]], [[true]]] [[call]] [[BIS_fnc_groupVehicles]];</code>
|x1= <code><nowiki>[</nowiki>[[group]] [[player]], [[true]]] [[call]] [[BIS_fnc_groupVehicles]];</code>


| [[group]], [[createVehicle]] |SEEALSO=
| [[group]], [[createVehicle]]
}}
}}



Revision as of 23:59, 17 January 2021

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:
groupcreateVehicle

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


Bottom Section