自定义定义脚本符号
通过 Editor UI、脚本或使用资源文件创建自己的自定义脚本符号。
阅读时间7 分钟最后更新于 6 天前
除了 Unity 的内置脚本符号之外,还可以定义自己的自定义脚本符号。自定义定义脚本符号的定义位置决定了其Apply作用域。您可以在以下位置定义自定义定义符号:
- 资源文件,适用于 Project 中的所有 Editor 和 Player 代码的符号,无论 Active 版本配置文件如何。
- Player Settings,适用于给定平台或其版本配置文件之一处于活动状态时所有 Editor 和 Player 代码的符号。
- 生成配置文件,适用于在给定生成配置文件处于活动状态时适用于所有 Editor 和 Player 代码的符号。
- 从代码中,适用于 Apply for the Active Platform 或 individual Player build 的符号,具体取决于使用的 API。
整个Project的自定义定义符号
您可以使用响应文件资源定义适用于整个项目的自定义脚本符号,如下所示:
- 为文件命名并将其放在 Project 的 Assets Folder 根目录中。
csc.rsp - ON 定义以 开头的行,后跟一个或多个以分号分隔的脚本符号。
-define:
Unity 在启动时读取此文件,并在编译Any代码之前应用该文件。例如,如果在文件中包含单一线,符号 和 将作为项目中 All C# 脚本的全局定义脚本符号包含在内。
csc.rsp-define:UNITY_DEBUG;UNITY_TESTUNITY_DEBUGUNITY_TEST平台的自定义定义符号
您可以定义指定的于平台的自定义义脚本符号,如下所示:
- 打开 Player 设置。
- 导航到 Other Settings > 脚本编译部分中的 Scripting Define Symbols 列表。
- 通过选择 + 按钮并在 Text Field 中输入符号的名称,向列表添加新的脚本符号。使用 - 按钮移除现有列表项。
- 当您完成列表编辑后,选择 Apply 以应用您的更改。Unity 使用新建符号重新编译Project中的脚本。
版本配置配置文件的自定义定义符号
您可以为版本配置配置文件定义自定义定义脚本符号,如下所示:
- 在 Build Profiles 窗口中选择要为其定义符号的生成配置文件。
- 导航到生成数据部分中的 Scripting Defines 列表。
- 通过选择 + 按钮并在 Text Field 中输入符号的名称,向列表添加新的脚本符号。使用 - 按钮移除现有列表项。对列表的修改会自动Save和Apply。
从代码定义的自定义定义符号
您可以使用以下 API 来定义脚本符号:
PlayerSettings.SetScriptingDefineSymbolsBuildPlayerOptions.extraScriptingDefinesBuild.Player.ScriptCompilationSettings-extraScriptingDefines
BuildPlayerOptions.extraScriptingDefinesBuild.Player.ScriptCompilationSettings-extraScriptDefinesPlayerSettings.SetScriptingDefineSymbols批次模式下的自定义定义符号
When Editor 以批次处理模式运行时,没有触发器脚本重新编译的机制。如果需要在以批次模式运行的 Editor 中定义指定的符号,则必须从使用 csc.rsp 资源文件启动时就已就位。
脚本符号继承
如果在多个位置定义自定义脚本符号,Unity 会将所有 Apply 用于当前版本配置的符号相加。符号继承自每个作用域,而不是覆盖,如下所示:Project-Wide 符号(来自 )+平台指定的符号(来自 Player Settings)+版本配置文件符号(来自版本数据)。仅当平台和生成配置文件符号与 Active 生成配置文件 Match 匹配时才包含这些符号。
csc.rsp例如,假设Project在以下位置定义了以下自定义定义脚本符号:
位置 | 定义的符号 |
|---|---|
| |
| Windows Player Settings | |
| WindowsBuildProfile1 | |
| WindowsBuildProfile2 | |
根据此示例配置,表显示了WhenActive不同版本配置文件时,Editor器和Player器代码Active的符号:
Active 版本配置文件 | Active 符号 |
|---|---|
| Android | |
| Windows | |
| WindowsBuildProfile1 | |
| WindowsBuildProfile2 | |
您可以使用代码中的 指令测试此行为。有关更多信息,请参阅测试条件编译。
#if