uikiller for ts使用手册(一)

前言

uikiller js版地址：https://github.com/ShawnZhang2015/uikiller

uikiller for TypeScript是uikiller的ts版本，目前uikiller在ts中还存在一些瑕疵，例如：

1. 访问节点时在IDE中会警告变量不存在，有不少红线提示

2. 访问组件时在IDE中会警告变量不存在，有不少红线提示

   

3. 在property中使用geter直接访问成员节点时，需要添加变量检查，不然在编辑中会报错

//-------------JavaScript----------------
properties: {    
    string: {
        get() {            
            //js中可直接访问节点变量
            return this._label.$Label.string;
        }
    }
}
//-------------TypeScript----------------
@property
    get string() {        
        /**
         * 需要添加绑定节点变量检查，
         * 不然编辑器会报错，报错后需要重启编辑器才行
         */
        if (this._label) {            
            return this._label.$Label.string;
        }        
        return '';
    }
    set string(value) {        
        this._label.$Label.string = value;
    }
}

注意事项：

1. uikiller-for-ts的测试场景是基于Cocos Creator 2.0.2环境测试通过 如果需要使用到1.x版本请自行修改源码。

2. uikiller带有控制器机制，目前还比粗糙，仅供学习，请勿用于实际项目！

快速上手指南

uikiller是使用名命规则来控制UI节点、组件和触摸事件，减少UI相关的代码与编辑器设置，实现原理是提前对UI树的遍历。 在CocosCreator中UI编程基于组件模式，我根据自己的项目经验，将组件分为两类：功能型与控制型。

功能型组件

功能型组件：以装饰宿主节点为己任，从不控制其它节点。

特点：通用性强，可挂载任意节点，Creator内置的组件绝大多数属于这类。 举例：Sprite、Label、Button、Widget等。

控制型组件

控制型组件：管理和控制其它节点及节点上的组件，通常会根据上层业务要求，调用其它节点的属性方法完成任务。

特点：业务逻辑性强，通用性差。 举例：完成具体业务功能的自定义组件。

关于功能型和控制型组件的探索可以参考我的另一篇文章《CocosCreator组件化编程的探索》

有了上面的了解，我将uikiller定位为一个区域的管理者，下面介绍一下uikiller的基本用法。

一、Thor组件

Thor组件继承自cc.Component，同时封装了uikiller的组件绑定能力，提供了当前UI树的直接访问控制能力。

//导入Thor组件

import Thor from 'Thor';
const { ccclass } = cc._decorator;
@ccclass
export default class MyComponent extends Thor {
cc.Class({
    onLoad() {
    }
};

使用uikiller提供的Thor组件做为自定组件的基类，并挂载到场景或预制体的根节点上，该组件脚本即可拥有控制UI树的两大能力：节点访问与触摸事件监听。

二、节点访问

在Thor子类脚本中，可直访问整个UI树中以下划线“_”开头命名的节点。

import Thor from 'Thor';
const { ccclass } = cc._decorator;
@ccclass
export default class MyComponent extends Thor {
    onLoad() {        //直接访问节点
        cc.log(this._image.name);
        cc.log(this._label.name);
        cc.log(this._button.name);
    },
});

三、组件访问

在node节点访问的基础上，使用“$” + “组件名”访问节点上挂载的组件对象。

import Thor from 'Thor';
const { ccclass } = cc._decorator;
@ccclass
export default class MyComponent extends Thor {
    onLoad() {        
        //在节点上使用“$组件名”访问组件
        this._label.$Label.string = 'hello world';       
        //注意继承了Thor的子类，
        //onLoad函数在编辑器状态就会被执行，
        //可以根据具体业务使用CC_EDITOR变量逻辑判定是否要在编辑状态时间
        if (!CC_EDITOR) {            
            //禁用按钮
            this._disableBtn.$Button.interactable = false;
        }
    },
});

三、触摸事件监听

下划线“_”开头的节点可以自动关联其触摸事件。

目前支持五个触摸事件：

TouchStart、TouchMove、TouchEnd、TouchCancel、TouchLong

命名规则

_on + 控件名(去下划线，首字母大写) + 触摸事件

例如节点名为_label，事件函数为：onLabelTouchEnd 为什么定义这样的命名规则呢?首先“__”开头表示私有，on表示事件，后面形成形成驼峰命名，以具体触摸事件为后缀。

1. 监听节点事件

import Thor from 'Thor';
const { ccclass } = cc._decorator;
@ccclass
export default class MyComponent extends Thor {    
    /*
    *sender 响应事件的节点
    *event  事件对象，可以从中获取触摸坐标点等信息
    */
    _onLabelTouchEnd(sender, event) {
        cc.assert(sender === this._label);
        sender.$Label.string = '你抚摸了我';    
    }

2. 节点触摸事件监听

上面讲的都是子节点的触摸事件监听，如果要组件监听当前节点(this.node)如何操作呢？ ###命名规则

_on + 触摸事件(首字母大写，形成驼峰命名)

同样支持五个事件：TouchStart、TouchMove、TouchEnd、TouchCancel、TouchLong

import Thor from 'Thor';
const { ccclass } = cc._decorator;
@ccclass
export default class MyComponent extends Thor {    
    //监听当前节点的触摸事件
    _onTouchStart(sender) {
        cc.assert(this.node === sender);
    }
})

3. 长按事件监听

长按事件是uikill扩展的触摸事件类型，可以给节点设置touchLongTime属性控制长按触发时间，默认是1秒，注意以毫秒为单位。

import Thor from 'Thor';
const { ccclass } = cc._decorator;
@ccclass
export default class MyComponent extends Thor {
    onLoad() {        
        this._label.touchLongTime = 500;
    }

    _onLabelTouchLong(sender) {
        cc.assert(sender === this._label);
    }
}        

---

如果觉得公众号上的文章对你或你的朋友有所帮助，请记得分享给大家，愿我们一起成长！