BIS fnc bitflagsToArray: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Generated by BIS_fnc_exportFunctionsToWiki)
 
m (Text replacement - "\|seealso= ([^ ]+)(\]\]|\}\}), *(\[\[|\{\{)" to "|seealso= $1$2 $3")
(36 intermediate revisions by 7 users not shown)
Line 1: Line 1:
{{RV|type=function


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


| arma3 |= Game name
|gr1= Bitwise


|1.00|= Game version
|descr= Returns array with all bit flags which are set in the given flagset<br><br>
____________________________________________________________________________________________
'''Limitations''':<br>
Due to various limitations of the Real Virtuality engine this function is
intended to work with unsigned 24 bit integers only. This means that the
supported range is 2^0...2^24 (1...16777216)


| <pre>/*
|s1= flagset call [[BIS_fnc_bitflagsToArray]]
Author:
Killzone_Kid
Description:
Returns array with all bit flags which are set in the given flagset
Parameter:
0: [NUMBER] - flagset


Return:
|p1= flagset: [[Number]] - decimal or hexadecimal unsigned 24 bit integer
[ARRAY] - array of set bit flags
Examples:
15 call BIS_fnc_bitflagsToArray // [1,2,4,8]
2342 call BIS_fnc_bitflagsToArray // [2,4,32,256,2048]
[2 + 4 + 8] call BIS_fnc_bitflagsToArray // [2,4,8]
[2 + 2 + 2 + 4 + 8 + 8 + 8] call BIS_fnc_bitflagsToArray // [2,32]
Limitations:
Due to various limitations of the Real Virtuality engine this function is
intended to work with unsigned 24 bit integers only. This means that the
supported range is 2^0...2^24 (1...16777216)
*/


</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
|r1= [[Array]] - array of set bit flags
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_bitflagsToArray]]; --> |= Syntax
|x1=<code>15 [[call]] [[BIS_fnc_bitflagsToArray]]; // [1,2,4,8]
|p1= |= Parameter 1
2342 [[call]] [[BIS_fnc_bitflagsToArray]]; // [2,4,32,256,2048]
 
[2 + 4 + 8] [[call]] [[BIS_fnc_bitflagsToArray]]; // [2,4,8]
| |= Return value
[2 + 2 + 2 + 4 + 8 + 8 + 8] [[call]] [[BIS_fnc_bitflagsToArray]]; // [2,32]</code>
____________________________________________________________________________________________
 
|x1= <code></code> |=
____________________________________________________________________________________________
 
| |= See also


|seealso= [[BIS fnc bitflagsFlip]] [[BIS fnc bitflagsSet]] [[BIS fnc bitflagsCheck]] [[BIS fnc bitflagsUnset]]
}}
}}
<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: Bitwise|{{uc:bitflagsToArray}}]]
[[Category:Functions|{{uc:bitflagsToArray}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:bitflagsToArray}}]]

Revision as of 13:58, 1 July 2022

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

Description

Description:
Returns array with all bit flags which are set in the given flagset

Limitations:
Due to various limitations of the Real Virtuality engine this function is intended to work with unsigned 24 bit integers only. This means that the supported range is 2^0...2^24 (1...16777216)
Execution:
call
Groups:
Bitwise

Syntax

Syntax:
flagset call BIS_fnc_bitflagsToArray
Parameters:
flagset: Number - decimal or hexadecimal unsigned 24 bit integer
Return Value:
Array - array of set bit flags

Examples

Example 1:
15 call BIS_fnc_bitflagsToArray; // [1,2,4,8] 2342 call BIS_fnc_bitflagsToArray; // [2,4,32,256,2048] [2 + 4 + 8] call BIS_fnc_bitflagsToArray; // [2,4,8] [2 + 2 + 2 + 4 + 8 + 8 + 8] call BIS_fnc_bitflagsToArray; // [2,32]

Additional Information

See also:
BIS fnc bitflagsFlip BIS fnc bitflagsSet BIS fnc bitflagsCheck BIS fnc bitflagsUnset

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_bitflagsToArray&oldid=324058"