YgameEngine 文档

项目概述

YgameEngine 是一个基于 Godot 引擎的游戏开发工具库，用于加速游戏制作流程并提供个人常用功能的封装。该引擎提供了一套完整的工具类和模块，涵盖调试、场景管理、网络通信、数据存储、角色系统等多个方面。

基本信息

版本: 10.0
支持引擎: Godot 4.5+
QQ群: 696526224

核心特性

• 24+ 核心功能模块
• 6+ 可视化编辑器
• 100+ API接口

安装与配置

安装步骤

下载 YgameEngine 插件
将插件放置在 Godot 项目的 addons 目录下
在 Godot 编辑器中启用插件

启用插件

启用插件后，系统会自动将 引擎.gd 挂载至项目的全局自动加载，您可以通过 引擎.xxx 来调用各种功能。

# 基本使用示例
引擎.调试.打印("Hello YgameEngine!")
引擎.场景.切换场景("res://scenes/main.tscn")

调试模块

提供调试模式下的增强打印功能，支持带颜色的输出和格式化显示。

基本打印

# 基本打印
引擎.调试.打印("重要信息")

# 带注释的打印
引擎.调试.注释打印("玩家位置", player.position)

# 检查调试模式
if 引擎.调试.取调试模式():
    print("当前处于调试模式")

数据结构打印

# 打印字典
引擎.调试.打印字典(player.stats, "玩家属性")

# 打印数组
引擎.调试.打印数组(items_list, "物品列表")

场景管理

提供场景切换、管理和控制的功能。

场景操作

# 切换场景
引擎.场景.切换场景("res://scenes/gameplay.tscn")

# 获取当前场景
var 当前场景 = 引擎.场景.取当前场景()

# 等待指定时间
await 引擎.场景.等待(2.0)

# 销毁当前场景
引擎.场景.销毁当前场景()

音频管理

# 播放音效
引擎.场景.播放音效(load("res://audio/sfx.wav"))

# 播放音乐
引擎.场景.播放音乐(load("res://audio/bgm.mp3"))

# 设置音量
引擎.场景.设置背景声音大小(0.5)
引擎.场景.设置音效声音大小(0.5)

网络通信

提供基于 UDP 的网络通信功能，包括客户端和服务端。

UDP 客户端

# 创建客户端
var 客户端 = 引擎.网络.UDP_创建客户端()

# 连接服务器
客户端.UDP_连接("127.0.0.1", 8777)

# 发送数据
客户端.UDP_发送数据({"消息": "Hello Server"}, "utf8")

# 处理数据
客户端.UDP_处理数据({
    "客户端收到消息": func(数据):
        print("收到服务器消息:", 数据)
})

网页请求

# GET 请求
var 结果 = await 引擎.网络.网页请求_GET("https://api.example.com/data")

# POST 请求
var 结果 = await 引擎.网络.网页请求_POST("https://api.example.com/submit", {"key": "value"})