BIS fnc allTurrets: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (template:command argument fix)
m (Text replacement - "\|seealso= ([^ ]+)(\]\]|\}\}), *(\[\[|\{\{)" to "|seealso= $1$2 $3")
 
(32 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{RV|type=function


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


| arma3|= Game name
|gr1= Object Manipulation


|1.76|= Game version
|descr= Returns all vehicle turrets from config with options. Does what [[allTurrets]] command does, except the param is vehicle's config classname.
____________________________________________________________________________________________


| Returns all vehicle turrets from config with options. Does what [[allTurrets]] command does, except the param is vehicle's config class name|DESCRIPTION=
|s1= vehicleClass call [[BIS_fnc_allTurrets]]
____________________________________________________________________________________________


| vehicleClass call [[BIS_fnc_allTurrets]] |SYNTAX=
|p1= vehicleClass: [[String]] - classname of the vehicle


|p1=vehicleClass: [[String]] - Classname of the vehicle |= Parameter 1
|r1= [[Array]] of turret paths


|[[Array]] - Array of turret paths |RETURNVALUE=
|s2= [vehicleClass, personTurrets] call [[BIS_fnc_allTurrets]]


| s2= [vehicleClass, personTurrets] call [[BIS_fnc_allTurrets]] |SYNTAX=
|p21= vehicleClass: [[String]] - classname of the vehicle


|p21=vehicleClass: [[String]] - Classname of the vehicle |= Parameter 1
|p22= personTurrets: [[Boolean]] - [[true]] to include FFV (firing from vehicle) turrets, [[false]] to exclude them
|p22=personTurrets: [[Boolean]]  
* [[true]] - include person (cargo) FFV (firing from vehicle) turrets
* [[false]] - exclude person (cargo) FFV turrets|= Parameter 1


| r2= [[Array]]|RETURNVALUE=
|r2= [[Array]]
____________________________________________________________________________________________


|x1= <code>_allTurrets = "C_Offroad_01_F" [[call]] [[BIS_fnc_allTurrets]]; // []</code> |=
|x1= <sqf>private _allTurrets = "C_Offroad_01_F" call BIS_fnc_allTurrets; // []</sqf>
|x2= <code>_allTurrets = ["C_Offroad_01_F", [[true]]] [[call]] [[BIS_fnc_allTurrets]]; // [[0],[1],[2],[3]]</code> |=
|x3= <code>_allTurrets = ["C_Offroad_01_F", [[false]]] [[call]] [[BIS_fnc_allTurrets]]; // []</code> |=
____________________________________________________________________________________________


| [[allTurrets]], [[BIS_fnc_getTurrets]]|SEEALSO=
|x2= <sqf>private _allTurrets = ["C_Offroad_01_F", true] call BIS_fnc_allTurrets; // [[0],[1],[2],[3]]</sqf>


|x3= <sqf>private _allTurrets = ["C_Offroad_01_F", false] call BIS_fnc_allTurrets; // []</sqf>
|seealso= [[allTurrets]] [[BIS_fnc_getTurrets]] [[BIS_fnc_turretConfig]] [[BIS_fnc_vehicleCrewTurrets]]
}}
}}
<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: Objects|{{uc:allTurrets}}]]
[[Category:Functions|{{uc:allTurrets}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:allTurrets}}]]

Latest revision as of 12:58, 1 July 2022

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

Description

Description:
Returns all vehicle turrets from config with options. Does what allTurrets command does, except the param is vehicle's config classname.
Execution:
call
Groups:
Object Manipulation

Syntax

Syntax:
vehicleClass call BIS_fnc_allTurrets
Parameters:
vehicleClass: String - classname of the vehicle
Return Value:
Array of turret paths

Alternative Syntax

Syntax:
[vehicleClass, personTurrets] call BIS_fnc_allTurrets
Parameters:
vehicleClass: String - classname of the vehicle
personTurrets: Boolean - true to include FFV (firing from vehicle) turrets, false to exclude them
Return Value:
Array

Examples

Example 1:
private _allTurrets = "C_Offroad_01_F" call BIS_fnc_allTurrets; // []
Example 2:
private _allTurrets = ["C_Offroad_01_F", true] call BIS_fnc_allTurrets; // [[0],[1],[2],[3]]
Example 3:
private _allTurrets = ["C_Offroad_01_F", false] call BIS_fnc_allTurrets; // []

Additional Information

See also:
allTurrets BIS_fnc_getTurrets BIS_fnc_turretConfig BIS_fnc_vehicleCrewTurrets

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_allTurrets&oldid=324061"