BIS fnc bitflagsFlip: Difference between revisions

Revision as of 02:01, 31 October 2016

-wrong parameter ("arma3dev") defined!-[[:Category:Introduced with arma3dev version 1.65|1.65]]

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:: Uncategorised

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 bitflagsSet BIS fnc bitflagsCheck BIS fnc bitflagsToArray BIS 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

[[Category:Introduced with arma3dev version 1.65]][[ Category: arma3dev: New Functions | BIS FNC BITFLAGSFLIP]][[ Category: arma3dev: Functions | BIS FNC BITFLAGSFLIP]]

@@ Line 1: / Line 1: @@
+{{DISPLAYTITLE:BIS_fnc_bitflagsFlip}}
+{{Function|=
+____________________________________________________________________________________________
-{{Function|= Comments
+| arma3dev |=
-____________________________________________________________________________________________
+|1.65|=
-| arma3 |= Game name
+|arg= |= MPARGUMENTS
-|1.00|= Game version
+|eff= |= MPEFFECTS
 ____________________________________________________________________________________________
-| ''N/A'' |= Description
+| Flips one or more flags (set gets unset and vice versa) in the given flagset, represented with decimal or hexadecimal number<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>
+'''Limitations''':<br>
+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) |=
 ____________________________________________________________________________________________
-| <!-- [] call [[BIS_fnc_bitflagsFlip]]; --> |= Syntax
+| [flagset, flag] call '''BIS_fnc_bitflagsFlip''' |=
-|p1= |= Parameter 1
-| |= Return value
+|p1= flagset: [[Number]] - flagset |=
-____________________________________________________________________________________________
+|p2= flag: [[Number]] - one or more flags to flip |=
+| [[Number]]  - new flagset with given flag or flags flipped |= Return value
+|x1=<code>[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)</code>|= EXAMPLE1
+__________
+| [[BIS fnc bitflagsSet]], [[BIS fnc bitflagsCheck]], [[BIS fnc bitflagsToArray]], [[BIS fnc bitflagsUnset]]|= SEEALSO
-|x1= <code></code> |=
+|  |= MPBEHAVIOUR
 ____________________________________________________________________________________________
+}}
-| |= See also
-}}
+<h3 style='display:none'>Bottom Section</h3>
-<h3 style="display:none">Notes</h3>
 <dl class="command_description">
 <!-- Note Section BEGIN -->
 <!-- Note Section END -->
 </dl>
-<h3 style="display:none">Bottom Section</h3>
-[[Category:Function Group: Bitwise|{{uc:bitflagsFlip}}]]
-[[Category:Functions|{{uc:bitflagsFlip}}]]
 [[Category:{{Name|arma3}}: Functions|{{uc:bitflagsFlip}}]]