Arma 3 Scripting

BIS_fnc_bitflagsFlip

  • Arma 3 v1.66

Function · Markdown · JSON · original wiki page

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)

Syntax

[flagset, flag] call BIS_fnc_bitflagsFlip

Parameters:

Returns: 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)

See also

BIS_fnc_bitflagsSet · BIS_fnc_bitflagsCheck · BIS_fnc_bitflagsToArray · BIS_fnc_bitflagsUnset