SetFlags: Difference between revisions

From Eternity Wiki
Jump to navigationJump to search
m (→‎Parameter Information: flags1 -> flags)
 
(One intermediate revision by the same user not shown)
Line 4: Line 4:
* Args1 (''flag_field'') = Select Bits Field (no default)  
* Args1 (''flag_field'') = Select Bits Field (no default)  
** 0 = Any of the flags can be manipulated
** 0 = Any of the flags can be manipulated
** 1 = Restrict to flags1
** 1 = Restrict to flags (original Doom & MBF flags)
** 2 = Restrict to flags2
** 2 = Restrict to flags2
** 3 = Restrict to flags3
** 3 = Restrict to flags3
** 4 = Restrict to flags4
** 4 = Restrict to flags4
* Args2 (''flags'') = Value to Logical-OR with selected Bits field (default of 0 = 0)
* Args2 (''flags'') = Value to Logical-OR 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===
===Purpose and usage===

Latest revision as of 08:42, 20 February 2010

SetFlags(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 Logical-OR 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]

Adds the flags set in Args2 to the object's Bits field selected by Args1. This "turns on" effects controlled by those bits. Any flag may be edited by this codepointer.

See Thing type flags for a list of available flags.

See also: UnSetFlags