叉叉脚本开发手册

叉叉脚本

引擎版本：1.9.314

前言

  叉叉脚本使用 Lua 语言进行编写,支持Lua的所有语法与基本函数，配合叉叉脚本特有的函数命令,实现找图、找色、触摸等高级功能。
  编写脚本前请先学习 lua 的基本语法。
  Lua官方手册：http://www.lua.org/manual/5.1/
  Lua中文开发手册：http://book.luaer.cn/
  叉叉开发者平台：http://dev.xxzhushou.cn/
特别注意：

1.由于安全性方面的考虑，以下函数在叉叉脚本中不予以支持：
debub库所有函数、io.tmpfile、io.popen、os.execute、os.exit、os.remove、os.rename、os.tmpname
2.io.open的用法比较特殊，参数中不能填写具体路径，只能是文件名，比如：
io.open('aa.txt') 是正确的，io.open('../../../aa.txt')则运行会报错。
另外，io库支持公共文件夹，比如io.input('[public]xx.txt')，就会在[tengine]/public下读取xx.txt这个文件。

脚本文件格式支持说明：

• xsp0 文件包复制到移动设备对应开发助手脚本存放目录中，进入开发助手客户端“本地脚本”列表即可运行保存好的脚本
• xsp1 文件包复制到移动设备对应叉叉助手存放目录中，进入叉叉客户端“我的”tab启动应用，打开悬浮窗即可运行保存好的脚本

 *iOS可使用ifunbox等工具将脚本文件复制到设备

开发文件夹路径

本地脚本存放路径

• 开发助手
  Android：/sdcard/xsp/
  iOS(开发助手版本>= 1.0.10)：/var/mobile/Library/XXIDEHelper/xsp/
  iOS(开发助手版本<1.0.10)：/Library/ApplicationSupport/XXIDEHelper/xsp/

• 叉叉助手
  Android：/sdcard/com.xxAssistant/script/
  iOS(叉叉版本>=2.5.0): /var/mobile/Library/XXAssistant/Lua/LocalLuas/
  iOS(叉叉版本<2.5.0): /Library/ApplicationSupport/XXAssistant/Lua/LocalLuas/

• IPA精灵
  IPA精灵：应用文件夹/Documents/Lua/LocalLuas

公共文件夹路径

• 开发助手
  Android(引擎版本>=1.7.2)：/data/data/com.xxscript.idehelper/tengine/public
  Android(引擎版本<1.7.2)：/data/data/com.xxscript.idehelper/cache/tengine/public
  iOS(开发助手版本>=1.0.10)：/var/mobile/Library/XXIDEHelper/xsp/Temp/public
  iOS(开发助手版本<1.0.10) ：/Library/ApplicationSupport/XXIDEHelper/xsp/Temp/public

• 叉叉助手
  Android(引擎版本>=1.7.2)：/data/data/com.xxAssistant/tengine/public
  Android(引擎版本<1.7.2)：/data/data/com.xxAssistant/cache/tengine/public
  iOS(叉叉版本>=2.5.0): /var/mobile/Library/XXAssistant/Lua/Luas/Temp/public
  iOS(叉叉版本<2.5.0): /Library/ApplicationSupport/XXAssistant/Lua/Luas/Temp/public

• IPA精灵
  IPA精灵：应用文件夹/Documents/Lua/Luas/Temp/public

截图存放路径

• 开发助手
  Android(引擎版本>=1.7.2)：/data/data/com.xxscript.idehelper/tengine/public
  Android(引擎版本<1.7.2)：/data/data/com.xxscript.idehelper/cache/tengine/public
  iOS(开发助手版本>=1.0.10)：/var/mobile/Library/XXIDEHelper/xsp/Temp
  iOS(开发助手<1.0.10) ：/Library/ApplicationSupport/XXIDEHelper/xsp/Temp

• 叉叉助手
  Android(引擎版本>=1.7.2)：/data/data/com.xxAssistant/tengine/public
  Android(引擎版本<1.7.2)：/data/data/com.xxAssistant/cache/tengine/public
  iOS(叉叉版本>=2.5.0):/var/mobile/Library/XXAssistant/Lua/Luas/Temp
  iOS(叉叉版本<2.5.0):/Library/Application Support/XXAssistant/Lua/Luas/Temp

• IPA精灵
  IPA精灵：应用文件夹/Documents/Lua/Luas/Temp/

日志文件路径

• 开发助手
  Android：/sdcard/com.xxscript.idehelper/tengine/log/user/脚本名.log
  iOS：/tmp/user/脚本名.log

• 叉叉助手
  Android：/sdcard/com.xxAssistant/tengine/log/user/脚本id.log
  Android免Root：/sdcard/com.noroot/tengine/log/user/脚本id.log
  iOS:/tmp/user/脚本id.log

• 叉叉小精灵
  Android：/sdcard/小精灵包名/tengine/log/user/脚本id.log

• IPA精灵
  IPA精灵：应用文件夹/Document/Temp/脚本id.log
  IPA精灵（开发版）：应用文件夹/Document/Temp/脚本名.log

脚本开发实用技巧（持续更新）

戳这里：https://www.zybuluo.com/xxzhushou/note/726742

叉叉脚本定制版发布指引

戳这里：https://www.zybuluo.com/xxzhushou/note/755911

iOS免越狱接口说明：适配免越狱引擎必读

函数：init 初始化

函数功能：脚本使用触摸函数前必须调用，以指定应用程序以及坐标系
函数语法：
  init(appid, rotate)

参数说明：

返回值：无

脚本实例：

init("com.apple.Music", 0); --以应用 "com.apple.Music" 竖屏初始化
init("0", 1); --以当前应用 Home 键在右初始化

函数：touchDown 触摸按下

函数功能：发送触摸事件
函数语法：
  touchDown(index, x, y)

参数说明：

返回值：无

脚本实例：

• 点击和抬起

touchDown(1, 150, 150)  --ID为1的手指在坐标（150,150）处按下
mSleep(200) --延时200毫秒
touchUp(1, 150, 150)  --ID为1的手指抬起

• 封装点击函数

