MassRelationObservers.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "MassObserverProcessor.h"
#include "MassEntityQuery.h"
#include "MassRelationObservers.generated.h"
 
#define UE_API MASSENTITY_API
 
namespace UE::Mass::Relations
{
    struct FRelationTypeTraits;
    enum class ERelationRole : uint8;
}
 
UCLASS(MinimalAPI)
class UMassRelationObserver : public UMassObserverProcessor
{
    GENERATED_BODY()
 
public:
    UE_API UMassRelationObserver();
 
    UE_API virtual bool ConfigureRelationObserver(UE::Mass::FTypeHandle InRegisteredTypeHandle, const UE::Mass::FRelationTypeTraits& Traits);
 
protected:
    UE_API virtual void InitializeInternal(UObject& Owner, const TSharedRef<FMassEntityManager>& EntityManager) override;
    UE_API virtual void ConfigureQueries(const TSharedRef<FMassEntityManager>& EntityManager) override;
 
    FMassEntityQuery EntityQuery;
    UE::Mass::FTypeHandle RelationTypeHandle;
    EMassFragmentAccess ObservedTypeAccess = EMassFragmentAccess::ReadWrite;
    EMassFragmentAccess RelationFragmentAccessType = EMassFragmentAccess::ReadWrite;
    bool bAutoAddRelationFragmentRequirement = true;
    bool bAutoAddRelationTagRequirement = true;
 
    FString DebugDescription;
};
 
UCLASS(MinimalAPI)
class UMassRelationEntityCreation : public UMassRelationObserver
{
    GENERATED_BODY()
public:
    static constexpr int32 RelationCreationObserverExecutionPriority = 1024;
 
    UE_API UMassRelationEntityCreation();
 
protected:
    UE_API virtual void Execute(FMassEntityManager& EntityManager, FMassExecutionContext& Context) override;
};
 
UCLASS(MinimalAPI)
class UMassRelationEntityGuardDog : public UMassRelationObserver
{
    GENERATED_BODY()
public:
    UE_API UMassRelationEntityGuardDog();
 
protected:
    UE_API virtual void Execute(FMassEntityManager& EntityManager, FMassExecutionContext& Context) override;
};
 
UCLASS(MinimalAPI)
class UMassRelationEntityDestruction : public UMassRelationObserver
{
    GENERATED_BODY()
public:
    UE_API UMassRelationEntityDestruction();
 
protected:
    UE_API virtual void Execute(FMassEntityManager& EntityManager, FMassExecutionContext& Context) override;
};
 
UCLASS(MinimalAPI)
class UMassRelationRoleDestruction : public UMassRelationObserver
{
    GENERATED_BODY()
 
public:
    UE_API UMassRelationRoleDestruction();
 
    UE_API virtual bool ConfigureRelationObserver(UE::Mass::FTypeHandle InRegisteredTypeHandle, const UE::Mass::FRelationTypeTraits& Traits) override;
    static UE_API void AddObserverInstances(FMassObserverManager& GetObserverManager, UE::Mass::FTypeHandle InRegisteredTypeHandle, const UE::Mass::FRelationTypeTraits& Traits);
 
protected:
    UE_API virtual void Execute(FMassEntityManager& EntityManager, FMassExecutionContext& Context) override;
    UE_API virtual void ConfigureQueries(const TSharedRef<FMassEntityManager>& EntityManager) override;
 
    FMassExecuteFunction ExecuteFunction;
 
    UE::Mass::Relations::ERelationRole RelationRole = UE::Mass::Relations::ERelationRole::MAX;
 
    const UScriptStruct* ExcludedRelationFragmentType = nullptr;
};
 
#undef UE_API