BIS fnc unitHeadgear: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - "_{10,} " to "") |
Lou Montana (talk | contribs) m (Text replacement - "{{HashLink" to "{{Link") |
||
(18 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
{{ | {{RV|type=function | ||
| arma3 | | |game1= arma3 | ||
|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]] | |||
|p1= unit: [[Object]] | |||
|p2= headgear: [[Boolean]], [[String]] or [[Array]] - (Optional, default [[false]]) can be one of: | |p2= headgear: [[Boolean]], [[String]] or [[Array]] - (Optional, default [[false]]) can be one of: | ||
* [[Boolean]] - if [[false]], change nothing to the headgear | * [[Boolean]] - if [[false]], change nothing to the headgear | ||
* [[String]] - valid Headgear class or a valid class from [[Description.ext#CfgUnitTemplates|Description.ext CfgUnitTemplates]] | * [[String]] - valid Headgear class or a valid class from [[Description.ext#CfgUnitTemplates|Description.ext CfgUnitTemplates]] | ||
* [[Array]] - headgear list with individual probability | * [[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 | * [[Boolean]] - if [[false]], change nothing to the facewear | ||
* [[String]] - valid facewear class or a valid class from [[Description.ext#CfgUnitTemplates|Description.ext CfgUnitTemplates]] | * [[String]] - valid facewear class or a valid class from [[Description.ext#CfgUnitTemplates|Description.ext CfgUnitTemplates]] | ||
* [[Array]] - facewear list with individual probability | * [[Array]] - facewear list with individual probability | ||
| | |r1= [[Boolean]] - [[true]] when done | ||
| | |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> | |||
| | |seealso= {{Link|Description.ext#CfgUnitTemplates}} [[addGoggles]] [[addHeadgear]] | ||
}} | }} | ||
Latest revision as of 17:43, 4 January 2023
Description
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
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