Quick-3.3 API方法

init

文件：quick-3.3/quick/framework/init.lua
功能：quick引擎框架初始化，载入预定义常量和模块。

常量

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

LOAD_DEPRECATED_API = false 默认值，禁用

DISABLE_DEPRECATED_WARNING

功能：是否在使用过时废弃API时显示警告信息

DISABLE_DEPRECATED_WARNING = true -- 默认值，启用

USE_DEPRECATED_EVENT_ARGUMENTS

功能：是否使用过时废弃的Node事件参数格式

USE_DEPRECATED_EVENT_ARGUMENTS = false -- 默认值，禁用

模块

debug 调试接口
functions 对Lua标准库扩展的函数库
coco2dx 对cocos2d-x c++接口的封装和扩展
device 对设备接口的扩展
transition 动作相关接口
display 场景、图像、动画的接口
filter 过滤器渲染的sprite接口
audio 音效接口
network 网络接口
crypto 加密接口
json JSON编码解码接口
luaj Android平台中从Lua调用Java方法的接口。
luaoc iOS平台中从Lua调用Object-C方法的接口
cc Quick框架扩展的基础类和组件

debug

文件：quick3.3/quick/framework/debug.lua
功能：提供调试接口

DEPRECATED(newFunction, oldName, newName)

功能：定义一个过期作废的接口

PRINT_DEPRECATED(message)

功能：显示过期作废信息

printLog(tagname, format, ...)

功能：打印调试信息

printLog(tagname, format, ...)
@param string tagname 调试信息的标签
@param string format 调试信息格式
@param [mixed ...] 更多参数

printError(format, ...)

输出tag标签为error类型的调试信息

printInfo(format, ....)

输出tag标签为info类型的调试信息

dump(value, description, nesting)

功能：输出值的内容

dump(value, description, nesting)
@param mixed value 要输出的值
@param [string description] 输出内容前的文字描述
@param [integer nesting] 输出时嵌套层级，默认为3。

functions

文件：quick-3.3/quick/framework/functions.lua
功能：对Lua标准库的扩展和常用函数

printf(format, ....)

功能：输出格式化字符串

printf(format, ....) 
@param string format 输出格式
@param [mixed ...] 更多参数

示例：

printf("value = %d", 100)

checknumber(value, base)

功能：检查并尝试装换为数值，若无法转换则返回0。

checknumber(value, base)
@param mixed value 需要检查的值
@param [integer base] 进制类型，默认为十进制。
@return number 0

checkint(value)

检查并尝试转换为整数，若无法转换则返回0。

checkint(value)
@param mixed value 待检查的值
@return integer

checkbool(value)

检查并尝试转换为布尔值，除了nil和false外，其他均返回true。

checkbool(value)
@param mixed value 待检查的值
@return bool 返回布尔值

checktable(value)

功能：检查参数值是否为表数据类型，若非则返回一个空表。

checktable(value)
@param mixed value 待检查的值
@return table 返回表

isset(hashTable, key)

功能：若表中指定键的值为nil或输入值不是表则返回false，否则返回true。

isset(hashTable, key)
@param table hashTable 待检查的表
@param mixed key 待检查的键
@return boolean

clone(object)

功能：深度克隆一个值（深拷贝）

clone(object)
@param mixed object 待克隆的值
@return mixed

class(classname, super)

功能：创建类

class(classname, super)
@param string classname 类名
@param [mixed super] 父类或创建对象实例的函数
@return table

iskindof(object, classname)

功能：若对象是指定类或其子类的实例则返回true，否则返回false。

iskindof(object, classname)
@param mixed object 待检查的类名
@param string classname 类名
@return boolean

import(moduleName, currentModuleName)

功能：载入一个模块

import(moduleName, currentModuleName)
@param string moduleName 待载入模块的名称
@param [string currentModuleName] 当前模块名称
@return module

handler(object, method)

功能：将Lua对象及其方法包装为一个匿名函数

handler(object, method)
@param mixed object Lua对象
@param function method 对象方法
@return function

math.newrandomseed()

功能：根据系统时间初始化随机种子，为后续math.random()返回更加随机的值。

math.round(value)

功能：对数值进行四舍五入，若参数不是数值则返回0。

math.round(value)
@param number value 输入值
@return number

math.angle2radian(angle)

功能：角度转弧度

math.angle2radian(angle)

math.radian2angle(radian)

功能：弧度转角度

io.exists(path)

功能：检查指定目录或文件是否存在，若存在返回true否则返回false。

io.exists(path)
@param string path 待检查文件或目录的完整路径
@return boolean

io.readfile(path)

功能：读取文件内容，返回包含文件内容的字符串，若失败则返回为nil。

io.readfile(path)
@param string path 待读取的文件路径
@return string

io.writefile(path, content, mode)

功能：以字符串内容写入文件，成功返回true失败返回false。

io.writefile(path, content, mode)
@param string path 文件完整路径
@param string content 待写入的内容
@param [string mode] 写入模式，默认为`w+b`。
@return boolean

写入模式mode决定io.write()如何写入内容

w+ 覆盖文件已有内容，若文件不存在则创建新文件。
a+ 追加内容到文件尾部，若文件不存在则创建文件。
b 表示二进制写入数据以避免内容写入不完整

使用注意

Android中文件只能写入存储卡所在路径，assets和data等目录都无法写入。

io.pathinfo(path)

功能：拆分一个路径字符串，返回组成路径的各个部分。

io.pathinfo(path)
@param string path 待分拆的路径
@return table

io.filesize(path)

功能：获取指定文件的大小，若失败则返回false。

io.filesize(path)
@param string path 文件路径
@return integer

table.nums(table)

功能：计算表格中包含的字段数量，计算表中不为nil值的个数。

table.nums(hashTable)
@param table hashTable 待检查的表
@return integer

table.keys(hashTable)

功能：获取指定表中的所有的键

table.keys(hashTable)
@param table hashTable 待检查的表
@return table

table.values(hashTable)

功能：获取指定表中所有键值

table.values(hashTable)
@param table hashTable 待检查的表
@return table

table.merge(dstTable, srcTable)

功能：将源表中所有键与值赋值到目标表对象中，若存在同名键则覆盖其值。

table.merge(dstTable, srcTable)
@param table dstTable  目标表
@param table srcTable 原始表

