Class ParticleModule

Optional _app

appRenderIndex

data

entity

extData

Readonly instanceId

onSetApp

app

• get app(): App

• Returns App

• set app(value): void

• Parameters

  • value: App

  Returns void

destroyed

• get destroyed(): boolean

• Whether it has been destroyed.

  Returns boolean

enabled

• get enabled(): boolean

• Indicates whether the component is enabled.

  Returns boolean
• set enabled(value): void

• Parameters

  • value: boolean

  Returns void

uiConfig

• get uiConfig(): UiObjectConfig<any, string, any>

• Returns UiObjectConfig<any, string, any>

_onAwake

• _onAwake(): void
• Internal

  Returns void

_onDestroy

• _onDestroy(): void
• Internal

  Returns void

_onDisable

• _onDisable(): void
• Internal

  Returns void

_onEnable

• _onEnable(): void
• Internal

  Returns void

_setActive

• _setActive(value): void
• Internal

  Parameters

  • value: boolean

  Returns void

addDispose

• addDispose(cb): void

• Parameters

  • cb: Function

  Returns void

applyMixinsTo

• applyMixinsTo(toClassInst, methodNames?, addMethods?, filterName?): void

• Parameters

  • toClassInst: any

  • Optional methodNames: string[]

  • Optional addMethods: string[]

  • Optional filterName: string[]

  Returns void

destroy

• destroy(): void

• Destroy self.

  Returns void

dispatch

• dispatch(event, ...data): boolean

• 触发指定事件名称.

  Parameters

  • event: string

    Event name

  • Rest ...data: any

    Data

  Returns boolean

  • Whether the dispatching is successful

effectScope

• effectScope(fn): void

• Parameters

  • fn: (() => any)

    • • (): any

      • Returns any

  Returns void

eventNames

• eventNames(): string[]

• 返回注册的所有事件名.

  Returns string[]

  所有事件名

hasEvent

• hasEvent(event): boolean

• 确定是否存在事件侦听

  Parameters

  • event: string

    事件名

  Returns boolean

  返回是否存在相应的事件

listenerCount

• listenerCount(event): number

• 返回具有指定事件名称的侦听总数.

  Parameters

  • event: string

    Event name

  Returns number

  The count of listeners

off

• off(event, fn?): EventDispatcher

• 移除监听.

  Parameters

  • event: string

    Event name

  • Optional fn: Function

    Function, If is undefined, delete all corresponding event listeners.

  Returns EventDispatcher

on

• on(event, fn): EventDispatcher

• 增加监听

  Parameters

  • event: string

    Event name

  • fn: Function

    Function

  Returns EventDispatcher

  This

once

• once(event, fn): EventDispatcher

• 只监听一次.

  Parameters

  • event: string

    Event name

  • fn: Function

    Function

  Returns EventDispatcher

  This

removeAllEventListeners

• removeAllEventListeners(event?): void

• 通过事件名移除所有监听.

  Parameters

  • Optional event: string

    Event name, delete all events if not passed

  Returns void

removeDispose

• removeDispose(cb): void

• Parameters

  • cb: Function

  Returns void