quick-cocos2d-x API函数汇总
1. init
在quick\framework\init.lua文件中。
quick framework 初始化,载入 quickframework 预定义的常量、模块。
1.1 常量
在初始化框架之前,可以定义以下常量:
· DEBUG: 设置框架的调试输出级别
·
DEBUG =
0-- 不输出任何调试信息(默认值)
·
DEBUG =
1-- 输出基本的调试信息
·
DEBUG =
2-- 输出详细的调试信息
· DEBUG_FPS: 设置是否在画面中显示渲染帧率等信息
·
DEBUG_FPS =
false-- 不显示(默认值)
·
DEBUG_FPS =
true-- 显示
· DEBUG_MEM: 设置是否输出内存占用信息
·
DEBUG_MEM =
false-- 不输出(默认值)
·
DEBUG_MEM =
true-- 每 10 秒输出一次
· LOAD_DEPRECATED_API: 是否载入过时的 API 定义,默认为 false
· DISABLE_DEPRECATED_WARNING: 使用过时的 API 时是否显示警告信息,默认为 true
· USE_DEPRECATED_EVENT_ARGUMENTS:是否使用过时的 Node 事件参数格式,默认为 false
1.2 自动载入的模块
框架初始化时,会自动载入以下基本模块:
· debug: 调试接口
· functions: 提供一组常用的函数,以及对 Lua 标准库的扩展
· cocos2dx: 对 cocos2d-x C++ 接口的封装和扩展
· device: 针对设备接口的扩展
· transition: 与动作相关的接口
· display: 创建场景、图像、动画的接口
· filter: 具备过滤器渲染的 Sprite 接口
· audio: 音乐和音效的接口
· network: 网络相关的接口
· crypto: 加密相关的接口
· json: JSON 的编码和解码接口
· luaj: 提供从 Lua 调用 Java 方法的接口(仅限 Android 平台)
· luaoc: 提供从 Lua 调用 Objective-C 方法的接口(仅限 iOS 平台)
· cc: quick 框架扩展的基础类和组件
quick\framework\platform\mac.lua文件
quick\framework\cc\mac.lua文件
2. debug
quick\framework\debug.lua文件
提供调试接口
Functions |
定义一个作废的接口 |
显示作废信息 |
打印调试信息 |
输出 tag 为 ERR 的调试信息 |
输出 tag 为 INFO 的调试信息 |
输出值的内容 |
Functions
DEPRECATED(newfunction, oldname, newname)
定义一个作废的接口
PRINT_DEPRECATED(msg)
显示作废信息
printLog(tag, fmt, ...)
打印调试信息
用法示例
printLog(
"WARN",
"Network connection lost at %d",
os.time())
Parameters
· string tag 调试信息的 tag
· string fmt 调试信息格式
· [mixed ...] 更多参数
printError(fmt, ...)
输出 tag 为 ERR 的调试信息
Parameters
· string fmt 调试信息格式
· [mixed ...] 更多参数
printInfo(fmt, ...)
输出 tag 为 INFO 的调试信息
Parameters
· string fmt 调试信息格式
· [mixed ...] 更多参数
dump(value, desciption, nesting)
输出值的内容
用法示例
localt = {comp =
"chukong", engine =
"quick"}
dump(t)
Parameters
· mixed value 要输出的值
· [string desciption] 输出内容前的文字描述
@parma [integer nesting] 输出时的嵌套层级,默认为 3
3. functions
quick\framework\ functions.lua文件
提供一组常用函数,以及对 Lua 标准库的扩展
Functions |
输出格式化字符串 |
检查并尝试转换为数值,如果无法转换则返回 0 |
检查并尝试转换为整数,如果无法转换则返回 0 |
检查并尝试转换为布尔值,除了 nil 和 false,其他任何值都会返回 true |
检查值是否是一个表格,如果不是则返回一个空表格 |
如果表格中指定 key 的值为 nil,或者输入值不是表格,返回 false,否则返回 true |
深度克隆一个值 |
创建一个类 |
如果对象是指定类或其子类的实例,返回 true,否则返回 false |
载入一个模块 |
将 Lua 对象及其方法包装为一个匿名函数 |
根据系统时间初始化随机数种子,让后续的 math.random() 返回更随机的值 |
对数值进行四舍五入,如果不是数值则返回 0 |
角度转弧度 |
弧度转角度 |
检查指定的文件或目录是否存在,如果存在返回 true,否则返回 false |
读取文件内容,返回包含文件内容的字符串,如果失败返回 nil |
以字符串内容写入文件,成功返回 true,失败返回 false |
拆分一个路径字符串,返回组成路径的各个部分 |
返回指定文件的大小,如果失败返回 false |
计算表格包含的字段数量 |
返回指定表格中的所有键 |
返回指定表格中的所有值 |
将来源表格中所有键及其值复制到目标表格对象中,如果存在同名键,则覆盖其值 |
在目标表格的指定位置插入来源表格,如果没有指定位置则连接两个表格 |
从表格中查找指定值,返回其索引,如果没找到返回 false |
从表格中查找指定值,返回其 key,如果没找到返回 nil |
从表格中删除指定值,返回删除的值的个数 |
对表格中每一个值执行一次指定的函数,并用函数返回值更新表格内容 |
对表格中每一个值执行一次指定的函数,但不改变表格内容 |
对表格中每一个值执行一次指定的函数,如果该函数返回 false,则对应的值会从表格中删除 |
遍历表格,确保其中的值唯一 |
将特殊字符转为 HTML 转义符 |
将 HTML 转义符还原为特殊字符,功能与 string.htmlspecialchars() 正好相反 |
将字符串中的 \n 换行符转换为 HTML 标记 |
将字符串中的特殊字符和 \n 换行符转换为 HTML 转移符和标记 |