BIS fnc encodeFlags: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (1 revision imported: BIS Functions update 2/7)
(pf)
Line 1: Line 1:
 
{{Function|Comments=
{{Function|= Comments
____________________________________________________________________________________________
____________________________________________________________________________________________


| arma3 |= Game name
| arma3 |Game name=


|1.00|= Game version
|1.00|Game version=
____________________________________________________________________________________________
____________________________________________________________________________________________


| <pre>/*
| Encodes array of unique binary flags with indexes between 0-15 into a single scalar.|Description=
 
____________________________________________________________________________________________
Encodes array of unique binary flags with indexes between 0-15 into a single scalar.


Syntax:
| flags call [[BIS_fnc_encodeFlags]] |Syntax=
-------
_encodedFlags:scalar = _flags:array call bis_fnc_encodeFlags;


Example:
--------
13 = [0,2,3] call bis_fnc_encodeFlags;


*/
|p1= flags: [[Array]] - Array of unique binary flags with indexes between 0-15 |Parameter 1=


#define ERROR {_encoded = 0;["[x] Input parameter must be an array of non-decimal numbers between 0 and 15!"] call bis_fnc_error;}
| [[Scalar]] - Encoded flags |Return value=


</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
____________________________________________________________________________________________
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_encodeFlags]]; --> |= Syntax
|x1= <code> _encodedFlags = [0,2,3] call [[BIS_fnc_encodeFlags]];//Returns 13</code>|Example 1=
|p1= |= Parameter 1
 
| |= Return value
____________________________________________________________________________________________
____________________________________________________________________________________________


|x1= <code></code> |=
| [[BIS_fnc_decodeFlags]] |See also=
____________________________________________________________________________________________
 
| |= See also
 
}}
}}


Revision as of 14:04, 5 July 2018

Arma 3 logo black.png1.00
Hover & click on the images for description

Description

Description:
Encodes array of unique binary flags with indexes between 0-15 into a single scalar.
Execution:
call
Groups:
Uncategorised

Syntax

Syntax:
flags call BIS_fnc_encodeFlags
Parameters:
flags: Array - Array of unique binary flags with indexes between 0-15
Return Value:
Scalar - Encoded flags

Examples

Example 1:
_encodedFlags = [0,2,3] call BIS_fnc_encodeFlags;//Returns 13

Additional Information

See also:
BIS_fnc_decodeFlags

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

Notes

Bottom Section

Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_encodeFlags&oldid=108833"