Class Script

脚本组件

Export

Date

2022.3.19

Author

lyx

Hierarchy

Component
- Script
  - Annotation
  - OrbitControl

Constructors

constructor

new Script(entity, parameters?): Script
Parameters
- entity: Entity
- parameters: ComponentParameters = {}
Returns Script

Inherited from Component.constructor

Properties

`Protected` _engine

_engine: Engine

`Protected` _entity

_entity: Entity

`Protected` _started

_started: boolean = false

`Readonly` isScript

isScript: boolean = true

脚本组件标识

Memberof

Script

userData

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

用户数据

Type declaration

[key: string]: any

Memberof

Component

Accessors

enabled

get enabled(): boolean
获取组件是否启用

Returns boolean

Memberof
Component

Inherited from Component.enabled
set enabled(value): void
启用或禁用组件
Parameters
- value: boolean
Returns void

Memberof
Component

Inherited from Component.enabled

engine

get engine(): Engine
获取引擎对象

Returns Engine

Memberof
EngineObject

Inherited from Component.engine

entity

get entity(): Entity
获取组件所属实体

Returns Entity

Memberof
Component

Inherited from Component.entity

started

get started(): boolean
获取脚本是否已启用

Returns boolean

Memberof
Script

Methods

`Protected` _onAwake

_onAwake(): void
Protected
唤醒脚本

Returns void

Memberof
Script

Overrides Component._onAwake

`Protected` _onDestroy

_onDestroy(): void
Protected
销毁脚本

Returns void

Memberof
Script

Overrides Component._onDestroy

`Protected` _onDisable

_onDisable(): void
Protected
禁用脚本

Returns void

Memberof
Script

Overrides Component._onDisable

`Protected` _onEnable

_onEnable(): void
Protected
启用脚本

Returns void

Memberof
Script

Overrides Component._onEnable

addEventListener

addEventListener(type, callback, parameters?): number
添加事件监听器
Parameters
- type: string
  
  事件类型（不区分大小写）
- callback: ((event) => void)
  
  事件监听回调
  - - (event): void
    - Parameters
      
      event: {
      type: string;
      [key: string]: any;
      }
      
      [key: string]: any
      
      type: string
      
      Returns void
- Optional parameters: {
  priority?: Priority;
  target?: any;
  } = {}
  
  事件参数
  - Optional priority?: Priority
  - Optional target?: any
Returns number

Memberof
EventDispatcher

Inherited from Component.addEventListener

destroy

destroy(): void
销毁组件

Returns void

Memberof
Component

Inherited from Component.destroy

dispatchEvent

dispatchEvent(event): void
分发事件
Parameters
- event: {
  type: string;
  [key: string]: any;
  }
  - [key: string]: any
  - type: string
Returns void

Memberof
EventDispatcher

Inherited from Component.dispatchEvent

dispose

dispose(): void
释放接口

Returns void

Memberof
EventDispatcher

Inherited from Component.dispose

onAwake

onAwake(): void
脚本唤醒回调（首次启用脚本时调用且只会被调用一次）

Returns void

Memberof
Script

onCameraChanged

onCameraChanged(event): void
‘camerachanged’事件回调
Parameters
- event: any
Returns void

Memberof
Script

onClick

onClick(event): void
‘click’事件回调
Parameters
- event: MouseEvent
Returns void

Memberof
Script

onCollisionEnter

onCollisionEnter(collision): void
进入碰撞器响应
Parameters
- collision: Collision
  
  碰撞信息
Returns void

Memberof
Script

onCollisionExit

onCollisionExit(collision): void
离开碰撞器响应
Parameters
- collision: Collision
  
  碰撞信息
Returns void

Memberof
Script

onCollisionStay

onCollisionStay(collision): void
逗留在碰撞器中响应
Parameters
- collision: Collision
  
  碰撞信息
Returns void

Memberof
Script

onDblClick

onDblClick(event): void
‘dblclick’事件回调
Parameters
- event: MouseEvent
Returns void

Memberof
Script

onDestroy

onDestroy(): void
脚本销毁回调（仅调用一次）

Returns void

Memberof
Script

onDisable

onDisable(): void
脚本禁用回调（多次调用）

Returns void

Memberof
Script

onEnable

