Class BehaviorModule

EntityBase.

Hierarchy (view full)

EntityModuleBase
- BehaviorModule

Implements

IEntityModuleBase

Constructors

constructor

new BehaviorModule(entity, behavior?): BehaviorModule
Parameters
- entity: Entity
- Optional behavior: Behavior | Behavior[]
Returns BehaviorModule
Overrides EntityModuleBase.constructor

Properties

`Optional` _app

_app?: App

`Protected` _destroyed

_destroyed: boolean = false

appRenderIndex

appRenderIndex: number = 0

behaviors

behaviors: Behavior[]

data

data: ShallowReactive<{
[key: string]: any;
}> = ...

Type declaration

[key: string]: any

entity

entity: Entity

extData

extData: {
[key: string]: any;
} = {}

Type declaration

[key: string]: any

ids

ids: string[]

`Readonly` instanceId

instanceId: number = ++AppObject._instanceIdCounter

onSetApp

onSetApp: Signal = ...

`Static` moduleName

moduleName: string = "BehaviorModule"

Accessors

app

get app(): App
Returns App
Inherited from EntityModuleBase.app
set app(value): void
Parameters
- value: App
Returns void
Inherited from EntityModuleBase.app

destroyed

get destroyed(): boolean
Whether it has been destroyed.

Returns boolean
Inherited from EntityModuleBase.destroyed

enabled

get enabled(): boolean
Indicates whether the component is enabled.

Returns boolean
Inherited from EntityModuleBase.enabled
set enabled(value): void
Parameters
- value: boolean
Returns void
Inherited from EntityModuleBase.enabled

uiConfig

get uiConfig(): UiObjectConfig<any, string, any>
Returns UiObjectConfig<any, string, any>
Inherited from EntityModuleBase.uiConfig

Methods

_onAwake

_onAwake(): void
Internal
Returns void
Inherited from EntityModuleBase._onAwake

_onDestroy

_onDestroy(): void
Internal
Returns void
Inherited from EntityModuleBase._onDestroy

_onDisable

_onDisable(): void
Internal
Returns void
Inherited from EntityModuleBase._onDisable

_onEnable

_onEnable(): void
Internal
Returns void
Inherited from EntityModuleBase._onEnable

_setActive

_setActive(value): void
Internal
Parameters
- value: boolean
Returns void
Inherited from EntityModuleBase._setActive

addAction

addAction(func, id?): string
Parameters
- func: ((context) => void | BehaviorStatus)
  - - (context): void | BehaviorStatus
    - Parameters
      context: {
          elapsed: number;
          entity: Entity;
          timeDelta: number;
          [key: string]: any;
      }
      [key: string]: any
      elapsed: number
      entity: Entity
      timeDelta: number
      Returns void | BehaviorStatus
- Optional id: string
Returns string

addBehavior

addBehavior(behavior, id?): string
Parameters
- behavior: Behavior
- Optional id: string
Returns string

addDispose

addDispose(cb): void
Parameters
- cb: Function
Returns void
Inherited from EntityModuleBase.addDispose

applyMixinsTo

applyMixinsTo(toClassInst, methodNames?, addMethods?, filterName?): void
Parameters
- toClassInst: any
- Optional methodNames: string[]
- Optional addMethods: string[]
- Optional filterName: string[]
Returns void
Inherited from EntityModuleBase.applyMixinsTo

destroy

destroy(): void
Destroy self.

Returns void
Inherited from EntityModuleBase.destroy

dispatch

dispatch(event, ...data): boolean
触发指定事件名称.
Parameters
- event: string
  Event name
- Rest ...data: any
  Data
Returns boolean
- Whether the dispatching is successful
Inherited from EntityModuleBase.dispatch

effectScope

effectScope(fn): void
Parameters
- fn: (() => any)
  - - (): any
    - Returns any
Returns void
Inherited from EntityModuleBase.effectScope

eventNames

eventNames(): string[]
返回注册的所有事件名.

Returns string[]
所有事件名

Inherited from EntityModuleBase.eventNames

getBehaviorById

getBehaviorById(id): Behavior
Parameters
- id: string
Returns Behavior

getBehaviors

getBehaviors(): Behavior[]
Returns Behavior[]

hasEvent

hasEvent(event): boolean
确定是否存在事件侦听
Parameters
- event: string
  事件名
Returns boolean
返回是否存在相应的事件

Inherited from EntityModuleBase.hasEvent

