Class BaseScript<T>Abstract

constructor

• new BaseScript<T extends LikoNode = LikoNode>(): BaseScript<T>

  Type Parameters

  • T extends LikoNode = LikoNode

  Returns BaseScript<T>

id

label

awaked

• get awaked(): boolean

  脚本是否已被激活（添加到场景后触发）

  Returns boolean

destroyed

• get destroyed(): boolean

  脚本是否已被销毁

  Returns boolean

enabled

• get enabled(): boolean

  脚本是否启用，禁用时不执行更新且触发 onDisable

  Returns boolean
• set enabled(value: boolean): void

  Parameters

  • value: boolean

  Returns void

scene

• get scene(): undefined | IScene

  目标节点所在的场景引用（建议缓存为局部变量以提高性能）

  Returns undefined | IScene

stage

• get stage(): undefined | Stage

  目标节点所在的舞台引用

  Returns undefined | Stage

target

• get target(): T

  脚本挂载的目标节点，设置后触发 onCreate

  Returns T
• set target(value: T): void

  Parameters

  • value: T

  Returns void

destroy

• destroy(): void

  销毁脚本实例

  Returns void

  Remarks

  销毁后脚本将不再可用，系统会自动：

  • 触发 onDestroy 回调
  • 清除在 target、scene、stage、timer 上的所有监听
  • 解除与目标节点的关联
  • 设置 destroyed 状态为 true
  • 设置 enabled 状态为 false

  注意： 如果使用了 Timer.system 的监听，需要在 onDestroy 中手动清除

onAwake

• onAwake(): void

  脚本第一次被激活时触发的回调函数

  Returns void

  Remarks

  只会触发一次，此时：

  • target 已经添加到场景中
  • 可以安全访问 scene 和 stage
  • 适合进行初始化设置和事件监听

onCreate

• onCreate(): void

  当脚本的 target 被设置时触发的回调函数

  Returns void

  Remarks

  生命周期中的第一个回调，此时：

  • target 已经设置完成
  • 可以访问 target 的属性和方法
  • 但 scene 和 stage 可能还未初始化

onDestroy

• onDestroy(): void

  脚本被销毁时触发的回调函数

  Returns void

  Remarks

  用于清理资源和释放引用，如：

  • 移除事件监听
  • 清理定时器
  • 释放对象引用

  注意： 系统会自动清理大部分监听，但使用 Timer.system 的监听需要手动清除

onDisable

• onDisable(): void

  当脚本被禁用时触发的回调函数

  Returns void

onEnable

• onEnable(): void

  当脚本被启用时触发的回调函数

  Returns void

onUpdate

• onUpdate(delta: number): void

  每帧更新时触发的回调函数

  Parameters

  • delta: number

    距离上一帧的时间间隔（毫秒）

  Returns void

  Remarks

  用于实现脚本的主要逻辑，如：

  • 移动和动画
  • 状态检查和更新
  • 输入处理
  • 物理计算等

setProp

• setProp(key: string, value: unknown): void

  设置单个属性值

  Parameters

  • key: string

    属性名
  • value: unknown

    属性值

  Returns void

setProps

• setProps(props?: Record<string, unknown>): this

  批量设置脚本属性

  Parameters

  • Optionalprops: Record<string, unknown>

    要设置的属性键值对

  Returns this

  当前实例，支持链式调用

signal

• signal(key: string, params?: Record<string, any>): void

  向同场景的其他脚本发送信号

  Parameters

  • key: string

    信号类型标识符
  • Optionalparams: Record<string, any>

    可选的信号参数对象

  Returns void

  Remarks

  发送的信号可以在同场景其他脚本的 onSignal 方法中被监听到，用于脚本间通信。

  注意：

  • 必须在脚本销毁前发送信号，否则无法正确触发
  • 信号只能在同一场景内传递
  • key 不区分大小写

update

• update(delta: number): void

  执行脚本的更新逻辑

  Parameters

  • delta: number

    距离上一帧的时间间隔（毫秒）

  Returns void

  Remarks

  系统每帧调用一次，用于更新脚本状态。

  执行条件：

  • 脚本必须处于启用状态（enabled = true）
  • 脚本必须已经激活（awaked = true）
  • 如果是首次执行，会先触发 onAwake