Egret Start

小游戏开发必读

  1. 因为rawinflate这个库在小游戏平台有问题,所以直接不使用它。请使用最新编辑器,发布时勾选“不压缩描述文件”就可以了。rawinflate这个库就不会再引用到(也不需要打包了)。
  2. 小游戏不支持fui扩展名,所以在发布界面要把扩展名修改成小游戏支持的扩展名(自己查阅小游戏文档)。代码里不需要改任何东西,因为扩展名是在default.res.json里使用的。
  3. 在scripts/wxgame/wxgame.ts里,在适当的地方加上:

    if(filename == "libs/fairygui/fairygui.js" || filename == "libs/fairygui/fairygui.min.js") {
    content += ";window.fairygui = fairygui;";
    }
  4. AddPackage有两种方式,一种是传统的传入文件名方式,另一种是直接传入fui整个文件的内容,也就是说不管你内容是从哪里来的。两种方式可以按需选择。

  5. 如果遇到加载失败,请检查egret的加载流程。因为FairyGUI不负责加载,你需要确保资源已经顺利加载了再AddPackage。
  6. 在发布对话框,全局设置里,勾选“使用二进制格式”。

Egret 4.x

  1. 将FairyGUI库以及依赖的rawinflate库拷贝到libs目录。(如果你在编辑器发布时没有勾选压缩描述文件,那么这个库是不需要的)。

  2. 在index.html里添加上述两个库的引用。

    注:FairyGUI只依赖egret的core和res两个模块,不需要gui和eui。

  3. 使用FairyGUI编辑器完成UI编辑。发布目录请选择Egret工程的resource/assets目录。发布后得到两个(或以上)文件。

  4. 在default.res.json里,将上述的文件添加到定义中。扩展名为fui文件,类型请选择为bin。注意:Egret自动检测添加的资源,名称通常会自动加上下划线和后缀,例如basic.fui,名称自动设置为“basic_fui”,这里我们要手动将_fui去掉,名称只需要为“basic”。

    资源一般都加到preload组里,如果你是高阶玩家,也可以试试动态加载。确保在使用到相应的元件前加载好就行。

  5. 在代码里完成规定的初始化,例如设定默认字体,滚动条等等。

    /**
    * 创建游戏场景
    * Create a game scene
    */
    private createGameScene():void {
    fairygui.UIPackage.addPackage("basic");
    fairygui.UIConfig.defaultFont = "宋体";
    fairygui.UIConfig.verticalScrollBar = fairygui.UIPackage.getItemURL("Basic", "ScrollBar_VT");
    fairygui.UIConfig.horizontalScrollBar = fairygui.UIPackage.getItemURL("Basic", "ScrollBar_HZ");
    fairygui.UIConfig.popupMenu = fairygui.UIPackage.getItemURL("Basic", "PopupMenu");
    fairygui.UIConfig.buttonSound = fairygui.UIPackage.getItemURL("Basic","click");
    this.stage.addChild(fairygui.GRoot.inst.displayObject);
    this.mainPanel = new MainPanel();
    }

如果出现“fairygui not defined”的错误,请再一次检查index.html里是否有fairygui.js的引用。

Egret 5.x

步骤与4.x的基本一样,不过不再需要在index.html文件里添加fairygui和rawinflate的引用。你只需要以下这个步骤:

  1. 复制一份rawinflate.min.js,并改名为rawinflate.js。(如果你在编辑器发布时没有勾选压缩描述文件,那么这个库是不需要的)。
  2. 在egretProperties.json文件中添加:

    {
    "name": "rawinflate",
    "path": "./libs/rawinflate"
    },
    {
    "name": "fairygui",
    "path": "./libs/fairygui"
    }