脚本编辑器的扩展格式

脚本编辑器备有以下扩展格式。

脚本的说明格式

# --Description: 样本

通过进行上述编写后,将被视为脚本的说明文。
此处记载的字符串(上述示例中为 样本 )将被反映至脚本列表的说明栏和菜单项目。

此外,通过在--Description:的后面编写本地化符号,还可以根据所设置的工具显示语言,显示本地化后的说明。
支持以下本地化符号。

语言 本地化符号
日语 [ja]
英语 [en]
中文 [zh]

写入脚本时如下。

# --Description:[ja]日本語の説明
# --Description:[en]English explanation
# --Description:[zh]中文说明

用户变量格式

通过使用“用户变量”功能,无需在脚本编辑器上直接编写脚本,可通过 GUI 操作来指定对象、字符串或更改数值等。
# --BeginUserVariable, # --EndUserVariable 范围内定义的变量将视为“用户变量”。
此外,定义使用对象的用户变量时,需要导入未替换导入名称的 cri.atomcraft.project。

import cri.atomcraft.project
# --BeginUserVariable
"""
VARIABLE_STRING:
type: string
comment: 要搜索的Cue名称
VARIABLE_NUMBER:
type: number
comment: 音量
VARIABLE_OBJECT:
type: object
comment: 要操作的Cue Sheet
"""
VARIABLE_STRING = "test"
VARIABLE_NUMBER = 1.0
VARIABLE_OBJECT = None
# --EndUserVariable

为了用户变量画面上会显示所定义的用户变量,在用三重双引号"""括住的docstring中 记载变量名、种类和说明,然后设置变量的初始值。

种类有三种,根据变量的内容来更改要指定的种类。

类型的种类说明
object 变量为对象时指定
string 变量为字符串时指定
number 变量为数值时指定

保存并更新后,脚本编辑器右侧的GUI区域内会显示这些用户变量。
定义了用户变量的脚本在脚本列表中会附带图标。

criatom_tools_atomcraft_api_uservariable.png

更改用户变量

在编辑器右侧的GUI中更改值并按下[应用]按钮后,脚本中将会反映更改的内容。
要指定对象类型的变量时,可以通过从CRI Atom Craft树中拖放该对象来进行指定。
要解除指定对象类型的变量时,从右键菜单中选择“清除”。