Class Flags<T>

Manager class responsible for retrieving data off of bit-wise flags

Type parameters

T: number

Hierarchy

Flags

Index

Constructors

constructor

Accessors

bits

Methods

has
from

Constructors

constructor

new Flags(flags: number): Flags

- Defined in src/structures/flags/Flags.ts:9
Parameters
- flags: number
Returns Flags

Accessors

bits

get bits(): number

- Defined in src/structures/flags/Flags.ts:28
Returns the bits of the flags this instance contains

Returns number

Methods

has

has(flag: T): boolean

- Defined in src/structures/flags/Flags.ts:20
Whether a specific flag is included in this instance's flags

Parameters
- flag: T
  
  The flag to check if included
Returns boolean

Static from

from<T>(...flags: T[]): Flags<T>

- Defined in src/structures/flags/Flags.ts:37
Creates a new instance of Flags based on given flags

Type parameters
- T: number
Parameters
- Rest ...flags: T[]
  
  An array of all flags the Flags instance should contain
Returns Flags<T>

Generated using TypeDoc