onEnable(): void
脚本启用回调（多次调用）

Returns void

Memberof
Script

onKeyDown

onKeyDown(event): void
‘keydown’事件回调
Parameters
- event: KeyboardEvent
Returns void

Memberof
Script

onKeyUp

onKeyUp(event): void
‘keyup’事件回调
Parameters
- event: KeyboardEvent
Returns void

Memberof
Script

onLateUpdate

onLateUpdate(timeSinceLastFrame, totalTime): void
脚本更新新完成回调（逐帧调用）
Parameters
- timeSinceLastFrame: number
  
  距离上一帧更新的时长（单位：毫秒）
- totalTime: number
  
  总时长 (单位：毫秒)
Returns void

Memberof
Script

onPhysicsUpdate

onPhysicsUpdate(): void
物理更新回调，每一帧可以调用多次

Returns void

Memberof
Script

onPointerCancel

onPointerCancel(event): void
‘pointercancel’事件回调
Parameters
- event: PointerEvent
Returns void

Memberof
Script

onPointerDown

onPointerDown(event): void
‘pointerdown’事件回调
Parameters
- event: PointerEvent
Returns void

Memberof
Script

onPointerMove

onPointerMove(event): void
‘pointermove’事件回调
Parameters
- event: PointerEvent
Returns void

Memberof
Script

onPointerUp

onPointerUp(event): void
‘pointerup’事件回调
Parameters
- event: PointerEvent
Returns void

Memberof
Script

onResize

onResize(event): void
‘resize’事件回调
Parameters
- event: any
Returns void

Memberof
Script

onStart

onStart(): void
脚本开始执行回调（在首次帧循环时调用且只会被调用一次）

Returns void

Memberof
Script

onTriggerEnter

onTriggerEnter(collision): void
进入触发器响应
Parameters
- collision: Collision
  
  碰撞信息
Returns void

Memberof
Script

onTriggerExit

onTriggerExit(collision): void
离开触发器响应
Parameters
- collision: Collision
  
  碰撞信息
Returns void

Memberof
Script

onTriggerStay

onTriggerStay(collision): void
逗留在触发器中响应
Parameters
- collision: Collision
  
  碰撞信息
Returns void

Memberof
Script

onUpdate

onUpdate(timeSinceLastFrame, totalTime): void
脚本更新回调（逐帧调用）
Parameters
- timeSinceLastFrame: number
  
  距离上一帧更新的时长（单位：毫秒）
- totalTime: number
  
  总时长 (单位：毫秒)
Returns void

Memberof
Script

onWheel

onWheel(event): void
‘wheel’事件回调
Parameters
- event: WheelEvent
Returns void

Memberof
Script

postRenderDepth

postRenderDepth(event): void
‘postrenderdepth’事件回调
Parameters
- event: any
Returns void

Memberof
Script

preRenderDepth

preRenderDepth(event): void
‘prerenderdepth’事件回调
Parameters
- event: any
Returns void

Memberof
Script

removeAllEventListeners

removeAllEventListeners(): void
移除所有事件监听器

Returns void

Memberof
EventDispatcher

Inherited from Component.removeAllEventListeners

removeEventListener

removeEventListener(type, callback?): void
移除事件监听器
Parameters
- type: string
  
  事件类型（不区分大小写）
- Optional callback: ((event) => void)
  
  事件监听回调（可选，不设置则表示移除所有监听器）
  - - (event): void
    - Parameters
      
      event: {
      type: string;
      [key: string]: any;
      }
      
      [key: string]: any
      
      type: string
      
      Returns void
Returns void

Memberof
EventDispatcher

Inherited from Component.removeEventListener

removeEventListenerByEventId

removeEventListenerByEventId(eventID): void
通过事件Id移除事件监听器
Parameters
- eventID: number
Returns void

Memberof
EventDispatcher

Inherited from Component.removeEventListenerByEventId

setActive

setActive(value): void
激活或冻结组件
Parameters
- value: boolean
Returns void

Memberof
Component

Inherited from Component.setActive

updateProperties

updateProperties(parameters): Promise<void>
批量更新组件属性
Parameters
- parameters: {
  [key: string]: any;
  }
  - [key: string]: any
Returns Promise<void>

Memberof
Component

Inherited from Component.updateProperties