SetFlags: Difference between revisions
From Eternity Wiki
Jump to navigationJump to search
m (→Purpose and usage: toggle is misleading, as this doesn't toggle) |
(added ( ) syntax) |
||
| Line 1: | Line 1: | ||
'''SetFlags'''(''flag_field'', ''flags'') | |||
===Parameter Information === | ===Parameter Information === | ||
* Args1 = 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 flags1 | ||
| Line 8: | Line 8: | ||
** 3 = Restrict to flags3 | ** 3 = Restrict to flags3 | ||
** 4 = Restrict to flags4 | ** 4 = Restrict to flags4 | ||
* Args2 = 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) | ||
===Purpose and usage=== | ===Purpose and usage=== | ||
Revision as of 06:28, 20 February 2010
SetFlags(flag_field, flags)
Parameter Information
- Args1 (flag_field)) = Select Bits Field (no default)
- 0 = Any of the flags can be manipulated
- 1 = Restrict to flags1
- 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)
Purpose and usage
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.