table.insertto(dstTable, srcTable, position)

功能：在目标表中指定位置插入源表，若无指定位置则连接两表。

table.insertto(dstTable, srcTable, position)
@param table dstTable 目标表
@param table srcTable 原始表
@param integer position 插入位置

table.indexof(array, value, position)

功能：从表中查找指定值并返回其索引，若无则返回false。

table.indexof(array, value, index)
@param table array 待检查的表
@param mixed value 待查找的值
@param [integer index] 起始索引值

table.keyof(hashTable, value)

功能：从表中查找指定值若存在则返回其键名key，若无则返回nil。

table.keyof(hashTable, value)
@param table hashTable 待检查的表
@param mixed value 待检查的值
@return string 待检查值的键名key

table.removebyvalue(array, value, removedSame)

功能：从表中删除指定值，成功则返回删除值的个数。

table.removebyvalue(array, value, removedSame)
@param table array 待检查的表
@param mixed value 待删除的值
@param [boolean removedSame] 是否删除相同的值
@return integer

table.map(hashTable, fn)

功能：对表中每个值执行一次指定函数并用函数返回值更新表内容。

table.map(hashTable, fn)
@param table hashTable 待检查的表
@param function fn 待执行的函数

table.walk(hashTable, fn)

功能：对表中每个值执行一次指定的函数但不改变表内容。

table.walk(hashTable, fn)
@param table hashTable 待检查的表
@param function fn 待执行的函数

table.filter(hashTable, fn)

功能：对表中每个值执行一次指定的函数，若函数返回false则对应的值会从表中删除。

table.filter(hashTable, fn)
@param table hahsTable  待处理的表
@param function fn 待执行的函数

table.unique(hashTable)

功能：遍历表确保其值的唯一性

table.unique(hashTable)
@param table hashTable 待处理的表
@return table 包含具有唯一值的新表

string.htmlspecialchars(input)

功能：将特殊字符转换为HTML转义符

string.htmlspecialchars(input)
@param string input 待输入的字符串
@return string 转换结果

string.restorehtmlspecialchars(input)

功能：将HTML转义符还原为特殊字符，与string.htmlspecialchars()功能相反。

string.restorehtmlspecialchars(input)
@param string input 待输入字符串
@param string 转换的结果

string.nl2br(input)

功能：将字符串中的\n换行符转换为HTML标记<br/>。

string.nl2br(input)
@param string input 待输入字符串
@return string 转换结果

string.text2html(input)

功能：将字符串中的特殊字符和\n换行符转换为HTML转义符和标记。

string.text2html(input)
@param string input 待输入的字符串
@return string 转换结果字符串

string.split(input, delimiter)

功能：使用指定字符或字符串分隔输入字符串，返回包含分隔结果的数组。

string.split(input, delimiter)
@param string input 待输入的字符串
@param delimiter 分隔符
@return array

string.ltrim(input)

功能：去除输入字符串头部或左边的空白字符，空白字符包括空格、制表符\t、换行符\n，回首行符\r。

string.ltrim(input)
@param string input 待输入字符串
@return string

string.rtrim(input)

功能：去除输入字符串尾部或右边的空白字符

string.rtrim(input)
@param string input 待输入字符串
@return string

string.trim(input)

功能：去除字符串首位空白字符

string.trim(input)
@param string input
@return string

string.ucfirst(input)

功能：将字符串首字符转为大写

string.ucfirst(input)
@param string input 待处理输入
@return string

string.urlencode(input)

功能：将字符转换为符合URL传递规则的格式

string.urlencode(input)
@param string input 待输入字符串
@return string

string.urldecode(input)

功能：将URL中特殊字符还原并返回

string.urldecode(input)
@param string input 待输入字符串
@return string

string.utf8len(input)

功能：计算UTF8字符串的长度，其中每个中文占一个字符。

string.utf8len(input)
@param string input 输入字符串
@return integer 长度

string.formatnumberthousands(number)

功能：将数值格式化为包含千分位分隔符的字符串

string.formatnumberthousands(number)
@param number number 输入数值
@return string

cocos2dx

文件：quick-3.3\quick\framework\cocos2dx.lua
目录：quick-3.3\quick\framework\cocos2dx
功能：针对cocos2dx的封装和扩展

预定义节点事件

cc.NODE_EVENT

enter、exit等事件

cc.NODE_ENTER_FRAME_EVENT

帧事件

cc.NODE_TOUCH_EVENT

触摸事件

cc.NODE_TOUCH_CAPTURE_EVENT

捕获触摸事件

预定义层事件

cc.ACCELERATE_EVENT

重力感应事件

cc.KEYPAD_EVENT

硬件按键事件

预定义触摸模式

cc.TOUCH_MODE_ALL_AT_ONCE

多点触摸

cc.TOUCH_MODE_ONE_BY_ONE

单点触摸

device

文件：quick-3.3/quick/framework/device.lua
功能：提供设备属性的查询及设备功能的访问

属性

device.platform

功能：获取当前设备运行平台的名称，可用值为ios、android、mac、windows。

device.model

功能：获取设备型号，可用值为unknown、iphone、ipad。

device.language

功能：获取设备当前使用的语言

device.writablePath

功能：获取设备上可写入数据的首选路径

iOS 返回应用所在的Documents目录
Android 返回存储卡的根目录
其他平台的返回值由quick-x-player决定

device.cachePath

功能：获取设备上课写入数据的缓存目录

iOS 返回应用程序所在的Library/Caches目录
其他平台的返回值同device.writablePath

device.directorySeparator

功能：目录分隔符，在Windows平台是\，其他平台为/。

device.pathSeparator

功能：路径分隔符，在Windows平台是;，其他平台为:。

函数

divice.showActivityIndicator()

功能：显示活动指示器，在iOS和Android设备上显示系统的活动指示器，可用于阻塞操作时通知用户需要等待。

device.hideActivityIndicator()

功能：隐藏正在显示的活动指示器

device.showAlert(title, message, buttonLabels, listener)

功能：显示包含按钮的弹出对话框

device.showAlert(title, message, buttonLables, listener)
@param string title 对话框标题
@param string message 对话框内容
@param table buttonLabels 包含多个按钮标题的表对象
@param function listener 事件回调函数

device.cancelAlert()

