BIS fnc bitflagsSet: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "{{Function " to "{{RV|type=function ")
m (Text replacement - " \|seealso *= *([^ ]*)\[\[BIS fnc ([a-zA-Z0-9_]+)\]\]([^ ]*)" to " |seealso= $1BIS_fnc_$2$3")
 
(26 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{DISPLAYTITLE:BIS_fnc_bitflagsSet}}{{RV|type=function
{{RV|type=function


| arma3
|game1= arma3
|1.66
|version1= 1.66


|gr1= Bitwise
|gr1= Bitwise


|arg=
|descr= Sets one or more flags in the given flagset, represented with decimal or hexadecimal number<br>
 
|eff=
 
| Sets 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 18: Line 14:
supported range is 2^0...2^24 (1...16777216)
supported range is 2^0...2^24 (1...16777216)


| [flagset, flag] call '''BIS_fnc_bitflagsSet'''
|s1= [flagset, flag] call [[BIS_fnc_bitflagsSet]]


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


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


|x1=<code>[0, 16] [[call]] [[BIS_fnc_bitflagsSet]]; // 16
|x1=<sqf>[0, 16] call BIS_fnc_bitflagsSet; // 16
[16, 2] [[call]] [[BIS_fnc_bitflagsSet]]; // 18 (which is 2 + 16)
[16, 2] call BIS_fnc_bitflagsSet; // 18 (which is 2 + 16)
[18, 2 + 8 + 16] [[call]] [[BIS_fnc_bitflagsSet]]; // 26 (which is 2 + 8 + 16)</code>
[18, 2 + 8 + 16] call BIS_fnc_bitflagsSet; // 26 (which is 2 + 8 + 16)</sqf>


| [[BIS fnc bitflagsFlip]], [[BIS fnc bitflagsCheck]], [[BIS fnc bitflagsToArray]], [[BIS fnc bitflagsUnset]]
|seealso=    [[BIS_fnc_bitflagsFlip]] [[BIS_fnc_bitflagsCheck]] [[BIS_fnc_bitflagsToArray]] [[BIS_fnc_bitflagsUnset]]
}}
}}
[[Category:{{Name|arma3}}: Functions|{{uc:bitflagsSet}}]]
[[Category:Functions|{{uc:bitflagsSet}}]]

Latest revision as of 18:02, 13 July 2022

Hover & click on the images for description

Description

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

Examples

Example 1:
[0, 16] call BIS_fnc_bitflagsSet; // 16 [16, 2] call BIS_fnc_bitflagsSet; // 18 (which is 2 + 16) [18, 2 + 8 + 16] call BIS_fnc_bitflagsSet; // 26 (which is 2 + 8 + 16)

Additional Information

See also:
BIS_fnc_bitflagsFlip 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