BIS fnc bitflagsCheck: Difference between revisions
Lou Montana (talk | contribs) m (Text replacement - "_{10,} " to "")  | 
				Lou Montana (talk | contribs)  m (Text replacement - " *\| *([Cc]omments|COMMENTS|[Gg]ame [Nn]ame|Game [Vv]ersion|Game Version \(number surrounded by NO SPACES\)|Multiplayer Arguments \("local" or "global"\)|Multiplayer Effects \("local" or "global"\)|Multiplayer Execution \("server" o...)  | 
				||
| Line 1: | Line 1: | ||
{{DISPLAYTITLE:BIS_fnc_bitflagsCheck}}{{Function  | {{DISPLAYTITLE:BIS_fnc_bitflagsCheck}}{{Function  | ||
| arma3 |Game=  | | arma3 |Game=  | ||
|1.66  | |1.66  | ||
|gr1= Bitwise   | |gr1= Bitwise  | ||
|arg= |MPARGUMENTS=    | |arg= |MPARGUMENTS=    | ||
| Line 16: | Line 16: | ||
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)   | supported range is 2^0...2^24 (1...16777216)  | ||
| [flagset, flag] call '''BIS_fnc_bitflagsCheck'''   | | [flagset, flag] call '''BIS_fnc_bitflagsCheck'''  | ||
|p1= flagset: [[Number]] - flagset   | |p1= flagset: [[Number]] - flagset  | ||
|p2= flag: [[Number]] - one or more flags to check   | |p2= flag: [[Number]] - one or more flags to check  | ||
| [[Boolean]]    | | [[Boolean]]    | ||
* [[true]]: one or more flags are set in given flagset  | * [[true]]: one or more flags are set in given flagset  | ||
* [[false]]: no given flag or flags are set in the given flagset   | * [[false]]: no given flag or flags are set in the given flagset  | ||
|x1=<code>[2 + 4 + 8, 8] [[call]] [[BIS_fnc_bitflagsCheck]]; // true  | |x1=<code>[2 + 4 + 8, 8] [[call]] [[BIS_fnc_bitflagsCheck]]; // true  | ||
[2 + 4 + 8, 2 + 32] [[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] [[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</code>  | ||
| [[BIS fnc bitflagsFlip]], [[BIS fnc bitflagsSet]], [[BIS fnc bitflagsToArray]], [[BIS fnc bitflagsUnset]]  | | [[BIS fnc bitflagsFlip]], [[BIS fnc bitflagsSet]], [[BIS fnc bitflagsToArray]], [[BIS fnc bitflagsUnset]]  | ||
|  |MPBEHAVIOUR=    | |  |MPBEHAVIOUR=    | ||
Revision as of 22:40, 17 January 2021
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
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, flag] call BIS_fnc_bitflagsCheck
 - Parameters:
 - flagset: Number - flagset
 - flag: Number - one or more flags to check
 - Return Value:
 - Boolean
 
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
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