功能：取消正在显示的对话框，取消对话框时不会执行显示对话框时指定的回调函数。

device.getOpenUDID()

功能：获取设备的OpenUDID值，OpenUDID是为设备仿造的UDID(唯一设备识别码)，用来识别用户的设备。

注意：

若删除了应用在重新安装，获得OpenUDID会发生变化。
iOS7不支持OpenUDID

device.getOpenUDID()
@return string 设备的OpenUDID值

device.openURL(URL)

功能：用浏览器打开指定网址

device.openURL(url)
@param string url 网址、邮件、拨号等字符串

device.showInputBox(title, message, defaultValue)

功能：显示一个输入框，并返回用户输入的内容。当用户点击取消按钮时，showInputBox()函数返回空字符串。

device.showInputBox(title, message, defaultValue)
@param string title 对话框标题
@param string message 对话框提示信息
@param string defaultMessage 输入框默认值
@return string 用户输入的字符串

transition

文件：quick-3.3\quick\framework\transition.lua
功能：为图像创造效果

函数

transition.newEasing(action, easingName, more)

功能：创建一个缓动效果

transition.newEasing(action, easingName, more)
@param Action action 动作对象
@param string easingName 缓冲效果的名字
@param mixed more 创建缓冲效果的参数
@return mixed

transition.create(action, args)

功能：创建一个动作效果

transition.create(action, args)
@param Action action 动作对象
@param table args 参数表对象
@return mixed

transition.execute(target, action, args)

功能：执行一个动作效果，可为原来单一的动作添加各种附加特性。

transition.execute(target, action, args)
@param cc.Node target 显示对象
@param Action action 动作对象
@param table args 参数表对象
@return mixed

参数表对象

delay 等待多长时间后开始执行动作
easing 缓动效果的名字及可选的附加参数，效果名字不区分大小写。
onComplete 动作执行完成后要调用的函数
time 执行动作需要的时间

transition.rotateTo(target, args)

功能：将显示对象旋转到指定角度，并返回Action动作对象。

transition.rotateTo(target, args)
@param cc.Node target 显示对象
@param table args 参数表对象
@return mixed

transition.moveTo(target, args)

功能：将显示对象移动到指定位置，并返回Action动作对象。

transition.moveTo(target, args)
@param cc.Node target 显示对象
@param table args 参数表
@return mixed

transition.moveBy(target, args)

功能：将显示对象移动一定距离，并返回Action动作对象。

transition.moveBy(target, args)
@param cc.Node target 显示对象
@param table args 参数表对象
@return mixed

transition.fadeIn(target, args)

功能：淡入显示对象，并返回动作对象。fadeIn淡入操作会首先将对象的透明度设置为0（0%，完全透明），然后再逐步增加到255（100%，完全不透明）。若不希望改变对象当前的透明，应使用fadeTo()。

transition.fadeIn(target, args)
@param cc.Node target 显示对象
@param table args 参数表对象
@return mixed

transition.fadeTo(target, args)

功能：将显示对象的透明度改变为指定值，并返回Action动作对象。

transition.fadeTo(target, args)
@param cc.Node target 显示对象
@param table args 参数表对象                                                                                 
@return mixed

transition.sequence(actions)

功能：创建一个动作序列对象

transition.sequence(actions)
@param table args 动作表对象
@return Sequence 动作序列对象

transition.playAnimationOnce(target, animation, removeWhenFinished, onComplete, delay)

功能：在显示对象上播放一次动画并返回Action动作对象

transition.playAnimationOnce(target, animation, removeWhenFinished, onComplete, delay)
@param cc.Node target 显示对象
@param cc.Node animation 动作对象
@param boolean removeWhenFinished 播放完后删除显示对象
@param function onComplete 播放完成后要执行的函数
@param number delay 播放前等待的时间
@return table

transition.playAnimationForever(target, animation, delay)

功能：在显示对象上循环播放动画并返回Action动作对象

transition.playAnimationForever(target, animation, delay)
@param cc.Node target 显示对象
@param cc.Node animation 动作对象
@param number delay 播放前等待的时间
@return table

transition.removeAction(action)

功能：停止一个正在执行的动作

transition.removeAction(action)
@param mixed target

transition.stopTarget(target)

功能：停止一个显示对象上所正在执行的动作
注意：显示对象的performWithDelay()是用动作来实现延时回调操作，若停止显示对象上的所有动作，会清除该对象上的延时回调操作。

transtion.stopTarget(target)
@param mixed target

transition.pauseTarget(target)

功能：暂停显示对象上所有正在执行的动作

transition.pauseTarget(target)
@param mixed target

transition.resumeTarget(target)

功能：恢复显示对象上所有暂停的动作

transition.resumeTarget(target)
@param mixed target

display

文件：quick-3.3\quick\framework\display.lua
功能：与显示图像、场景相关的功能，display模块封装了绝大部分与显示相关的功能，并负责根据config.lua中定义的分辨率设定计算屏幕的设计分辨率。

属性

display.sizeInPixels.width

屏幕的像素分辨率宽

display.sizeInPixels.height

屏幕的像素分辨率高

display.widthInPixels

屏幕的像素分辨率宽

display.heightInPixels

屏幕的像素分辨率高

display.contentScaleFactor

内容缩放因子

display.size.width

屏幕的设计分辨率宽

display.size.height

屏幕的设计分辨率高

display.width

屏幕的设计分辨率宽

display.height

屏幕的设计分辨率高

display.cx

屏幕中央的x坐标

display.cy

屏幕中央的y坐标

display.left

屏幕左边的坐标

display.top

屏幕上边的坐标

display.right

屏幕右边的坐标

display.bottom

屏幕底部的坐标

display.c_left

当父对象在屏幕中央时，屏幕左边的坐标。

display.c_top

当父对象在屏幕中央时，屏幕顶部的坐标。

display.c_right

当父对象在屏幕中央时，屏幕右边的坐标。

display.c_bottom

当父对象在屏幕中央时，屏幕下边的坐标。

颜色

display.COLOR_WHITE

白色cc.c3b(255,255,255)

display.COLOR_BLACK

黑色cc.c3b(0,0,0)

函数

display.newScene(name)

功能：创建一个新场景并返回Scene场景对象，指定场景时方便调试。

display.newScene(name)
@param string name 场景名称
@return Scence

