接口: ScriptEngine
接口: ScriptEngine
engines.ScriptEngine
脚本引擎对象,表示一次脚本或项目执行的引擎示例。可以通过引擎和跨脚本通信,获取引擎的状态,停止引擎运行等。
继承关系
-
ScriptEngine
目录
属性
方法
属性
executionConfig
• Readonly
executionConfig: ReadOnlyExecutionConfig
获取本次运行指定的运行配置。
id
• Readonly
id: number
引擎的唯一id,不同引擎的id必不相同。
source
• Readonly
source: any
引擎源文件的对象。
sourceFile
• Readonly
sourceFile: string
引擎的源文件路径。
workingDirectory
• Readonly
workingDirectory: string
引擎运行的所在目录。一般是项目的根目录或者脚本文件的父目录。
方法
emit
▸ emit(event
, ...args
): void
发送事件给引擎。对于nodejs引擎,可以用require("engines").myEngine().on("event_name", () => {})
来监听事件;对于pro8引擎,则可以用$events.on("event_name", () => {})
来监听事件。
参数
名称 | 类型 | 描述 |
---|---|---|
event |
string |
事件名称 |
...args |
any [] |
事件参数,必须是可以转换为JSON的数据 |
返回值
void
forceStop
▸ forceStop(): void
强制停止引擎运行。
返回值
void
getTag
▸ getTag(key
): any
Returns the tag associated with this engine and the specified key.
参数
名称 | 类型 |
---|---|
key |
string |
返回值
any