**UnrealSharp技术文档**

UnrealSharp技术文档

UnrealSharp UnrealSharp is a plugin to Unreal Engine 5, which enables developers to create games using C# with Hot Reload 项目地址: https://gitcode.com/gh_mirrors/unr/UnrealSharp

---

安装指南

前提条件

确保您的开发环境满足以下条件：

• Unreal Engine 5.3或更高版本
• .NET 8.0+ 已安装

步骤

1. 下载UnrealSharp: 访问UnrealSharp官方网站，按照页面提供的指引下载最新版本的插件。

2. 集成到UE5项目中:

   • 将下载的UnrealSharp文件夹复制到您的Unreal Engine项目中的Plugins目录下（如果没有该目录，需要手动创建）。
   • 在Unreal Engine编辑器中打开您的项目，前往Edit > Plugins查看是否成功列出UnrealSharp插件，并启用它。

3. 环境配置:

   • 确保Visual Studio或其他支持C#的IDE已经配置好.NET 8.0的支持。
   • 对于新项目，考虑从UnrealSharp提供的示例项目开始，如UnrealSharp-Cropout，以快速了解结构和设置。

注意事项

• Linux平台目前不支持，请期待后续版本的更新。
• 对于早期版本的UE5，可能需要手动适应或等待兼容性更新。

---

项目使用说明

初始化C#环境

在Unreal Engine项目启动后，您可以在C#环境中编写代码。通过Visual Studio或其他编辑器连接至UE5，即可开始创建类和脚本。

示例项目应用

• 参考【Sample Project】部分提及的UnrealSharp-Cropout，将原本基于Blueprint的RTS游戏转换为C#实现，学习其架构和实现逻辑。

实际操作案例

使用提供的代码示例作为起点，定义actor类、事件响应等，例如上述代码展示了一个资源基础类AResourceBase，展示了如何处理物品拾取、生命值管理以及Niagara特效的触发。

---

项目API使用文档

UnrealSharp自动为您生成了面向UE5 API的C#绑定，使您可以像操作原生UE组件一样操作C#对象。主要特性包括：

• 使用属性([UProperty])注解来映射Unreal Engine的属性。
• 通过多播委托(MulticastDelegate)处理事件，如OnIsPickedUpDelegate用于物品拾取的广播。
• 利用[UFunction]注解定义Unreal Engine可以识别的方法。

---

项目安装方式

重复“安装指南”中的步骤，重点在于正确放置插件并启用之，以及确保所有依赖环境（如.NET版本）均按要求配置完成。

---

通过这份文档，您应能够顺利地设置UnrealSharp环境，理解基本的项目结构和开发流程。利用C#的强大功能，探索更高效的游戏开发之路。如果有更多疑问，参与Discord社区讨论或查阅官方文档将是获取帮助的好方法。祝您开发愉快！

UnrealSharp UnrealSharp is a plugin to Unreal Engine 5, which enables developers to create games using C# with Hot Reload 项目地址: https://gitcode.com/gh_mirrors/unr/UnrealSharp