display.newPhysicsScene(name)

功能：创建一个新场景并返回Scece场景对象，指定场景名称方便调试。

display.newPhysicsScene(name)
@param string name 场景名称
@return Scence

display.wrapSceneWithTransition(scene, transitionType, time, more)

功能：用场景切换过渡效果包装场景对象，并返回场景过渡对象。

display.wrapSceneWithTransition(scence, transitionType, time, more)
@param Scene scene 场景名称
@param string transitionType 过渡效果名称
@param number time 过渡时间
@param string more 过渡效果附加参数
@return Scene

过渡效果

crossFade 淡出当前场景的同时淡入下一个场景
fade 淡出当前场景到指定颜色，默认颜色为cc.c3b(0,0,0)，可用wrapSceneWithTransition()的最后一个参数指定颜色。
faseBL 从左下角开始淡出场景
fadeDown 从底部开始淡出场景
fadeTR 从右上角开始淡出场景
fadeUp 从顶部开始淡出场景
flipAngular 当前场景倾斜后翻转成下一个场景，默认从左边开始翻转，可指定为：
- cc.TRANSITION_ORIENTATION_LEFT_OVER 从左边开始
- cc.TRANSITION_ORIENTATION_RIGHT_OVER 从右边开始
- cc.TRANSITION_ORIENTATION_UP_OVER 从顶部开始
- cc.TRANSITION_ORIENTATION_DOWN_OVER 从底部开始
flipX 水平翻转，默认从左往右翻转。
flipY 垂直翻转，默认从上往下翻转。
zoomFlipAngular 倾斜翻转的同时放大
zoomFlipX水平翻转的同时放大
zoomFlipY 垂直翻转同时放大
jumpZoom 跳跃放大切换场景
moveInB 新场景从底部进入，现有场景同时从顶部退出。
moveInL 新场景从左侧进入，现有场景同时从右侧退出。
moveInR 新场景从右侧进入，现有场景同时从左侧退出。
moveInT 新场景从顶部进入，现有场景同时从底部退出。
pageTurn 翻页小工，附加参数为true表示从左侧往右翻页。
rotoZoom 旋转放大切换场景
shrinkGrow 收缩交叉切换场景
slideInB 新场景从底部进入，直接覆盖现有场景。
slideInL 新场景从左侧进入，直接覆盖现有场景。
slideInR 新场景从右侧进入，直接覆盖现有场景。
slideInT 新场景从顶部进入，直接覆盖现有场景。
splitCols 分成多列切换入新场景
splitRows 分成多行切换入新场景类似百叶窗。
turnOffTiles 当前场景分成多个块，主键替换为新场景。

display.replaceScene(newScene, transitionType, time, more)

功能：切换到新场景

display.replaceScence(newScene, transitionType, time, more)
@param Scene newScene 场景对象
@param string transitionType 过渡效果名称
@param number time 过渡时间
@param mixed more 过渡效果附加参数

display.getRunningScene()

功能：返回当前正在运行的场景对象

display.getRunningScence()
@return Scene

display.pause()

功能：暂停当前场景

display.resume()

功能：回复当前暂停的场景

display.newLayer()

功能：创建并返回一个Layer层对象，Layer层对象提供了触摸事件、重力感应、Android按键检测等功能。

display.newColorLayer(color)

功能：创建一个颜色填充层，LayerColor对象使用指定的颜色填充。

display.newColorLayer(color)
@param ccColor3B color
@return LayerColor

display.newNode()

功能：创建并返回一个Node对象，Node对象不能显示对象，但可作为其他显示对象的容器，起到群组的作用。

display.newNode()
@return Node

display.newClippingRegionNode(rect)

功能：创建并返回一个ClippingRegionNode对象，创建ClippingRegionNode对象时需指定一个屏幕区域，然后在显示时，所以加入ClippingRegionNode对象的内容都会进行剪裁，超出指定区域的内容不会显示。ClippingRegionNode的父对象其坐标必须是0,0。

display.newClippingRegionNode(rect)
@param table rect 指定的区域
@return ClippingRegionNode

display.newSprite(filename, x, y, params)

功能：创建并返回一个sprite精灵显示对象，有三种方式创建显示对象：

从图片文件创建
从缓存的图片帧创建
从SpriteFrame对象创建

如果指定了x，y参数，那么创建显示对象后会调用对象的 setPosition() 方法设置对象的位置。

display.newSprite(filename, x, y, params)
@param mixed filename 图像名称或SpriteFrame精灵帧对象
@param number x 
@param number y
@param table params
@return Sprite

display.newScale9Sprite(filename, x, y, size, capInsets)

功能：创建并返回一个Sprite9Scale显示对象，Sprite9Scale即九宫格图像，一个矩形图像被分为9部分，根据要求拉伸图像，同时保证拉伸后的图像四边不变形。

display.newScale9Sprite(filename, x, y, size, capInsets)
@param string filename 图像名称
@param number x
@param number y
@param table size
@return Sprite9Scale

display.newTilesSprite(filename, rect)

功能：创建并返回一个平铺的Sprite显示对象

display.newTilesSprite(filename, rect)
@param string filename 图像名称
@param cc.rect rect 平铺范围
@return Sprite

display.newTiledBatchNode(filename, plistFile, size, hPadding, vPadding)

功能：创建一个瓷砖贴图SpriteBatchNode，图像不是一个POT文件。

display.newTiledBatchNode(filename, plistFile, size, hPadding, vPadding)
@param mixed filename
@param string plistFile
@param size size
@param integer hPadding
@param integer vPadding
@return SpriteBatchNode

display.newMaskedSprite(mask, pic)

创建一个带蒙版的精灵

display.newMashedSprite(mask, picture)
@param string mask 裁剪形状的图片名称
@param string picture 被裁剪的图片名称
@return Sprite

display.newFilteredSprite(filename, filters, params)

创建一个过滤的精灵

display.newFilteredSprite(filename, filters, params)
@param string filename 
@param mixed filters
@param table params
@return FilteredSprite

display.newGraySprite(filename, param)

通过过滤的精灵创建一个灰色精灵

display.newGraySprite(filename, params)
@param mixed filename
@param table params
@return FilteredSprite

display.newDrawNode()

创建并返回空的DrawNode对象

display.newDrawNode()
@return DrawNode

