Class AppBase

事件派发管理

Hierarchy (view full)

EventDispatcher
- AppBase
  - App

Indexable

[key: string]: any

Constructors

constructor

new AppBase(param?): AppBase
Parameters
- Optional param: AppBaseOptions
Returns AppBase
Overrides EventDispatcher.constructor

Properties

`Readonly` _modules

_modules: ModuleBase[] = []

containerSize

containerSize: {
height: number;
width: number;
} = ...

Type declaration

height: number
width: number

data

data: ShallowReactive<{
    camera?: Camera;
    container?: HTMLElement;
    domElement?: HTMLElement;
    scene?: Scene;
    [key: string]: any;
}> = ...

Type declaration

[key: string]: any
Optional camera?: Camera
Optional container?: HTMLElement
Optional domElement?: HTMLElement
Optional scene?: Scene

`Readonly` moduleManager

moduleManager: ModuleManager = ...

needRenderUpdate

needRenderUpdate: boolean = true

`Readonly` options

options: AppBaseOptions

tweenManager

tweenManager: TweenManager = ...

Accessors

camera

get camera(): Camera
Returns Camera
set camera(value): void
Parameters
- value: Camera
Returns void

cameraControl

get cameraControl(): CameraControls
Returns CameraControls

container

get container(): HTMLElement
Returns HTMLElement
set container(value): void
Parameters
- value: HTMLElement
Returns void

destroyed

get destroyed(): boolean
Indicates whether the engine is destroyed.

Returns boolean

domElement

get domElement(): HTMLElement
Returns HTMLElement
set domElement(value): void
Parameters
- value: HTMLElement
Returns void

isPaused

get isPaused(): boolean
Whether the engine is paused.

Returns boolean

scene

get scene(): Scene
Returns Scene
set scene(value): void
Parameters
- value: Scene
Returns void

targetFrameRate

get targetFrameRate(): number
Set the target frame rate you want to achieve.

Returns number
Remarks
It only takes effect when vSyncCount = 0 (ie, vertical synchronization is turned off). The larger the value, the higher the target frame rate, Number.POSITIVE_INFINITY represents the infinite target frame rate.
set targetFrameRate(value): void
Parameters
- value: number
Returns void

time

get time(): Time
The time information of the engine.

Returns Time

uiConfig

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

vSyncCount

get vSyncCount(): number
在vSyncCount被设置为0时才能生效，而当其设置为大于0时，则不生效。当vSyncCount为1时，游戏帧率会与设备的刷新帧率保持一致，例如一台设备刷新频率是60Hz则，此时其游戏帧率为60FPS 当vSyncCount为2时，游戏帧率会设置为刷新帧率的一半，例如一台设备刷新帧率是60Hz时，则游戏帧率为30FPS

Returns number
Remarks
0 means that the vertical synchronization is turned off.
set vSyncCount(value): void
Parameters
- value: number
Returns void

Methods

add

add<T, U>(type, params?): T
增加模块，等同于this.addModule(xxx)
Type Parameters
- T extends AppModuleBase
- U
Parameters
- type: (new (app?, obj?) => T)
  - - new (app?, obj?): T
    - Parameters
      Optional app: any
      Optional obj: U
      Returns T
- Optional params: U
Returns T

addModule

addModule<T, U>(type, params?): T
增加模块，等同于this.add(xxx)
Type Parameters
- T extends AppModuleBase
- U
Parameters
- type: (new (app?, obj?) => T)
  - - new (app?, obj?): T
    - Parameters
      Optional app: any
      Optional obj: U
      Returns T
- Optional params: U
Returns T

callModules

callModules(methodName, ...args): void
Parameters
- methodName: string
- Rest ...args: any
Returns void

destroy

destroy(): void
Destroy engine.

Returns void
Remarks
If call during frame execution will delay until the end of the frame

dispatch

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

eventNames

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

Returns string[]
所有事件名

Inherited from EventDispatcher.eventNames

getModule

getModule<T, U>(type): T
Type Parameters
- T extends AppModuleBase
- U
Parameters
- type: (new (app?, obj?) => T)
  - - new (app?, obj?): T
    - Parameters
      Optional app: any
      Optional obj: U
      Returns T
Returns T

hasEvent

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

Inherited from EventDispatcher.hasEvent

listenerCount

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

Inherited from EventDispatcher.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 EventDispatcher.off

on

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

Inherited from EventDispatcher.on

onNextFrame

onNextFrame(callback): void
下帧回调
Parameters
- callback: ((app) => void)
  - - (app): void
    - Parameters
      app: AppBase
      Returns void
Returns void

once

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

Inherited from EventDispatcher.once

pause

pause(): void
Pause the engine.

Returns void

removeAllEventListeners

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

removeAllModules

removeAllModules(): void
Returns void

removeModule

removeModule<T, U>(type): void
Type Parameters
- T extends AppModuleBase
- U
Parameters
- type: (new (app?, obj?) => T)
  - - new (app?, obj?): T
    - Parameters
      Optional app: any
      Optional obj: U
      Returns T
Returns void

resume

resume(): void
Resume the engine.

Returns void

run

run(): void
Execution engine loop.

Returns void

update

update(): void
Update the engine loop manually. If you call engine.run(), you generally don't need to call this function.

Returns void

Class AppBase

Hierarchy (view full)

Indexable

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Optional param: AppBaseOptions

Returns AppBase

Properties

Readonly _modules

containerSize

Type declaration

height: number

width: number

data

Type declaration

[key: string]: any

Optional camera?: Camera

Optional container?: HTMLElement

Optional domElement?: HTMLElement

Optional scene?: Scene

Readonly moduleManager

needRenderUpdate

Readonly options

tweenManager

Accessors

camera

Returns Camera

Parameters

value: Camera

Returns void

cameraControl

Returns CameraControls

container

Returns HTMLElement

Parameters

value: HTMLElement

Returns void

destroyed

Returns boolean

domElement

Returns HTMLElement

Parameters

value: HTMLElement

Returns void

isPaused

Returns boolean

scene

Returns Scene

Parameters

value: Scene

Returns void

targetFrameRate

Returns number

Remarks

Parameters

value: number

Returns void

time

Returns Time

uiConfig

Returns UiObjectConfig<any, string, any>

vSyncCount

Returns number

Remarks

Parameters

value: number

Returns void

Methods

add

Type Parameters

T extends AppModuleBase

U

Parameters

type: (new (app?, obj?) => T)

`Optional` param: AppBaseOptions

`Readonly` _modules

`Optional` camera?: Camera

`Optional` container?: HTMLElement

`Optional` domElement?: HTMLElement

`Optional` scene?: Scene

`Readonly` moduleManager

`Readonly` options

`Optional` app: any

`Optional` obj: U

`Optional` params: U

`Optional` app: any

`Optional` obj: U

`Optional` params: U

`Rest` ...args: any

`Rest` ...data: any

`Optional` app: any

`Optional` obj: U

`Optional` fn: Function