Skip to content

daichangxin/gen-package-defines-plugin

Repository files navigation

gen-package-defines-plugin

将包中设置为“导出”的组件导出interface定义。适合typescript项目,如Egret、Laya、CocosCreator...

仅支持FairyGUI-Editor2020版本,之前的版本插件请前往:https://github.com/daichangxin/AutoGenerateCodePlugin

使用

使用Fairy Editor,将整个目录复制到项目的插件目录。

代码做处理,主要是在创建组件时将子对象抽出来方便获取。

代码导出风格如下:

1、每个fairygui的包,导出对应一个文件,如包名为farm,则导出的文件是${设置的导出目录}/farm.ts

2、为了方便区分定义导出,所有文件默认添加declare namespace c作为命名空间。

3、例子

export interface itemCountUI {
    txt_count: fgui.GTextField;
}

export interface dele_plantItem {
    state: fgui.Controller;
    bg: fgui.GLoader;
    btn_plant: fgui.GButton;
    txt_time: fgui.GTextField;
    txt_reward: fgui.GTextField;
    btn_vipPlant: fgui.GButton;
    itemCountUI: fgui.GComponent & { $skin: itemCountUI };
    icon_crop: fgui.GLoader;
    beanIcon: fgui.GImage;
}

其中,dele_plantItem是设置为导出类型的自定义组件,组件的子对象itemCountUI也是一个自定义组件,虽然未设置导出,但因为被引用到也会被导出出来。