Class Component

constructor

• new Component(entity, options?): Component

• Parameters

  • entity: Entity
  • options: ComponentOptions = {}

  Returns Component

Readonlyentity

userData

enabled

• get enabled(): boolean

• Indicates whether the component is enabled.

  Returns boolean

  Memberof

  Component

• set enabled(value): void

• Set whether the component is enabled.

  Parameters

  • value: boolean

  Returns void

  Memberof

  Component

scene

• get scene(): Scene

• Scene own the component

  Returns Scene

  Memberof

  Component

desrtoy

• desrtoy(): void

• Destroy component

  Returns void

  Memberof

  Component

dispose

• dispose(): void

• Clear subscribers

  Returns void

  Memberof

  EventDispatcher

emit

• emit(event): void

• Emit event

  Parameters

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

    • [key: string]: any

    • type: string

  Returns void

  Memberof

  EventDispatcher

off

• off(type, callback?): void

• Unsubscribe a event, if the callback param is not defined, all subscribers of this type will be removed.

  Parameters

  • type: string
  • Optionalcallback: SubscriberCallbackFn

    subscriber callback

  Returns void

  Memberof

  EventDispatcher

on

• on(type, callback, options?): void

• Subscribe a event

  Parameters

  • type: string

    event type
  • callback: SubscriberCallbackFn

    callback functions
  • Optionaloptions: {
        priority?: Priority;
        target?: any;
    } = {}

    options

    • Optionalpriority?: Priority

    • Optionaltarget?: any

  Returns void

  Memberof

  EventDispatcher

once

• once(type, callback, options?): void

• Subscribe a event, just emit once

  Parameters

  • type: string
  • callback: SubscriberCallbackFn

    subscriber callback
  • options: {
        priority?: Priority;
        target?: any;
    } = {}

    • Optionalpriority?: Priority

    • Optionaltarget?: any

  Returns void

  Memberof

  EventDispatcher