Class Script

Script base class

Export

Script

Date

2023.12.27

Author

yisky

Hierarchy (view full)

Component
- Script

Index

Constructors

Properties

_awoken _enabled entity isScript userData

Accessors

Constructors

constructor

new Script(entity, options?): Script
Parameters
- entity: Entity
- options: ComponentOptions = {}
Returns Script
Inherited from Component.constructor

Properties

`Protected`_awoken

_awoken: boolean = false

`Protected`_enabled

_enabled: boolean = false

`Readonly`entity

entity: Entity

`Readonly`isScript

isScript: boolean = true

Read-only flag to check if a given component is of type Script

Memberof

Script

userData

userData: {
[key: string]: any;
}

Component user data

Memberof

Component

Accessors

enabled

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

Returns boolean
Memberof
Component

Inherited from Component.enabled
set enabled(value): void
Set whether the component is enabled.
Parameters
- value: boolean
Returns void
Memberof
Component

Inherited from Component.enabled

scene

get scene(): Scene
Scene own the component

Returns Scene
Memberof
Component

Inherited from Component.scene

Methods

`Protected`_onAwake

_onAwake(): void
Protected
Awake script

Returns void
Memberof
Script

Overrides Component._onAwake

`Protected`_onDestroy

_onDestroy(): void
Protected
Destroy script

Returns void
Memberof
Script

Overrides Component._onDestroy

`Protected`_onDisable

_onDisable(): void
Protected
Disable script

Returns void
Memberof
Script

Overrides Component._onDisable

`Protected`_onEnable

_onEnable(): void
Protected
Enable script

Returns void
Memberof
Script

Overrides Component._onEnable

desrtoy

desrtoy(): void
Destroy component

Returns void
Memberof
Component

Inherited from Component.desrtoy

dispose

dispose(): void
Clear subscribers

Returns void
Memberof
EventDispatcher

Inherited from Component.dispose

emit

emit(event): void
Emit event
Parameters
- event: {
  type: string;
  [key: string]: any;
  }
  - [key: string]: any
  - type: string
Returns void
Memberof
EventDispatcher

Inherited from Component.emit

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

Inherited from Component.off

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

Inherited from Component.on

onAfterCameraRender

onAfterCameraRender(camera): void
Script after camera render, called per camera.
Parameters
- camera: Camera
Returns void
Memberof
Script

onAwake

onAwake(): void
Awake script (Only call once when it's first enable)

Returns void
Memberof
Script

onBeforeCameraRender

onBeforeCameraRender(camera): void
Script before camera render, called per camera.
Parameters
- camera: Camera
Returns void
Memberof
Script

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

Inherited from Component.once

onDestroy

onDestroy(): void
Destroy script

Returns void
Memberof
Script

onDisable

onDisable(): void
Disable the script

Returns void
Memberof
Script

onDisableInScene

onDisableInScene(): void
Disable the script when detach from scene

Returns void
Memberof
Script

onEnable

onEnable(): void
Enable the script

Returns void
Memberof
Script

onLateUpdate

onLateUpdate(timeSinceLastFrame, totalTime): void
Script late update
Parameters
- timeSinceLastFrame: number
  time since last frame in seconds
- totalTime: number
  total time in seconds
Returns void
Memberof
Script

onPhysicsUpdate

onPhysicsUpdate(): void
Script physics update

Returns void
Memberof
Script

onStart

onStart(): void
Start script (Call when the animation loop first start)

Returns void
Memberof
Script

onUpdate

onUpdate(timeSinceLastFrame, totalTime): void
Script update
Parameters
- timeSinceLastFrame: number
  time since last frame in seconds
- totalTime: number
  total time in seconds
Returns void
Memberof
Script