laya

仿 vue angular 做的个小项目， 形似神不似。使用 webapp 那套思想来做游戏开发试一试。

phaser游戏引擎中提供的 DisplayObject 类对象作为标签类的实现， 使用 html 模板的方式封装成组件， 以组件为
基本单位来组织项目结构， 重用代码。 组件提供了 MVVM 框架类似的数据绑定， 结合事件系统和 redux 的状态管理， 可以
深度解耦各个组件之间的依赖， 便于调试，维护和做单元测试。

组件

一个完整的组件定义如下：

@component({
  template: `
    <container l-bind-visible="GAME_STATE === 'ETC'">
        <integer-bitmap-text font="'numbers'" x="creditPosition.x" 
                             y="creditPosition.y" size="size"
                     anchor-x="0.5" anchor-y="0.5" l-bind-text="creditValue">
        </integer-bitmap-text>
    </container>
  `,
   injector: {
      GAME_STATE
   },
   name: 'ScoreBoard'
})
export default class ScoreBoard extends layaAbstract.AbstractComponent {
  @data
  private betValue = 0;
  @prop
  private creditPosition; 
  @prop
  private size;
  @getter('scoreBoard.creditValue')
  private creditValue;
  // ...

  $$init() {
    // ...
  }

  $$create() {
    // ...
  }

  @watch(['creditValue'])
  creditValueHandler() {
    // ...
  }
}

component 注解标注该类是一个组件类， 要作为一个组件使用，该类还必须继承自 AbstractComponent 类。 注解接受一个 ComponentLike 类型的参数：

interface ComponentLike {
    template: string,
    injector?: any,
    name: string
}

template 属性的是该组件的 HTML 模板。
injector 用于注入 组件实例上下文之外的变量， 用于在模板中直接访问。
name 组件的名称，这个必须和组件类类名相同。

模板就和 MVVM 框架中的模板一样， 只不过没用浏览器提供的那些标签了， 都是 phaser 提供的 DisplayObject 。

<container>标签对应于 phaser.Group 类(稍后会列出完整的可用标签列表)，为了忘记 phaser 和替换引擎所
以换了名字。标签中的属性都是 phaser.Group 类对象的属性， 给属性赋值就是给那些类对象赋值。属性可以用字面量
赋值 font="'numbers'" anchor-x="0.5" 注意字符串字面量要加上单引号， 也可以用当前组件的响应式属性赋值
x="creditPosition.x" creditPosition 就是标记为 @getter 的响应式属性， 这个属性的值来自于 redux 保存
的 state 对象。注意虽然属性是响应式的， 但是并没有使用 l-bind 指令， 因此页面并不会动态改变， 只是在第一次
创建这个组件的时候用到 creditPosition.x 的值。而 l-bind-text="creditValue" 这样为标签的 text 属性做
了绑定后，界面就会动态响应 creditValue 值的变化。

响应式属性

响应式属性就是在属性值变化时， 响应式系统可以感知到的属性。这种属性由类的成员变量添加注解来指明， 一共有三中
注解：

• data 用于标注一个响应式属性， 该属性只能在组件内部才能访问得到， 并且可以自由赋值, 注意虽然有 TS 的private
  限制， 但是 js 这种灵活的语言还是可以在组件外部使用某些方法访问和修改该属性， 但是不要这样做。
• prop 表示该属性的值是由父组件传进来的，虽然（暂时）可以修改，但是在组件内部不要试图修改这个值，否则会造成数
  据流向不清楚，调试困难。
• getter 这种属性的值是由 redux 管理的 state 中取到的，取值方式是给注解传入一个路径字符串， 从根路径开始一路
  引用到需要的属性。getter 属性不能赋值，只能由 redux 的 action 触发修改。

指令

指令也是照搬的 vue 和 angular 的概念。指令用来给标签实例添加功能。
指令的形式： l-[名称]-[参数] = "[表达式]", 参数可以没有，表达式可以是任何有效的 JavaScript 表达式， 表达式
中只能访问到组件实例的属性值和基本类型的字面量，只支持一个方法调用 bind 方法。
一共内置了 6 种指令：

• l-bind  将标签类的属性绑定到表达式的值，使标签类自动响应表达式值的变化。指令的参数就是要绑定的属性。
  l-bind-visible = " test "，当 test 为 true 时， 该标签实例才可见。还有 l-bind-x, l-bind-key等等，关于哪
  些属性可以绑定，在标签一节中详细说明。
• l-ref  使得 component 实例可以通过 this.$$refs.xxx 访问到标签类的实例。例如： 模板中定义 l-ref="'reelSound' + reelIndex"

<sound-task l-ref="'reelSound' + reelIndex">
    <sound key="'scatsto0' + (reelIndex + 1)" l-if="list[0] === scatterKey || list[1] === scatterKey || list[2] === scatterKey"></sound>
    <sound key="'spin_end' + (reelIndex + 1)" l-if="list[0] !== scatterKey && list[1] !== scatterKey && list[2] !== scatterKey"></sound>
</sound-task>

然后在组件类的方法中可以访问到该标签实例：

tweenDone(index) {
    this.$$refs['reelSound' + index].play();
}

