BIS fnc bitflagsCheck: Difference between revisions

Revision as of 00:31, 31 October 2016

-wrong parameter ("arma3dev") defined!-[[:Category:Introduced with arma3dev version 1.65|1.65]]

Hover & click on the images for description

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)
To check which flags are present in given flagset use BIS_fnc_bitflagsToArray
Execution:: call
Groups:: Uncategorised

Syntax

Syntax:

[flagset, flag] call BIS_fnc_bitflagsCheck

Parameters:

flagset: Number - decimal or hexadecimal unsigned 24 bit integer

flag: Number - decimal or hexadecimal unsigned 24 bit integer

Return Value:

Boolean

true: one or more flags are set in given flagset
false: no given flag or flags are set in the given flagset

Examples

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

Additional Information

See also:: BIS fnc bitflagsFlip BIS fnc bitflagsSet BIS fnc bitflagsToArray 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

[[Category:Introduced with arma3dev version 1.65]][[ Category: arma3dev: New Functions | BIS FNC BITFLAGSCHECK]][[ Category: arma3dev: Functions | BIS FNC BITFLAGSCHECK]]

@@ Line 1: / Line 1: @@
+{{DISPLAYTITLE:BIS_fnc_bitflagsCheck}}
+{{Function|=
+____________________________________________________________________________________________
-{{Function|= Comments
+| arma3dev |=
-____________________________________________________________________________________________
+|1.65|=
-| arma3 |= Game name
+|arg= |= MPARGUMENTS
-|1.00|= Game version
+|eff= |= MPEFFECTS
 ____________________________________________________________________________________________
-| ''N/A'' |= Description
+| Checks if one or more flags are set in the given flagset, represented with decimal or hexadecimal number<br>
+(Hexadecimal number representation is simply auto-converted into decimal by the engine)<br>
+To check which flags are present in given flagset use [[BIS_fnc_bitflagsToArray]] |=
 ____________________________________________________________________________________________
-| <!-- [] call [[BIS_fnc_bitflagsCheck]]; --> |= Syntax
+| [flagset, flag] call '''BIS_fnc_bitflagsCheck''' |=
-|p1= |= Parameter 1
-| |= Return value
+|p1= flagset: [[Number]] - decimal or hexadecimal unsigned 24 bit integer |=
-____________________________________________________________________________________________
+|p2= flag: [[Number]] - decimal or hexadecimal unsigned 24 bit integer |=
+| [[Boolean]]
+* [[true]]: one or more flags are set in given flagset
+* [[false]]: no given flag or flags are set in the given flagset   |= Return value
+|x1=<code>[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>|= EXAMPLE1
+__________
+| [[BIS fnc bitflagsFlip]], [[BIS fnc bitflagsSet]], [[BIS fnc bitflagsToArray]], [[BIS fnc bitflagsUnset]]|= SEEALSO
-|x1= <code></code> |=
+|  |= MPBEHAVIOUR
 ____________________________________________________________________________________________
+}}
-| |= See also
-}}
+<h3 style='display:none'>Bottom Section</h3>
-<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:bitflagsCheck}}]]
-[[Category:Functions|{{uc:bitflagsCheck}}]]
 [[Category:{{Name|arma3}}: Functions|{{uc:bitflagsCheck}}]]