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文件的函数。逻辑代码的核心部分在init和createFile中。