Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Actor

Data related to the Discord user that the actor represents.

Hierarchy

  • Component
    • Actor

Indexable

[name: string]: any

Data related to the Discord user that the actor represents.

Index

Properties

Accessors

Methods

Object literals

Properties

color

color: number

The Discord user color, determined by highest role color.

entity

entity: Entity

id

id: string

userID

userID: string

The Discord user ID.

username

username: string

The Discord username, or nickname if available.

Static key

key: string = "actor"

Static registered

registered: Boolean

Static serialize

serialize: Boolean

Static serializeFields

serializeFields: string[]

Static skipSerializeFields

skipSerializeFields: string[]

Static subbed

subbed: Boolean

Static typeName

typeName: string = "Actor"

Accessors

key

  • set key(arg: string): any

  • Parameters

    • arg: string

    Returns any

type

  • get type(): string

  • Returns string

Methods

destroy

  • destroy(): void

  • Returns void

getObject

  • getObject(withIds?: undefined | false | true): IComponentObject

  • Parameters

    • Optional withIds: undefined | false | true

    Returns IComponentObject

init

  • init(initial: any): void

  • Parameters

    • initial: any

    Returns void

postDestroy

  • postDestroy(): void

  • Returns void

preDestroy

  • preDestroy(): void

  • Returns void

preInit

  • preInit(initial: any): any

  • Parameters

    • initial: any

    Returns any

update

  • update(values?: IComponentUpdate): void

  • Parameters

    • Optional values: IComponentUpdate

    Returns void

Object literals

Static properties

properties: object

color

color: number = 0

userID

userID: string = ""

username

username: string = ""

Generated using TypeDoc