Core Function SetFlag

Revision as of 07:50, 15 September 2015 (view source) UberFoX (Talk | contribs) (→Return Value) ← Older edit		Revision as of 07:51, 15 September 2015 (view source) UberFoX (Talk | contribs) (→Remarks) Newer edit →
Line 36:		Line 36:
	This is just an easier way to do bit flags.		This is just an easier way to do bit flags.
		+
		+	This modifies the original enumInst and it's return value can be ignored.
	=== Example ===		=== Example ===

---

Revision as of 07:51, 15 September 2015

SetFlag( <enumInst>, <flag/flags>, <state> ) 

Contents 1 Description 2 Parameters 2.1 enumInst 2.2 flag 2.3 state 3 Return Value 4 Remarks 5 Example

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.

Example

See HasFlag( ) for examples.