BIS fnc bitflagsUnset: Difference between revisions

From Bohemia Interactive Community
m (Text replacement - "|= |p2=" to "|Parameter1= |p2=")
m (Text replacement - "[[BIS fnc " to "[[BIS_fnc_")
 
(44 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{DISPLAYTITLE:BIS_fnc_bitflagsUnset}}
{{RV|type=function
{{Function|=
____________________________________________________________________________________________


| arma3dev |=
|game1= arma3
|1.65|=
|version1= 1.66


|arg= |MPARGUMENTS=  
|gr1= Bitwise


|eff= |MPEFFECTS=
|descr= 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>
(Hexadecimal number representation is simply auto-converted into decimal by the engine)<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]]<br><br>
To check which flags are present in given flagset use [[BIS_fnc_bitflagsToArray]]<br><br>
Line 17: Line 12:
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_bitflagsUnset''' |=
|s1= [flagset, flag] call [[BIS_fnc_bitflagsUnset]]


|p1= flagset: [[Number]] - flagset |Parameter1=
|p1= flagset: [[Number]] - flagset
|p2= flag: [[Number]] - one or more flags to unset |=
|p2= flag: [[Number]] - one or more flags to unset


| [[Number]]  - new flagset with given flag or flags unset |RETURNVALUE=
|r1= [[Number]]  - new flagset with given flag or flags unset


|x1=<code>[2 + 4 + 8, 8] [[call]] [[BIS_fnc_bitflagsUnset]]; // 6 (which is 2 + 4)
|x1=<sqf>[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, 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] 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)</sqf>
__________


| [[BIS fnc bitflagsFlip]], [[BIS fnc bitflagsCheck]], [[BIS fnc bitflagsToArray]], [[BIS fnc bitflagsSet]]|SEEALSO=
|seealso=    [[BIS_fnc_bitflagsFlip]] [[BIS_fnc_bitflagsCheck]] [[BIS_fnc_bitflagsToArray]] [[BIS_fnc_bitflagsSet]]
 
|  |MPBEHAVIOUR=
____________________________________________________________________________________________
}}
}}
<h3 style='display:none'>Bottom Section</h3>
<dl class="command_description">
<!-- Note Section BEGIN -->
<!-- Note Section END -->
</dl>
[[Category:{{Name|arma3}}: Functions|{{uc:bitflagsUnset}}]]

Latest revision as of 18:04, 13 July 2022

Arma 3 logo black.png 1.66
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_bitflagsFlip BIS_fnc_bitflagsCheck BIS_fnc_bitflagsToArray BIS_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
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_bitflagsUnset&oldid=328654"