BIS fnc encodeFlags2: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (infobox to template)
(Page filling)
Line 1: Line 1:
{{Function|= Comments
{{Function|Comments=


| arma3 |Game name=
| arma3 |Game name=
Line 5: Line 5:
|1.00|Game version=
|1.00|Game version=


<!---|arg= local |Multiplayer Arguments=--->
| Encodes array of unique binary flags (zeroes or ones) into a single scalar.
{{Important | Note that the input array is in {{Wikipedia|Endianness#Definition|Big Endian}}, meaning that the smallest value is '''to the left'''.}} |Description=


<!---|eff= local |Multiplayer Effects=--->
| arrayOfNumbers call [[BIS_fnc_encodeFlags2]] |Syntax=


| <pre>/*
|p1= arrayOfNumbers: [[Array]] of [[Number]]s - "boolean" flags where 0 = false and 1 = true |Parameter 1=


Encodes array of unique binary flags (zeroes or ones) into a single scalar.
| [[Number]] - the calculated number |Return value=


Syntax:
|x1= <code>[[private]] _result = [1,0,1,1] [[call]] [[BIS_fnc_encodeFlags2]];
-------
[[hint]] [[str]] _result; {{cc|Displays 13}}</code> |Example 1=
_encodedFlags:scalar = _flags:array call bis_fnc_encodeFlags2;


Example:
| [[BIS_fnc_encodeFlags]] [[BIS_fnc_encodeFlags4]] [[BIS_fnc_encodeFlags8]]
--------
[[BIS_fnc_decodeFlags]] [[BIS_fnc_decodeFlags2]] [[BIS_fnc_decodeFlags4]] [[BIS_fnc_decodeFlags8]] |See also=
13 = [1,0,1,1] call bis_fnc_encodeFlags2;
 
//0.136
*/</pre>{{placeholder}}<!-- Remove this after fill-in --> |Description=
 
|[] call [[BIS_fnc_encodeFlags2]]|Syntax=
 
|p1= parameter: Datatype - (Optional, default defValue) description |Parameter 1=
 
|Datatype - description|Return value=
 
|x1= <code></code>|Example 1=
 
| |See also=
}}
}}


[[Category:Function Group: Misc|{{uc:encodeFlags2}}]]
[[Category:Function Group: Misc|{{uc:encodeFlags2}}]]
[[Category:Functions|{{uc:encodeFlags2}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:encodeFlags2}}]]

Revision as of 11:42, 26 June 2020

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

Description

Description:
Encodes array of unique binary flags (zeroes or ones) into a single scalar.
⚠
Note that the input array is in Big Endian, meaning that the smallest value is to the left.
Execution:
call
Groups:
Uncategorised

Syntax

Syntax:
arrayOfNumbers call BIS_fnc_encodeFlags2
Parameters:
arrayOfNumbers: Array of Numbers - "boolean" flags where 0 = false and 1 = true
Return Value:
Number - the calculated number

Examples

Example 1:
private _result = [1,0,1,1] call BIS_fnc_encodeFlags2; hint str _result; // Displays 13

Additional Information

See also:
BIS_fnc_encodeFlags BIS_fnc_encodeFlags4 BIS_fnc_encodeFlags8 BIS_fnc_decodeFlags BIS_fnc_decodeFlags2 BIS_fnc_decodeFlags4 BIS_fnc_decodeFlags8

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_encodeFlags2&oldid=154546"