BIS fnc unitHeadgear: Difference between revisions

Revision as of 11:13, 18 January 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 8: / Line 8: @@
 * [[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>[[this]]] [[call]] [[BIS_fnc_unitHeadgear]];					{{codecomment| // headgear and face wear, same as [this, [], []]}}</code>|x2= <code><nowiki>[</nowiki>[[this]], [], []] [[call]] [[BIS_fnc_unitHeadgear]];			{{codecomment| // headgear only}}</code>|x3= <code><nowiki>[</nowiki>[[this]], [[nil]], []]  [[call]] [[BIS_fnc_unitHeadgear]];			{{codecomment| // facewear only}}</code>|x4= <code><nowiki>[</nowiki>[[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]] |See also=
+* [[Array]] - facewear list with individual probability| [[Boolean]] - [[true]] when done|x1= <code><nowiki>[</nowiki>[[this]]] [[call]] [[BIS_fnc_unitHeadgear]];					{{codecomment| // headgear and face wear, same as [this, [], []]}}</code>|x2= <code><nowiki>[</nowiki>[[this]], [], []] [[call]] [[BIS_fnc_unitHeadgear]];			{{codecomment| // headgear only}}</code>|x3= <code><nowiki>[</nowiki>[[this]], [[nil]], []]  [[call]] [[BIS_fnc_unitHeadgear]];			{{codecomment| // facewear only}}</code>|x4= <code><nowiki>[</nowiki>[[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]]
 }}
 [[Category:Functions|{{uc:unitHeadgear}}]]
 [[Category:{{Name|arma3}}: Functions|{{uc:unitHeadgear}}]]