BIS fnc decodeFlags2: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (infobox to template)
m (Text replacement - " |s1=[" to " |s1= [")
 
(16 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Function|= Comments
{{RV|type=function


| arma3 |Game name=
|game1= arma3
|version1= 1.00


|1.00|Game version=
|gr1= Bitwise


<!---|arg= local |Multiplayer Arguments=--->
|descr= Decodes a single scalar into array of unique binary flags (zeroes or ones).
{{Feature|informative|The maximal decodable number is '''16777215''' (2<sup>24</sup> - 1).}}


<!---|eff= local |Multiplayer Effects=--->
|s1= [value, size] call [[BIS_fnc_decodeFlags2]]


| <pre>/*
|p1= value: [[Number]] - (Optional, default 0) the value to be converted
Decodes a single scalar into array of unique binary flags (zeroes or onces). Max. number that can be decoded is 16777215 (= 2^24 - 1). An optional parameter can by supplied to resize the binary flags output to set ammount of binary values/bits.


Syntax:
|p2= size: [[Number]] - (Optional, default 1) wanted array size
-------
_flags:array = _encodedFlags:scalar call bis_fnc_decodeFlags2;
_flags:array = [_encodedFlags:scalar,_size:scalar] call bis_fnc_decodeFlags2;


Example:
|r1= [[Array]] of [[Number]]s - "boolean" flags where 0 {{=}} false and 1 {{=}} true
--------
[1,0,1,1] = 13 call bis_fnc_decodeFlags2;
[1,0,1,1,0,0,0,0] = [13,8] call bis_fnc_decodeFlags2;
*/</pre>{{placeholder}}<!-- Remove this after fill-in --> |Description=


|[] call [[BIS_fnc_decodeFlags2]]|Syntax=
|x1= <sqf>private _result = 13 call BIS_fnc_decodeFlags2; // returns [1,0,1,1]</sqf>


|p1= parameter: Datatype - (Optional, default defValue) description |Parameter 1=
|x2= <sqf>private _result = [13, 8] call BIS_fnc_decodeFlags2; // returns [1,0,1,1,0,0,0,0]</sqf>


|Datatype - description|Return value=
|seealso=
 
[[BIS_fnc_encodeFlags]] [[BIS_fnc_encodeFlags2]] [[BIS_fnc_encodeFlags4]] [[BIS_fnc_encodeFlags8]]
|x1= <code></code>|Example 1=
[[BIS_fnc_decodeFlags]] [[BIS_fnc_decodeFlags4]] [[BIS_fnc_decodeFlags8]]
 
| |See also=
}}
}}
[[Category:Function Group: Misc|{{uc:decodeFlags2}}]]
[[Category:Functions|{{uc:decodeFlags2}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:decodeFlags2}}]]

Latest revision as of 23:11, 12 July 2022

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

Description

Description:
Decodes a single scalar into array of unique binary flags (zeroes or ones).
ⓘ
The maximal decodable number is 16777215 (224 - 1).
Execution:
call
Groups:
Bitwise

Syntax

Syntax:
[value, size] call BIS_fnc_decodeFlags2
Parameters:
value: Number - (Optional, default 0) the value to be converted
size: Number - (Optional, default 1) wanted array size
Return Value:
Array of Numbers - "boolean" flags where 0 = false and 1 = true

Examples

Example 1:
private _result = 13 call BIS_fnc_decodeFlags2; // returns [1,0,1,1]
Example 2:
private _result = [13, 8] call BIS_fnc_decodeFlags2; // returns [1,0,1,1,0,0,0,0]

Additional Information

See also:
BIS_fnc_encodeFlags BIS_fnc_encodeFlags2 BIS_fnc_encodeFlags4 BIS_fnc_encodeFlags8 BIS_fnc_decodeFlags 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_decodeFlags2&oldid=327243"