类 Script

En

The Script class is used to create the parent class of a script, which is an abstract class and does not allow instances.

Zh

Script 类用于创建脚本的父类，该类为抽象类，不允许实例。

Blueprint Inheritable

层级 (查看完整内容)

构造函数

constructor

属性

_extra _id _singleton owner runInEditor scriptPath

访问器

awaked destroyed enabled hideFlags id

方法

destroy hasHideFlag onAdded onAwake onCollisionEnter? onCollisionExit? onCollisionStay? onDestroy onDisable onEnable onJointBreak? onKeyDown? onKeyPress? onKeyUp? onLateUpdate? onMouseClick? onMouseDoubleClick? onMouseDown? onMouseDrag? onMouseDragEnd? onMouseMove? onMouseOut? onMouseOver? onMouseRightClick? onMouseUp? onPostRender? onPreRender? onReset? onRightMouseDown? onRightMouseUp? onStart? onTriggerEnter? onTriggerExit? onTriggerStay? onUpdate?

构造函数

constructor

属性

_extra

_extra: IComponentExtra

En

Extra data of the node.

Zh

组件的额外数据。IDE内部使用。

Blueprint Ignore

_id

_id: number

En

Unique identifier for the component.

Zh

组件的唯一标识。

_singleton

_singleton: boolean

En

Whether the component is a singleton, meaning only one instance of this type of script can be added to the same node.

Zh

是否为单例，即同一个节点只能添加此类型的脚本一次。

只读owner

owner: Sprite | Sprite3D

En

Script belonging to sprite

Zh

脚本所属精灵

runInEditor

runInEditor: boolean

En

Whether the script can run in the IDE environment.

Zh

是否可以在 IDE 环境中运行。

Blueprint Ignore

scriptPath

scriptPath: string

En

The path of the script file.

Zh

脚本文件的路径。

Blueprint Ignore

访问器

awaked

destroyed

enabled

hideFlags

id

方法

destroy

hasHideFlag

onAdded

  • onAdded(): void

  • 返回 void

    En

    Called after the component is added to a node. Unlike Awake, onAdded is called even if the node is not active.

    Zh

    组件被添加到节点后调用，与 onAwake 不同的是，即使节点未激活也会调用 onAdded。

    Blueprint Event

onAwake

  • onAwake(): void

  • 返回 void

    En

    Executed after the component is activated. At this point, all nodes and components have been created. This method is executed only once.

    Zh

    组件被激活后执行，此时所有节点和组件均已创建完毕，此方法只执行一次。

    Blueprint Event

可选onCollisionEnter

  • onCollisionEnter(collision): void

  • 参数

    返回 void

    En

    Called when a 3D physics collider event begins (not applicable to 2D).

    Zh

    3D物理碰撞器事件开始时调用（不适用于2D）。

    Blueprint Event

可选onCollisionExit

  • onCollisionExit(collision): void

  • 参数

    返回 void

    En

    Called when a 3D physics collider event ends (not applicable to 2D).

    Zh

    3D物理碰撞器事件结束碰撞时调用（不适用于2D）。

    Blueprint Event

可选onCollisionStay

  • onCollisionStay(collision): void

  • 参数

    返回 void

    En

    Called during the frame a 3D physics collider event stays collided (not applicable to 2D).

    Zh

    3D物理碰撞器事件持续碰撞时调用（不适用于2D）。

    Blueprint Event

onDestroy

onDisable

onEnable

可选onJointBreak

可选onKeyDown

可选onKeyPress

  • onKeyPress(evt): void

  • 参数

    • evt: Event

      The keyboard event.

    返回 void

    En

    Called when a key is pressed and holds long enough to generate a character.

    Zh

    键盘产生一个字符时执行。

    Blueprint Event

可选onKeyUp

可选onLateUpdate

可选onMouseClick

  • onMouseClick(evt): void

  • 参数

    • evt: Event

      The mouse event.

    返回 void

    En

    Called when the mouse button is clicked (pressed and released) on the node.

    Zh

    鼠标点击时执行。

    Blueprint Event

