BTComposite_SimpleParallel.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "UObject/ObjectMacros.h"
#include "BehaviorTree/BTCompositeNode.h"
#include "BTComposite_SimpleParallel.generated.h"
 
namespace EBTParallelChild
{
    enum Type
    {
        MainTask,
        BackgroundTree,
    };
}
 
UENUM()
namespace EBTParallelMode
{
    // keep in sync with DescribeFinishMode
 
    enum Type : int
    {
        AbortBackground UMETA(DisplayName="Immediate" , ToolTip="When main task finishes, immediately abort background tree."),
        WaitForBackground UMETA(DisplayName="Delayed" , ToolTip="When main task finishes, wait for background tree to finish."),
    };
}
 
struct FBTParallelMemory : public FBTCompositeMemory
{
    int32 LastSearchId;
 
    TEnumAsByte<EBTNodeResult::Type> MainTaskResult;
 
    uint8 bMainTaskIsActive : 1;
 
    uint8 bForceBackgroundTree : 1;
 
    uint8 bRepeatMainTask : 1;
};
 
UCLASS(HideCategories=(Composite), MinimalAPI)
class UBTComposite_SimpleParallel : public UBTCompositeNode
{
    GENERATED_UCLASS_BODY()
 
    
    UPROPERTY(EditInstanceOnly, Category = Parallel)
    TEnumAsByte<EBTParallelMode::Type> FinishMode;
 
    AIMODULE_API virtual int32 GetNextChildHandler(FBehaviorTreeSearchData& SearchData, int32 PrevChild, EBTNodeResult::Type LastResult) const override;
 
    AIMODULE_API virtual void NotifyChildExecution(UBehaviorTreeComponent& OwnerComp, uint8* NodeMemory, int32 ChildIdx, EBTNodeResult::Type& NodeResult) const override;
    AIMODULE_API virtual void NotifyNodeDeactivation(FBehaviorTreeSearchData& SearchData, EBTNodeResult::Type& NodeResult) const override;
    AIMODULE_API virtual bool CanNotifyDecoratorsOnDeactivation(FBehaviorTreeSearchData& SearchData, int32 ChildIdx, EBTNodeResult::Type& NodeResult) const override;
    AIMODULE_API virtual bool CanPushSubtree(UBehaviorTreeComponent& OwnerComp, uint8* NodeMemory, int32 ChildIdx) const override;
    AIMODULE_API virtual void SetChildOverride(FBehaviorTreeSearchData& SearchData, int8 Index) const override;
    AIMODULE_API virtual uint16 GetInstanceMemorySize() const override;
    AIMODULE_API virtual void InitializeMemory(UBehaviorTreeComponent& OwnerComp, uint8* NodeMemory, EBTMemoryInit::Type InitType) const override;
    AIMODULE_API virtual void CleanupMemory(UBehaviorTreeComponent& OwnerComp, uint8* NodeMemory, EBTMemoryClear::Type CleanupType) const override;
    AIMODULE_API virtual FString GetStaticDescription() const override;
    AIMODULE_API virtual void DescribeRuntimeValues(const UBehaviorTreeComponent& OwnerComp, uint8* NodeMemory, EBTDescriptionVerbosity::Type Verbosity, TArray<FString>& Values) const override;
 
    static AIMODULE_API FString DescribeFinishMode(EBTParallelMode::Type Mode);
 
#if WITH_EDITOR
    AIMODULE_API virtual bool CanAbortLowerPriority() const override;
    AIMODULE_API virtual bool CanAbortSelf() const override;
    AIMODULE_API virtual FName GetNodeIconName() const override;
#endif // WITH_EDITOR
};