Class: BitmaskEnum

Constructor

(abstract) new BitmaskEnum(name, bitNumber)

Constructor.

Extends:

module:util~Enum

Parameters:

Name	Type	Description
`name`	string	the name
`bitNumber`	number	the bit offset, starting from `1` for the least significant bit

Source: util/bitmaskEnum.js, line 13

Extends

module:util~Enum

Members

bitmaskBitNumber

Get the bit offset value, starting from 1 for the least significant bit.

Source: util/bitmaskEnum.js, line 33

bitmaskBitOffset

Get the bit offset value, starting from 0 for the least significant bit.

Source: util/bitmaskEnum.js, line 42

name

Get the enum name.

Overrides: module:util~Enum#name
Source: util/enum.js, line 28

Methods

equals(value) → {boolean}

Test if a string is equal to this enum's name.

As long as enum values are consistently obtained from the module:util~Enum.enumValues array then enum instances can be compared with ===. If unsure, this method can be used to compare string values instead.

If value is passed as an actual Enum instance, then if that enum is the same class as this enum it's name is compared to this instance's name.

Parameters:

Name	Type	Description
`value`	string \| Enum	the value to test

Overrides: module:util~Enum#equals
Source: util/enum.js, line 45

Returns:

true if value is the same as this instance's name value

Type:: boolean

(static) bitmaskValue(maskables) → {number}

Get a bitmask value for a set of {@code Bitmaskable} objects.

Parameters:

Name	Type	Description
`maskables`	Iterable.<BitmaskEnum>	the set of `BitmaskEnum` objects

Source: util/bitmaskEnum.js, line 73

Returns:

a bitmask value of all module:util~BitmaskEnum#bitmaskBitOffset() values of the given maskables

Type:: number

(static) enumForBitNumber(bitNumber, values) → {BitmaskEnum}

Get a BitmaskEnum objects for a bit number.

Parameters:

Name	Type	Description
`bitNumber`	number	a bit number value of the `BitmaskEnum` object to find
`values`	Iterable.<BitmaskEnum>	the complete set of possible `BitmaskEnum` objects