function tap(x, y)
    touchDown(0, x, y);
    mSleep(200);
    touchUp(0, x, y);
end
tap(100,100);   --调用：点击坐标为100,100的点

注意事项：

需要注意的是在使用 touchDown、touchUp 函数时，中间一定要插入一定的延时，建议大于 20毫秒，否则可能会出现点击无效等异常情况。

函数：touchMove 移动

函数功能：发送触摸事件
函数语法：
  touchMove(index, x, y)

参数说明：

返回值：无

脚本实例：

• 连续划动

touchDown(1, 150, 550); --在 (150, 550) 按下
for i = 0, 200, 10 do   --使用for循环连续滑动
    touchMove(1, 150 + i, 550); 
    mSleep(150);        --延迟
end
touchUp(1, 150 + 200, 550); --在 (350, 550) 抬起

• 多点触控

touchDown(1, 100, 100);             --ID为1的手指在 (100, 100) 按下
touchDown(2, 300, 500);             --ID为2的手指在 (300, 500) 按下
mSleep(50);
for i = 1, 100, 1 do                --使用 for 循环使两只手指向不同方向分离
    touchMove(1, 200 - i, 400 - i); 
    touchMove(2, 300 + i, 500 + i);
    mSleep(50);
end
touchUp(1, 200 - 100, 400 - 100);   
touchUp(2, 300 + 100, 500 + 100);   --分别抬起2只手指

注意事项：

需要注意的是在使用 touchDown、touchUp 函数时，中间一定要插入一定的延时，建议大于 20毫秒，否则可能会出现点击无效等异常情况。

函数：touchUp 触摸抬起

函数功能：发送触摸事件
函数语法：
  touchUp(index, x, y)

参数说明：

返回值：无

脚本实例：

• 连续划动

touchDown(1, 150, 550); --在 (150, 550) 按下
for i = 0, 200, 10 do   --使用for循环连续滑动
    touchMove(1, 150 + i, 550); 
    mSleep(150);        --延迟
end
touchUp(1, 150 + 200, 550); --在 (350, 550) 抬起

• 多点触控

touchDown(1, 100, 100);             --ID为1的手指在 (100, 100) 按下
touchDown(2, 300, 500);             --ID为2的手指在 (300, 500) 按下
mSleep(50);
for i = 1, 100, 1 do                --使用 for 循环使两只手指向不同方向分离
    touchMove(1, 200 - i, 400 - i); 
    touchMove(2, 300 + i, 500 + i);
    mSleep(50);
end
touchUp(1, 200 - 100, 400 - 100);   
touchUp(2, 300 + 100, 500 + 100);   --分别抬起2只手指

注意事项：

需要注意的是在使用 touchDown、touchUp 函数时，中间一定要插入一定的延时，建议大于 20毫秒，否则可能会出现点击无效等异常情况。

函数：catchTouchPoint 获取用户点击坐标

函数功能：调用该函数后，将等待用户完成一次或多次屏幕点击，并返回点击的坐标
函数语法：
  results = catchTouchPoint(touchCount)
  x,y = catchTouchPoint()

参数说明：

脚本实例：

• 获取单个点击坐标

dialog("请点击屏幕一次", 0);
x,y = catchTouchPoint();
mSleep(1000);
dialog("x:"..x.." y:"..y, 0);

• 获取多个点击坐标

local results = catchTouchPoint(3);
for i = 1, #results do
    sysLog("第"..i.."个坐标为:"..i..",x="..results[i].x..",y="..results[i].y);
end

注意事项：

1.此函数触发后将一直等待用户完成屏幕点击，并阻止脚本继续运行。
2.此函数获取到的坐标为竖屏坐标，横屏情况需要自行转换。
3.此函数有较小的延迟，连续点击时，请勿点击过快。

函数：findColor 区域多点找色（推荐使用）

函数功能：在指定区域，根据颜色以及其周边点的颜色，寻找符合条件的点的坐标，支持模糊查找
函数语法：
    x, y = findColor(
     {left, top, right, bottom},
     color0,
     degree,
     hdir,
     vdir,
     priority
    )
    
    x, y = findColor(
     {left, top, right, bottom},
     "x0|y0|color0,x1|y1|color1(|degree1),x2|y2|color2(-offset2),...",
     degree,
     hdir,
     vdir,
     priority
    )
    
    x, y = findColor(
     {left, top, right, bottom},
     {
      {x = x0, y = y0, color = color0},
      {x = x1, y = y1, color = color1, (degree = degree1)},
      {x = x2, y = y2, color = color2, (offset = offset2)},
      ...
     },
     degree,
     hdir,
     vdir,
     priority
    )

参数说明：

说明：
1.起始点坐标值填写0,0时，偏移位置坐标值使用相对坐标；填写为非0,0的坐标时，则认为偏移位置坐标为绝对坐标，找色时，将根据填写的绝对坐标换算出的相对坐标进行寻找。
2.偏移位置颜色的偏色值或精度可任意选用，同时填写了偏色值和精度时，将以偏色为准，忽略精度值。
3.个别偏移位置颜色偏色值或精度优先于全局找色精度，全局找色精度对未指定偏色或精度的颜色有效。

脚本实例：

• 精确寻找指定单色的坐标

x, y = findColor({50, 50, 300, 300},0x112233)
if x ~= -1 and y ~= -1 then  --如指定区域找到符合条件的某点
    touchDown(1, x, y);      --点击该点
    mSleep(50)
    touchUp(1, x, y);
else                         --如找不到符合条件的点
    dialog("没找到你要的坐标呢",0);
end

使用以上方法找色时，常常会因为屏幕上有大量符合指定颜色的点而不能找到需要的坐标。该函数通过在寻找到一个符合指定颜色color的坐标后，进一步确认其周边点坐标的方式，来确定准确目标。例如，现在我们在图像上找到了我们需要的一个按钮，这个按钮的样式是不变的，但是它的整体位置却会在整个屏幕上变化，现在我们想要在脚本运行时得到其坐标。

