Difference between revisions of "cmf kosherArsenal fnc init"

From cluster wiki
Jump to navigation Jump to search
(Added a second example for the function highlighting the ability to have multiple loadout files in one mission and added a reference to cmf_common_fnc_setRole.)
Line 18: Line 18:
|s1=[loadouts, light, forePrimary, randomPos] call [[cmf_kosherArsenal_fnc_init]]
|s1=[loadouts, light, forePrimary, randomPos] call [[cmf_kosherArsenal_fnc_init]]


|p1= loadouts: [https://community.bistudio.com/wiki/Array Array] - An array containing the filenames for loadouts to load (ommit .sqf from the filename).
|p1= loadouts: [https://community.bistudio.com/wiki/Array Array] - An array containing the filenames for loadouts to load (ommit .sqf from the filename).  


|p2= light: [https://community.bistudio.com/wiki/Boolean Boolean] - When true will attach a light that is only visible for the unit in the arsenal.
|p2= light: [https://community.bistudio.com/wiki/Boolean Boolean] - When true will attach a light that is only visible for the unit in the arsenal.
Line 29: Line 29:


|x1= {{code|lang=scilab|<nowiki>[["exampleLoadout"], true, false, true] call cmf_kosherArsenal_fnc_init;</nowiki>}}
|x1= {{code|lang=scilab|<nowiki>[["exampleLoadout"], true, false, true] call cmf_kosherArsenal_fnc_init;</nowiki>}}
|x2= {{code|lang=scilab|<nowiki>[["exmapleLoadout0", "exmapleLoadout1"], false] call cmf_kosherArsenal_fnc_init;</nowiki>}}


|seealso= [[cmf_kosherArsenal_fnc_ammobox]] [[cmf_kosherArsenal_fnc_forceArsenal]] [[cmf_kosherArsenal_fnc_forceClose]]  
|seealso= [[cmf_kosherArsenal_fnc_ammobox]] [[cmf_kosherArsenal_fnc_forceArsenal]] [[cmf_kosherArsenal_fnc_forceClose]] [[cmf_kosherArsenal_fnc_kosherAI]] [[cmf_common_fnc_setRole]]  
[[cmf_kosherArsenal_fnc_kosherAI]]


|var1= {{!}} GLOBAL {{!}}{{!}} Unit {{!}}{{!}} cmf_kosherArsenal_loadout {{!}}{{!}} A variable containing the loadoutfile to use
|var1= {{!}} GLOBAL {{!}}{{!}} Unit {{!}}{{!}} cmf_kosherArsenal_loadout {{!}}{{!}} A variable containing the loadoutfile to use

Revision as of 18:52, 28 November 2023


Hover & click on the images for description
Description
Description:
This function will initialize kosherArsenal for the local player.
Execution:
Call
Groups:
CMF3: kosherArsenal
Syntax
Syntax:
[loadouts, light, forePrimary, randomPos] call cmf_kosherArsenal_fnc_init
Parameters:
loadouts: Array - An array containing the filenames for loadouts to load (ommit .sqf from the filename).
light: Boolean - When true will attach a light that is only visible for the unit in the arsenal.
forcePrimary: Boolean - When true will force the unit to select a primary weapon before exiting the arsenal.
randomPos: Boolean - When true will randomize the unit's position (to prevent cluttering when multiple units spawn in, is now deprecated as Arma 3 does this automatically).
Return Value:
None
Examples
Example 1:
[["exampleLoadout"], true, false, true] call cmf_kosherArsenal_fnc_init;
Example 2:
[["exmapleLoadout0", "exmapleLoadout1"], false] call cmf_kosherArsenal_fnc_init;
Additional Information
See also:
cmf_kosherArsenal_fnc_ammobox cmf_kosherArsenal_fnc_forceArsenal cmf_kosherArsenal_fnc_forceClose cmf_kosherArsenal_fnc_kosherAI cmf_common_fnc_setRole
Internal Variables
Locality Namespace Name Description
GLOBAL Unit cmf_kosherArsenal_loadout A variable containing the loadoutfile to use
Events
Locality Name Variables Description
LOCAL cmf_kosherArsenal_onOpen [wasForced] Is raised locally when the kosherArsenal arsenal is opened
LOCAL cmf_kosherArsenal_onAmmoboxClose [wasForced] Is raised locally when the kosherArsenal arsenal is closed
Notes