display.newSolidCircle(radius, params)

创建并返回一个DrawNode实心圆对象

display.newSolidCircle(radius, params)
@param number radius 实心圆的半径
@param table params 创建圆的参数x，y为原点位置，color中圆的颜色。
@return DrawNode

display.newCircle(radius, params)

创建并返回一个DrawNode圆对象

display.newCircle(radius, params)
@param number radius 
@param table params
@return DrawNode

display.newRect(rect, params)

创建并返回一个DrawNode矩形对象

display.newRect(rect, params)
@param table rect
@param table params
@return DrawNode

display.newLine(points, params)

创建并返回一个DrawNode线性对象

display.newLine(points, params)
@param table point 
@param table params
@return DrawNode

display.newPolygon(points, params, drawNode)

创建并返回一个PolygonShape多边形对象

display.newPolygon(points, params, drawNode)
@param table points 包含多边形每个点坐标的表对象
@param number scale 缩放比例
@return DrawNode

display.newBMFontLabel(params)

display.newBMFontLabel(params)
@param table params
@return Label

使用位图字体创建文本显示对象，并返回Label对象。BMFont通常用于显示英文内容，因为英文字母加数字和常用符号不多，生成的BMFont文件较小。若是中文应使用TTFLabel。

可用参数

text 待显示的文本
font 字体文件名
align 文字的水平对齐方式
maxLineWidth 最大行宽
offsetX 图像的X偏移量
offsetY 图像的Y偏移量
x,y 坐标

display.newTTFLabel(params)

display.newTTFLabel(params)
@param table params 参数表对象
@return UILabel

使用TTF字体创建文字显示对象并返回Label对象。

可用参数

text 待显示的文本
font 字体名称，若是非系统自带的TTF字体，那么指定为字体文件名。
size 文字尺寸，因为是TTF字体，所以可任意指定尺寸。
color 文字颜色，用`cc.c3b()`指定，默认为白色。
align 文字的水平对其方式
valign 文字的垂直对其方式，仅指定了 dimensions 参数时有效。
dimensions 文字显示对象的尺寸，使用 cc.size() 指定。
x,y 坐标

align和valign参数可选值

cc.TEXT_ALIGNMENT_LEFT 左对齐
cc.TEXT_ALIGNMENT_CENTER 水平居中对齐
cc.TEXT_ALIGNMENT_RIGHT 右对齐
cc.VERTICAL_TEXT_ALIGNMENT_TOP 垂直顶部对齐
cc.VERTICAL_TEXT_ALIGNMENT_CENTER 垂直居中对齐
cc.VERTICAL_TEXT_ALIGNMENT_BOTTOM 垂直底部对齐

display.align(target, anchorPoint, x, y)

将指定的显示对象按照特定锚点对齐

display.align(target, anchorPoint, x, y)
@param Sprite target 显示对象
@param integer anchorPoint 锚点位置
@param integer x
@param integer y

显示对象锚点位置

display.CENTER 图像中央
display.LEFT_TOP
display.TOP_LEFT 图像左上角
display.CENTER_TOP
display.TOP_CENTER 图像顶部中间
display.RIGHT_TOP
display.TOP_RIGHT 图像顶部的中间
display.CENTER_LEFT
display.LEFT_CENTER 图像左边的中间
display.CENTER_RIGHT
display.RIGHT_CENTER 图像右边的中间
display.BOTTOM_LEFT
display.LEFT_BOTTOM 图像左边的底部
display.BOTTOM_RIGHT
display.RIGHT_BOTTOM 图像右边的底部
display.BOTTOM_CENTER
display.CENTER_BOTTOM 图像中间的底部

display.addSpriteFrames(plistFilename, image, handler)

将指定的SpriteSheets材质文件及其数据文件载入图像帧缓存

display.addSpriteFrames(plistFilename, image, handler)
@param string plistFilename 数据文件名
@param string image 材质文件名

SpriteSheets是包含多种图片的集合，SpriteSheets材质文件由多张图片组成，而数据文件则记录了图片在材质文件中的位置等信息。

display.removeSpriteFramesWithFile(plistFilename, imageFilename)

从内存中卸载 SpriteSheets材质和数据文件

display.removeSpriteFramesWithFile(plistFilename, imageFilename)
@param string plistFilename 数据文件名
@param string imageFilename 材质文件名

display.setTexturePixelFormat(filename, format)

设置材质格式，为节约内存，会使用一些颜色品质较低的材质格式，例如针对背景图使用cc.TEXTURE2_D_PIXEL_FORMAT_RGB565格式。

display.setTexturePixelFormat(filename, format)
@param string filename 材质文件名
@param integer format 材质格式

display.removeSpriteFrameByImageName(imageName)

从图像帧缓存中删除一个图像

display.removeSpriteFrameByImageName(imageName)
@param string imageName 图像文件名

display.newBatchNode(image, capacity)

从指定的图像文件创建并返回一个批量渲染对象

display.newBatchNode(image, capacity)
@param string image 图像文件名
@param integer capacity 
@return SpriteBatchNode

display.newSpriteFrame(frameName)

创建并返回一个图像帧对象

display.newSpriteFrame(frameName)
@param string frameName 图像帧名称
@return SpriteFrameCache

display.newFrames(pattern, begin, length, isReversed)

以特定模式创建一个包含多个图像帧对象的数组

display.newFrames(pattern, begin, length, isReversed)
@param string pattern 模式字符串
@param integer begin 起始索引
@param integer length 长度
@param boolean isReversed 是否是递减索引
@return table 图像帧数组

display.newAnimation(frames, time)

以包含图像帧的数组创建一个动画对象

display.newAnimation(frame, time)
@param table frames 图像帧的数组
@param number time 每帧动画之间的间隔时间
@return Animation

display.setAnimationCache(name, animation)

以指定名字缓存创建好的动画对象，以便后续反复使用。

display.setAnimationCache(name, animation)
@param string name 名字
@param animation Animation 动画对象

display.getAnimationCache(name)

获取指定名字缓存的动画对象，若不存在则返回nil。

display.getAnimationCache(name)
@param string name
@return Animation

display.removeAnimationCache(name)

删除指定名字缓存的动画对象

display.removeAnimationCache(name)
@param string name

display.removeUnusedSpriteFrames()

从内存中卸载没有使用SpriteSheets材质

