Class UserFlagsBitField

Utility class for working with user flags

Hierarchy

UserFlagsBitField

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new UserFlagsBitField(bits: UserFlagsCheckType): UserFlagsBitField

- Defined in src/utils/bitfield/UserFlagsBitField.ts:14
Parameters
- bits: UserFlagsCheckType
Returns UserFlagsBitField

Properties

bitfield

bitfield: number

Static Flags

Flags: typeof UserFlags = UserFlags

Object containing all available user flags

Static defaultBit

defaultBit: number = 0

The default bit

Methods

add

add(...bits: UserFlagsCheckType[]): UserFlagsBitField

- Defined in src/utils/bitfield/UserFlagsBitField.ts:19
Adds bits to these ones

Parameters
- Rest ...bits: UserFlagsCheckType[]
Returns UserFlagsBitField

has

has(bit: UserFlagsCheckType): boolean

- Defined in src/utils/bitfield/UserFlagsBitField.ts:27
Checks whether the bitfield has a bit, or multiple bits

Parameters
- bit: UserFlagsCheckType
Returns boolean

remove

remove(...bits: any[]): UserFlagsBitField

- Defined in src/utils/bitfield/UserFlagsBitField.ts:34
Removes bits from these

Parameters
- Rest ...bits: any[]
Returns UserFlagsBitField

toArray

toArray(): string[]

- Defined in src/utils/bitfield/UserFlagsBitField.ts:44
Gets an Array of UserFlags names based on the bits available

Returns string[]

Static parse

parse(bit: UserFlagsCheckType): number

- Defined in src/utils/bitfield/UserFlagsBitField.ts:48
Parameters
- bit: UserFlagsCheckType
Returns number

Generated using TypeDoc version 0.22.16, the 9/16/2022 at 1:09:16 AM