SKUFlagsBitField

export class SKUFlagsBitField extends BitField<SKUFlagsString>
export class SKUFlagsBitField extends BitField<SKUFlagsString>
Data structure that makes it easy to interact with an flags bitfield.
bitfield:number
Bitfield of the packed bits
Inherited from BitField
Static
Numeric bitfield flags. Defined in extension classes
Inherited from BitField
Static
FLAGS:typeof SKUFlags
[Symbol.iterator]():IterableIterator<SKUFlagsString>
Adds bits to these ones.
Returns
These bits or new BitField if the instance is frozen.
NameTypeOptionalDescription
...bitsBitFieldResolvable<SKUFlagsString, number>[]NoBits to add
Inherited from BitField
any(bit):boolean
Checks whether the bitfield has a bit, or any of multiple bits.
NameTypeOptionalDescription
bitBitFieldResolvable<SKUFlagsString, number>NoBit(s) to check for
Inherited from BitField
equals(bit):boolean
Checks if this bitfield equals another
NameTypeOptionalDescription
bitBitFieldResolvable<SKUFlagsString, number>NoBit(s) to check for
Inherited from BitField
Freezes these bits, making them immutable.
Inherited from BitField
has(bit):boolean
Checks whether the bitfield has a bit, or multiple bits.
NameTypeOptionalDescription
bitBitFieldResolvable<SKUFlagsString, number>NoBit(s) to check for
Inherited from BitField
missing(bits, ...hasParams):SKUFlagsString[]
Gets all given bits that are missing from the bitfield.
NameTypeOptionalDescription
bitsBitFieldResolvable<SKUFlagsString, number>NoBit(s) to check for
...hasParamsreadonly unknown[]NoAdditional parameters for the has method, if any
Inherited from BitField
remove(...bits):BitField<SKUFlagsString, number>
Removes bits from these.
Returns
These bits or new BitField if the instance is frozen.
NameTypeOptionalDescription
...bitsBitFieldResolvable<SKUFlagsString, number>[]NoBits to remove
Inherited from BitField
Static
resolve(bit?):number
NameTypeOptionalDescription
bitBitFieldResolvable<SKUFlagsString, number>YesNone
serialize(...hasParams):Record<SKUFlagsString, boolean>
Gets an object mapping field names to a boolean indicating whether the bit is available.
NameTypeOptionalDescription
...hasParamsreadonly unknown[]NoAdditional parameters for the has method, if any
Inherited from BitField
toArray(...hasParams):SKUFlagsString[]
Gets an Array of bitfield names based on the bits available.
NameTypeOptionalDescription
...hasParamsreadonly unknown[]NoAdditional parameters for the has method, if any
Inherited from BitField
toJSON():number extends number ? number : string
valueOf():number