BIS fnc bitflagsUnset: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "|Game version=" to "|Game version= |gr1= Bitwise |GROUP1=")
m (Text replacement - "_{10,} " to "")
Line 1: Line 1:
{{DISPLAYTITLE:BIS_fnc_bitflagsUnset}}{{Function|Comments=
{{DISPLAYTITLE:BIS_fnc_bitflagsUnset}}{{Function|Comments=
____________________________________________________________________________________________


| arma3 |Game=
| arma3 |Game=
Line 10: Line 9:


|eff= |MPEFFECTS=  
|eff= |MPEFFECTS=  
____________________________________________________________________________________________


| Unsets one or more flags in the given flagset, represented with decimal or hexadecimal number<br>
| Unsets one or more flags in the given flagset, represented with decimal or hexadecimal number<br>
Line 19: Line 17:
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) |DESCRIPTION=
____________________________________________________________________________________________


| [flagset, flag] call '''BIS_fnc_bitflagsUnset''' |SYNTAX=
| [flagset, flag] call '''BIS_fnc_bitflagsUnset''' |SYNTAX=
Line 32: Line 29:
[2 + 4 + 8, 1 + 8] [[call]] [[BIS_fnc_bitflagsUnset]]; // 6 (which is 2 + 4)
[2 + 4 + 8, 1 + 8] [[call]] [[BIS_fnc_bitflagsUnset]]; // 6 (which is 2 + 4)
[2 + 4 + 8, 1 + 8 + 8 + 2 + 2] [[call]] [[BIS_fnc_bitflagsUnset]]; // 10 (which is 2 + 8, since 1 + 8 + 8 + 2 + 2 is in fact 1 + 4 + 16)</code>|EXAMPLE1=  
[2 + 4 + 8, 1 + 8 + 8 + 2 + 2] [[call]] [[BIS_fnc_bitflagsUnset]]; // 10 (which is 2 + 8, since 1 + 8 + 8 + 2 + 2 is in fact 1 + 4 + 16)</code>|EXAMPLE1=  
__________


| [[BIS fnc bitflagsFlip]], [[BIS fnc bitflagsCheck]], [[BIS fnc bitflagsToArray]], [[BIS fnc bitflagsSet]]|SEEALSO=  
| [[BIS fnc bitflagsFlip]], [[BIS fnc bitflagsCheck]], [[BIS fnc bitflagsToArray]], [[BIS fnc bitflagsSet]]|SEEALSO=  


|  |MPBEHAVIOUR=  
|  |MPBEHAVIOUR=  
____________________________________________________________________________________________
}}
}}



Revision as of 22:43, 16 January 2021

Hover & click on the images for description

Description

Description:
Unsets one or more flags 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_bitflagsUnset
Parameters:
flagset: Number - flagset
flag: Number - one or more flags to unset
Return Value:
Number - new flagset with given flag or flags unset

Examples

Example 1:
[2 + 4 + 8, 8] call BIS_fnc_bitflagsUnset; // 6 (which is 2 + 4) [2 + 4 + 8, 2 + 8] call BIS_fnc_bitflagsUnset; // 4 [2 + 4 + 8, 1 + 8] call BIS_fnc_bitflagsUnset; // 6 (which is 2 + 4) [2 + 4 + 8, 1 + 8 + 8 + 2 + 2] call BIS_fnc_bitflagsUnset; // 10 (which is 2 + 8, since 1 + 8 + 8 + 2 + 2 is in fact 1 + 4 + 16)

Additional Information

See also:
BIS fnc bitflagsFlipBIS fnc bitflagsCheckBIS fnc bitflagsToArrayBIS fnc bitflagsSet

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


Bottom Section