listenerCount

listenerCount(event): number
返回具有指定事件名称的侦听总数.
Parameters
- event: string
  Event name
Returns number
The count of listeners

Inherited from EntityModuleBase.listenerCount

off

off(event, fn?): EventDispatcher
移除监听.
Parameters
- event: string
  Event name
- Optional fn: Function
  Function, If is undefined, delete all corresponding event listeners.
Returns EventDispatcher
Inherited from EntityModuleBase.off

on

on(event, fn): EventDispatcher
增加监听
Parameters
- event: string
  Event name
- fn: Function
  Function
Returns EventDispatcher
This

Inherited from EntityModuleBase.on

onAppUpdate

onAppUpdate(time): void
Parameters
- time: Time
Returns void
Implementation of IEntityModuleBase.onAppUpdate

once

once(event, fn): EventDispatcher
只监听一次.
Parameters
- event: string
  Event name
- fn: Function
  Function
Returns EventDispatcher
This

Inherited from EntityModuleBase.once

removeAllEventListeners

removeAllEventListeners(event?): void
通过事件名移除所有监听.
Parameters
- Optional event: string
  Event name, delete all events if not passed
Returns void
Inherited from EntityModuleBase.removeAllEventListeners

removeBehavior

removeBehavior(behavior): void
Parameters
- behavior: Behavior
Returns void

removeBehaviorById

removeBehaviorById(id): void
Parameters
- id: string
Returns void

removeBehaviorByTypeName

removeBehaviorByTypeName(typename): void
Parameters
- typename: string
Returns void

removeDispose

removeDispose(cb): void
Parameters
- cb: Function
Returns void
Inherited from EntityModuleBase.removeDispose

setupUiConfig

setupUiConfig(): {
    children: (() => {
        app: App;
        children: {
            getValue: (() => boolean);
            label: string;
            setValue: ((v) => void);
            type: string;
        }[];
        expanded: boolean;
        label: string;
        type: string;
    }[])[];
    expanded: boolean;
    label: string;
    type: string;
}
Returns {
    children: (() => {
        app: App;
        children: {
            getValue: (() => boolean);
            label: string;
            setValue: ((v) => void);
            type: string;
        }[];
        expanded: boolean;
        label: string;
        type: string;
    }[])[];
    expanded: boolean;
    label: string;
    type: string;
}
- children: (() => {
      app: App;
      children: {
          getValue: (() => boolean);
          label: string;
          setValue: ((v) => void);
          type: string;
      }[];
      expanded: boolean;
      label: string;
      type: string;
  }[])[]
- expanded: boolean
- label: string
- type: string
Implementation of IEntityModuleBase.setupUiConfig

Class BehaviorModule

Hierarchy (view full)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

entity: Entity

Optional behavior: Behavior | Behavior[]

Returns BehaviorModule

Properties

Optional _app

Protected _destroyed

appRenderIndex

behaviors

data

Type declaration

[key: string]: any

entity

extData

Type declaration

[key: string]: any

ids

Readonly instanceId

onSetApp

Static moduleName

Accessors

app

Returns App

Parameters

value: App

Returns void

destroyed

Returns boolean

enabled

Returns boolean

Parameters

value: boolean

Returns void

uiConfig

Returns UiObjectConfig<any, string, any>

Methods

_onAwake

Returns void

_onDestroy

Returns void

_onDisable

Returns void

_onEnable

Returns void

_setActive

Parameters

value: boolean

Returns void

addAction

Parameters

func: ((context) => void | BehaviorStatus)

Parameters

context: { elapsed: number; entity: Entity; timeDelta: number; [key: string]: any; }

[key: string]: any

elapsed: number

entity: Entity

timeDelta: number

Returns void | BehaviorStatus

Optional id: string

Returns string

addBehavior

Parameters

behavior: Behavior

Optional id: string

Returns string

addDispose

Parameters

cb: Function

Returns void

applyMixinsTo

`Optional` behavior: Behavior | Behavior[]

`Optional` _app

`Protected` _destroyed

`Readonly` instanceId

`Static` moduleName

context: {
elapsed: number;
entity: Entity;
timeDelta: number;
[key: string]: any;
}

`Optional` id: string

`Optional` id: string

`Optional` methodNames: string[]

`Optional` addMethods: string[]

`Optional` filterName: string[]

`Rest` ...data: any

`Optional` fn: Function

`Optional` event: string