创建脚本

    • 资源管理器 中选中想要放置组件脚本的文件夹,然后右键点击并选择 TypeScript 即可。
    • 直接点击 资源管理器 左上角的 + 按钮,然后选择 TypeScript 即可。

    在创建脚本时,名称不能为空,默认为 。我们将创建的组件脚本命名为 say-hello,可以看到在 资源管理器 中生成了一个名为 say-hello 的脚本文件:

    ts

    一份基础的组件脚本如下:

    创建脚本时,其初始文件名会处理为它的 className, 在项目中不允许重复。需要注意的是,重命名创建后的脚本文件,不会自动同步更新 className,详情请参考下文 脚本重命名 部分的内容。

    开发者可根据自己的需求,选择自己喜爱的文本工具(如:Vim、Sublime Text、Web Storm、VSCode 等)进行脚本编辑,请在编辑器菜单栏 偏好设置外部程序 中设置脚本编辑器。

    然后双击脚本资源,可以直接打开脚本编辑器进行编辑。编辑完脚本并保存,然后返回编辑器,Cocos Creator 会自动检测到脚本的改动,并迅速编译。

    将脚本添加到场景节点中,实际上就是为这个节点添加一个脚本组件。在 层级管理器 中选中希望添加脚本的场景节点,此时该节点的属性会显示在 属性检查器 中,添加脚本组件包括以下两种方式:

    1. 点击 属性检查器 最下方的 添加组件 按钮,然后选择 自定义脚本 -> SayHello 来添加我们刚刚编写的脚本组件,或者也可以直接搜索 SayHello 来添加。

    脚本组件的组件名是以脚本中定义的类名为准的,而不是脚本文件名。脚本的类名会与创建脚本时的脚本文件名保持一致,但之后如果有修改了脚本文件名/脚本类名,这两者之间并不会自动同步,如果需要的话,可以手动同步。

    以上文中的 say-hello.ts 为例,若我们在 资源管理器 中将其重命名为 hello,可以看到 属性检查器 中的脚本组件名还是原来的 SayHello,只有脚本名称变成了 :

    change-script name

    保存脚本后返回编辑器,可以看到 属性检查器 中的脚本组件名变成了 Hello,但是脚本文件名还是原来的 say-hello

    从 v3.3 开始,Creator 支持在项目中自定义脚本模板。操作步骤如下:

    1. 在项目目录下新建 .creator/asset-template/typescript 目录,并在 目录下添加包含了自定义脚本模板内容的文本文件,该文件可以是任意格式或者不带格式的文件。

      custom component file

      自定义脚本模板的内容可参考上文中的基础组件脚本,其中包含了默认给定的几个预设参数,用于满足部分项目管理的需求:

    2. 然后回到编辑器,可以看到在 资源管理器 创建资源菜单的 TypeScript 下出现了二级菜单,其中包含了原先编辑器自带的组件脚本模板(NewComponent),以及在上个步骤中添加的三个自定义脚本模板:

      add-custom-comp