[关闭]
@xxzhushou 2019-01-07 19:55 字数 102631 阅读 30004
叉叉引擎XMod2.0 API手册
叉叉脚本 XMod
此页面已于2019-01-01起废弃,后续不再更新维护,敬请移步新文档库:叉叉脚本工具文档
目录索引
叉叉引擎XMod2.0 API手册
Lua扩展
◆ 函数 log : 输出日志到控制台
◆ 函数 printf : 格式化输出日志到控制台
◆ 函数 sleep : 休眠、暂停运行
◆ 函数 os.netTime : 获取网络时间
◆ 函数 os.milliTime : 获取毫秒级别本地时间
特别说明
内置全局类型
类Point 坐标
◆ 常量 Point.ZERO
◆ 常量 Point.INVALID
◆ 变量 Point.x : x坐标值
◆ 变量 Point.y : y坐标值
◆ 函数 Point : 构建坐标实例
◆ 基本运算
类Size 尺寸
◆ 常量 Size.ZERO
◆ 常量 Size.INVALID
◆ 变量 Size.width : 尺寸的宽
◆ 变量 Size.height : 尺寸的高
◆ 函数 Size : 构建尺寸实例
◆ 基本运算
类Rect 矩形
◆ 常量 Rect.ZERO
◆ 变量 Rect.x : 左上角x坐标值
◆ 变量 Rect.y : 左上角y坐标值
◆ 变量 Rect.width : 矩形的宽
◆ 变量 Rect.height : 矩形的高
◆ 函数 Rect : 构建矩形实例
◆ 函数 Rect:tl : 获取矩形的左上角坐标
◆ 函数 Rect:br : 获取矩形的右下角坐标
◆ 函数 Rect:size : 获取矩形尺寸
◆ 函数 Rect:contains : 判断矩形是否包含坐标
◆ 函数 Rect:union : 矩形合并操作
◆ 函数 Rect:intersect : 矩形相切操作
类Color3B 颜色值(整型)
◆ 变量 Color3B.r : 红色色值
◆ 变量 Color3B.g : 绿色色值
◆ 变量 Color3B.b : 蓝色色值
◆ 函数 Color3B : 构造颜色值(整型)实例
◆ 函数 Color3B:toInt : 转换成整型色值
◆ 函数 Color3B:toString : 转换成字符串色值
类Color3F 颜色值(浮点型)
◆ 变量 Color3F.r : 红色色值
◆ 变量 Color3F.g : 绿色色值
◆ 变量 Color3F.b : 蓝色色值
◆ 函数 Color3F : 构造颜色值(浮点型)实例
◆ 函数 Color3F:toInt : 转换成整型色值
◆ 函数 Color3F:toString : 转换成字符串色值
综合模块 —— xmod
◆ 常量 xmod.PLATFORM_IOS
◆ 常量 xmod.PLATFORM_ANDROID
◆ 常量 xmod.PLATFORM
◆ 常量 xmod.PRODUCT_CODE
◆ 常量 xmod.PRODUCT_CODE_DEV
◆ 常量 xmod.PRODUCT_CODE_XXZS
◆ 常量 xmod.PRODUCT_CODE_IPA
◆ 常量 xmod.PRODUCT_CODE_KUWAN
◆ 常量 xmod.PRODUCT_CODE_SPIRIT
◆ 常量 xmod.PRODUCT_NAME
◆ 常量 xmod.VERSION_CODE
◆ 常量 xmod.VERSION_NAME
◆ 常量 xmod.HANDLER_ON_USER_EXIT
◆ 常量 xmod.HANDLER_ON_RUNTIME_ERROR
◆ 常量 xmod.SCREENCAP_POLICY_STANDARD
◆ 常量 xmod.SCREENCAP_POLICY_AGGRESSIVE
◆ 常量 xmod.SCREENCAP_POLICY
◆ 常量 xmod.SCREENCAP_KEEP
◆ 函数 xmod.setConfig : 设置引擎属性
◆ 函数 xmod.getConfig : 获取引擎属性
◆ 函数 xmod.getPublicPath : 获取引擎公共目录
◆ 函数 xmod.getPrivatePath : 获取脚本私有目录
◆ 函数 xmod.resolvePath : 目录转换
◆ 函数 xmod.setOnEventCallback : 设置事件回调
◆ 函数 xmod.exit : 脚本退出
◆ 函数 xmod.restart : 脚本重启
脚本控制模块 —— script
类UserInfo 用户信息
◆ 变量 UserInfo.id : 唯一标识
◆ 变量 UserInfo.membership : 会员标识
◆ 变量 UserInfo.expiredTime : 剩余时间
类ScriptInfo 脚本信息
◆ 变量 ScriptInfo.id : 唯一标识
◆ 函数 script.getUserInfo : 获取用户信息
◆ 函数 script.getScriptInfo : 获取脚本信息
◆ 函数 script.getBillboard : 获取脚本公告
◆ 函数 script.getUIData : 获取ui目录资源内容
◆ 函数 script.getResData : 获取res目录资源内容
界面图像模块 —— screen
类Image 图像
◆ 常量 Image.ROTATION_CLOCKWISE_90
◆ 常量 Image.ROTATION_CLOCKWISE_180
◆ 常量 Image.ROTATION_CLOCKWISE_270
◆ 函数 Image.fromScreen : 从屏幕构造图像实例
◆ 函数 Image.fromFile : 从文件构造图像实例
◆ 函数 Image:release : 释放图像
◆ 函数 Image:getSize : 获取图像尺寸
◆ 函数 Image:getWidth : 获取图像尺寸-宽
◆ 函数 Image:getHeight : 获取图像尺寸-高
◆ 函数 Image:setRotation : 旋转图像
◆ 函数 Image:saveToFile : 把图像实例保存到本地
◆ 函数 Image:clip : 截取图像
◆ 函数 Image:getRGB : 获取图像颜色值(整型)
◆ 函数 Image:getColor : 获取图像颜色值
◆ 函数 Image:binarize : 图像二值化成table
◆ 常量 screen.LANDSCAPE_RIGHT
◆ 常量 screen.LANDSCAPE_LEFT
◆ 常量 screen.PORTRAIT
◆ 常量 screen.PRIORITY_DEFAULT
◆ 常量 screen.PRIORITY_LEFT_FIRST
◆ 常量 screen.PRIORITY_RIGHT_FIRST
◆ 常量 screen.PRIORITY_UP_FIRST
◆ 常量 screen.PRIORITY_DOWN_FIRST
◆ 常量 screen.PRIORITY_HORIZONTAL_FIRST
◆ 常量 screen.PRIORITY_VERTICAL_FIRST
◆ 常量 screen.MOCK_NONE
◆ 常量 screen.MOCK_INPUT
◆ 常量 screen.MOCK_INPUT_FIXED
◆ 常量 screen.MOCK_INPUT_RELATIVE
◆ 常量 screen.MOCK_OUTPUT
◆ 常量 screen.MOCK_BOTH
◆ 函数 screen.init : 初始化屏幕参数
◆ 函数 screen.getSize : 获取屏幕分辨率尺寸
◆ 函数 screen.getDPI : 获取屏幕DPI
◆ 函数 screen.capture : 截取屏幕
◆ 函数 screen.keep : 保持屏幕内容
◆ 函数 screen.getOrientation : 获取屏幕方向
◆ 函数 screen.snapshot : 截图并保存至本地
◆ 函数 screen.getRGB : 获取屏幕颜色值(RGB)
◆ 函数 screen.getColor : 获取屏幕颜色值
◆ 函数 screen.matchColor : 比较颜色值
◆ 函数 screen.matchColors : 比较颜色序列
◆ 函数 screen.findImage : 查找图像
◆ 函数 screen.findColor : 查找颜色值/序列坐标
◆ 函数 screen.findColors : 查找所有颜色值/序列坐标
◆ 函数 screen.setMockMode : 设置坐标转换模式
◆ 函数 screen.setMockTransform : 设置坐标转换回调函数
点按模块 —— touch
◆ 常量 touch.KEY_HOME
◆ 常量 touch.KEY_BACK
◆ 常量 touch.KEY_MENU
◆ 常量 touch.KEY_POWER
◆ 常量 touch.KEY_VOLUME_UP
◆ 常量 touch.KEY_VOLUME_DOWN
◆ 函数 touch.down : 模拟点击按下
◆ 函数 touch.move : 模拟点击滑动
◆ 函数 touch.up : 模拟点击抬起
◆ 函数 touch.press : 模拟按键按下
◆ 函数 touch.doublePress : 模拟按键双击
◆ 函数 touch.captureTap : 捕获用户点击
简单存储模块 —— storage
◆ 函数 storage.put : 存储数据
◆ 函数 storage.get : 提取数据
◆ 函数 storage.purge : 清除所有数据
◆ 函数 storage.commit : 提交数据缓存
任务执行模块 —— task
◆ 函数 task.execTimer : 定时执行任务
◆ 函数 task.execAsync : 异步执行任务
系统/运行时模块 —— runtime
◆ 函数 runtime.vibrate : 模拟设备震动
◆ 函数 runtime.readClipboard : 读取粘贴板
◆ 函数 runtime.writeClipboard : 写入粘贴板
◆ 函数 runtime.inputText : 模拟输入文本
◆ 函数 runtime.launchApp : 启动应用
◆ 函数 runtime.killApp : 关闭应用
◆ 函数 runtime.isAppRunning : 判断应用是否运行