偏好设置

偏好设置 面板中提供了编辑器的个性化设置，点击编辑器主菜单栏中的 Cocos Creator -> 偏好设置 即可打开。

偏好设置 由几个不同的分页组成，包括 通用设置、外部程序、设备管理器、引擎管理器、资源数据库、控制台、属性检查器、预览、构建发布 和 实验室。修改设置之后 偏好设置 面板会自动保存修改。

通用设置

general

通用设置 分页主要是针对编辑器相关的一些基础信息进行配置，包括：

  • 编辑器语言：可以选择中文或英文，修改语言设置后编辑器会自动切换语言，若有点地方没有切换，可刷新一下编辑器。

  • 选择本机预览 IP 地址：用户可以在本机有多个 IP 地址的情况下，手动选择其中之一作为预览时的默认地址和二维码地址。这里会列出所有本机的 IP，编辑器默认自动挑选一个 IP。

  • 预览服务器端口号：修改编辑器预览游戏时使用的端口号，修改完成后需要重启编辑器才能生效。

  • 数值默认步长：用于设置 属性检查器 中通过步进按钮调整数值属性时的步长幅度。默认步长为 0.001。属性检查器 中的步进按钮包括以下两种：

    • 当鼠标移动到数值属性输入框的右边时，会出现一组上下箭头，可以按照一定的步进幅度连续增加或减小数值。

      step button

    • 当鼠标悬浮在数值属性的名称附近时，光标会变成 mouse cursor 这样的形状，然后左右拖动鼠标，也可以按照一定的步进幅度连续增加或减小数值。

  • 配色主题：设置编辑器的显示颜色，目前包括 creator 和 dark 两种。

外部程序

外部程序 分页用于设置构建发布到原生平台时所需的开发环境，以及配置一些第三方程序。当鼠标移动到具体的配置项时，左侧会显示一个灰色的圆形问号图标，点击该图标可设置将配置项应用于当前项目中或者应用于全局所有项目中。当设置为应用于当前项目时，灰色的图标会变成黄色。

external-program

  • WeChat 开发者工具：配置微信小游戏开发者工具，详情请参考 发布到微信小游戏。

  • Android NDK：设置 Android NDK 路径，详情请参考 安装配置原生开发环境。

  • Android SDK：设置 Android SDK 路径，详情请参考 安装配置原生开发环境。

  • 鸿蒙 OS SDK：设置 HarmonyOS SDK 路径，详情请参考 发布 Huawei HarmonyOS 应用。

  • 鸿蒙 OS NDK 路径：设置 HarmonyOS NDK 路径，详情请参考 发布 Huawei HarmonyOS 应用。

  • 默认脚本编辑器：可以选用任意外部文本编辑工具（例如 VS Code）的可执行文件，作为在 资源管理器 中双击脚本文件时的打开方式。可以点击输入框后面的 搜索图标 按钮选择偏好的文本编辑器的可执行文件。文件夹图标则用于打开已设置完成的文本编辑器的所在路径。

  • 默认浏览器：用于选择编辑器预览时使用的浏览器，可点击输入框后面的 搜索图标 按钮指定一个浏览器的路径。

设备管理器

设备管理器 分页用于管理使用模拟器或者浏览器预览时的设备分辨率，支持在面板右侧手动添加/修改/删除自定义的设备分辨率。编辑器默认的设备分辨率不支持修改/删除。

device-manager

引擎管理器

引擎管理器 分页用于自定义引擎时配置引擎路径。

engine-manager

  • 使用内置 TypeScript 引擎：是否使用 Cocos Creator 安装路径下自带的 engine 路径作为 TypeScript 引擎路径。这个引擎用于编辑器里场景的渲染、内置组件的声明（也就是使用代码编辑器，如 VSCode 时的智能提示），以及场景在 Web 环境下的预览。

  • 自定义 TypeScript 引擎路径：除了使用自带的 engine，也可以前往 engine 仓库（GitHub | Gitee）克隆或 fork 一份引擎到本地的任意位置进行定制，然后取消勾选 使用内置 TypeScript 引擎，并将 自定义 TypeScript 引擎路径 指定为定制好的引擎路径，就可以在编辑器中使用这份定制后的引擎了。

  • 使用内置原生引擎：是否使用 Cocos Creator 安装路径下自带的 cocos2d-x 路径作为原生引擎路径。这个引擎用于构建发布时所有原生平台（iOS、 Android、Mac、Windows）的工程构建和编译。

  • 自定义原生引擎路径：取消上一项 使用内置原生引擎 的选择后，就可以手动指定原生引擎路径了。注意这里使用的原生引擎必须从 engine-native（GitHub | Gitee）或该仓库的 fork 下载。

关于自定义引擎，具体内容可参考 引擎定制工作流程

资源数据库

资源数据库 分页用于设置 资源管理器 面板中的资源数据库的相关信息，包括 日志等级、忽略文件 和 默认 Meta。

asset-db

  • 日志等级：用于设置 资源管理器 中的资源数据库输出到 控制台 的信息类型。目前包括 仅输出错误、仅输出错误和警告、输出错误、警告以及日志 和 输出所有信息 四种。
  • 忽略文件（正则）：使用正则表达式，填入具体资源文件的路径，则该资源将会被忽略。
  • 默认 Meta：用于设置项目内资源导入时的默认配置。详情参考下文介绍。