首先确定一个参照点：
颜色为 0x181F85，坐标为 (268, 802)，下表序号1。
记录下来，继续寻找周边的几个参照点，以及与第一个参照点的相对坐标，分别为下表序号2~4：

现在我们找到了需要的所有参照点：

应用上述坐标写成多点找色脚本（以下4种任选1种）：

• 相对坐标的写法：

x, y = findColor(
    {0, 0, 639, 959},
    "0|0|0x181F85,29|1|0x00BBFE|90,103|-4|0x0B6BBE-0x050505,65|9|0x150972")
x, y = findColor(
    {0, 0, 639, 959},
    {
      {x = 0, y = 0, color = 0x181F85},
      {x = 29, y = 1, color = 0x00BBFE, degree = 90},
      {x = 103, y = -4, color = 0x0B6BBE, offset = 0x050505},
      {x = 65, y = 9, color = 0x150972}
    })

• 绝对坐标的写法：

x, y = findColor(
    {0, 0, 639, 959},
    "268|802|0x181F85,297|803|0x00BBFE|90,371|798|0x0B6BBE-050505,333|811|0x150972")
x, y = findColor(
    {0, 0, 639, 959},
    {
      {x = 268, y = 802, color = 0x181F85},
      {x = 297, y = 803 color = 0x00BBFE, degree = 90},
      {x = 371, y = 798 color = 0x0B6BBE, offset = 0x050505},
      {x = 333, y = 811 color = 0x150972}
    })

新旧多点找色API对比：

findColorInRegionFuzzy = function(tcolor, degree, x1, y1, x2, y2, hdir, vdir)
  return findColor(
    {x1, y1, x2, y2},
    tcolor,
    degree,
    hdir or 0,
    vdir or 0
  )
end
findMultiColorInRegionFuzzy = function(tcolor, posandcolors, degree, x1, y1, x2, y2, hdir, vdir)
  posandcolors = string.format("0|0|0x%x,%s", tcolor, posandcolors)
  return findColor(
    {x1, y1, x2, y2},
    posandcolors,
    degree,
    hdir or 0,
    vdir or 0
  )
end
findMultiColorInRegionFuzzy2 = function(tcolor, posandcolors, degree, x1, y1, x2, y2, hdir, vdir)
  table.insert(posandcolors, 1, {x = 0, y = 0, color = tcolor})
  return findColor(
    {x1, y1, x2, y2},
    posandcolors,
    degree,
    hdir or 0,
    vdir or 0
  )
end

关于搜索方向：

注意事项：

1.未找到则返回 (-1, -1) ，所以找到时 x, y 均不等于 -1，~= 为不等于操作符，是 Lua 基本语法， 属于逻辑控制。
2.该代码应用过程中，建议使用"保持屏幕"优化找色速度。
3.颜色值的十六进制文本中，其顺序为RGB。
4.相对坐标为偏移位置坐标相对于第一个点的坐标，即用这个点的横坐标、纵坐标分别减去第一个点的横坐标、纵坐标，可以为负数。
5.使用此函数时精度参数设置过低或允许的偏色多大，会导致性能大幅下降。
6.支持引擎版本：1.8.30或更新

函数：findColors 高级区域多点找色（推荐使用）

函数功能：在指定区域，根据颜色以及其周边点的颜色，寻找所有符合条件的点的坐标，支持模糊查找
函数语法：
  point = findColors(
   {left, top, right, bottom},
   color0,
   degree,
   hdir,
   vdir,
   priority,
  )
  
  point = findColors(
   {left, top, right, bottom},
   "x0|y0|color0,x1|y1|color1(|degree1),x2|y2|color2(-offset2),...",
   degree,
   hdir,
   vdir,
   priority,
  )
  
  point = findColors(
   {left, top, right, bottom},
   {
   {x = x0, y = y0, color = color0},
   {x = x1, y = y1 color = color1, (degree = degree1)},
   {x = x2, y = y2 color = color2, (offset = offset2)},
   ...
   },
   degree,
   hdir,
   vdir,
   priority,
  )

参数说明：

说明：
1.起始点坐标值填写0,0时，偏移位置坐标值使用相对坐标；填写为非0,0的坐标时，则认为偏移位置坐标为绝对坐标，找色时，将根据填写的绝对坐标换算出的相对坐标进行寻找。
2.偏移位置颜色的偏色值或精度可任意选用，同时填写了偏色值和精度时，将以偏色为准，忽略精度值。
3.个别偏移位置颜色偏色值或精度优先于全局找色精度，全局找色精度对未指定偏色或精度的颜色有效。

返回的 table 为key-value的形式，如下：
point = {
 {x = 100,y = 110},
 {x = 200,y = 210},
 {x = 300,y = 310},
 ...
}

脚本实例：

point = findColors(
    {0, 0, 639, 959}, 
    0x181F85)
if #point ~= 0 then  --如果找到符合条件的点
    for var = 1, #point do
        sysLog(point[var].x..":"..point[var].y)
    end
end
point = findColors(
    {0, 0, 639, 959},
    "0|0|0x181F85,29|1|0x00BBFE|90,103|-4|0x0B6BBE-050505,65|9|0x150972")
if #point ~= 0 then  --如果找到符合条件的点
    for var = 1, #point do
        sysLog(point[var].x..":"..point[var].y)
    end
end

• 相对坐标的写法：

point = findColors(
    {0, 0, 639, 959},
    {
      {x = 0, y = 0, color = 0x181F85},
      {x = 29, y = 1, color = 0x00BBFE, degree = 90},
      {x = 103, y = -4, color = 0x0B6BBE, offset = 0x050505},
      {x = 65, y = 9, color = 0x150972}
    })

• 绝对坐标的写法：

point = findColors(
    {0, 0, 639, 959},
    "268|802|0x181F85,297|803|0x00BBFE|90,371|798|0x0B6BBE-050505,333|811|0x150972")
point = findColors(
    {0, 0, 639, 959},
    {
      {x = 268, y = 802, color = 0x181F85},
      {x = 297, y = 803, color = 0x00BBFE, degree = 90},
      {x = 371, y = 798, color = 0x0B6BBE, offset = 0x050505},
      {x = 333, y = 811, color = 0x150972}
    })

