docs/api/index.html

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>quick-cocos2d-x v3 API Documents - init</title>
<link rel="stylesheet" href="luadocx-style.css" type="text/css" />
<link rel="stylesheet" href="luadocx-style-monokai.css" type="text/css" />
<script src="luadocx-highlight.min.js"></script>
<script type="text/javascript" charset="utf-8">hljs.initHighlightingOnLoad();</script>
</head>
<body>
  <div id="container">

    <table id="main">
      <tr>
        <td id="navigation">

          <h2>Links</h2>
          <ul>
            <li><a href="index.html">Index</a></li>
          </ul>

          <h2>Modules</h2>
          <ul>
            <li><a href="audio.html">audio</a></li>
            <li><a href="cocos2dx.html">cocos2dx</a></li>
            <li><a href="crypto.html">crypto</a></li>
            <li><a href="debug.html">debug</a></li>
            <li><a href="device.html">device</a></li>
            <li><a href="display.html">display</a></li>
            <li><a href="filter.html">filter</a></li>
            <li><a href="functions.html">functions</a></li>
            <li><strong>init</strong></li>
            <li><a href="json.html">json</a></li>
            <li><a href="luaj.html">luaj</a></li>
            <li><a href="luaoc.html">luaoc</a></li>
            <li><a href="network.html">network</a></li>
            <li><a href="scheduler.html">scheduler</a></li>
            <li><a href="shortcodes.html">shortcodes</a></li>
            <li><a href="transition.html">transition</a></li>
            <li><a href="ui.html">ui</a></li>
          </ul>

        </td> <!-- navigation -->

        <td id="content">

          <!-- BEGIN module doc -->

          <div id="module_doc">

<h1>init</h1>

<p>quick framework 初始化</p>

<p>载入 quick framework 预定义的常量、模块。</p>

<h3>常量</h3>

<p>在初始化框架之前，可以定义以下常量：</p>

<ul>
<li><p>DEBUG: 设置框架的调试输出级别</p>

<pre><code class="lua">DEBUG = 0           -- 不输出任何调试信息（默认值）
DEBUG = 1           -- 输出基本的调试信息
DEBUG = 2           -- 输出详细的调试信息
</code></pre></li>
<li><p>DEBUG_FPS: 设置是否在画面中显示渲染帧率等信息</p>

<pre><code class="lua">DEBUG_FPS = false   -- 不显示（默认值）
DEBUG_FPS = true    -- 显示
</code></pre></li>
<li><p>DEBUG_MEM: 设置是否输出内存占用信息</p>

<pre><code class="lua">DEBUG_MEM = false   -- 不输出（默认值）
DEBUG_MEM = true    -- 每 10 秒输出一次
</code></pre></li>
<li><p>LOAD_DEPRECATED_API: 是否载入过时的 API 定义，默认为 false</p></li>
<li><p>DISABLE_DEPRECATED_WARNING: 使用过时的 API 时是否显示警告信息，默认为 true</p></li>
<li><p>USE_DEPRECATED_EVENT_ARGUMENTS: 是否使用过时的 Node 事件参数格式，默认为 false</p></li>
</ul>

<p><br /></p>

<h3>自动载入的模块</h3>

<p>框架初始化时，会自动载入以下基本模块：</p>

<ul>
<li>debug: 调试接口</li>
<li>functions: 提供一组常用的函数，以及对 Lua 标准库的扩展</li>
<li>cocos2dx: 对 cocos2d-x C++ 接口的封装和扩展</li>
<li>device: 针对设备接口的扩展</li>
<li>transition: 与动作相关的接口</li>
<li>display: 创建场景、图像、动画的接口</li>
<li>filter: 具备过滤器渲染的 Sprite 接口</li>
<li>audio: 音乐和音效的接口</li>
<li>network: 网络相关的接口</li>
<li>crypto: 加密相关的接口</li>
<li>json: JSON 的编码和解码接口</li>
<li>luaj: 提供从 Lua 调用 Java 方法的接口（仅限 Android 平台）</li>
<li>luaoc: 提供从 Lua 调用 Objective-C 方法的接口（仅限 iOS 平台）</li>
<li>cc: quick 框架扩展的基础类和组件</li>
</ul>

          </div>

          <!-- END module doc -->


      </td> <!-- id="content" -->

      </tr>
    </table> <!-- id="main" -->

    <div id="about">
      <i>update: 2014-09-19 16:07:27, generated by <a href="http://github.com/dualface/luadocx">luadocx 1.3</a></i>
    </div> <!-- id="about" -->

  </div> <!-- id="container" -->

</body>
</html>