Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Entity

Hierarchy

Implements

  • EventTarget

Indexable

[index: string]: any

Index

Constructors

Accessors

Methods

Constructors

constructor

  • new Entity(config?: EntityConfig): Entity

  • Parameters

    • Optional config: EntityConfig

    Returns Entity

Accessors

client

id

  • get id(): string

  • Returns string

name

  • get name(): string
  • set name(value: string): void

  • Returns string

  • Parameters

    • value: string

    Returns void

Methods

addEventListener

dispatchEvent

  • dispatchEvent(event: Event): boolean

  • Parameters

    • event: Event

    Returns boolean

removeEventListener

  • removeEventListener(type: string, callback: EventListener<Entity>): Promise<void>

  • Parameters

    • type: string
    • callback: EventListener<Entity>

    Returns Promise<void>

setClient

  • 为实体指定关联的客户端

    throws

    {@link ClientAlreadySetError} 该错误将会在重复设置客户端时抛出

    Parameters

    Returns Promise<void>