UnrealSharp

简介

UnrealSharp是一个适用于虚幻引擎5的插件，允许游戏开发者在项目中使用C#和.NET 8的强大功能。该插件弥合了C#和UE5之间的差距，为那些更喜欢C#而非C++/蓝图的开发者提供了一个无缝高效的工作流程。

工作流程展示

特性

C#集成：用C#编写游戏逻辑。
与虚幻引擎5无缝兼容：完全集成了最新的UE5特性和API。
热重载：无需重启引擎即可即时编译和重新加载代码。
自动绑定：根据反射暴露的内容自动生成C# API。
.NET生态系统：使用任何NuGet包扩展功能。

示例项目

查看UnrealSharp-Cropout，这是一个正在进行的项目，旨在将原本用蓝图创建的Cropout转换为使用UnrealSharp的C#版本。

前提条件

虚幻引擎5.3+（未来将支持早期版本）
.NET 8.0+

UnrealSharp 0.2版本问题

尚未实现Linux支持。

开始使用

访问网站的开始使用页面！

如果你想贡献文档，可以参与这个仓库！

代码示例

using UnrealSharp;
using UnrealSharp.Attributes;
using UnrealSharp.Engine;
using UnrealSharp.Niagara;

namespace ManagedSharpProject;

public partial class OnIsPickedUpDelegate : MulticastDelegate<OnIsPickedUpDelegate.Signature>
{
    public delegate void Signature(bool bIsPickedUp);
}

[UClass]
// 部分类仅在你希望UnrealSharp生成辅助方法时才需要。
// 例如：MyCustomComponent foundComponent = MyCustomComponent.Get(actorReference);
public partial class AResourceBase : AActor, IInteractable
{
    public AResourceBase()
    {
        SetReplicates(true);
        RespawnTime = 500.0f;
    }
    
    // 资源的网格体
    [UProperty(DefaultComponent = true, RootComponent = true)]
    public UStaticMeshComponent Mesh { get; set; }
    
    // 资源的生命值组件（如果有的话）
    [UProperty(DefaultComponent = true)]
    public UHealthComponent HealthComponent { get; set; }
    
    [UProperty(PropertyFlags.EditDefaultsOnly)]
    public int PickUpAmount { get; set; }
    
    // 资源重生所需的时间
    [UProperty(PropertyFlags.EditDefaultsOnly | PropertyFlags.BlueprintReadOnly)]
    protected float RespawnTime { get; set; }
    
    // 资源是否被拾取，会被复制到客户端。
    [UProperty(PropertyFlags.BlueprintReadOnly, ReplicatedUsing = nameof(OnRep_IsPickedUp))]
    protected bool bIsPickedUp { get; set; }
    
    // 资源被拾取时播放的效果
    [UProperty(PropertyFlags.EditDefaultsOnly)]
    public TSoftObjectPtr<UNiagaraSystem>? PickUpEffect { get; set; }
    
    // 资源被拾取时调用的委托，在客户端也会广播。
    [UProperty(PropertyFlags.BlueprintAssignable)]
    public OnIsPickedUpDelegate OnIsPickedUp { get; set; }

    protected override void ReceiveBeginPlay()
    {
        HealthComponent.OnDeath += OnDeath;
        base.ReceiveBeginPlay();
    }

    [UFunction]
    protected virtual void OnDeath(APlayer player) {}

    // 接口方法实现
    public void OnInteract(APlayer player)
    {
        GatherResource(player);
    }
    
    [UFunction(FunctionFlags.BlueprintCallable)]
    protected void GatherResource(APlayer player)
    {
        if (bIsPickedUp)
        {
            return;
        }

        if (!player.Inventory.AddItem(this, PickUpAmount))
        {
            return;
        }

        // 使用生成的辅助方法从PlayerState获取ExperienceComponent。
        UExperienceComponent experienceComponent = UExperienceComponent.Get(player.PlayerState);
        experienceComponent.AddExperience(PickUpAmount);
        
        // 在一定时间后重生资源
        SetTimer(OnRespawned, RespawnTime, false);
        
        bIsPickedUp = true;
        OnRep_IsPickedUp();
    }
    
    [UFunction]
    public void OnRespawned()
    {
        bIsPickedUp = false;
        OnRep_IsPickedUp();
    }
    
    // 当bIsPickedUp属性被复制时调用
    [UFunction]
    public void OnRep_IsPickedUp()
    {
        if (PickUpEffect is not null)
        {
            UNiagaraFunctionLibrary.SpawnSystemAtLocation(this, PickUpEffect, GetActorLocation(), GetActorRotation());
        }
        
        OnIsPickedUpChanged(bIsPickedUp);
        OnIsPickedUp.Invoke(bIsPickedUp);
    }
    
    // 可以在蓝图中被重写
    [UFunction(FunctionFlags.BlueprintEvent)]
    public void OnIsPickedUpChanged(bool bIsPickedUp)
    {
        SetActorHiddenInGame(bIsPickedUp);
    }
}