BIS fnc bitflagsCheck: Difference between revisions

Revision as of 22:44, 12 July 2022

Hover & click on the images for description

Description:: Checks if one or more flags are set in the given flagset, represented with decimal or hexadecimal number
(Hexadecimal number representation is simply auto-converted into decimal by the engine)
In other words, it simply performs a bitwise AND (&) operation on the two numbers: flags & flagset > 0
To check which flags are present in given flagset use BIS_fnc_bitflagsToArray

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:

[flagset, flag] call BIS_fnc_bitflagsCheck

Parameters:

flagset: Number - flagset

flag: Number - one or more flags to check

Return Value:

Boolean

Example 1:: [2 + 4 + 8, 8] call BIS_fnc_bitflagsCheck; // true [2 + 4 + 8, 2 + 32] call BIS_fnc_bitflagsCheck; // true [2 + 4 + 8, 1] call BIS_fnc_bitflagsCheck; // false [2 + 4 + 8, 1 + 32] call BIS_fnc_bitflagsCheck; // false

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

: 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

@@ Line 24: / Line 24: @@
 * [[false]]: no given flag or flags are set in the given flagset
-|x1=<code>[2 + 4 + 8, 8] call BIS_fnc_bitflagsCheck; // true
+|x1=<sqf>[2 + 4 + 8, 8] call BIS_fnc_bitflagsCheck; // true
 [2 + 4 + 8, 2 + 32] call BIS_fnc_bitflagsCheck; // true
 [2 + 4 + 8, 1] call BIS_fnc_bitflagsCheck; // false
-[2 + 4 + 8, 1 + 32] call BIS_fnc_bitflagsCheck; // false</code>
+[2 + 4 + 8, 1 + 32] call BIS_fnc_bitflagsCheck; // false</sqf>
 |seealso= [[BIS fnc bitflagsFlip]] [[BIS fnc bitflagsSet]] [[BIS fnc bitflagsToArray]] [[BIS fnc bitflagsUnset]]
 }}