Core Function SetFlag
From Sputnik Wiki
(Difference between revisions)
(→Remarks) |
(→Remarks) |
||
| Line 38: | Line 38: | ||
This modifies the original enumInst and it's return value can be ignored. | This modifies the original enumInst and it's return value can be ignored. | ||
| + | |||
| + | <syntaxhighlight lang="sputnik"> | ||
| + | // Since SetFlag modifies the enumInst directly | ||
| + | // it can be used stand alone like this: | ||
| + | SetFlag($enumInst, $OPT_H, true); | ||
| + | // This keeps your code cleaner since you do not | ||
| + | // need to do this: | ||
| + | $enumInst = SetFlag($enumInst, $OPT_H, true); | ||
| + | // since that would be rather pointless | ||
| + | </syntaxhighlight> | ||
=== Example === | === Example === | ||
Revision as of 07:52, 15 September 2015
SetFlag( <enumInst>, <flag/flags>, <state> )
Contents |
Description
Enable or Disable a flag (or array of flags) in a given enum instance.
Parameters
enumInst
Instance of an enum (or any integer will do)
flag
Either:
An enum flag (or any integer)
OR
An array of enum flags.
state
Optional; The state to set the flag to should be a boolean of true or false.
Default: true
Return Value
Returns the current value of the enumInst (a copy of it)
Remarks
This is just an easier way to do bit flags.
This modifies the original enumInst and it's return value can be ignored.
// Since SetFlag modifies the enumInst directly // it can be used stand alone like this: SetFlag($enumInst, $OPT_H, true); // This keeps your code cleaner since you do not // need to do this: $enumInst = SetFlag($enumInst, $OPT_H, true); // since that would be rather pointless
Example
See HasFlag( ) for examples.
