BIS fnc decodeFlags2: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "{{Function|= Comments " to "{{Function|Comments= ")
(Page filling)
Line 5: Line 5:
|1.00|Game version=
|1.00|Game version=


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


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


| <pre>/*
|p1= value: [[Number]] - (Optional, default 0) the value to be converted |Parameter 1=
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 |Parameter 2=
-------
_flags:array = _encodedFlags:scalar call bis_fnc_decodeFlags2;
_flags:array = [_encodedFlags:scalar,_size:scalar] call bis_fnc_decodeFlags2;


Example:
| [[Array]] of [[Number]]s - "boolean" flags where 0 {{=}} false and 1 {{=}} true |Return value=
--------
[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= <code>[[private]] _result = 13 [[call]] [[BIS_fnc_decodeFlags2]]; {{cc|returns [1,0,1,1]}}</code> |Example 1=


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


|Datatype - description|Return value=
| [[BIS_fnc_encodeFlags]] [[BIS_fnc_encodeFlags2]] [[BIS_fnc_encodeFlags4]] [[BIS_fnc_encodeFlags8]]
[[BIS_fnc_decodeFlags]] [[BIS_fnc_decodeFlags4]] [[BIS_fnc_decodeFlags8]] |See also=
}}


|x1= <code></code>|Example 1=
| |See also=
}}


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

Revision as of 20:31, 28 June 2020

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

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=154915"