display.removeUnusedSpriteFrames()

display.newProgressTimer(image, progressType)

创建一个进度条的节点

-- 进度条类型
display.PROGRESS_TIMER_BAR 环形
display.PROGRESS_TIMER_RADIAL

display.printscreen(node, args)

获取一个节点的纹理内容

保存节点的纹理到磁盘文件
以节点的纹理创建一个精灵并返回

注意：node的content size必须大于(0,0)，否则会收到错误信息。

LUAERROR:ASSERT FAILED ON LUA EXECUTE: Invalid size

display.printscreen(node, args)
@param Node node
@param table args 
@return FilteredSprite

filter

文件：quick-3.3/quick/framework/filter.lua
功能：滤镜功能

函数

filter.newFilter(filterName, param)

创建一个滤镜效果，并返回Filter场景对象。

filter.newFilter(filterName, params)
@param string filterName 滤镜名称
@param table params
@return Filter

filter.newFilters(filterNames, params)

创建滤镜数组并返回Filter的数组对象

filter.newFilters(filterNames, params)
@param table filterName 滤镜名称数组
@param table params 对应参数数组
@return Filters

audio

文件：quick-3.3\quick\framework\audio.lua
功能：播放音乐和音效

函数

audio.getMusicVolume()

返回音乐的音量值

audio.getMusicVolume()
@return number 返回值在0.0到1.0之间，0.0表示完全静音，1.0表示100%音量。

audio.setMusicVolume(volume)

设置音乐的音量

audio.setMusicVolume(volume)
@param number volume 音量在0.0到1.0之间，0.0表示完全静音，1.0表示100%音量。

audio.getSoundsVolume()

返回音效的音量值

audio.getSoundsVolume()
@return number 返回值在0.0到1.0之间，0.0表示是完全静音，1.0表示100%音量。

audio.setSoundsVolume(volume)

设置音效的音量

audio.setSoundsVolume(volume)
@param number volume 音量在0.0到1.0之间，0.0表示完全静音，1.0表示100%音量。

audio.preloadMusic(filename)

与载入一个音乐文件，在播放音乐前预先载入，可在需要播放音乐时无延迟立即播放。不过限于硬件设备和操作系统的限制，通常只能预载入一个音乐文件。

audio.preloadMusic(filename)
@param string filename 音乐文件名

audio.playMusic(filename, isLoop)

播放音乐，若音乐文件尚未载入，则会首先载入音乐文件，然后开始播放。
注意：即便音乐音量为0.0， audio.playMusic() 仍然会进行播放操作。若希望停止音乐降低CPU占用，应使用 audio.stopMusic() 接口完全停止音乐播放。

audio.playMusic(filename, isLoop)
@param string filename 音乐文件名称
@param boolean isLoop 是否循环播放，默认为true。

audio.stopMusic(isReleaseData)

停止播放音乐

audio.stopMusic(isReleaseData)
@param boolean isReleaseData 是否释放音乐数据，默认为true。

audio.pauseMusic()

恢复暂停的音乐

audio.rewindMusic()

从头开始重新播放当前音乐

audio.willPlayMusic()

检查是否可以开始播放音乐，若可以则返回true，若尚未载入音乐或载入的音乐格式不被设备所支持则返回false。

audio.isMusicPlaying()

检查当前是否正在播放音乐，若有音乐正在播放则返回true否则返回false。

audio.playSound(filename, isLoop)

播放音效并返回音效句柄，若音效尚未载入则会载入后开始播放，该方法返回的音效句柄用于 audio.stopSounds()、audio.pauseSound()等。

audio.playSound(filename, isLoop)
@param  string filename 音效文件名
@param boolean isLoop 是否重复播放，默认为false。
@return integer 音效句柄

audio.pauseSound(handle)

暂停指定的音效

audio.pauseAllSounds()

暂停所有音效

audio.resumeSound(handle)

恢复暂停的音效

audio.resumeAllSounds()

恢复所有的音效

audio.stopSound(handle)

停止指定的音效

audio.stopAllSounds()

停止所有音效

audio.preloadSound(filename)

与载入一个音效文件，可在进行场景前，载入该场景需要的所有音效，这样就不会因为首次播放某个未载入的音效，而导致游戏暂停执行。

audio.unloadSound(filename)

从内存卸载一个音效，退出场景时，可卸载掉只有该场景使用的音效，从而节约内存。

network

文件：quick-3.3\quick\framework\network.lua
功能：网络服务

函数

network.isLocalWiFiAvailable()

检查WIFI网络是否可用，WIFI网络可用不代表可以访问互联网。

network.isLocalWiFiAvailable()
@return boolean 网络是否可用

network.isInternetConnectionAvailable()

检查互联网连接是否可用，通常本接口返回3G网络的状态，具体情况与设备和操作系统有关。

network.isInternetConnectionAvailable()
@return boolean

network.isHostNameReachable()

检查是否可以解析指定的主机名，该接口会阻塞程序，因此在调用该接口时应提醒用户应用程序在一段时间内会失去响应。

network.isHostNameReachable(hostname)
@param boolean

network.getInternetConnectionStatus()

返回互联网连接状态值，状态值分为三种：

kCCNetworkStatusNotReachable 无法访问互联网
kCCNetworkStatusReachableViaWiFi 通过WIFI
kCCNetworkStatusReachableViaWWAN 通过3G网络

network.getInternetConnectionStatus()
@return string

network.createHTTPRequest(callback, url, method)

创建异常HTTP请求，返回cc.HTTPRequest对象。

network.createHTTPRequest(callback, url, method)
@return HTTPRequest

crypto

文件：quick-3.3\quick\framework\crypto.lua
功能：加密解密数据编码

函数

crypto.encryptAES256(plaintext, key)

使用AES256算法加密内容，AES256仅在iOS和MAC平台可用，加密解密尽量选择跨平台的XXTEA接口。

crypto.encryptAES256(plaintext, key)
@param string plaintext 明文字符串
@param string key 密钥字符串
@return string 加密后的字符串

crypto.decryptAES256(ciphertext, key)

使用AES256算法解密内容，AES256仅在iOS和MAC平台可用，加密解密尽量选择平台的XXTEA接口。

crypto.decryptAES256(ciphertext, key)
@param string ciphertext 加密后的字符串
@param string key 密钥字符串
@return string 明文字符串