可选onMouseDoubleClick

可选onMouseDown

可选onMouseDrag

  • onMouseDrag(evt): void

  • 参数

    • evt: Event

      The mouse event.

    返回 void

    En

    Called when the mouse is held down and an object is dragged.

    Zh

    鼠标按住一个物体后，拖拽时执行。

    Blueprint Event

可选onMouseDragEnd

  • onMouseDragEnd(evt): void

  • 参数

    • evt: Event

      The mouse event.

    返回 void

    En

    Called when the mouse button is released after dragging an object.

    Zh

    鼠标按住一个物体，拖拽一定距离，释放鼠标按键后执行。

    Blueprint Event

可选onMouseMove

可选onMouseOut

可选onMouseOver

可选onMouseRightClick

  • onMouseRightClick(evt): void

  • 参数

    • evt: Event

      The mouse event.

    返回 void

    En

    Called when the right mouse button is clicked on the node.

    Zh

    鼠标右键点击时执行。

    Blueprint Event

可选onMouseUp

可选onPostRender

可选onPreRender

可选onReset

  • onReset(): void

  • 返回 void

    En

    Resets the component's parameters to their default values. If this function is implemented, the component will be reset and automatically recycled for future use. If not reset, it will not be recycled for reuse.

    Zh

    将组件的参数重置为默认值。如果实现了这个函数，组件将被重置并自动回收到对象池，方便下次复用。 如果没有重置，则不会进行回收复用。

可选onRightMouseDown

  • onRightMouseDown(evt): void

  • 参数

    • evt: Event

      The mouse event.

    返回 void

    En

    Called when the right or middle mouse button is pressed down.

    Zh

    鼠标右键或中键按下时执行。

    Blueprint Event

可选onRightMouseUp

  • onRightMouseUp(evt): void

  • 参数

    • evt: Event

      The mouse event.

    返回 void

    En

    Called when the right or middle mouse button is released.

    Zh

    鼠标右键或中键抬起时执行。

    Blueprint Event

可选onStart

可选onTriggerEnter

  • onTriggerEnter(other, self?, contact?): void

  • 参数

    • other: PhysicsColliderComponent | ColliderBase

      The collider component or base of the other object in the collision.

    • 可选self: ColliderBase

      The collider component or base of the object itself.

    • 可选contact: any

      The contact point information.

    返回 void

    En

    Called when a 3D physics trigger event or a 2D physics collision event begins.

    Zh

    开始碰撞时执行的3D物理触发器事件或2D物理碰撞事件。

    Blueprint Event

可选onTriggerExit

  • onTriggerExit(other, self?, contact?): void

  • 参数

    • other: PhysicsColliderComponent | ColliderBase

      The collider component or base of the other object in the collision.

    • 可选self: ColliderBase

      The collider component or base of the object itself.

    • 可选contact: any

      The contact point information.

    返回 void

    En

    Called when a 3D physics trigger event or a 2D physics collision event ends.

    Zh

    结束碰撞时执行的3D物理触发器事件或2D物理碰撞事件。

    Blueprint Event

可选onTriggerStay

  • onTriggerStay(other, self?, contact?): void

  • 参数

    • other: PhysicsColliderComponent | ColliderBase

      The collider component or base of the other object in the collision.

    • 可选self: ColliderBase

      The collider component or base of the object itself, if not provided it's assumed to be the owner of the script.

    • 可选contact: any

      The contact point information, can be any type depending on the physics engine used.

    返回 void

    En

    Called during the frame a 3D physics trigger event or a 2D physics collision event stays collided.

    Zh

    持续碰撞时执行的3D物理触发器事件或2D物理碰撞事件。

    Blueprint Event

可选onUpdate

  • onUpdate(): void

  • 返回 void

    En

    Executed every frame during the update phase. Avoid writing complex loop logic or using the getComponent method here.

    Zh

    每帧更新时执行，在 update 阶段。尽量不要在这里写大循环逻辑或使用 getComponent 方法。

    Blueprint Event

显示设置

成员可见性

目录

构造函数
属性
访问器
方法