Module: @lumjs/core/flags

Helper functions for working with binary flags.

Source:

Methods

(static) allFlags(…flag) → {number}

Combine an entire set of flags into a single set.

Parameters:
Name Type Attributes Description
flag number <repeatable>

Any number of flags you want to add.
Source:
Returns:

All the passed flags combined into one set.

Type
number

(static) setFlag(flags, flag, valueopt) → {number}

Add or remove a binary flag from a set of flags.

Parameters:
Name Type Attributes Default Description
flags number

An integer representing a set of flags.
flag number

An integer representing the flag to add or remove.
value boolean <optional>
 true

true means add, false means remove.
Source:
Returns:

The flags with the flag added or removed accordingly.

Type
number