BIS fnc bitflagsToArray: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "_{10,} " to "")
m (Text replacement - " \|seealso *= *([^ ]*)\[\[BIS fnc ([a-zA-Z0-9_]+)\]\]([^ ]*)" to " |seealso= $1BIS_fnc_$2$3")
 
(34 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{DISPLAYTITLE:BIS_fnc_bitflagsToArray}}{{Function|Comments=
{{RV|type=function


| arma3 |Game=
|game1= arma3
|1.66|Game version=
|version1= 1.66


|gr1= Bitwise |GROUP1=
|gr1= Bitwise


|arg= |MPARGUMENTS=
|descr= Returns array with all bit flags which are set in the given flagset<br><br>
 
|eff= |MPEFFECTS=
 
| Returns array with all bit flags which are set in the given flagset<br><br>
'''Limitations''':<br>
'''Limitations''':<br>
Due to various limitations of the Real Virtuality engine this function is  
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  
intended to work with unsigned 24 bit integers only. This means that the  
supported range is 2^0...2^24 (1...16777216) |DESCRIPTION=
supported range is 2^0...2^24 (1...16777216)
 
| flagset call '''BIS_fnc_bitflagsToArray''' |SYNTAX=


|p1= flagset: [[Number]] - decimal or hexadecimal unsigned 24 bit integer |PARAMETER1=
|s1= flagset call [[BIS_fnc_bitflagsToArray]]


| [[Array]] - array of set bit flags  |RETURNVALUE=
|p1= flagset: [[Number]] - decimal or hexadecimal unsigned 24 bit integer


|x1=<code>15 [[call]] [[BIS_fnc_bitflagsToArray]]; // [1,2,4,8]
|r1= [[Array]] - array of set bit flags
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]</code>|EXAMPLE1=


| [[BIS fnc bitflagsFlip]], [[BIS fnc bitflagsSet]], [[BIS fnc bitflagsCheck]], [[BIS fnc bitflagsUnset]]|SEEALSO=
|x1=<sqf>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]</sqf>


| |MPBEHAVIOUR=  
|seealso=     [[BIS_fnc_bitflagsFlip]] [[BIS_fnc_bitflagsSet]] [[BIS_fnc_bitflagsCheck]] [[BIS_fnc_bitflagsUnset]]
}}
}}
<h3 style='display:none'>Bottom Section</h3>
<dl class="command_description">
<!-- Note Section BEGIN -->
<!-- Note Section END -->
</dl>
[[Category:{{Name|arma3}}: Functions|{{uc:bitflagsToArray}}]]
[[Category:Functions|{{uc:bitflagsToArray}}]]

Latest revision as of 18:02, 13 July 2022

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