开源!! Creator3.8+ 游戏框架(涉及UI(FGUI)、实体组件、Http、行为树、四叉树、全局定时器、全局事件、资源管理、红点解决方案等内容)

条件显示节点

特点

  • 用于在游戏中显示或隐藏特定UI元素。
  • 一般用于红点提示
  • 主要是解耦用,条件单独实现,节点关联单条件或者多个条件

使用

定义条件

// 定义条件类型枚举
enum ConditionType {
  condition1,
  condition2,
  condition3,
}

// 定义条件
@conditionClass(ConditionType.condition1)
export class Condition1 extends kunpo.ConditionBase {
    protected onInit(): void {
      // 监听条件发生变化, 则调用一次 this.tryUpdate();
        kunpo.GlobalEvent.add("condition1", () => {
            this.tryUpdate();
        }, this);
    }

    protected evaluate(): boolean {
      	//TODO:: 根据条件数据,返回true or false
        return true;
    }
}

节点关联条件

/** 任意一个满足 显示节点 */
new kunpo.ConditionAnyNode(fgui.GObject, ConditionType.condition1, ConditionType.condition2);

/** 所有条件都满足 显示节点 */
new kunpo.ConditionAllNode(fgui.GObject, ConditionType.Condition1, ConditionType.Condition2, ConditionType.Condition3);

全局事件系统

使用


import { GlobalEvent } from 'kunpocc';

// 添加事件监听

GlobalEvent.add('eventName', (arg1, arg2) => {

console.log('事件触发:', arg1, arg2);

}, this);

// 添加一次性事件监听

GlobalEvent.addOnce('oneTimeEvent', (data) => {

console.log('一次性事件触发:', data);

}, this);

// 发送事件

GlobalEvent.send('eventName', 'arg1', 'arg2');

// 发送事件到指定目标

GlobalEvent.sendToTarget('eventName', target, 'arg1', 'arg2');

// 移除事件监听

GlobalEvent.remove('eventName', callback, this);

// 移除指定目标的所有事件监听

GlobalEvent.removeByTarget(this);

// 移除指定事件名和目标的事件监听

GlobalEvent.removeByNameAndTarget('eventName', this);

计时器

使用


import { GlobalTimer } from 'kunpocc';

// 启动一次性定时器(2秒后执行)

const timerId1 = GlobalTimer.startTimer(() => {

console.log('2秒后执行一次');

}, 2);

// 启动循环定时器(每3秒执行一次,执行5次)

const timerId2 = GlobalTimer.startTimer(() => {

console.log('每3秒执行一次,总共执行5次');

}, 3, 5);

// 启动无限循环定时器(每1秒执行一次)

const timerId3 = GlobalTimer.startTimer(() => {

console.log('每1秒执行一次,无限循环');

}, 1, -1);

// 停止定时器

GlobalTimer.stopTimer(timerId1);

GlobalTimer.stopTimer(timerId2);

GlobalTimer.stopTimer(timerId3);

注意事项:

  • 定时器的时间间隔单位为秒

  • loop 参数说明:

  • 0:执行一次

  • 正整数 n:执行 n 次

  • -1:无限循环

平台

Platform 类提供了游戏运行平台的相关信息和判断方法。

平台类型

import { Platform, PlatformType } from 'kunpocc';

// 平台类型枚举
enum PlatformType {
    Android = 1,    // 安卓
    IOS,            // iOS
    HarmonyOS,      // 鸿蒙
    WX,             // 微信小游戏
    Alipay,         // 支付宝小游戏
    Bytedance,      // 字节小游戏
    HuaweiQuick,    // 华为快游戏
    Browser         // 浏览器
}

// 获取当前平台类型
const currentPlatform = Platform.platform;

平台判断

import { Platform } from 'kunpocc';

// 原生平台判断
if (Platform.isNative) {
    console.log('当前是原生平台');
}

// 移动平台判断
if (Platform.isMobile) {
    console.log('当前是移动平台');
}

// 原生移动平台判断
if (Platform.isNativeMobile) {
    console.log('当前是原生移动平台');
}

// 具体平台判断
if (Platform.isAndroid) {
    console.log('当前是安卓平台');
}

if (Platform.isIOS) {
    console.log('当前是iOS平台');
}

if (Platform.isHarmonyOS) {
    console.log('当前是鸿蒙系统');
}

// 小游戏平台判断
if (Platform.isWX) {
    console.log('当前是微信小游戏');
}

if (Platform.isAlipay) {
    console.log('当前是支付宝小游戏');
}

if (Platform.isBytedance) {
    console.log('当前是字节小游戏');
}

if (Platform.isHuaweiQuick) {
    console.log('当前是华为快游戏');
}

// 浏览器判断
if (Platform.isBrowser) {
    console.log('当前是浏览器环境');
}

使用示例

import { Platform, PlatformType } from 'kunpocc';