crypto.encrypXXTEA(plaintext, key)

使用XXTEA算法加密内容

crypto.encryptXXTEA(plaintext, key)
@param string plaintext 明文字符串
@param string key 密钥字符串
@return string 加密后的字符串

crypto.decryptXXTEA(ciphertext, key)

使用XXTEA算法解密内容

crypto.decryptoXXTEA(ciphertext, key)
@param string ciphertext 加密后的字符串
@param string key 密钥字符串
@return string 明文字符串

crypto.encodeBase64(plaintext)

使用BASE64算法编码内容

crypto.encodeBase64(plaintext)
@param strign plaintext 源文字符串
@return string 编码后的字符串

crypto.decodeBase64(ciphertext)

使用BASE64算法解码内容

crypto.decodeBase64(ciphertext)
@param strign 源文字符串
@return string

crypto.md5(input, isRawOutput)

计算内容的MD5编码

crypto.md5(input, isRawOutput)
@param string input 内容字符串
@param boolean isRawOutput 是否返回二进制MD5编码
@return string MD5字符串

crypto.md5file(path)

计算文件的MD5编码

crypto.md5file(path)
@param string path 文件路径
@return string MD5字符串

json

文件：quick-3.3\quick\framework\json.lua

函数

safeLoad()

JSON编码与解码

json.encode(var)

将表格数据编码为JSON字符串

table 作为字典使用时，整型键值将被转换为字符串键值。
table 所有键值为整型时，会当做数组看待，空位将转化为null。

json.encode(var)
@param table var 表对象
@return string json 字符串

json.decode(text)

将JSON字符串解码为表格对象

json.decode(text)
@param string json字符串
@return table 表对象

luaj

文件：quick-3.3\quick\framework\luaj.lua
功能：Lua与Java的交互接口

函数

checkArguments(args, sig)

私有方法

luaj.callStaticMethod(classname, method, args, sig)

调用Java类的接口，只能调用Java类的静态方法。

luaj.callStaticMethod(classname, method, args, sig)
@param string classname Java类名
@param string method Java类静态方法名
@param table args Java类静态方法所需要的各种参数数组
@param [string sig] Java类方法的签名
@return boolean

luaoc

文件：quick-3.3\quick\framework\luaoc.lua
功能：Lua与Object-C的交互接口

函数

luaoc.callStaticMethod(classname, method, args)

调用Object-C类的接口，只能调用Object-C类的类方法。

luaoc.callStaticMethod(classname, method, args)
@param string classname Object-C类名
@param string method Object-C类方法名
@param table args Object-C类方法所需的各种参数字典key值为方法的参数名
@return boolean

ui

文件：quick-3.3\quick\framework\ui.lua
功能：创建和管理用户界面

函数

ui.newEditBox(params)

创建一个文字输入框，并返回后EditBox对象。

可用参数

image
输入框的图像，可以是图像名或是Sprite9Scale显示对象。用display.newScale9Sprite()创建 Sprite9Scale显示对象。
imagePressed
输入状态时输入框显示的图像
imageDisabled
禁止状态时输入框显示的图像
listener
回调函数
size
输入框的尺寸，用cc.size(width, height)创建
x,y

ui.newEditBox(params)
@param table params 参数表
@return EditBox 文字输入框

ui.newBMFontLabel(params)

用位图字体创建文本显示对象并返回LabelBMFont对象，BMFont通常用于显示英文内容，因为英文字母和数字和常用符号也不多，生成的BMFont文件较小。如果是中文应该是用TTFLabel。

可用参数

text 要显示的文本
font 字体文件名称
align 文字的水平对齐方式
x,y 坐标

ui.newBMFontLabel(params)
@param table params 参数表
@return LabelBMFont

ui.newTTFLabel(params)

使用TTF字体创建文字显示对象并返回LabelTTF对象。

ui.newTTFLabel(params)
@param table params 参数表
@return LabelTTF

可用参数

text 要显示的文本
font 字体名称，若是非系统自带的TTF字体则指定为字体文件名。
size 文字尺寸，因为是TTF字体，所以可以任意指定尺寸。
color 文章你颜色，用 cc.c3b() 指定，默认为白色。
align 文字的水平对齐方式
valign 文字的垂直对齐方式，仅在指定了dimensions 参数时有效。
dimensions 文字显示对象的尺寸，使用 cc.size() 指定。
x,y 坐标

ui.newTTFLabelWithShadow(params)

创建带阴影的TTF文字显示对象，并返回LabelTTF对象。相比ui.newTTFLabel()增加一个参数 shadowColor 阴影颜色，用 cc.c4b()指定，默认为黑色。

ui.newTTFLabelWithShadow(params)
@param table params 参数表
@return LabelTTF

ui.newTTFLabelWithOutline()

创建带描边效果的TTF文字显示对象，并返回LabelTTF对象。相对ui.newTTFLabel()增加一个参数 outlineColor 描边颜色，用cc.c4b()指定，默认为黑色。

ui.newTTFLabelWithOutline(params)
@param table params 参数表
@return LabelTTF

Shortcodes

文字：quick-3.3\quick\framework\shortcodes.lua

函数

Node:add(child, zorder, tag)

在当前接口中加入一个子节点

Node:add(child, zorder, tag)
@param node child 要加入的节点
@param number zorder 要加入节点的Z值
@param number tag 要加入节点的tag
@return node

Node:addTo(target, zorder, tag)

把当前节点作为一个子节点添加到target中

Node:addTo(target, zorder, tag)
@param node target 想作为其子节点的节点
@param number zorder 当前节点的Z值
@param number tag 当前节点的tag

Node:show()

显示当前节点，让当前节点可显示。

Node:show()
@return node 当前节点

Node:hide()

隐藏当前节点，让当前节点不可显示。

Node:hide()
@return node 当前节点

Node:pos(x, y)

设置当前节点的位置

Node:pos(x, y)
@param number x X值
@param number y Y值
@return node 当前节点

Node:scale(scale)

设置当前节点的缩放值

Node:scale(scale)
@param number scale 要缩放的值
@return node 当前节点

Node:rotation(r)

设置当前节点的旋转角度值

Node:rotataion(r)
@param number r 旋转角度r
@param node 当前节点

Node:size(width, height)

