FairyGUI为UI导出Lua代码

前段时间了解了一下tolua在unity3d中的使用,因为使用了FairyGUI来编辑游戏中需要的UI,正好FairyGUI也能支持在tolua中使用,所以有了让FairyGUI编辑器为UI生成lua代码的需求。

首先表达一个观点:FairyGUI编辑器为UI生成代码非必要,但确实是有用的(如果还没看过FairyGUI为UI生成的代码,建议先依照FairyGUI教程做个demo试试看)。

有了UI的代码之后,在编辑代码时编辑器能够提示出当前UI对象有哪些组件可以被访问到,而不必去调用GetChild( chileName )来获得子组件(因为childName是字符串,往往比较容易写错,而且首先你必须知道你需要的子组件的名字。对于多人联合开发来说,这需要每个人都持有这个UI工程,并且能在FairyGUI编辑器中打开查看组件内容),不论是C#这种强类型语言,还是lua这种弱类型语言。

在讨论群里提问被怼很伤:你不需要为UI导出lua代码;你不需要在lua中创建UI。

回归正题。

这个插件我放到了git上,地址在这里https://github.com/qufangliu/Plugin_FairyGUI_Lua

主要参考内容:
FairyGUI讨论1群里共享的Plugin,这是社区中的问答
FairyGUI编辑器插件如何写


直接上手使用

首先你要去git上下载这个插件,这个仓库中包括了插件源码直接可以导入编辑器的插件,仔细阅读readme.txt文件,里面写了详细步骤。

我这里使用的是Mac,在Windows上应该差不多。

  1. 找到FairyGUI编辑器的代码模板目录,在Mac上是:/Applications/FairyGUI-Editor.app/Contents/Resources/template,将下载的template/Lua目录拷贝到编辑器的模板目录中(原本是没有Lua目录的,如果你已经有了,可以把原有的改名备份一下)。

    拷贝代码模板

  2. 打开FairyGUI编辑器的插件目录,可以从编辑器的工具->插件管理->打开插件目录...打开,也可以直接打开/Applications/FairyGUI-Editor.app/Contents/Resources/plugins,将下载的bin/FairyGUILuaGen.swc拷贝到目录中,并重新打开FairyGUI编辑器,或者点击“插件管理器”的“重新载入”。

    导入插件

  3. 在FairyGUI编辑器中点击文件->项目设置->自定义属性,添加如下两条属性:
    gen_lua = true
    lua_class_prefix = UI_

    项目设置

然后按照正常流程,配置好项目的发布设置之后,点击“发布”按钮即可。


导出的代码是怎样的

一个测试demo的导出代码

如何使用导出的Lua代码(在lua中创建UI)

当然,首先你要配置好相关的环境,在Unity3d接入tolua+fairyGUI+StrangeIOC中我有说明。

然后通过以下lua代码创建UI:

require("FairyGUI")
-- 引入Binder文件,Binder文件将导出的UI“类”注册到FairyGUI中
require('DemoBinder')

-- UI所在的包名
UIPackageName = "Demo"

function CreateFairyGUI(uiName)
    -- 创建UI(不是直接调用UI“类”的ctor函数,也不是调用new)
    local view = UIPackage.CreateObject(UIPackageName, uiName)
    -- 将UI添加到GRoot
    GRoot.inst:AddChild(view)

    return view
end

这个过程可能是你会从C#中调用这个创建方法,获取到返回的UI对象,然后在C#中对这个UI进行AddComponent等操作,后续的操作与从C#中创建的UI对象的操作相同。


关于插件的编辑,因为没有做过as项目,我踩了一些坑:

  1. 我看了社区问答,使用了FlashBuilder4.7来编辑插件,结果发现根本运行不起来。后来找大佬帮忙看了,改用IntelliJ IDEA 2018.1.4来编辑。
  2. 没有在原Plugin项目上编辑,而是新建了一个AS项目(ActionScript library for desktop (Adobe AIR)),项目依赖了Flex SDK 4.6.0,下载地址
  3. 关于FairyGUI插件的编辑,没有找到什么教程。纯粹是根据FairyGUI-Plugin-Demo中的示例,以及接口中的注释来看的,由于想了解IPublishData中包含的数据,我写了个打印log到本地log.txt文件的函数。逻辑代码的核心部分在initcreateFile中。
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 157,198评论 4 359
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 66,663评论 1 290
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 106,985评论 0 237
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 43,673评论 0 202
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 51,994评论 3 285
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,399评论 1 211
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,717评论 2 310
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,407评论 0 194
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,112评论 1 239
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,371评论 2 241
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 31,891评论 1 256
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,255评论 2 250
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 32,881评论 3 233
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,010评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,764评论 0 192
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,412评论 2 269
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,299评论 2 260

推荐阅读更多精彩内容