• l-wref  与 l-ref 类型， 不过是将标签类的实例暴露到 window 全局变量下。用 window.$$refs.xxx 来访问。
• l-if   根据指令表达式的值， 创建或者删除绑定的标签。
• l-update 当指令的表达式值改变时， 重新刷新整个组件。这个可以替代 Phaser 的 bringToTop 方法， 其他作用待挖掘。
• l-repeat 根据表达式的值，重复创建绑定标签的子元素实例。赋值时使用指令的参数部分取值， 参数 + 'Index' 取索引，
  值只支持数组和数字，例如：

@component({
    template: `
        <container l-repeat-row="3" l-update="update">
            <shadow l-repeat-column="[1,2,3,4,5]">
                <tmage key="'symbols'" x="row" y="column + rowIndex * 5" frame="'kuang'" visible="false">
                </tmage>
            </shadow>
        </container>
    `,
    name: 'WinPanel'
})

还可以自行添加指令， 指令对象的类型定义如下：

export interface Directive {
    name:   string;
    bind:   (cpt: AbstractComponent | AbstractSence, target: any, argument: string, value: (context) => any, triggers: Array<string>) => void;
    unbind: () =>  void;
}

bind方法的参数：
  cpt 作为指令表达式求值的上下文对象，也就是组件类实例对象， 表达式" foo === 'x' ? : n : m ", 最后会被解析成 function(vm){return vm.foo === 'x' ? vm.n : vm.m}。
  target 指令作用的标签对象，可能为 DisplayObject SupportObject 或者是 Component 对象   argument 指令的参数
  value: 指令表达式转换后的求值方法，需传入 cpt。
  triggers 指令表达式中的所有变量

抽象游戏引擎

出于替换游戏引擎和 sdl native 方案。 laya 在 游戏引擎上层做了一层抽象， 也就是标签对应着 laya 类， laya 类使用底层游戏引擎实现功能。每个标签类实现了一个 laya 接口， 这个接口定义了标签类必须要提供的一些方法， 这样， 如果出了更好的游戏引擎， 只需再提供一套实现了接口中相应功能的标签类即可，而无需改动游戏逻辑代码。

举例来说： container 标签类的类定义如下：

 class Container extends AbstractDisplayObject<Phaser.Group> implements LayaContainer { //... }

AbstractDisplayObject 泛型类提供了一些通用方法，如果销毁 DisplayObject 实例， 获取底层真实的游戏引擎对象等。 LayaContainer 接口，定义了标签要实现的功能。 可以用 Phaser.Group 实现， 或者其他的游戏引擎对象来实现，或者自己写一个也可以。

LayaContainer 当前只定义了3个抽象方法

interface LayaContainer extends AbstractDisplayObject<any> {
    // 添加子元素
    add(obj: AbstractDisplayObject<any>): void;
    // 移除子元素
    remove(obj: AbstractDisplayObject<any>, destory: boolean): boolean;
    // 销毁自己
    destroy(): void;
}

然后来看 Container 是如何实现的

import {LayaContainer} from '../../abstract/LayaInterface';
import {AbstractDisplayObject} from '../../abstract/AbstractDisplay';
import display from '../../decorators/Display';
import Graphics from './Graphics';
import setUp from '../chain/SetUp';
import userInterface from '../chain/UserInterface';

@display({
    require: [],
    optional: ['name'],
    name: 'Container'
})
export default class Container extends AbstractDisplayObject<Phaser.Group> implements LayaContainer {
    /** 定义于 AbstractDisplayObject 中的抽象方法，必须提供此方法的实现，laya 在解析完 xml 模板后， 就是
        调用这个方法来构建真实的游戏引擎对象。
        this.realObject 也是在 AbstractDisplayObject 中定义， 引用了真实的游戏引擎对象
        需要注意的是，参数中的 game 是 LayaGame(Phaser.Game的抽象)。
        require 是调用 Phaser.Container 构造函数必须提供的属性值， 也就是 <container> 标签必须存在的属性值。
                如果没有，就会报警告。 有哪些属性在 上面的 @display 注解中指明。
        optional 是调用 Phaser.Container 构造函数时，可选的参数，同样也是在 @display 中指明。
                这里有一点需要注意， 如果在 @display 注解中指明了某个属性， 比如 name, 那么在调用构造函数时才会
                传入这个参数和对应的值。 而如果没有在 @display 注解中指明，也就是 optional 为空数组。 那么
                <container name="container1"></container> 这里的name不是在构造时传入的， 而是构造函数调用后，
                再给对象的 name 存取器属性赋值。 大多数时候无论哪种方式都能正常工作， 但还是建议根据引擎对象的构造函数
                明确指明。
    */
    buildRealObject(game, require, optional) {
        this.realObject = new Phaser.Group(game.realGame, null, optional.name);
    }

    add(obj: AbstractDisplayObject<any>): void {
        this.realObject.add(obj.getRealObject());
    }

    remove(child, destroy): boolean {
        return this.realObject.remove(child, destroy);
    }

    set Mask(value: Graphics) {
        this.realObject.mask = value.getRealObject();
    }

    set inputEnable(value: boolean) {
        this.realObject.ignoreChildInput = !value;
    }
}

setUp(Container.prototype, userInterface);

标签

<container>

container 对应 Phaser.Group 类， 每个组件必须以 <container> 作为唯一根元素，可以嵌套 <container> 标签。

属性表：

属性名	说明
name	标识 container，可以在 Phaser.World 中