// 根据平台类型执行不同逻辑
switch (Platform.platform) {
    case PlatformType.Android:
        // 安卓平台特定逻辑
        break;
    case PlatformType.IOS:
        // iOS平台特定逻辑
        break;
    case PlatformType.WX:
        // 微信小游戏特定逻辑
        break;
    default:
        // 其他平台逻辑
        break;
}

// 针对不同平台进行适配
if (Platform.isNativeMobile) {
    // 原生移动平台的处理
    if (Platform.isAndroid) {
        // 安卓特有功能
    } else if (Platform.isIOS) {
        // iOS特有功能
    }
} else if (Platform.isWX || Platform.isAlipay || Platform.isBytedance) {
    // 小游戏平台的处理
} else {
    // 浏览器平台的处理
}

屏幕


/** 屏幕宽度 */

public static ScreenWidth: number;

/** 屏幕高度 */

public static ScreenHeight: number;

/** 设计分辨率宽 */

public static DesignWidth: number;

/** 设计分辨率高 */

public static DesignHeight: number;

/** 安全区外一侧的高度 或 宽度 */

public static SafeAreaHeight: number;

/** 安全区的宽度 */

public static SafeWidth: number;

/** 安全区的高度 */

public static SafeHeight: number;

工具

一、数学工具 (MathTool)

import { MathTool } from 'kunpocc';

// 1. 数值限制
// 将数值限制在指定范围内
const value = MathTool.clampf(75, 0, 100);  // 返回75,因为在0-100范围内
const value2 = MathTool.clampf(150, 0, 100); // 返回100,因为超出上限
const value3 = MathTool.clampf(-50, 0, 100); // 返回0,因为低于下限

// 2. 随机数生成
// 生成指定范围内的整数(包含边界值)
const randomInt = MathTool.rand(1, 10);      // 返回1到10之间的整数

// 生成指定范围内的浮点数(包含最小值,不包含最大值)
const randomFloat = MathTool.randRange(0, 1); // 返回0到1之间的浮点数

// 3. 角度与弧度转换
// 角度转弧度
const radian = MathTool.rad(90);  // 90度转换为弧度:约1.57

// 弧度转角度
const degree = MathTool.deg(Math.PI); // π弧度转换为角度:180

// 4. 平滑过渡
// 用于实现数值的平滑变化,常用于相机跟随、UI动画等
const smoothValue = MathTool.smooth(
    0,    // 起始值
    100,  // 目标值
    0.16, // 已经过时间(秒)
    0.3   // 响应时间(秒)
);  // 返回一个平滑过渡的中间值

使用说明:

  1. clampf(value: number, min: number, max: number): number

    • 将数值限制在指定范围内
    • 如果小于最小值,返回最小值
    • 如果大于最大值,返回最大值
    • 否则返回原值
  2. rand(min: number, max: number): number

    • 生成指定范围内的随机整数
    • 包含最小值和最大值
    • 常用于随机选择、随机掉落等场景
  3. randRange(min: number, max: number): number

    • 生成指定范围内的随机浮点数
    • 包含最小值,不包含最大值
    • 常用于需要精确浮点随机数的场景
  4. rad(angle: number): number

    • 将角度转换为弧度
    • 计算公式:angle * Math.PI / 180
  5. deg(radian: number): number

    • 将弧度转换为角度
    • 计算公式:radian * 180 / Math.PI
  6. smooth(current: number, target: number, elapsedTime: number, responseTime: number): number

    • 计算平滑过渡的值
    • current: 当前值
    • target: 目标值
    • elapsedTime: 已经过时间(秒)
    • responseTime: 响应时间(秒)
    • 常用于实现平滑的相机移动、UI动画等

二、MD5

import { md5 } from 'kunpocc';

// 字符串 MD5 加密
const hash = md5('Hello, World!');
console.log(hash); // 输出32位MD5哈希值

// 注意:
// 1. 输入必须是字符串类型
// 2. 不能传入 undefined 或 null
try {
    md5(null);
} catch (error) {
    console.error('MD5输入不能为null或undefined');
}

三、数据结构

  • 二叉堆(BinaryHeap 最大、最小堆)
  • 单向(LinkedList)、双向链表 (DoublyLinkedList
  • 栈(Stack

四、适配相关 Adapter (不需要关心)

马住马住马住马住

:+1::+1::+1:

大喊666!

git给个星吧,感谢~

star了

爱你哟 :+1:

马克波罗!

mark,老哥2.4.x的版本的分支有么 :smiley:

2.4的没有

2.4是插件的形式用的 跟这个不一样

适合新人学习吗

适合的,逻辑倒是不复杂

赞!感谢分享。
看起来是很不错的框架,要是有配套的深度案例项目就更好了,demo体现不出来。

主要是没有太多时间完善demo,后续我会尽量抽时间把demo做的完善一些
功能的话在线上项目宫爆:老奶奶家族篇中已经验证过了,是可以放心用的

1赞