outline-组件化cocos2dx的插件

思路

项目托管地址。c++版已不再维护。

写这个插件原本是为了填补官方的空缺,当时公司项目的cocos2d版本是3.10。对我来说,用studio有点过时,而用官方的creator_to_cocos2dx插件,最低只支持到cocos2d-3.14。抱着just for fun的心态,就写了这个creator插件。

导出代码的想法并不是因为我不想学静态文件的组织与编解码,而是一闪而过的念头。当时我的工作主要是写UI,我经常遇到思虑疲乏时,通过字符串标记来获取节点变得很吃力的情况,而且容易打断思维。另外我也知道,进行android开发时,会自动生成资源的映射代码,配合代码提示各种爽。所以我便萌生了导出代码的念头,把节点的层级关系,直接暴露在ide的代码提示之下,这样程序员就可以借代码提示来逐层检索节点。当然,导出代码还有其它的好处。比如使得控件的定义更加灵活,当要使用creator中不支持的控件时,可以使用creator中相似的控件代替之,然后再在导出的文件中重写这个节点的构建函数,就能依然保持所见即所得的编辑效果

导出自定义组件的想法也是由生活所迫,因为经常写UI,我已经受够了在代码中加一些UI相关的参数了,这个参数是指手上的牌与牌之间的间距该多大,那个参数是指打出牌的间距等等,为它们取个名字就够我伤脑筋的了,更何况它们会使我的代码的UI与逻辑分割变得不严谨,代码也变得难懂。或许这只是我的强迫症,但是如果把这些参数都在creator中设置,并且导出后位于它所描述的node上,还能通过代码提示检索它,这样岂不更清净?所以这里导出的自定义组件,我主要是作为UI数据编辑器来用的。

主要让outline展现出组件化思想的(这里的组件化指的是react.js提出的组件化),是它导出的是节点,而不是场景,围绕导出的节点形成组件,再由多个这样的组件形成更大的组件;另一方面,配合节点能够附加creator自定义组件的特性,model和view的分割更加彻底。

Hello,world

假设你已经有一定的creator基础,在创建一个creator项目前需要取消自动剪裁(文末有具体提示)。之后在creaor中编辑好一个包含Hello,world的creator项目。另外创建并编译好一个cocos2dx-lua的项目(姑且把它放到f盘下并取名proj_cocos2d_lua),那么以下操作将会为creator项目安装outline插件,并把creator项目中的Hello,world界面导出到cocos2dx-lua项目中。
1、克隆仓库:

    git clone https://github.com/limall/outline.git

2、找到项目根目录下的ccc-plugin文件夹,把它复制到你的creator项目的packages目录中,为了和其他插件区别将复制过来的文件夹重命名为"outline":


复制outline项目根目录下的ccc-plugin文件夹
creator项目根目录下的packages目录

3、重新打开creator项目,会发现资源管理器中多了几个脚本:


安装了插件后资源管理器中会出现几个脚本

拖动ExportRule脚本至层级管理器的Canvas节点中,结果如下:


拖动后自动生成ExportRule节点

再点击生成的ExportRule节点,来设置一个导出的规则,如图:


ExportRule的属性

以下是每个属性的含义:

Rule Name:这个导出规则的代号  
Src_Node:需要导出的节点
Dst Path:导出文件的路径和名称
Exclude Nodes:排除不想导出的子节点
Use World Position:导出的节点是否使用世界坐标系
Namespace:导出的节点模板所挂载到的全局变量名
res_dst:导出资源文件的位置

4、设置好了ExportRule后,按Ctrl+s保存下项目,接着点击菜单栏中的outline>>export-node:

点击outline>>export-node

接着会弹出ExportRule选择框,如图:
ExportRule选择框

选中之前设置的helloworld,点击导出,如果导出成功,会在控制台输出成功导出信息,如图:
控制台输出成功导出信息

5、在cocos2d lua端(下文简称lua端)添加并初始化解析代码:

  • 将插件根目录下的lua-interpret目录复制到lua端项目中,这里将复制好的目录改名为"outline";
  • 引用outline目录下的outline.lua文件。
  • 引用outline.lua文件之后,调用outline_global.init(src)函数,参数src为outline目录相对于search path的路径。
  • 假设把文件都复制到search path目录下的outline目录中,那么初始化解析模块的参考代码如下:
require("outline.outline")
outline_global.init("outline.")

通常这些初始化的代码将放到main.lua中。
6、编辑***\MainScene.lua,先在文首导入我们刚刚导出的文件:

require "app.views.node_helloworld.lua"

再在onCreate函数中添加如下代码即可:

O.MainNode:create(self)

改好的代码如图:


改好的MainScene.lua代码

其中O是在ExportRule中设置的全局变量,MainNode则是导出的节点的名称。
如果你用vs2015编辑,并且已经配置好BabelLua,那么键入"O."时便会出现MainNode的代码提示了。
最后,运行效果如下:


运行结果s

注意

  • 记得将config.lua中的CC_DISABLE_GLOBAL设为false来准许定义全局变量,否则会出错。
  • 使用creator创建项目前,需要在creator偏好设置中将导入图片时自动裁剪取消勾选(如下图),否则会因为creator在导入图片时自动裁剪,导致导出到cocos2d-x时位置出现偏差。


    QQ截图20180402165743.png
  • creator在导出node前必须先要保存scene
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 199,340评论 5 467
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 83,762评论 2 376
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 146,329评论 0 329
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 53,678评论 1 270
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 62,583评论 5 359
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 47,995评论 1 275
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,493评论 3 390
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,145评论 0 254
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,293评论 1 294
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,250评论 2 317
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,267评论 1 328
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,973评论 3 316
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,556评论 3 303
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,648评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,873评论 1 255
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,257评论 2 345
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 41,809评论 2 339

推荐阅读更多精彩内容