新旧高级多点区域找色API对比：

findMultiColorInRegionFuzzyExt = function(tcolor, posandcolors, degree, x1, y1, x2, y2, hdir, vdir)
  posandcolors = string.format("0|0|0x%x,%s", tcolor, posandcolors)
  return findColors(
    {x1, y1, x2, y2},
    posandcolors,
    degree,
    hdir or 0,
    vdir or 0
  )
end
findMultiColorInRegionFuzzyExt2 = function(tcolor, posandcolors, degree, x1, y1, x2, y2, hdir, vdir)
  table.insert(posandcolors, 1, {x = 0, y = 0, color = tcolor})
  return findColors(
    {x1, y1, x2, y2},
    posandcolors,
    degree,
    hdir or 0,
    vdir or 0
  )
end

注意事项：

1.高级区域多点找色函数目前最多支持返回99个。
2.支持引擎版本：1.8.30或更新

函数：findColorInRegionFuzzy 模糊区域找色（推荐使用findColor代替）

函数功能：在指定区域中，寻找符合指定颜色的坐标，模糊查找。（请使用findColor函数代替）
函数语法：
  x, y = findColorInRegionFuzzy(color, degree, x1, y1, x2, y2,hdir,vdir)

参数说明：

脚本实例：

• 精确寻找指定颜色的坐标

x, y = findColorInRegionFuzzy(0x112233, 100, 50, 50, 300, 300); 
if x ~= -1 and y ~= -1 then  --如指定区域找到符合条件的某点
    touchDown(1, x, y);      --点击该点
    mSleep(50)
    touchUp(1, x, y);
else                         --如找不到符合条件的点
    dialog("没找到你要的坐标呢",0);
end

• 模糊查找接近指定颜色的坐标

for deg = 100, 70, -1 do           --使用 for 循环不断降低精确度
    x, y = findColorInRegionFuzzy(0xffffff, deg, 50, 50, 300, 300); 
    if x ~= -1 and y ~= -1 then   --如指定区域找到符合条件的某点
        touchDown(1, x, y);       --点击该点
        mSleep(50)
        touchUp(1, x, y);
        break;                    --跳出循环
    end
end
dialog("噢天哪！还是没找到",0);

注意事项：

1.未找到则返回 (-1, -1) ，所以找到时 x, y 均不等于 -1，~= 为不等于操作符，是 Lua 基本语法， 属于逻辑控制。
2.该代码应用过程中，建议使用"保持屏幕"优化找色速度。

函数：findMultiColorInRegionFuzzy 区域多点找色（推荐使用findColor代替）

函数功能：在指定区域，根据颜色以及其周边点的颜色，寻找符合条件的点的坐标，支持模糊查找。（请使用findColor函数代替）
函数语法：
  x, y = findMultiColorInRegionFuzzy(color, posandcolor, degree, x1, y1, x2, y2,hdir,vdir)

参数说明：

脚本实例：
使用“区域模糊找色”函数时，常常会因为屏幕上有大量符合指定颜色的点而不能找到需要的坐标。该函数通过在寻找到一个符合指定颜色color的坐标后，进一步确认其周边点坐标的方式，来确定准确目标。例如，现在我们在图像上找到了我们需要的一个按钮，这个按钮的样式是不变的，但是它的整体位置却会在整个屏幕上变化，现在我们想要在脚本运行时得到其坐标。

首先确定一个参照点：
颜色为 0x181F85，坐标为 (268, 802)，下表序号1。
记录下来，继续寻找周边的几个参照点，以及与第一个参照点的相对坐标，分别为下表序号2~4：

现在我们找到了需要的所有参照点：

应用上述坐标写成多点找色脚本：

• 多点找色

x, y = findMultiColorInRegionFuzzy(0x181F85, "29|1|0x00BBFE,103|-4|0x0B6BBE,65|9|0x150972", 100, 0, 0, 639, 959);

注意事项：

1.posandcolor 参数中的坐标为相对坐标。
2.颜色值的十六进制文本中，其顺序为RGB。
3.相对于第一个点的坐标，即用这个点的横坐标、纵坐标分别减去第一个点的横坐标、纵坐标，可以为负数。
4.使用此函数时精度参数设置过低，会导致性能大幅下降。

函数：findMultiColorInRegionFuzzy2 区域多点找色（推荐使用findColor代替）

函数功能：在指定区域，根据颜色以及其周边点的颜色，寻找符合条件的点的坐标，支持模糊查找。（请使用findColor函数代替）
函数语法：
  x, y = findMultiColorInRegionFuzzy2(color, {{posandcolor}}, degree, x1, y1, x2, y2,hdir,vdir)

参数说明：

脚本实例：
该函数是区域多点找色函数findMultiColorInRegionFuzzy的增强版，将周边参照点的颜色及相对坐标写成table的形式，更方便动态调整。

x, y = findMultiColorInRegionFuzzy2(0x181F85, {{x=29, y=1, color=0x00BBFE},{x=103,y=- 4,color=0x0B6BBE},{x=65,y=9,color=0x150972}}, 100, 0, 0, 639, 959)

函数：findMultiColorInRegionFuzzyExt 高级区域多点找色（推荐使用findColors代替）

函数功能：在指定区域，根据颜色以及其周边点的颜色，寻找所有符合条件的点的坐标，支持模糊查找
函数语法：
  point = findMultiColorInRegionFuzzyExt(color, posandcolor, degree, x1, y1, x2, y2,hdir,vdir)

参数说明：

返回的 table 为key-value的形式，如下：
table = {
{x = 100,y = 110},
{x = 200,y = 210},
{x = 300,y = 310},
...
}

脚本实例：

point = findMultiColorInRegionFuzzyExt(0xcf0000,"-37|3|0x942814,-38|20|0xeba62d,1|54|0xf2b054,28|22|0x8a5707", 90, 97, 220, 903, 701)
if #point ~= 0 then  --如果找到符合条件的点
    for var = 1,#point do
        sysLog(point[var].x..":"..point[var].y)
    end
end

