UnSetFlags: Difference between revisions

From Eternity Wiki
Jump to navigationJump to search
(New page: Type: Miscellaneous, parameterized Parameter Information: * Args1 = Select Bits Field (no default) **1 = Bits **2 = Bits2 **3 = Bits3 *Args2 = Value to Inverse-Logical-AND with sele...)
 
(→‎Purpose and usage: some more correction)
 
(5 intermediate revisions by the same user not shown)
Line 1: Line 1:
Type: Miscellaneous, parameterized
'''UnSetFlags'''(''flag_field'', ''flags'')


Parameter Information:
===Parameter Information ===
* Args1 = Select Bits Field (no default)  
* Args1 (''flag_field'') = Select Bits Field (no default)  
**1 = Bits
** 0 = Any of the flags can be manipulated
**2 = Bits2
** 1 = Restrict to flags (original Doom & MBF flags)
**3 = Bits3
** 2 = Restrict to flags2
*Args2 = Value to Inverse-Logical-AND with selected Bits field (default of 0 = 0)  
** 3 = Restrict to flags3
** 4 = Restrict to flags4
* Args2 (''flags'') = Value to Inverse-Logical-AND with selected Bits field (default of 0 = 0). Use a succession of flag mnemonics separated by | (vertical bar), + or comma (,). You'll need to enclose the whole group in quotation marks if you use + or ,.


Purpose: Removes the flags set in Args2 from the object's Bits field selected by Args1. This "turns off" effects controlled by those bits. New to Eternity.
===Purpose and usage===
Removes the flags set in Args2 from the object's Bits field selected by Args1. This "turns off" effects controlled by those bits. Any flag may be removed by this codepointer.


Thunk: Yes.
See [[Thing type flags]] for a list of available flags.
 
See also: [[SetFlags]]
 
[[Category:Codepointers]]

Latest revision as of 09:05, 20 February 2010

UnSetFlags(flag_field, flags)

Parameter Information[edit]

  • Args1 (flag_field) = Select Bits Field (no default)
    • 0 = Any of the flags can be manipulated
    • 1 = Restrict to flags (original Doom & MBF flags)
    • 2 = Restrict to flags2
    • 3 = Restrict to flags3
    • 4 = Restrict to flags4
  • Args2 (flags) = Value to Inverse-Logical-AND with selected Bits field (default of 0 = 0). Use a succession of flag mnemonics separated by | (vertical bar), + or comma (,). You'll need to enclose the whole group in quotation marks if you use + or ,.

Purpose and usage[edit]

Removes the flags set in Args2 from the object's Bits field selected by Args1. This "turns off" effects controlled by those bits. Any flag may be removed by this codepointer.

See Thing type flags for a list of available flags.

See also: SetFlags