Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UserFlags

Hierarchy

  • BitField<UserFlagsString>
    • UserFlags

Index

Constructors

Properties

Methods

Constructors

constructor

  • new UserFlags(bits?: BitFieldResolvable<UserFlagsString, number>): UserFlags

  • Parameters

    • Optional bits: BitFieldResolvable<UserFlagsString, number>

    Returns UserFlags

Properties

bitfield

bitfield: number

Static FLAGS

FLAGS: Record<UserFlagsString, number>

Methods

[iterator]

  • [iterator](): IterableIterator<UserFlagsString>

  • Returns IterableIterator<UserFlagsString>

add

  • add(...bits: BitFieldResolvable<UserFlagsString, number>[]): BitField<UserFlagsString, number>

  • Parameters

    • Rest ...bits: BitFieldResolvable<UserFlagsString, number>[]

    Returns BitField<UserFlagsString, number>

any

  • any(bit: BitFieldResolvable<UserFlagsString, number>): boolean

  • Parameters

    • bit: BitFieldResolvable<UserFlagsString, number>

    Returns boolean

equals

  • equals(bit: BitFieldResolvable<UserFlagsString, number>): boolean

  • Parameters

    • bit: BitFieldResolvable<UserFlagsString, number>

    Returns boolean

freeze

  • freeze(): Readonly<BitField<UserFlagsString, number>>

  • Returns Readonly<BitField<UserFlagsString, number>>

has

  • has(bit: BitFieldResolvable<UserFlagsString, number>): boolean

  • Parameters

    • bit: BitFieldResolvable<UserFlagsString, number>

    Returns boolean

missing

  • missing(bits: BitFieldResolvable<UserFlagsString, number>, ...hasParams: readonly unknown[]): UserFlagsString[]

  • Parameters

    • bits: BitFieldResolvable<UserFlagsString, number>
    • Rest ...hasParams: readonly unknown[]

    Returns UserFlagsString[]

remove

  • remove(...bits: BitFieldResolvable<UserFlagsString, number>[]): BitField<UserFlagsString, number>

  • Parameters

    • Rest ...bits: BitFieldResolvable<UserFlagsString, number>[]

    Returns BitField<UserFlagsString, number>

serialize

  • serialize(...hasParams: readonly unknown[]): Record<UserFlagsString, boolean>

  • Parameters

    • Rest ...hasParams: readonly unknown[]

    Returns Record<UserFlagsString, boolean>

toArray

  • toArray(...hasParams: readonly unknown[]): UserFlagsString[]

  • Parameters

    • Rest ...hasParams: readonly unknown[]

    Returns UserFlagsString[]

toJSON

  • toJSON(): number

  • Returns number

valueOf

  • valueOf(): number

  • Returns number

Static resolve

  • resolve(bit?: BitFieldResolvable<UserFlagsString, number>): number

  • Parameters

    • Optional bit: BitFieldResolvable<UserFlagsString, number>

    Returns number

Generated using TypeDoc