Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UserFlags

Handles UserFlags BitFields in Klasa-Core

Hierarchy

Implements

  • BitFieldObject

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

bitfield

bitfield: number

The bitfield data

Static DEFAULT

DEFAULT: number

The default flags for the bitfield

Static FLAGS

FLAGS: { [UserFlagsFlags.BugHunterLevel1]: number; [UserFlagsFlags.BugHunterLevel2]: number; [UserFlagsFlags.DiscordEmployee]: number; [UserFlagsFlags.DiscordPartner]: number; [UserFlagsFlags.EarlySupporter]: number; [UserFlagsFlags.HouseBalance]: number; [UserFlagsFlags.HouseBravery]: number; [UserFlagsFlags.HouseBrilliance]: number; [UserFlagsFlags.HypesquadEvents]: number; [UserFlagsFlags.System]: number; [UserFlagsFlags.TeamUser]: number } = {[UserFlagsFlags.DiscordEmployee]: 1 << 0,[UserFlagsFlags.DiscordPartner]: 1 << 1,[UserFlagsFlags.HypesquadEvents]: 1 << 2,[UserFlagsFlags.BugHunterLevel1]: 1 << 3,[UserFlagsFlags.HouseBravery]: 1 << 6,[UserFlagsFlags.HouseBrilliance]: 1 << 7,[UserFlagsFlags.HouseBalance]: 1 << 8,[UserFlagsFlags.EarlySupporter]: 1 << 9,[UserFlagsFlags.TeamUser]: 1 << 10,[UserFlagsFlags.System]: 1 << 12,[UserFlagsFlags.BugHunterLevel2]: 1 << 14} as const

The UserFlags flags

Type declaration

  • [UserFlagsFlags.BugHunterLevel1]: number
  • [UserFlagsFlags.BugHunterLevel2]: number
  • [UserFlagsFlags.DiscordEmployee]: number
  • [UserFlagsFlags.DiscordPartner]: number
  • [UserFlagsFlags.EarlySupporter]: number
  • [UserFlagsFlags.HouseBalance]: number
  • [UserFlagsFlags.HouseBravery]: number
  • [UserFlagsFlags.HouseBrilliance]: number
  • [UserFlagsFlags.HypesquadEvents]: number
  • [UserFlagsFlags.System]: number
  • [UserFlagsFlags.TeamUser]: number

Accessors

Static ALL

  • get ALL(): number

  • The value of all bits in this bitfield

    Returns number

Methods

[Symbol.iterator]

  • [Symbol.iterator](): IterableIterator<string>

  • Defines iterable behavior for BitFields

    Returns IterableIterator<string>

add

  • Adds a bit to this BitField or a new Bitfield if this is frozen

    Parameters

    Returns BitField<UserFlagsResolvable>

equals

  • Checks if this BitField matches another bitfield resolvable

    Parameters

    Returns boolean

freeze

  • freeze(): this

  • Freezes this BitField

    Returns this

has

  • Checks if this BitField has a bit or bits

    Parameters

    Returns boolean

mask

  • Returns only the bits in common between this bitfield and the passed bits.

    Parameters

    Returns BitField<UserFlagsResolvable>

missing

  • Returns any bits this BitField is missing

    Parameters

    Returns string[]

remove

serialize

  • serialize(): Record<string, boolean>

  • Returns an object of flags: boolean

    Returns Record<string, boolean>

toArray

  • toArray(): string[]

  • Returns an array of Flags that make up this BitField

    Returns string[]

toJSON

  • toJSON(): number

  • Defines what this Bitfield is when converted to JSON

    Returns number

valueOf

  • valueOf(): number

  • Defines value behavior of this BitField

    Returns number

Static resolve

  • resolve<T>(bit?: T): number

  • Resolves a BitFieldResolvable into a number

    Type parameters

    • T: BitFieldResolvable

    Parameters

    • Optional bit: T

      The bit/s to resolve

    Returns number

Generated using TypeDoc