# Cocos2d-js-Module

**Repository Path**: Levil/Cocos2d-js-Module

## Basic Information

- **Project Name**: Cocos2d-js-Module
- **Description**: 基于Cocos2d-js游戏引擎的轻量级JavaScript模块化开发解决方案。让Cocos2d-js项目拥有类似C++的#include、Lua的require的功能。
- **Primary Language**: JavaScript
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 17
- **Forks**: 6
- **Created**: 2015-03-29
- **Last Updated**: 2025-02-14

## Categories & Tags

**Categories**: game-dev

**Tags**: None

## README

#Cocos2d-js-Module

基于Cocos2d-js游戏引擎的轻量级JavaScript模块化开发解决方案。让Cocos2d-js项目拥有类似C++的#include、Lua的require的功能。

#使用方法
在Cocos2d-js项目的src文件夹中添加module.js文件，在main.js开头添加如下代码

require("src/module.js");

这样即可使用Module提供的模块化编程功能。

#API
#load(name, func)
添加一个模块，第一个参数name代表模块的名称（模块名必须和文件路径保持一致，在module.js文件顶部添加了文件搜索路径"src/"，所以模块名称省略掉开头的"src/"），第二个参数func是添加模块时调用的函数，func的返回值就是模块。

// Example  
load("app/GameScene", function(){ 

    var GameScene = cc.Scene.extend({});  
    return GameScene;   // return the module
    
})

#include(name)
获取一个模块，name是该模块的名称，模块名称应该和文件路径保持一致。

// Example  
var GameScene = include("app/GameScene");

#dumpModuleInfo()
打印日志，显示当前所有已经加载过的模块，方便调试。

// Example  
dumpModuleInfo();   // print the loaded modules

#查看例子
理论上2.x或3.x版本的Cocos2d-js都可以使用Module。Git中Module的例子是基于Cocos2d-js 3.x版本的。

查看3.x版本例子的方法：新建一个Cocos2d-js项目，用git上的代码覆盖项目中的文件即可。

更多内容可以查看Blog: http://blog.csdn.net/levildo/article/details/44709971

下一步要修改模块代理的生成，每个模块仅生成一个代理