注意事项：

1.高级区域多点找色函数目前最多支持返回99个点。

函数：findMultiColorInRegionFuzzyExt2 高级区域多点找色（推荐使用findColors代替）

函数功能：在指定区域，根据颜色以及其周边点的颜色，寻找所有符合条件的点的坐标，支持模糊查找
函数语法：
  point = findMultiColorInRegionFuzzyExt2(color, {{posandcolor}}, degree, x1, y1, x2, y2,hdir,vdir)

参数说明：

返回的 table 为为key-value的形式，如下：
table = {
{x = 100,y = 110},
{x = 200,y = 210},
{x = 300,y = 310},
...
}

脚本实例：
该函数是高级区域多点找色函数findMultiColorInRegionFuzzyExt的增强版，将周边参照点的颜色及相对坐标写成table的形式，更方便动态调整。

point = findMultiColorInRegionFuzzyExt2(0xcf0000, {{x=-37,y=3,color=0x942814},{x=-38,y=20,color=0xeba62d},{x=1,y=54,color=0xf2b054},{x=28,y=22,color=0x8a5707}}, 90, 97, 220, 903, 701)
if #point ~= 0 then  
    for var = 1,#point do
        sysLog(point[var].x..":"..point[var].y)
    end
end

注意事项：

1.高级区域多点找色函数目前最多支持返回99个点。

函数：getColor 获取屏幕某点颜色值

函数功能：获取屏幕某点颜色值
函数语法：
  color = getColor(x, y)

参数说明：

脚本实例：

• 如果某点符合某颜色则点击

if getColor(100, 100) == 0xffffff then 
   touchDown(1, 100, 100);
   touchUp(1, 100, 100);
end

注意事项：

getColor函数获得的颜色值十六进制文本中，实际顺序为RGB

函数：getColorRGB 获取颜色RGB值

函数功能：获取屏幕某点颜色值R,G,B 值。
函数语法：
  color_r, color_g, color_b = getColorRGB(x, y)

参数说明：

脚本实例：

• 判断某点的颜色与某颜色相似

r,g,b = getColorRGB(100,100); --获取该点的R,G,B值
if r > 200 and b < 150 then   --判断颜色强度
    touchDown(1,100,100);   
    touchUp(1,100,100);
end

• 封装一个单点模糊比色函数

function isColor(x,y,c,s)   --x,y为坐标值，c为颜色值，s为相似度，范围0~100。
    local fl,abs = math.floor,math.abs
    s = fl(0xff*(100-s)*0.01)
    local r,g,b = fl(c/0x10000),fl(c%0x10000/0x100),fl(c%0x100)
    local rr,gg,bb = getColorRGB(x,y)
    if abs(r-rr)<s and abs(g-gg)<s and abs(b-bb)<s then
        return true
    end
    return false
end
if isColor(963,  961, 0x7b593f,90) then     touchDown(963, 961)
    mSleep(50)
    touchUp(963, 961)
end

函数：findImageInRegionFuzzy 模糊区域找图

函数功能：在指定区域中，寻找指定的图案，返回其左上角顶点坐标，支持模糊查找。
函数语法：
  x, y = findImageInRegionFuzzy(picpath, degree, x1, y1, x2, y2, alpha)

参数说明：

脚本实例：

• 寻找符合条件的图片

x, y = findImageInRegionFuzzy("test_alpha.png", 100, 0, 0, 320, 480, 0xffffff);
if x ~= -1 and y ~= -1 then        --忽略背景色白色的情况下找到符合条件的图片则点击
    touchDown(1, x, y);            
    mSleep(50)
    touchUp(1, x, y);
else                               --如果没找到符合条件的
    dialog("没找到 ╮（╯▽╰）╭",0);
end

函数：snapshot 截图

函数功能：截取屏幕中指定区域的图像并生成指定格式的图片文件
函数语法：
  snapshot(picname, x1, y1, x2, y2, quality)

参数说明：

返回值：无

脚本实例：

• 全屏截图（分辨率1080*1920），并以当前日期为文件名保存

current_time = os.date("%Y-%m-%d", os.time());
snapshot(current_time..".png", 0, 0, 1079, 1919);  --截图并以当前时间戳命名
snapshot('[public]'..i..".jpg", 0, 0, 1079, 1919, 0.9);   --使用jpg格式截图，质量为0.9

注意事项：

1.保存图片的格式可为 bmp, jpg, png，推荐选择 png。
2.截图时，如使用全屏截图，右下角顶点坐标最大为当前分辨率最大值，否则会出现越界错误。
3.默认图片路径为脚本私有文件夹，文件相同将会被覆盖
4.本文实例中 os.date 与 os.time 为 Lua 基本库函数，请查阅附录 Lua 操作系统函数库。
5.".." 为字符串连接操作符，可以将字符串变量、常量连接在一起。
6.截图保存路径：
- 开发助手
Android：/data/data/com.xxscript.idehelper/tengine/public
iOS(开发助手版本>=1.0.10)：/var/mobile/Library/XXIDEHelper/xsp/Temp
iOS(开发助手<1.0.10) ：/Library/ApplicationSupport/XXIDEHelper/xsp/Temp
- 叉叉助手
android: /data/data/com.xxAssistant/tengine/public
iOS(叉叉版本>=2.5.0):/var/mobile/Library/XXAssistant/Lua/Luas/Temp
iOS(叉叉版本<2.5.0):/Library/Application Support/XXAssistant/Lua/Luas/Temp
- IPA精灵
IPA精灵：应用文件夹/Documents/Lua/Luas/Temp/
7.公共目录路径：
- 开发助手
Android：/data/data/com.xxscript.idehelper/tengine/public
iOS(开发助手版本>=1.0.10)：/var/mobile/Library/XXIDEHelper/xsp/Temp/public
iOS(开发助手版本<1.0.10) ：/Library/ApplicationSupport/XXIDEHelper/xsp/Temp/public
- 叉叉助手
Android： /sdcard/com.xxAssistant/tengine/public
iOS(叉叉版本>=2.5.0): /var/mobile/Library/XXAssistant/Lua/Luas/Temp/public
iOS(叉叉版本<2.5.0): /Library/ApplicationSupport/XXAssistant/Lua/Luas/Temp/public
- IPA精灵
IPA精灵：应用文件夹/Documents/Lua/Luas/Temp/public
8.引擎1.3.0版本增加对公共目录[public]访问支持，截图方向跟随init

