UberFoX at 08:02, 15 September 2015

2015-09-15T08:02:04Z

← Older revision		Revision as of 08:02, 15 September 2015
Line 5:		Line 5:
	=== Description ===		=== Description ===

−	Check if any flag is enabled in a given enum instance.	+	Check if any flag is enabled in a given enum instance.

	=== Parameters ===		=== Parameters ===

UberFoX: Created page with "

 HasFlag( , ... )

=== Description === Check if any flag is enabled in a given enum instance. === Parameters === ==== enumInst ==== Instance of ..."

2015-09-15T08:01:55Z

Created page with "<pre> HasFlag( <enumInst>, <flags>... ) </pre> === Description === Check if any flag is enabled in a given enum instance. === Parameters === ==== enumInst ==== Instance of ..."

New page

<pre>
HasFlag( <enumInst>, <flags>... )
</pre>

=== Description ===

Check if any flag is enabled in a given enum instance.

=== Parameters ===

==== enumInst ====

Instance of an enum (or any integer will do)

==== flags ====

One or more enum flags (or integers)

=== Return Value ===

Success: Returns true

Failure: Returns false

=== Remarks ===

This is just an easier way to do bit flags.

=== Example ===

<syntaxhighlight lang="sputnik">
enum Options {
$OPT_A = 0x01,
$OPT_B = 0x02,
$OPT_C = 0x04,
$OPT_H = 0x08
};

$opt = Options->$OPT_A;
say "HasFlagAny 'A' or 'C' : " . HasFlagAny($opt, Options->$OPT_A, Options->$OPT_C);
say "HasFlagAny 'C' or 'B' : " . HasFlagAny($opt, Options->$OPT_C, Options->$OPT_B);

// PRINTS
// HasFlagAny 'A' or 'C' : true
// HasFlagAny 'C' or 'B' : false
</syntaxhighlight>

[[Category:Core Function]]

Core Function HasFlagAny - Revision history

UberFoX at 08:02, 15 September 2015

UberFoX: Created page with "
HasFlag( , ... )
=== Description === Check if any flag is enabled in a given enum instance. === Parameters === ==== enumInst ==== Instance of ..."