BIS fnc unitHeadgear: Difference between revisions
Jump to navigation
Jump to search
m (1 revision imported: BIS Functions update 2/7) |
Lou Montana (talk | contribs) (Page filling) |
||
Line 1: | Line 1: | ||
{{Function|Comments= | |||
____________________________________________________________________________________________ | |||
| arma3 |Game name= | |||
| | |1.48|Game version= | ||
| | |args= local |MP arguments= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| | | Randomise headgear and facewear of a character. | ||
{{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]] |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= | |||
|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= | |||
| [[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= | ||
| | |x3= <code><nowiki>[</nowiki>[[this]], [[nil]], []] [[call]] [[BIS_fnc_unitHeadgear]]; {{codecomment| // facewear only}}</code> |Example 3= | ||
| | |x4= <code><nowiki>[</nowiki>[[this]], "myTemplate"] [[call]] [[BIS_fnc_unitHeadgear]]; {{codecomment| // class defined in [[Description.ext#CfgUnitTemplates|Description.ext CfgUnitTemplates]]}}</code> |Example 4= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| [[Description.ext#CfgUnitTemplates|Description.ext, | | [[Description.ext#CfgUnitTemplates|Description.ext/CfgUnitTemplates]], [[addGoggles]], [[addHeadgear]] |See also= | ||
}} | }} | ||
Revision as of 08:37, 8 June 2018
Description
- Description:
- Randomise headgear and facewear of a character.
- Execution:
- call
- Groups:
- Uncategorised
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
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