函数：keepScreen 保持屏幕

函数功能：函数功能：在脚本中保持当前屏幕内容不变，多次调用取色、找色、截图、找图等函数时，直接调用保持的屏幕内容。该函数主要用于优化找图找色函数的效率。
函数语法：
  keepScreen(flag)

参数说明：

返回值：无

脚本实例：

• 遍历屏幕区块

keepScreen(true);
for k = 1, 640, 10 do
    for j = 1, 960, 10 do
        --格式化颜色为十六进制文本
        color = string.format("%X", getColor(k, j));
        --输出系统日志
        sysLog("("..k..", "..j..") Color: "..color..".");
    end
end
keepScreen(false);

函数：inputText 输入字符串

函数功能：向输入框中输入文本
函数语法：
  inputText(string)

参数说明：

返回值：无

脚本实例：

• 输入文本

touchDown(1,150,150); --点击输入框获取焦点（假设已知输入框坐标150,150）
mSleep(50)
touchUp(1,150,150);
mSleep(1000); 
inputText("#CLEAR#") --删除输入框中的文字（假设输入框中已存在文字）
mSleep(1000); 
inputText("Welcome.#ENTER#"); --在输入框中输入字符串"Welcome."并回车

注意事项：

1.使用该函数前，必须先点击输入框获取焦点（指使当前的输入光标停留在某一输入框中）。
2.iOS系统上，该函数不支持第三方输入法(指百度输入法、搜狗输入法等)，请切换到系统内置输入法方可使用，对于弹出的窗口，需要先初始化再使用该函数，例如 App Store登录窗口(该窗口识别ID 为"com.apple.springboard")，安卓则无此限制。
3.可使用控制字符，包括 \n、\r、#ENTER#、#CLEAR#；#CLEAR#表示清空，需要注意的是，#ENTER#并非支持在所有应用中使用。

函数：createOcrDict 加载自定义的点阵字库

函数功能：加载自定义的点阵字库
函数语法：
  index = createOcrDict(dict)

参数说明：

脚本实例：

lines = {}
lines[1] = 'FFFFFC000000000000000000000001FFF$u$0.0.56$15'
lines[2] = 'FFFFFC$l$0.0.42$21'
lines[3] = '10EE1B06608811062084108218C1FF8FF$a$0.1.77$15'
lines[4] = 'FFFFFC03008030040080100200600F00F$h$0.0.71$21'
lines[5] = '0040080100200400801002FFFFFC010020040080100200400800400$王$4.2.83$21'
lines[6] = '1FE200400801002007F8000000000080601804030300E002002001001001001001$哈$0.1.118$26'
local dict = createOcrDict(lines) 
--或者可以写成这样的形式  local dict = createOcrDict("dict.txt") 
result = ocrText(dict, 0, 0, 1135, 639, {"0x613d3b-0x202020","0x797979-0x202020"}, 100, 0, 0) -- 表示范围内全部搜索，以字符串形式返回识别结果
sysLog('result: ' .. result)
results = ocrText(dict, 0, 0, 1135, 639, {"0x613d3b-0x202020"}, 100, 1, 1) -- 表示范围内横向搜索，以table形式返回识别到的所有结果及其坐标
for k,v in pairs(results) do
    sysLog(string.format('{x=%d, y=%d, text=%s}', v.x, v.y, v.text))
end

注意事项：

1.ocr函数不支持多分辨率，不受setScreenScale影响
2.字库文件“dict.txt”需注意文本编码必须使用 UTF-8 格式，并放置于脚本内 res 目录
3.搜索方向横向或竖向时的检索规则为：从识别到第一个匹配结果开始给予该位置横向或竖向搜索，忽略选定区域内其他范围；合理使用搜索方向参数可有效提高ocr函数性能。

函数：ocrText 文字点阵化识别

函数功能：识别屏幕上的文字。
函数语法：
  result = ocrText(index, x1, y1, x2, y2, {"c0-c1"} , sim, flag, dir)

参数说明：

脚本实例：

lines = {}
lines[1] = 'FFFFFC000000000000000000000001FFF$u$0.0.56$15'
lines[2] = 'FFFFFC$l$0.0.42$21'
lines[3] = '10EE1B06608811062084108218C1FF8FF$a$0.1.77$15'
lines[4] = 'FFFFFC03008030040080100200600F00F$h$0.0.71$21'
lines[5] = '0040080100200400801002FFFFFC010020040080100200400800400$王$4.2.83$21'
lines[6] = '1FE200400801002007F8000000000080601804030300E002002001001001001001$哈$0.1.118$26'
local dict = createOcrDict(lines) 
--或者可以写成这样的形式  local dict = createOcrDict("dict.txt") 
result = ocrText(dict, 0, 0, 1135, 639, {"0x613d3b-0x202020","0x797979-0x202020"}, 100, 0, 0) -- 表示范围内全部搜索，以字符串形式返回识别结果
sysLog('result: ' .. result)
results = ocrText(dict, 0, 0, 1135, 639, {"0x613d3b-0x202020"}, 100, 1, 1) -- 表示范围内横向搜索，以table形式返回识别到的所有结果及其坐标
for k,v in pairs(results) do
    sysLog(string.format('{x=%d, y=%d, text=%s}', v.x, v.y, v.text))
end

注意事项：

1.ocr函数不支持多分辨率，不受setScreenScale影响
2.字库文件“dict.txt”需注意文本编码必须使用 UTF-8 格式，并放置于脚本内 res 目录
3.搜索方向横向或竖向时的检索规则为：从识别到第一个匹配结果开始给予该位置横向或竖向搜索，忽略选定区域内其他范围；合理使用搜索方向参数可有效提高ocr函数性能。

函数：createOCR 载入高级文字识别字库(集成tesserOCR)

