必须通过官方手册结构化目录查触动精灵API,按模块分层、含版本兼容性、参数表、返回值和可运行示例;入口为https://www.touchsprite.com/doc→「开发文档」→「函数速查」;企业版函数需切换分支;离线文档可通过客户端或下载ZIP包获取;实操需四步验证函数可用性。

要查触动精灵函数库和API接口开发文档,必须进入官方手册的结构化目录体系,不能只靠网页搜索或第三方整理。官方文档按模块分层,每个函数都带引擎版本兼容性、参数表、返回值说明和真实可运行的用例代码。
打开官方开发手册主入口
在浏览器中访问 https://www.touchsprite.com/doc → 点击顶部导航栏「开发文档」→ 进入「触动精灵脚本开发手册」首页。
这个页面不是罗列函数的汇总页,而是按逻辑分类的树状结构:前言 → 学习前的准备 → 基础扩展库 → 高级扩展库 → Lua 编程 → 函数速查。跳过「前言」和「学习前的准备」,直接点开「函数速查」最高效。
精准定位函数所在模块
函数不是平铺在一页里,而是严格归属到不同模块下。比如:
— 【widget.find】 在「图色类及屏幕相关」子目录里;
— 【dialog】 在「UI交互类」目录下;
— 【runApp】 归属于「应用控制类」;
— 所有以 ts. 或 TS 开头的函数(如 TSVersions、TSNETVersion)都在「TSLib 基础扩展库」或「高级扩展库」章节中。
找不到函数?先确认它是否属于企业版专用——例如 plugin_api_call 和 VariableMonitor 仅出现在「触动企业版」文档分支,普通版手册里不显示。
查看函数详情页的三要素
点击任一函数名进入详情页后,必须核对以下三项内容:
① 参数表格:检查「必填」列是否为「是」,类型是否匹配(如 dialog 的 timeout 是 number 类型,传字符串会静默失败);
② 函数用例:复制粘贴示例代码到脚本中测试,注意注释里的限制条件(如「Android 系统在部分设备上需要开启悬浮窗权限」);
③ 注意事项区块:这里写着不可逆风险,例如 clearAllPhotos 会永久删除相册所有照片,os.remove 删除文件无回收站。
离线查阅本地文档包
方法一:安装触动精灵旗舰版客户端 → 启动后点击右上角「帮助」→「打开本地开发文档」,自动调用内置 HTML 文档;
方法二:手动下载离线包 → 访问官网「下载中心」→ 找到「触动精灵开发文档(离线版)」→ 下载 ZIP 包 → 解压后用浏览器打开 index.html。
离线包含全部版本更新日志,比如 v1.2.1 版本修复了 isColor 函数在 100 精度下无法识别的问题,这种细节在线文档可能被折叠,但离线包的「更新日志」章节里逐条列出。
验证函数是否可用的实操步骤
第一步:在脚本开头加入初始化检测语句:assert(init(), "init 失败,请检查引擎版本");
第二步:加载扩展库并断言存在:
ts_enterprise_lib = require("ts_enterprise_lib")<br>assert(ts_enterprise_lib, "企业库未加载成功");
第三步:调用目标函数前,先用 glSettings 查看当前全局属性是否启用对应功能(如 dialog 需要 glSettings["showDialog"] == true);
第四步:执行函数后立即检查返回值,runApp 返回非 0 表示启动失败,plugin_api_call 返回 ok == false 时必须读取 msg 字段定位错误原因。


















