Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Speaking

Handles Speaking BitFields in Klasa-Core

Hierarchy

Implements

  • BitFieldObject

Index

Constructors

constructor

Properties

bitfield

bitfield: number

The bitfield data

Static DEFAULT

DEFAULT: number

The default flags for the bitfield

Static FLAGS

FLAGS: { [SpeakingFlags.Soundshare]: number; [SpeakingFlags.Speaking]: number } = {[SpeakingFlags.Speaking]: 1 << 0,[SpeakingFlags.Soundshare]: 1 << 1} as const

The Speaking flags

Type declaration

  • [SpeakingFlags.Soundshare]: number
  • [SpeakingFlags.Speaking]: 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<SpeakingResolvable>

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<SpeakingResolvable>

missing

  • Returns any bits this BitField is missing

    Parameters

    Returns string[]

remove

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

    Parameters

    Returns BitField<SpeakingResolvable>

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