脚本函数

脚本控制

16 个函数

标记为入口

UI.markEntry()

将当前正在执行的事件标记为程序入口:关闭已显示界面并显示停止悬浮球;当前源文件结束后恢复普通悬浮球。

参数无参数
返回值无返回值

销毁程序

UI.destroyProgram()

销毁当前 UI 程序实例:关闭运行界面和悬浮球,停止现有脚本,执行窗口销毁事件后释放界面服务;不会退出当前应用。

参数无参数
返回值无返回值

隐藏停止按钮

FloatWindow.removeStopButton(): integer

隐藏运行状态下的停止悬浮球。

参数无参数
返回值返回值可以不接收
序号名称类型返回说明
1 status 执行状态
  • 1:成功
  • -2:失败
  • -3:当前没有运行中的停止悬浮球

显示停止按钮

FloatWindow.addStopButton(): integer

显示运行状态下的停止悬浮球。

参数无参数
返回值返回值可以不接收
序号名称类型返回说明
1 status 执行状态
  • 1:成功
  • -2:失败
  • -3:当前没有运行中的停止悬浮球

设置运行悬浮球位置

UI.setFloatBallPosition(x: integer, y: integer)

设置并保存运行悬浮球的屏幕像素位置;窗口显示期间只保存位置,窗口关闭后生效。

参数2 项
序号名称类型参数说明
1 x 悬浮球左上角 X 坐标,单位像素
2 y 悬浮球左上角 Y 坐标,单位像素
返回值无返回值

显示主界面

UI.showMain(blockOutside: integer)

显示当前已加载的主界面;参数填 0 可点击布局外关闭,填 1 禁止点击布局外关闭;省略时默认允许。主界面显示时运行悬浮球自动隐藏。

参数1 项
序号名称类型参数说明
1 blockOutside 点击布局外的处理方式:0 关闭主界面,1 不关闭。
返回值无返回值

关闭主界面

UI.closeMain()

关闭当前主界面但保留页面状态;没有其他布局窗口时恢复运行悬浮球。

参数无参数
返回值无返回值

暂停任务

Script.pause(任务类型: string, 任务ID: integer): integer

暂停主入口、指定线程、指定定时器,或调用任务之外的全部任务;保留Lua变量和执行位置,正在处理的native函数结束后再暂停。

参数2 项
序号名称类型参数说明
1 任务类型 main暂停主入口,thread暂停线程,timer暂停定时器,all暂停调用任务之外的全部任务
2 任务ID main或all填0;thread或timer填各自的1-99,线程和定时器可以使用相同ID
返回值返回值可以不接收
序号名称类型返回说明
1 任务数量 找到并提交暂停请求的任务数量。
  • 大于0:暂停请求已提交;如果目标是调用任务,会在恢复后返回
  • 0:目标任务不存在

继续任务

Script.resume(任务类型: string, 任务ID: integer): integer

继续主入口、指定线程、指定定时器或全部暂停任务;必须由仍在运行的任务调用。

参数2 项
序号名称类型参数说明
1 任务类型 main继续主入口,thread继续线程,timer继续定时器,all继续全部暂停任务
2 任务ID main或all填0;thread或timer填各自的1-99,线程和定时器可以使用相同ID
返回值返回值可以不接收
序号名称类型返回说明
1 恢复数量 实际恢复的任务数量。
  • 大于0:已恢复对应数量的暂停任务
  • 0:目标不存在或目标没有暂停

重新执行入口

Script.restart()

停止并清理当前运行的线程、定时器和触摸,再按原运行设置从入口源文件第一行重新执行;调用后不再执行当前下一行。

参数无参数
返回值无返回值

开启日志输出

Script.enableLog()

开启本次运行后续的 Log 和 print 输出;调试启动、UI启动和打包运行均可使用,日志写入现有控制台及日志文件。

参数无参数
返回值无返回值

关闭日志输出

Script.disableLog()

关闭本次运行后续的 Log 和 print 输出,已经写入的日志不会删除。

参数无参数
返回值无返回值

添加运行提示

Script.addRuntimePrompt()

恢复本次脚本运行中的普通提示发送;适合在函数或插件调用完成后恢复提示()。

参数无参数
返回值无返回值

移除运行提示

Script.removeRuntimePrompt()

立即移除当前普通提示并暂停后续提示发送;适合在函数或插件调用前关闭,只有调用添加运行提示后提示()才会重新显示,错误提示不受影响。

参数无参数
返回值无返回值

弹出对话框

UI.showDialogWait(layoutName: string, blockOutside: integer)

加载指定布局并等待关闭;第二个参数填 0 可点击布局外关闭,填 1 禁止点击布局外关闭;返回键始终可以关闭。

参数2 项
序号名称类型参数说明
1 layoutName 要显示的布局名称。示例:主页面
2 blockOutside 点击布局外的处理方式:0 关闭对话框,1 不关闭。
返回值无返回值

关闭对话框

UI.closeDialog()

关闭 UI.showDialogWait 创建的布局对话框,不关闭主界面。

参数无参数
返回值无返回值