BIS fnc unitHeadgear: Difference between revisions

Revision as of 22:37, 9 June 2021

1.48

LALocal

Hover & click on the images for description

Description

Description:: Randomise headgear and facewear of a character.
⚠
If the randomization is disabled, only strings parameters will be processed, array will be ignored and considered as false.
Execution:: call
Groups:: Inventory

Syntax

Syntax:

[unit, headgear, facewear] call BIS_fnc_unitHeadgear

Parameters:

unit: Object

headgear: Boolean, String or Array - (Optional, default false) can be one of:

Boolean - if false, change nothing to the headgear
String - valid Headgear class or a valid class from Description.ext CfgUnitTemplates
Array - headgear list with individual probability

facewear: Boolean, String or Array - (Optional, default false) can be one of:

Boolean - if false, change nothing to the facewear
String - valid facewear class or a valid class from Description.ext CfgUnitTemplates
Array - facewear list with individual probability

Return Value:

Boolean - true when done

Examples

Example 1:: [this] call BIS_fnc_unitHeadgear; // headgear and face wear, same as [this, [], []]
Example 2:: [this, [], []] call BIS_fnc_unitHeadgear; // headgear only
Example 3:: [this, nil, []] call BIS_fnc_unitHeadgear; // facewear only
Example 4:: [this, "myTemplate"] call BIS_fnc_unitHeadgear; // class defined in Description.ext - CfgUnitTemplates

Additional Information

See also:: Description.ext - CfgUnitTemplates addGoggles addHeadgear

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

@@ Line 1: / Line 1: @@
 {{RV|type=function
-| arma3|1.48|arg= local
-|gr1= Inventory| Randomise headgear and facewear of a character.
+|game1= arma3
-{{Feature|important|If the randomization is disabled, only strings parameters will be processed, array will be ignored and considered as false.}}| [unit, headgear, facewear] call BIS_fnc_unitHeadgear|p1= unit: [[Object]]|p2= headgear: [[Boolean]], [[String]] or [[Array]] - (Optional, default [[false]]) can be one of:
+|version1= 1.48
+|arg= local
+|gr1= Inventory
+|descr= Randomise headgear and facewear of a character.
+{{Feature|important|If the randomization is disabled, only strings parameters will be processed, array will be ignored and considered as false.}}
+|s1= [unit, headgear, facewear] call BIS_fnc_unitHeadgear
+|p1= unit: [[Object]]
+|p2= headgear: [[Boolean]], [[String]] or [[Array]] - (Optional, default [[false]]) can be one of:
 * [[Boolean]] - if [[false]], change nothing to the headgear
 * [[String]] - valid Headgear class or a valid class from [[Description.ext#CfgUnitTemplates|Description.ext CfgUnitTemplates]]
@@ Line 9: / Line 21: @@
 * [[Boolean]] - if [[false]], change nothing to the facewear
 * [[String]] - valid facewear class or a valid class from [[Description.ext#CfgUnitTemplates|Description.ext CfgUnitTemplates]]
-* [[Array]] - facewear list with individual probability| [[Boolean]] - [[true]] when done|x1= <code><nowiki>[</nowiki>[[Magic Variables#this_2|this]]] [[call]] [[BIS_fnc_unitHeadgear]];					{{codecomment| // headgear and face wear, same as [this, [], []]}}</code>|x2= <code><nowiki>[</nowiki>[[Magic Variables#this_2|this]], [], []] [[call]] [[BIS_fnc_unitHeadgear]];			{{cc|headgear only}}</code>|x3= <code><nowiki>[</nowiki>[[Magic Variables#this_2|this]], [[nil]], []]  [[call]] [[BIS_fnc_unitHeadgear]];			{{cc|facewear only}}</code>|x4= <code><nowiki>[</nowiki>[[Magic Variables#this_2|this]], "myTemplate"]  [[call]] [[BIS_fnc_unitHeadgear]];	{{codecomment| // class defined in [[Description.ext#CfgUnitTemplates|Description.ext CfgUnitTemplates]]}}</code>| [[Description.ext#CfgUnitTemplates|Description.ext/CfgUnitTemplates]], [[addGoggles]], [[addHeadgear]]
+* [[Array]] - facewear list with individual probability
-}}
+|r1= [[Boolean]] - [[true]] when done
+|x1= <code>[<nowiki/>[[Magic Variables#this_2|this]]] [[call]] [[BIS_fnc_unitHeadgear]];					{{cc|headgear and face wear, same as [this, [], []]}}</code>
+|x2= <code>[<nowiki/>[[Magic Variables#this_2|this]], [], []] [[call]] [[BIS_fnc_unitHeadgear]];			{{cc|headgear only}}</code>
+|x3= <code>[<nowiki/>[[Magic Variables#this_2|this]], [[nil]], []] [[call]] [[BIS_fnc_unitHeadgear]];			{{cc|facewear only}}</code>
+|x4= <code>[<nowiki/>[[Magic Variables#this_2|this]], "myTemplate"] [[call]] [[BIS_fnc_unitHeadgear]];	{{cc|class defined in {{HashLink|Description.ext#CfgUnitTemplates}}}}</code>
-[[Category:{{Name|arma3}}: Functions|{{uc:unitHeadgear}}]]
+|seealso= {{HashLink|Description.ext#CfgUnitTemplates}}, [[addGoggles]], [[addHeadgear]]
+}}