BIS fnc allTurrets: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "|= |x2=" to "|Example1= |x2=")
Line 1: Line 1:
{{Function|Comments=
{{Function|Comments=
____________________________________________________________________________________________
____________________________________________________________________________________________
Line 8: Line 7:
____________________________________________________________________________________________
____________________________________________________________________________________________


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


| vehicleClass call [[BIS_fnc_allTurrets]] |SYNTAX=
| vehicleClass call [[BIS_fnc_allTurrets]] |SYNTAX=


|p1=vehicleClass: [[String]] - Classname of the vehicle |PARAMETER1=
|p1= vehicleClass: [[String]] - Classname of the vehicle |PARAMETER1=


|[[Array]] - Array of turret paths |RETURNVALUE=
|[[Array]] - Array of turret paths |RETURNVALUE=


| s2= [vehicleClass, personTurrets] call [[BIS_fnc_allTurrets]] |SYNTAX2=
|s2= [vehicleClass, personTurrets] call [[BIS_fnc_allTurrets]] |SYNTAX2=


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


| r2= [[Array]]|RETURNVALUE=
|p22=personTurrets: [[Boolean]] - [[true]] to include FFV (firing from vehicle) turrets, [[false]] to exclude them |PARAMETER22=
 
|r2= [[Array]]|RETURNVALUE2=
____________________________________________________________________________________________
____________________________________________________________________________________________


|x1= <code>_allTurrets = "C_Offroad_01_F" [[call]] [[BIS_fnc_allTurrets]]; // []</code> |Example1=
|x1= <code>_allTurrets = "C_Offroad_01_F" [[call]] [[BIS_fnc_allTurrets]]; {{cc|[]}}</code> |Example1=
 
|x2= <code>_allTurrets = ["C_Offroad_01_F", [[true]]] [[call]] [[BIS_fnc_allTurrets]]; {{cc|<nowiki>[</nowiki>[0],[1],[2],[3]]}}</code> |Example2=


|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]]; {{cc|[]}}</code> |Example3=
|x3= <code>_allTurrets = ["C_Offroad_01_F", [[false]]] [[call]] [[BIS_fnc_allTurrets]]; // []</code> |=  
____________________________________________________________________________________________
____________________________________________________________________________________________


| [[allTurrets]], [[BIS_fnc_getTurrets]], [[BIS_fnc_turretConfig]], [[BIS_fnc_vehicleCrewTurrets]]|SEEALSO=
| [[allTurrets]], [[BIS_fnc_getTurrets]], [[BIS_fnc_turretConfig]], [[BIS_fnc_vehicleCrewTurrets]]|SEEALSO=
}}
}}



Revision as of 00:18, 5 September 2019

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

Syntax

Syntax:
vehicleClass call BIS_fnc_allTurrets
Parameters:
vehicleClass: String - Classname of the vehicle
Return Value:
Array - 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:
_allTurrets = "C_Offroad_01_F" call BIS_fnc_allTurrets; // []
Example 2:
_allTurrets = ["C_Offroad_01_F", true] call BIS_fnc_allTurrets; // [[0],[1],[2],[3]]
Example 3:
_allTurrets = ["C_Offroad_01_F", false] call BIS_fnc_allTurrets; // []

Additional Information

See also:
allTurretsBIS_fnc_getTurretsBIS_fnc_turretConfigBIS_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

Notes

Bottom Section