Class Group

userData

enabled

• get enabled(): boolean

• 获取组件是否启用

  Returns boolean

  Memberof

  Component

• set enabled(value): void

• 启用或禁用组件

  Parameters

  • value: boolean

  Returns void

  Memberof

  Component

engine

• get engine(): Engine

• 获取引擎对象

  Returns Engine

  Memberof

  EngineObject

entity

• get entity(): Entity

• 获取组件所属实体

  Returns Entity

  Memberof

  Component

addEventListener

• addEventListener(type, callback, parameters?): number

• 添加事件监听器

  Parameters

  • type: string

    事件类型（不区分大小写）

  • callback: ((event) => void)

    事件监听回调

    • • (event): void

      • Parameters

        • event: {
              type: string;
              [key: string]: any;
          }

          • [key: string]: any

          • type: string

        Returns void

  • Optional parameters: {
        priority?: Priority;
        target?: any;
    } = {}

    事件参数

    • Optional priority?: Priority

    • Optional target?: any

  Returns number

  Memberof

  EventDispatcher

destroy

• destroy(): void

• 销毁组件

  Returns void

  Memberof

  Component

dispatchEvent

• dispatchEvent(event): void

• 分发事件

  Parameters

  • event: {
        type: string;
        [key: string]: any;
    }

    • [key: string]: any

    • type: string

  Returns void

  Memberof

  EventDispatcher

dispose

• dispose(): void

• 释放接口

  Returns void

  Memberof

  EventDispatcher

removeAllEventListeners

• removeAllEventListeners(): void

• 移除所有事件监听器

  Returns void

  Memberof

  EventDispatcher

removeEventListener

• removeEventListener(type, callback?): void

• 移除事件监听器

  Parameters

  • type: string

    事件类型（不区分大小写）

  • Optional callback: ((event) => void)

    事件监听回调（可选，不设置则表示移除所有监听器）

    • • (event): void

      • Parameters

        • event: {
              type: string;
              [key: string]: any;
          }

          • [key: string]: any

          • type: string

        Returns void

  Returns void

  Memberof

  EventDispatcher

removeEventListenerByEventId

• removeEventListenerByEventId(eventID): void

• 通过事件Id移除事件监听器

  Parameters

  • eventID: number

  Returns void

  Memberof

  EventDispatcher

setActive

• setActive(value): void

• 激活或冻结组件

  Parameters

  • value: boolean

  Returns void

  Memberof

  Component

updateProperties

• updateProperties(parameters): Promise<void>

• 批量更新组件属性

  Parameters

  • parameters: {
        [key: string]: any;
    }

    • [key: string]: any

  Returns Promise<void>

  Memberof

  Component