BIS fnc bitflagsFlip: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " {2,}\}\}" to " }}")
m (Text replacement - " <dl class="command_description"> <!-- Note Section BEGIN --> <!-- Note Section END --> </dl>" to " ")
Line 35: Line 35:




<dl class="command_description">
 
<!-- Note Section BEGIN -->
<!-- Note Section END -->
</dl>


[[Category:{{Name|arma3}}: Functions|{{uc:bitflagsFlip}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:bitflagsFlip}}]]
[[Category:Functions|{{uc:bitflagsFlip}}]]
[[Category:Functions|{{uc:bitflagsFlip}}]]

Revision as of 21:45, 22 January 2021

Hover & click on the images for description

Description

Description:
Flips one or more flags (set gets unset and vice versa) 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_bitflagsFlip
Parameters:
flagset: Number - flagset
flag: Number - one or more flags to flip
Return Value:
Number - new flagset with given flag or flags flipped

Examples

Example 1:
[1 + 16, 8] call BIS_fnc_bitflagsFlip; // 25 (which is 1 + 8 + 16) [25, 8] call BIS_fnc_bitflagsFlip; // 17 (which is 1 + 16) [2 + 4 + 8, 2 + 8] call BIS_fnc_bitflagsFlip; // 4 [4, 2 + 8] call BIS_fnc_bitflagsFlip; // 14 (which is 2 + 4 + 8)

Additional Information

See also:
BIS fnc bitflagsSetBIS fnc bitflagsCheckBIS fnc bitflagsToArrayBIS 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