默认 meta

该项用于设置项目内资源导入时的默认配置。例如希望导入的图片默认为 sprite-frame 类型，那么便可以点击该项右侧的 编辑 按钮，然后在打开的 json 文件中填入以下内容：

  1. {
  2.     // image 表示资源的类型为图片
  3.     "image": {
  4.         "type": "sprite-frame"
  5.     }
  6. }

编辑完成并保存后，返回编辑器，点击 应用 按钮即可生效。

资源类型为 key，value 需要是一个 object，这个 object 就是最终导入资源时使用的默认配置。
例如上方示例代码中的 key 为 image，value 是 image 中配置的内容，点击 应用 后便会刷新资源数据库的配置信息，将 image 中的内容一一对应配置到资源 meta 文件的 userData 字段中。例如 image.type 设置为 sprite-frame，导入图片资源时，默认的 userData.type 就会被设置为 sprite-frame。便可以根据项目情况，动态地设置各种资源的默认导入配置。

如果想要知道资源类型，可以在 资源管理器 中右键点击资源，选择 在资源管理器中显示，然后在打开的文件夹中找到资源对应的 meta 文件并打开，importer 字段标记的便是资源的类型。

例如材质资源的 meta 文件如下，importer 字段中的 material 便是资源类型。

  1. {
  2.   "ver": "1.0.9",
  3.   "importer": "material",
  4.   "imported": true,
  5.   "uuid": "482a5162-dad9-446c-b548-8486c7598ee1",
  6.   "files": [
  7.     ".json"
  8.   ],
  9.   "subMetas": {},
  10.   "userData": {}
  11. }

控制台

控制台 分页用于设置 控制台 面板输出的日志，包括 显示日期 和 文字大小。

console

  • 显示日期：是否在 控制台 面板输出的日志前面显示日期。
  • 文字大小：用于设置 控制台 面板输出的日志文字大小。

属性检查器

属性检查器 分页中的 离开编辑自动保存 功能用于设置 属性检查器 面板是否在属性编辑完成后自动保存修改。

inspector

预览

预览 分页主要用于在使用编辑器正上方的 预览 按钮时，可以设置的各种选项，但只对当前项目有效。

preview

  • 保存场景自动刷新预览：若勾选该项，则在编辑器中保存场景时，会自动刷新已经打开的预览页面，目前暂时不支持使用模拟器预览。
  • 模拟器自动清除缓存：若勾选该项，则使用模拟器预览时会自动清除缓存。
  • 模拟器是否开启调试面板：若勾选该项，则使用模拟器预览项目时将自动打开调试窗口。
  • 模拟器是否等待调试面板开启：该项会在勾选了 模拟器是否开启调试面板 后生效，作用是暂停模拟器启动过程直至调试器连接完成，用于调试加载过程。

构建发布

构建发布 分页用于设置执行 构建发布 时相关的信息，包括 日志等级 和 缓存资源的序列化 JSON。

build

  • 日志等级：用于设置在构建发布到某个平台时，输出到 控制台 的信息类型。目前包括 仅输出错误、仅输出错误和警告、输出错误、警告以及日志 和 输出所有信息 四种。

  • 缓存资源的序列化 JSON：为了加快构建速度，减少重复反序列化未修改资源，在资源构建过程中将会缓存资源的序列化 JSON，这部分 JSON 会放置在项目的 temp/asset-db/assets/uuid/build 目录下，根据 debug 和 release 模式分为 debug.json 和 release.json 存放。

    build

    当存在缓存资源时构建将会直接取用，这部分缓存资源会在每次资源导入后重新更新，基本不需要关心。该选项默认勾选，但如果遇到了某些特殊需求，希望构建时不存储这部分序列化构建缓存资源，取消勾选该项即可。

实验室

实验室 分页中会不定期提供一些新的技术方案或实验性质的功能，可以通过开关选项来选择是否使用，大部分情况下默认开启。

laboratory

  • 场景即时缓存：该项默认开启，主要用于在场景编辑过程中每隔一段时间（目前时间间隔为 5s）便将场景文件缓存到项目目录下的 temp/scene/[SCENE_UUID]/[TIME].json 文件中。如遇突发情况比如场景崩溃、进程卡死等，再次打开编辑器时将会弹窗提示是否应用缓存内最近一次的场景文件。

    注意：在日常使用中，只要场景正常打开了，那么当前场景在打开之前缓存的所有场景文件都会被清空。如有特殊需求需要查看指定场景的缓存文件，请先在编辑器中关闭对应场景。

  • 开启烘焙功能：用于开启烘焙功能，详情可参考 光照贴图。

注意事项

在未来的版本中，实验室 中的这些功能可能被合并，但也有可能出现破坏兼容性的修改，甚至可能会被取消。如果想在开发环境中使用这些功能，请务必严格测试，并保持关注新版本的更新公告。

我们欢迎用户开启试用这些功能，并且在 论坛 提供宝贵的反馈意见，让这些功能更适合自己的使用场景，为项目提供更强大的助力。

扩展偏好设置面板

Creator 支持在 偏好设置 右侧添加自定义功能页，详情请参考 扩展偏好设置。