ScriptCommand

在脚本的 OnInit 方法中,可以调用 ScriptInitData.AddCommand 方法向 Opus 内部命令集添加命令。每次调用 AddCommand 都会返回一个 ScriptCommand 对象,脚本需要对其进行初始化。

属性名称返回类型描述

desc

字符串

使用此设置命令的描述,当用户从 Commands 标签页 中选择该命令时,会在 自定义 对话框中显示该描述。

fayt

返回一个 scriptfaytcommand 对象,可用于初始化此命令以 扩展即时查找字段

hide

布尔值

勾选 True,以在 命令编辑器 中显示的下拉命令列表中隐藏此命令。这样,你可以添加仍可在按钮和热键中使用的命令,但不会杂乱命令列表。

icon

字符串

使用此属性为此命令分配一个默认图标。你可以指定一个内部图标的名称(如果你想指定来自特定集合的图标,请使用 setname:iconname - 使用此方法,如果你将你的脚本打包在带自己图标集的 脚本包 中)或外部图标或图像文件的路径。

label

字符串

使用此设置命令的标签。这会显示在 自定义 对话框的 命令标签页(在 脚本命令 类别下),如果用户将该命令拖到工具栏上,它将形成创建的按钮的默认标签。

命令的实际名称(用于调用命令)通过 name 属性进行分配。

method

字符串

这是 Opus 在调用命令时将在脚本中调用的方法的名称。这通常被设置为 OnXXXXX,其中 XXXXX 是命令的名称,但是可以使用任何方法名称。

当调用该方法时,它会传递一个参数,即 ScriptCommandData 对象。一般而言,此方法称为 OnScriptCommand

name

字符串

这是命令的名称。这将确定在按钮和热键中使用命令时调用的名称。

noprogress

布尔值

如果你不希望你的命令在选择了多个文件时显示进度指示器,请将此设置为 false。

template

字符串

这允许你指定命令的可选命令行模板。这是一个格式为 ARGNAME1/MOD,ARGNAME2/MOD,ARGNAME3/MOD 等的字符串,其中 ARGNAME 是参数的名称,而 /MOD 是用于指示参数类型的 一个或多个修饰符。命令行模板可以指定任意需要的参数。

当调用你的命令并且触发其 OnScriptCommand 事件时,根据此模板解析命令行上提供的任何参数,并通过 ScriptCommandData.func.args 属性提供。

最后更新于