83 lines
2.0 KiB
Markdown
83 lines
2.0 KiB
Markdown
|
## 1. 预置全局变量
|
|||
|
|
|
|||
|
|
### `_G`
|
|||
|
|
- 类型：class实例
|
|||
|
|
- 描述：程序启动时为空，生命周期为软件运行时间，可在不同指令中访问
|
|||
|
|
- 包含方法：
|
|||
|
|
- `get(name: str) -> any`
|
|||
|
|
- `set(name: str, value: any) -> None`
|
|||
|
|
|
|||
|
|
### `proInfo`
|
|||
|
|
- 类型：`dict`
|
|||
|
|
- 描述：包含当前活动工程的信息
|
|||
|
|
|
|||
|
|
### `targetList`
|
|||
|
|
- 类型：`list`
|
|||
|
|
- 描述：包含当前任务所有指令和子任务的列表
|
|||
|
|
|
|||
|
|
### `cur_targetId`
|
|||
|
|
- 类型：`str`
|
|||
|
|
- 描述：当前目标Id
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
## 2. 接口函数
|
|||
|
|
|
|||
|
|
### `finish()`
|
|||
|
|
- 参数：无
|
|||
|
|
- 返回值：无
|
|||
|
|
- 描述：调用此接口，指令运行结束。脚本中必须显式地调用此函数，否则任务将不会停止。
|
|||
|
|
|
|||
|
|
### `log_d(msg: str, color: str = 'blue')`
|
|||
|
|
- 参数：
|
|||
|
|
- `msg`: 日志内容
|
|||
|
|
- `color`: 日志颜色
|
|||
|
|
- 描述：输出DEBUG级别的日志到日志窗口。
|
|||
|
|
|
|||
|
|
### `log_i(msg: str, color: str = 'green')`
|
|||
|
|
- 参数：
|
|||
|
|
- `msg`: 日志内容
|
|||
|
|
- `color`: 日志颜色
|
|||
|
|
- 描述：输出INFO级别的日志到日志窗口。
|
|||
|
|
|
|||
|
|
### `log_w(msg: str, color: str = 'yellow')`
|
|||
|
|
- 参数：
|
|||
|
|
- `msg`: 日志内容
|
|||
|
|
- `color`: 日志颜色
|
|||
|
|
- 描述：输出WARNING级别的日志到日志窗口。
|
|||
|
|
|
|||
|
|
### `log_e(msg: str, color: str = 'red')`
|
|||
|
|
- 参数：
|
|||
|
|
- `msg`: 日志内容
|
|||
|
|
- `color`: 日志颜色
|
|||
|
|
- 描述：输出ERROR级别的日志到日志窗口。
|
|||
|
|
|
|||
|
|
|
|||
|
|
## 3. 回调函数
|
|||
|
|
|
|||
|
|
### `next()`
|
|||
|
|
- 参数：无
|
|||
|
|
- 返回值：无
|
|||
|
|
- 描述：控制currentIndex自增。
|
|||
|
|
|
|||
|
|
### `start()`
|
|||
|
|
- 参数：无
|
|||
|
|
- 返回值：无
|
|||
|
|
- 描述：进入任务
|
|||
|
|
|
|||
|
|
### `callBack()`
|
|||
|
|
- 参数：
|
|||
|
|
- completed_state
|
|||
|
|
- 描述
|
|||
|
|
- 判断currentIndex==loop后调finishi()退出循环
|
|||
|
|
- loop=0时,可定时退出循环
|
|||
|
|
- completed_state == 0: 进入任务
|
|||
|
|
- completed_state == 1：执行任务
|
|||
|
|
- completed_state == 2：执行指令
|
|||
|
|
- completed_state == 3： 等待指令锁解除
|
|||
|
|
- completed_state == 4： 指令循环
|
|||
|
|
- completed_state == 5： 执行子任务
|
|||
|
|
- completed_state == 6： 子任务执行完毕
|
|||
|
|
|
|||
|
|
|