函数功能：载入高级文字识别字库，并指定检测方式
函数语法：
  ocr, msg = createOCR({
  type = "tesseract",
  mode = mode,
  path = path,
  lang = lang
  })

参数说明：

path 自定义字库，有两种路径选择：
对于自定义字库，有以下几种路径选择：
1. 内置到xsp的res目录下，直接指定res路径："res/"
2. 下载到public目录下，指定[public]和子路径："[public]downloads/tessdata/"
3. 使用开发助手/叉叉助手的字库扩展，指定[external]即可："[external]"
特别注意：下载到public目录的字库路径，traineddata的上层目录必须命名为tessdata

lang 字库语言文件：
1. lang 为.traineddata字库文件名，叉叉助手、开发助手中可下载的字库语言文件有：
chi_sim 简体中文字库
chi_tra 繁体中文字库
eng_ext 英文增强版字库
eng 内置默认精简版中英数字标点字库，免下载可用
2. 识别要求不高或识别数据比较标准，也可以path和lang都不填，使用默认字库eng，只支持一般的中英+数字+标点符号。

字库与语言配置样例：
1. path & lang均不填： 使用内置eng字库
2. path = [external] & lang = eng_ext/chi_sim/chi_tra：叉叉提供的字库扩展（需下载）
3. path = "res/" & lang = dictname（dictname：xsp打包中res目录字库文件名）

脚本实例：

local ocr, msg = createOCR({
    type = "tesseract", -- 指定tesseract引擎
    path = "[external]", -- 使用开发助手/叉叉助手的扩展字库，不填默认使用eng字库路径
    lang = "eng_ext" -- 使用英文增强字库(注意需要提前下载好)
})
if ocr ~= nil then
    -- ocr 创建成功，使用该实例进行后续识别操作（参见下面函数文档）
    sysLog("createOCR succeed: Tesseract-OCR v" .. msg)
else
    -- ocr 创建失败，根据msg提示调整
    sysLog("createOCR failed: " .. tostring(msg))
end

训练字库：
请参阅：【如何使用Tesseract-OCR(v3.02.02)训练字库】

注意事项：

支持引擎版本：1.8.10或更新
引擎内置Tesseract-OCR版本：3.02.02

函数：ocr:getText 高级文字识别

函数功能：使用已载入的高级文字识别字库进行识别
函数语法：
  local code, text = ocr:getText({
  psm = psm,
  rect = {x1, y1, x2, y2},
  diff = {diff},
  data = data,
  whitelist = whitelist,
  blacklist = blacklist
  })

参数说明：

脚本实例：

local ocr, msg = createOCR({
    type = "tesseract", -- 指定tesseract引擎
    path = "[external]", -- 使用开发助手/叉叉助手的扩展字库
    lang = "eng_ext" -- 使用英文增强字库(注意需要提前下载好)
})
if ocr ~= nil then
    string.trim = function(s)
        return s:match'^%s*(.*%S)' or ''
    end
    local code, text = 0, ""
    mSleep(1000)
    -- 识别屏幕图像内容(例如5/5s设备的当前时间显示)
    code, text = ocr:getText({
        rect = {249, 6, 249 + 144, 6 + 29},
        diff = {"0x000000-0x101010"}, -- 时间颜色为纯黑
        whitelist = "0123456789APM:" -- 添加所有可能出现的字符作为白名单
    })
    -- 输出示例："code = 0, text = 5:24 PM" (末尾可能有多余换行符，为正常结果，可以参考trim处理)
    sysLog("code = " .. tostring(code) .. ", text = " .. text:trim())
    mSleep(1000)
    -- 识别二值化二维数组(单个字符)
    code, text = ocr:getText({
        psm = 10, -- 所识别图片当作单个英文/数字字符
        data = {
            {0,0,0,0,1,0,0,0,0,0,0,0,0,0},
            {0,0,0,1,0,1,0,0,0,0,0,0,0,0},
            {0,0,0,0,1,0,0,0,0,0,0,0,0,0},
            {0,0,0,1,0,0,0,0,0,0,0,0,0,0},
            {0,0,0,1,0,0,0,0,0,0,0,0,0,0},
            {0,0,1,1,0,0,0,0,0,0,0,0,0,0},
            {0,1,0,1,0,0,0,0,0,0,0,0,0,0},
            {0,1,1,1,1,1,0,1,1,0,0,0,0,0},
            {1,0,1,1,0,0,0,0,1,1,1,0,0,0},
            {0,1,0,1,0,0,0,0,0,0,1,1,0,0},
            {1,1,1,0,0,0,0,0,0,0,1,1,0,0},
            {1,0,0,0,0,0,0,0,0,0,1,0,1,0},
            {1,0,0,0,0,0,0,0,0,0,0,1,1,0},
            {1,0,0,0,0,0,0,0,0,0,0,1,0,1},
            {1,0,0,0,0,0,0,0,0,0,0,0,1,0},
            {1,0,0,0,0,0,0,0,0,0,0,1,1,1},
            {1,0,0,0,0,0,0,0,0,0,0,1,0,1},
            {1,1,0,0,0,0,0,0,0,0,0,1,1,0},
            {1,0,1,0,0,0,0,0,0,0,1,0,0,0},
            {0,1,1,1,0,1,0,0,1,1,1,0,0,0},
            {0,0,0,1,1,1,0,1,1,0,0,0,0,0},
            {0,0,0,0,0,0,1,0,1,0,0,0,0,0}
        },
        whitelist = "0123456789" -- 添加白名单为数字类型
    })
    -- 输出示例："code = 0, text = 6"
    sysLog("code = " .. tostring(code) .. ", text = " .. text:trim())
    mSleep(1000)
    -- 识别二值化二维数组(多个字符)
    code, text = ocr:getText({
        psm = 7, -- 所识别图片当作一行文字
        data = {
            {1,1,1,1,1,1,1,1,0,0,0,0,0,1,1,1,1,1,0,0},
            {1,1,1,0,0,0,0,0,0,0,0,0,1,1,0,0,0,0,1,0},
            {1,0,0,0,0,0,0,0,0,0,0,1,0,0,0,0,0,0,0,1},
            {1,0,0,0,0,0,0,0,0,0,0,1,0,0,0,0,0,0,0,1},
            {1,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,1},
            {1,0,0,1,1,1,1,0,0,0,0,0,0,0,0,0,0,0,1,0},
            {1,1,1,0,0,0,1,1,0,0,0,0,0,0,1,1,1,1,0,0},
            {1,1,0,0,0,0,0,1,1,0,0,0,0,0,0,0,0,1,1,0},
            {0,0,0,0,0,0,0,0,1,0,0,0,0,0,0,0,0,0,1,1},
            {0,0,0,0,0,0,0,0,1,0,0,0,0,0,0,0,0,0,0,1},
            {0,0,0,0,0,0,0,0,1,0,0,0,0,0,0,0,0,0,0,1},
            {0,0,0,0,0,0,0,0,1,0,0,1,0,0,0,0,0,0,0,1},
            {1,0,0,0,0,0,0,1,1,0,0,1,1,0,0,0,0,0,0,1},
            {0,1,0,0,0,0,0,1,0,0,0,0,1,0,0,0,0,0,1,0},
            {0,0,1,1,1,1,1,0,0,0,0,0,0,1,1,1,1,1,0,0}
        },
        whitelist = "0123456789"
    })
    -- 输出示例："code = 0, text = 53"
    sysLog("code = " .. tostring(code) .. ", text = " .. text:trim())
