MassObserverProcessor.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "MassProcessor.h"
#include "MassObserverProcessor.generated.h"
 
#define UE_API MASSENTITY_API
 
 
namespace UE::Mass::ObserverManager
{
    struct FObserverContextIterator;
}
 
USTRUCT()
struct FMassObserverExecutionContext
{
    GENERATED_BODY()
 
    FMassObserverExecutionContext() = default;
    FMassObserverExecutionContext(const EMassObservedOperation InOperation, const TArrayView<const UScriptStruct*> InTypesInOperation)
        : Operation(InOperation), TypesInOperation(InTypesInOperation)
    {   
    }
 
    EMassObservedOperation GetOperationType() const
    {
        return Operation;
    }
 
    TConstArrayView<const UScriptStruct*> GetTypesInOperation() const
    {
        return TypesInOperation;
    }
 
    const UScriptStruct* GetCurrentType() const
    {
        return TypesInOperation[CurrentTypeIndex];
    }
 
    bool IsValid() const
    {
        return Operation <  EMassObservedOperation::MAX
            && TypesInOperation.IsValidIndex(CurrentTypeIndex);
    }
 
private:
    friend UE::Mass::ObserverManager::FObserverContextIterator;
    EMassObservedOperation Operation = EMassObservedOperation::MAX;
    TArrayView<const UScriptStruct*> TypesInOperation;
    int32 CurrentTypeIndex = INDEX_NONE;
};
 
UCLASS(MinimalAPI, abstract)
class UMassObserverProcessor : public UMassProcessor
{
    GENERATED_BODY()
 
public:
    UE_API UMassObserverProcessor();
 
    EMassObservedOperationFlags GetObservedOperations() const;
    TNotNull<const UScriptStruct*> GetObservedTypeChecked() const;
 
protected:
    UE_API virtual void PostInitProperties() override;
 
    UE_API virtual void Register();
 
protected:
    UPROPERTY(EditDefaultsOnly, Category = Processor, config)
    bool bAutoRegisterWithObserverRegistry = true;
 
    UPROPERTY()
    TObjectPtr<const UScriptStruct> ObservedType = nullptr;
 
    UE_DEPRECATED(5.7, "UMassObserverProcessor::Operation is deprecated. Use ObservedOperations instead")
    EMassObservedOperation Operation = EMassObservedOperation::MAX;
 
    EMassObservedOperationFlags ObservedOperations = EMassObservedOperationFlags::None;
};
 
 
//----------------------------------------------------------------------//
// inlines
//----------------------------------------------------------------------//
inline EMassObservedOperationFlags UMassObserverProcessor::GetObservedOperations() const
{
    return ObservedOperations;
}
 
inline TNotNull<const UScriptStruct*> UMassObserverProcessor::GetObservedTypeChecked() const
{
    return ObservedType;
}
 
#undef UE_API