BIS fnc encodeFlags: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Generated by BIS_fnc_exportFunctionsToWiki)
 
m (Text replacement - "(\|[pr][0-9]+ *= *[^-]+) *- *E([a-z])" to "$1 - e$2")
 
(28 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{RV|type=function


{{Function|= Comments
|game1= arma3
____________________________________________________________________________________________
|version1= 1.00


| arma3 |= Game name
|gr1= Bitwise


|1.00|= Game version
|descr= Encodes array of unique binary flags with indexes between 0-15 into a single scalar.
____________________________________________________________________________________________


| <pre>/*
|s1= flags call [[BIS_fnc_encodeFlags]]


Encodes array of unique binary flags with indexes between 0-15 into a single scalar.
|p1= flags: [[Array]] - array of unique binary flags with indexes between 0-15


Syntax:
|r1= [[Number]] - encoded flags
-------
_encodedFlags:scalar = _flags:array call bis_fnc_encodeFlags;


Example:
|x1= <sqf>private _encodedFlags = [0,2,3] call BIS_fnc_encodeFlags;//Returns 13</sqf>
--------
13 = [0,2,3] call bis_fnc_encodeFlags;
 
*/
 
#define ERROR {_encoded = 0;["[x] Input parameter must be an array of non-decimal numbers between 0 and 15!"] call bis_fnc_error;}
 
</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
____________________________________________________________________________________________
 
| <!-- [] call [[BIS_fnc_encodeFlags]]; --> |= Syntax
|p1= |= Parameter 1
 
| |= Return value
____________________________________________________________________________________________
 
|x1= <code></code> |=
____________________________________________________________________________________________
 
| |= See also


|seealso= [[BIS_fnc_decodeFlags]]
}}
}}
<h3 style="display:none">Notes</h3>
<dl class="command_description">
<!-- Note Section BEGIN -->
<!-- Note Section END -->
</dl>
<h3 style="display:none">Bottom Section</h3>
[[Category:Function Group: Misc|{{uc:encodeFlags}}]]
[[Category:Functions|{{uc:encodeFlags}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:encodeFlags}}]]

Latest revision as of 15:06, 8 November 2023

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:
Bitwise

Syntax

Syntax:
flags call BIS_fnc_encodeFlags
Parameters:
flags: Array - array of unique binary flags with indexes between 0-15
Return Value:
Number - encoded flags

Examples

Example 1:
private _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
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_encodeFlags&oldid=348540"