else
    sysLog("createOCR failed: " .. tostring(msg))
end

特别说明

diff = {"C1-D1", "C2-D2", …} 设置的意义是，当区域内任意一个颜色值Cxy，满足条件 min(Ci - Di, 0x000000) ≤ Cxy ≤ max(Ci + Di, 0xffffff)，i = 1, 2, … 的时候，这个位置的颜色就是有效颜色(0xffffff)，否则，都是无效颜色(0x000000)。这个处理过程称为二值化，经过这样处理后的二值化数据，提交给OCR识别会更加精确。

注意事项：

支持引擎版本：1.8.10或更新

函数：ocr:release 释放字库

函数功能：主动释放OCR字库，避免内存峰值过高导致被系统强杀
函数语法：
  ocr:release()

参数说明：
使用到字库较大的情况下，为避免内存峰值过高导致被系统强杀，请在OCR使用完毕时调用API释放ocr，否则只能依赖lua的gc自动清理。

脚本实例：

local ocr, msg = createOCR({
    type = "tesseract", -- 指定tesseract引擎
    path = "[external]", -- 使用开发助手/叉叉助手的扩展字库
    lang = "eng_ext" -- 使用英文增强字库(注意需要提前下载好)
})
local code, text = ocr:getText({
    rect = {249, 6, 249 + 144, 6 + 29},
    diff = {"0x000000-0x101010"},
    whitelist = "0123456789APM:"
})
-- ocr使用完毕，为避免内存峰值过高导致被系统强杀(主要是使用到字库较大的情况下)
-- 建议及时手动释放ocr
ocr:release()

注意事项：

支持引擎版本：1.8.11或更新

函数：binarizeImage 二值化图片转换为table

函数功能：对当前屏幕指定范围的图像二值化，并转换为table，得到的结果通过去噪或者矩阵运算后，可以提供给ocr:getText()识别成文字
函数语法：
  colorTbl = binarizeImage({
   rect = {x1, y1, x2, y2},
   diff = {diff}
  })

参数说明：

脚本实例：

colorTbl = binarizeImage({
  rect = {30, 80, 53, 101},
  diff = {"0xf7d363-0x1f1f1f", "0xefaa29-0x1f1f1f"}
})
-- 输出colorTbl每一行测试转换结果
for _, row in pairs(colorTbl) do
  sysLog(table.concat(row, ','))
end
--[[
colorTbl格式类似这样：
{
    {0,0,0,0,1,0,0,0,0,0,0,0,0,0},
    {0,0,0,1,0,1,0,0,0,0,0,0,0,0},
    {0,0,0,0,1,0,0,0,0,0,0,0,0,0},
    {0,0,0,1,0,0,0,0,0,0,0,0,0,0},
    {0,0,0,1,0,0,0,0,0,0,0,0,0,0},
    {0,0,1,1,0,0,0,0,0,0,0,0,0,0},
    {0,1,0,1,0,0,0,0,0,0,0,0,0,0},
    {0,1,1,1,1,1,0,1,1,0,0,0,0,0},
    {1,0,1,1,0,0,0,0,1,1,1,0,0,0},
    {0,1,0,1,0,0,0,0,0,0,1,1,0,0},
    {1,1,1,0,0,0,0,0,0,0,1,1,0,0},
    {1,0,0,0,0,0,0,0,0,0,1,0,1,0},
    {1,0,0,0,0,0,0,0,0,0,0,1,1,0},
    {1,0,0,0,0,0,0,0,0,0,0,1,0,1},
    {1,0,0,0,0,0,0,0,0,0,0,0,1,0},
    {1,0,0,0,0,0,0,0,0,0,0,1,1,1},
    {1,0,0,0,0,0,0,0,0,0,0,1,0,1},
    {1,1,0,0,0,0,0,0,0,0,0,1,1,0},
    {1,0,1,0,0,0,0,0,0,0,1,0,0,0},
    {0,1,1,1,0,1,0,0,1,1,1,0,0,0},
    {0,0,0,1,1,1,0,1,1,0,0,0,0,0},
    {0,0,0,0,0,0,1,0,1,0,0,0,0,0}
}
]]--
-- 对colorTbl结果进行可选的去噪或者矩阵运算纠正等处理
-- (假设处理函数是denoising)
colorTbl = denoising(colorTbl)
local ocr, msg = createOCR({
    type = "tesseract"
})
-- 使用ocr识别新的colorTbl
local code, text = ocr:getText({
    data = colorTbl,
    psm = 10 -- 单个字符模式识别
})
sysLog("code = " .. tostring(code) .. "， text = " .. text)
-- 输出结果：code = 0, text = 6