# kokos-js

**Repository Path**: weykon/kokos-js

## Basic Information

- **Project Name**: kokos-js
- **Description**: cocos creator 小游戏框架
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 9
- **Created**: 2020-05-06
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# kokos
+ 一个简单的 cocos creator 框架和一些规范
+ 让开发者能够把更多精力放在游戏玩法上
+ 建议使用 cocos creator 版本 2.2.1+

## 如何使用
+ 将本项目中的 /assets/resources/script/kokos 目录，复制粘贴到要使用本项目的工程的脚本目录下

## api 
### 事件
+ kk.event 对事件的处理
+ 建议在数据层发布事件，在 ui 层订阅事件  
+ kk.event.on(eventName:string, call: function, options: object)
    + options 参数和原生的 EventTarget 相同
    + 参考 https://developer.mozilla.org/zh-CN/docs/Web/API/EventTarget/addEventListener
+ ```javascript
    // 以加金币后刷新 ui 显示为例子，其中 gold 是金币的数值

    // ---------- 管理 ui 的脚本 -----------------------------------
    import kk from 'kokos'

    // 首先在控制 ui 的脚本监听刷新金币的事件
    kk.event.on('refreshGold', refreshUi)

    // 刷新 ui 的函数
    function refreshUi() {
        ui.label.string = gold
    }

    // --------- 管理数据的脚本 -------------------------------------
    import kk from 'kokos'

    // 加金币后派发刷新事件，就能刷新 ui
    function addGold(value) {
        gold += value
        kk.event.emit('refreshGold')
    }

    ```

## 配置
+ 在 kokos/config/kkConfig.js 下可以对项目进行配置

> 可以配置的属性

> isNetwork: Boolean 是否有网络，有网络时会发起短连接，无网络时数据则保存在缓存中。目前只有无网络状态

> healthAdvice.isShow: Boolean 是否显示健康忠告，在国内上线的游戏必须显示健康忠告。healthAdvice.showTimeS: Number 显示时间（秒）

> loading.isDealy: Boolean 是否延时 loading 场景，loading.dealyTimeS: Number 延时的时间（秒）

> firstScene: String 进入游戏 loading 完成后首次进入的场景

> baseDataKey: String 储存 kkBaseData 的 key 切勿与其他 key 相冲突

## 功能

## 更新日志