设置当前节点的大小

Node:size(width, height)
@param mixed width 宽度或cc.size表
@param number height 高度
@return node 当前节点

Node:opacity(opacity)

设置当前节点的透明度，0到255，0为完全透明。

Node:opacity(opacity)
@param number opacicty 透明度
@return node 当前节点

Node:zorder(z)

设置当前节点z值

Node:zorder(z)
@param number z z值
@return node 当前节点

Sprite:displayFrame(frame)

设置当前精灵的显示帧

Sprite:displayFrame(frame)
@param mixed frame 要显示的图片名或图片帧的frame
@return Sprite 当前精灵

Sprite:flipX(boolean)

在X方向上翻转当前精灵

Sprite:flipX(boolean)
@param boolean boolean 是否翻转
@return Sprite

Sprite:flipY(boolean)

在Y方向上翻转当前精灵

Sprite:flipY(boolean)
@param boolean boolean 是否翻转
@return Sprite

Layer:onTouch(listener)

在层上注册触摸监听

Layer:onTouch(listener)
@param function listener 监听函数
@return Layer 当前层

Layer:enableTouch(enabled)

设置层的触摸是否打开

Layer:enableTouch(enabled)
@param boolean enabled 是否打开触摸
@return Layer 当前层

Layer:onKeypad(listener)

在层上注册键盘监听

Layer:onKeypad(listener)
@param function listener 监听函数
@return Layer 当前层

Layer:enableKeypad(enabled)

设置层的键盘事件是否打开

Layer:enableKeypad(enabled)
@param boolean enabled 是否打开键盘事件
@param Layer 当前层

Layer:onAccelerate(listener)

在层上注册重力感应监听

Layer:onAccelerate(listener)
@param function listener 监听函数
@return Layer 当前层

Layer:enableAccelerometer(enabled)

设置层的重力感应事件是否打开

Layer:enableAccelerometer(enabled)
@param boolean enabled 是否打开加速度事件
@return Layer 当前层

Node:stop()

停止节点的所有动作

Node:stop()
@return node 当前节点

Node:fadeIn(time)

渐显动画

Node:fadeIn(time)
@param number time 渐显事件
@return node 当前节点

Node:fadeOut()

渐隐动画

Node:fadeOut(time)
@param number time 渐隐时间
@return node 当前节点

Node:fadeTo(time, opacity)

渐变到一个固定透明度

Node:fadeTo(time, opacity)
@param time 渐变时间
@param opacity 最终的透明度
@return node 当前节点

Node:moveTo(time, x, y)

在一段时间内移动节点到特定位置

Node:moveTo(time, x, y)
@param number time 移动时间
@param number x 要移动到的x点
@param number y 要移动到的y点
@return node

Node:moveBy(time, x, y)

在一段时间内移动相对位置

Node:moveBy(time, x, y)
@param number time 移动时间
@param number x 要移动的相对x值
@param number y 要移动的相对y值
@return node

Node:rotateTo(time, rotation)

在一段时间内旋转的角度

Node:rotateTo(time, rotation)
@param number time 移动时间
@param number rotation 旋转的角度
@return node 当前节点

Node:rotateBy(time, rotation)

在一段时间内旋转的相对角度

Node:rotateBy(time, rotation)
@param number time 移动时间
@param number rotation 旋转的相对角度
@return node 当前节点

Node:scaleTo(time, scale)

在一段时间内缩放

Node:scaleTo(time, scale)
@param number time 移动时间
@param number scale 缩放的值
@return node 当前节点

Node:scaleBy(time, scale)

在一段时间内的相对缩放

Node:scaleBy(time, scale)
@param number time 移动时间
@param number scale 相对缩放的值
@return node 当前节点

Node:skewTo(time, sx, xy)

在一段时间内倾斜的大小

Node:skewTo(time, sx, sy)
@param number time 移动时间
@param number sx 倾斜的x值
@param number sy 倾斜的y值
@return node 当前节点

Node:skewBy(time, sx, sy)

在一段时间内倾斜的相对大小

Node:skewBy(time, sx, sy)
@param number time 移动时间
@param number sx 倾斜的相对x值
@param number sy 倾斜的相对y值
@return node 当前节点

Node:tintTo(time, r, g, b)

在一段时间内染色

Node:tintTo(time, r, g, b)
@param number time 移动时间
@param number r 染色的R值
@param number g 染色的G值
@param number b 染色的B值
@return node 当前节点

Node:tintBy(time, r, g, b)

在第一段时间内相对染色

Node:timeBy(time, r, g, b)
@param number time 移动时间
@param number r 染色的相对R值
@param number g 染色的相对G值
@param number b 染色的相对B值
@return node 当前层

scheduler

文件：quick-3.3\quick\framework\scheduler.lua
功能：全局计时器、计划任务，该模块在框架初始化是不会自动载入的。
载入：local scheduler = require(cc.PACKAGE_NAME..".scheduler");

函数

scheduler.scheduleUpdateGlobal(listener)

计划一个全局帧事件回调，并返回该计划的句柄。

全局帧事件在任何场合中都会执行，因此可以再整个应用程序范围内实现较为精准的全局计时器。
该函数返回的句柄用作scheduler.unscheduleGlobal()的参数，可以取消指定的计划。

scheduler.scheduleUpdateGlobal(listener)
@param function listener 事件回调函数
@return mixed schedule 句柄

scheduler.scheduleGlobal(listener, interval)

计划一个以指定时间间隔执行的全局事件回调，并返回该计划的句柄。

scheduler.scheduleGlobal(listener, interval)
@param function listener 回调函数
@param number interval 间隔时间
@return mixed schedule 句柄

scheduler.unscheduleGlobal(handle)

取消一个全局计划， scheduler.unscheduleGlobal()的参数是scheduler.scheduleUpdateGlobal() 和 scheduler.scheduleGlobal()是返回值。

scheduler.unscheduleGlobal(handle)
@param mixed schedule句柄

scheduler.performWithDelayGlobal(listener, time)

计划一个全局延时回调，并返回该计划的句柄。scheduler.performWithDelayGlobal()会在等待指定时间后执行一次回调函数，然后自动取消该计划。

scheduler.performWithDelayGlobal(listener, time)
@param function listener 回调函数
@param number time 延迟事件
@return mixed schedule句柄