BIS fnc unitHeadgear: Difference between revisions

Latest revision as of 18:43, 4 January 2023

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, [], []] [this, [], []] call BIS_fnc_unitHeadgear; // headgear only [this, nil, []] call BIS_fnc_unitHeadgear; // facewear only [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: @@
-{{Function|Comments=
+{{RV|type=function
-| arma3 |Game name=
+|game1= arma3
+|version1= 1.48
-|1.48|Game version=
+|arg= local
-|arg= local |MP arguments=
+|gr1= Inventory
-|gr1 = Inventory |GROUP1=
+|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.}}
-| Randomise headgear and facewear of a character.
+|s1= [unit, headgear, facewear] call [[BIS_fnc_unitHeadgear]]
-{{Important|If the randomization is disabled, only strings parameters will be processed, array will be ignored and considered as false.}}|Description=
-| [unit, headgear, facewear] call BIS_fnc_unitHeadgear |Syntax=
+|p1= unit: [[Object]]
-|p1= unit: [[Object]] |Parameter 1=
 |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]]
-* [[Array]] - headgear list with individual probability |Parameter 2=
+* [[Array]] - headgear list with individual probability|p3= facewear: [[Boolean]], [[String]] or [[Array]] - (Optional, default [[false]]) can be one of:
-|p3= 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|Description.ext CfgUnitTemplates]]
-* [[Array]] - facewear list with individual probability |Parameter 3=
+* [[Array]] - facewear list with individual probability
-| [[Boolean]] - [[true]] when done |Return value=
-|x1= <code><nowiki>[</nowiki>[[this]]] [[call]] [[BIS_fnc_unitHeadgear]];					{{codecomment| // headgear and face wear, same as [this, [], []]}}</code> |Example 1=
-|x2= <code><nowiki>[</nowiki>[[this]], [], []] [[call]] [[BIS_fnc_unitHeadgear]];			{{codecomment| // headgear only}}</code> |Example 2=
+|r1= [[Boolean]] - [[true]] when done
-|x3= <code><nowiki>[</nowiki>[[this]], [[nil]], []]  [[call]] [[BIS_fnc_unitHeadgear]];			{{codecomment| // facewear only}}</code> |Example 3=
+|x1= <sqf>
+[this] call BIS_fnc_unitHeadgear;					// headgear and face wear, same as [this, [], []]
+[this, [], []] call BIS_fnc_unitHeadgear;			// headgear only
+[this, nil, []] call BIS_fnc_unitHeadgear;			// facewear only
+[this, "myTemplate"] call BIS_fnc_unitHeadgear;	// class defined in Description.ext - CfgUnitTemplates
+</sqf>
-|x4= <code><nowiki>[</nowiki>[[this]], "myTemplate"]  [[call]] [[BIS_fnc_unitHeadgear]];	{{codecomment| // class defined in [[Description.ext#CfgUnitTemplates|Description.ext CfgUnitTemplates]]}}</code> |Example 4=
+|seealso= {{Link|Description.ext#CfgUnitTemplates}} [[addGoggles]] [[addHeadgear]]
-| [[Description.ext#CfgUnitTemplates|Description.ext/CfgUnitTemplates]], [[addGoggles]], [[addHeadgear]] |See also=
 }}
-[[Category:Functions|{{uc:unitHeadgear}}]]
-[[Category:{{Name|arma3}}: Functions|{{uc:unitHeadgear}}]]