Core Function SetFlag - Revision history

UberFoX: /* Remarks */

2015-09-15T07:53:44Z

Remarks

← Older revision		Revision as of 07:53, 15 September 2015
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 will not set a flag to a value it is already set to for example if you try enable a flag that's already enabled it will ignore the request (same goes for disabling a flag) this will ensure your enumInst doesn't get incorrect values even if you spam it.

	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.
Line 42:		Line 44:
	// Since SetFlag modifies the enumInst directly		// Since SetFlag modifies the enumInst directly
	// it can be used stand alone like this:		// it can be used stand alone like this:
−	SetFlag($enumInst, $OPT_H, true);	+	SetFlag($enumInst, $OPT_H, true); // modifies $enumInst on the spot
	// This keeps your code cleaner since you do not		// This keeps your code cleaner since you do not
	// need to do this:		// need to do this:

UberFoX: /* Remarks */

2015-09-15T07:52:30Z

Remarks

← Older revision		Revision as of 07:52, 15 September 2015
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 ===

UberFoX: /* Remarks */

2015-09-15T07:51:09Z

Remarks

← Older revision		Revision as of 07:51, 15 September 2015
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 ===

UberFoX: /* Return Value */

2015-09-15T07:50:23Z

Return Value

← Older revision		Revision as of 07:50, 15 September 2015
Line 31:		Line 31:
	=== Return Value ===		=== Return Value ===

−	~~Success:~~ Returns ~~true~~	+	Returns the current value of the enumInst (a copy of it)
−		+
−	~~Failure: Returns false~~	+

	=== Remarks ===		=== Remarks ===

UberFoX: Created page with "

 SetFlag( , ,  )

=== Description === Enable or Disable a flag (or array of flags) in a given enum instance. === Parameters === ==== ..."

2015-09-15T07:49:51Z

Created page with "<pre> SetFlag( <enumInst>, <flag/flags>, <state> ) </pre> === Description === Enable or Disable a flag (or array of flags) in a given enum instance. === Parameters === ==== ..."

New page

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

=== 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 ===

Success: Returns true

Failure: Returns false

=== Remarks ===

This is just an easier way to do bit flags.

=== Example ===

See [[Core Function HasFlag|HasFlag( )]] for examples.

[[Category:Core Function]]