BTCompositeNode.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
#pragma once
 
#include "CoreMinimal.h"
#include "BehaviorTree/BTNode.h"
#include "BTCompositeNode.generated.h"
 
class UBTCompositeNode;
class UBTDecorator;
class UBTService;
class UBTTaskNode;
 
DECLARE_DELEGATE_RetVal_ThreeParams(int32, FGetNextChildDelegate, FBehaviorTreeSearchData& /*search data*/, int32 /*last child index*/, EBTNodeResult::Type /*last result*/);
 
struct FBTCompositeMemory
{
    int8 CurrentChild;
 
    int8 OverrideChild;
};
 
UENUM()
enum class EBTChildIndex : uint8
{
    FirstNode,
    TaskNode,
};
 
UENUM()
namespace EBTDecoratorLogic
{
    // keep in sync with DescribeLogicOp() in BTCompositeNode.cpp
 
    enum Type : int
    {
        Invalid,
        Test,
        And,
        Or,
        Not,
    };
}
 
USTRUCT()
struct FBTDecoratorLogic
{
    GENERATED_USTRUCT_BODY()
 
    UPROPERTY()
    TEnumAsByte<EBTDecoratorLogic::Type> Operation;
 
    UPROPERTY()
    uint16 Number;
 
    FBTDecoratorLogic() : Operation(EBTDecoratorLogic::Invalid), Number(0) {}
    FBTDecoratorLogic(uint8 InOperation, uint16 InNumber) : Operation(InOperation), Number(InNumber) {}
};
 
USTRUCT()
struct FBTCompositeChild
{
    GENERATED_USTRUCT_BODY()
 
    
    UPROPERTY()
    TObjectPtr<UBTCompositeNode> ChildComposite = nullptr;
 
    UPROPERTY()
    TObjectPtr<UBTTaskNode> ChildTask = nullptr;
 
    UPROPERTY()
    TArray<TObjectPtr<UBTDecorator>> Decorators;
 
    UPROPERTY()
    TArray<FBTDecoratorLogic> DecoratorOps;
};
 
UCLASS(Abstract, MinimalAPI)
class UBTCompositeNode : public UBTNode
{
    GENERATED_UCLASS_BODY()
 
    
    UPROPERTY()
    TArray<FBTCompositeChild> Children;
 
    UPROPERTY()
    TArray<TObjectPtr<UBTService>> Services;
 
    AIMODULE_API ~UBTCompositeNode();
 
    AIMODULE_API void InitializeComposite(uint16 InLastExecutionIndex);
 
    AIMODULE_API int32 FindChildToExecute(FBehaviorTreeSearchData& SearchData, EBTNodeResult::Type& LastResult) const;
 
    AIMODULE_API int32 GetChildIndex(FBehaviorTreeSearchData& SearchData, const UBTNode& ChildNode) const;
    AIMODULE_API int32 GetChildIndex(const UBTNode& ChildNode) const;
 
    AIMODULE_API void OnChildActivation(FBehaviorTreeSearchData& SearchData, const UBTNode& ChildNode) const;
    AIMODULE_API void OnChildActivation(FBehaviorTreeSearchData& SearchData, int32 ChildIndex) const;
 
    AIMODULE_API void OnChildDeactivation(FBehaviorTreeSearchData& SearchData, const UBTNode& ChildNode, EBTNodeResult::Type& NodeResult, const bool bRequestedFromValidInstance) const;
    AIMODULE_API void OnChildDeactivation(FBehaviorTreeSearchData& SearchData, int32 ChildIndex, EBTNodeResult::Type& NodeResult, const bool bRequestedFromValidInstance) const;
 
    AIMODULE_API void OnNodeActivation(FBehaviorTreeSearchData& SearchData) const;
 
    AIMODULE_API void OnNodeDeactivation(FBehaviorTreeSearchData& SearchData, EBTNodeResult::Type& NodeResult) const;
 
    AIMODULE_API void OnNodeRestart(FBehaviorTreeSearchData& SearchData) const;
 
    AIMODULE_API void ConditionalNotifyChildExecution(UBehaviorTreeComponent& OwnerComp, uint8* NodeMemory, const UBTNode& ChildNode, EBTNodeResult::Type& NodeResult) const;
 
    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;
 
    UBTNode* GetChildNode(int32 Index) const;
 
    int32 GetChildrenNum() const;
 
    AIMODULE_API uint16 GetChildExecutionIndex(int32 Index, EBTChildIndex ChildMode = EBTChildIndex::TaskNode) const;
 
    uint16 GetLastExecutionIndex() const;
 
    AIMODULE_API virtual void SetChildOverride(FBehaviorTreeSearchData& SearchData, int8 Index) const;
 
    AIMODULE_API virtual void DescribeRuntimeValues(const UBehaviorTreeComponent& OwnerComp, uint8* NodeMemory, EBTDescriptionVerbosity::Type Verbosity, TArray<FString>& Values) const override;
 
    AIMODULE_API virtual bool CanPushSubtree(UBehaviorTreeComponent& OwnerComp, uint8* NodeMemory, int32 ChildIdx) const;
 
#if WITH_EDITOR
    AIMODULE_API virtual bool CanAbortLowerPriority() const;
    AIMODULE_API virtual bool CanAbortSelf() const;
#endif // WITH_EDITOR
 
    AIMODULE_API int32 GetMatchingChildIndex(int32 ActiveInstanceIdx, FBTNodeIndex& NodeIdx) const;
 
    AIMODULE_API uint16 GetBranchExecutionIndex(uint16 NodeInBranchIdx) const;
 
    AIMODULE_API bool DoDecoratorsAllowExecution(UBehaviorTreeComponent& OwnerComp, const int32 InstanceIdx, const int32 ChildIdx) const;
 
    bool IsApplyingDecoratorScope() const;
 
    // Deprecated methods
    UE_DEPRECATED(5.0, "This function is deprecated. Please use RequestBranchDeactivation instead.")
    void OnChildDeactivation(FBehaviorTreeSearchData& SearchData, const UBTNode& ChildNode, EBTNodeResult::Type& NodeResult) const { OnChildDeactivation(SearchData, ChildNode, NodeResult, /*bRequestedFromValidInstance*/true); }
    UE_DEPRECATED(5.0, "This function is deprecated. Please use RequestBranchDeactivation instead.")
    void OnChildDeactivation(FBehaviorTreeSearchData& SearchData, int32 ChildIndex, EBTNodeResult::Type& NodeResult) const { OnChildDeactivation(SearchData, ChildIndex, NodeResult, /*bRequestedFromValidInstance*/true ); }
 
protected:
 
    UPROPERTY(EditAnywhere, Category = Composite)
    uint32 bApplyDecoratorScope : 1;
 
    uint32 bUseChildExecutionNotify : 1;
 
    uint32 bUseNodeActivationNotify : 1;
 
    uint32 bUseNodeDeactivationNotify : 1;
 
    uint32 bUseDecoratorsActivationCheck : 1;
 
    uint32 bUseDecoratorsDeactivationCheck : 1;
 
    uint32 bUseDecoratorsFailedActivationCheck : 1;
 
    uint16 LastExecutionIndex;
 
    AIMODULE_API virtual void NotifyChildExecution(UBehaviorTreeComponent& OwnerComp, uint8* NodeMemory, int32 ChildIdx, EBTNodeResult::Type& NodeResult) const;
 
    AIMODULE_API virtual void NotifyNodeActivation(FBehaviorTreeSearchData& SearchData) const;
 
    AIMODULE_API virtual void NotifyNodeDeactivation(FBehaviorTreeSearchData& SearchData, EBTNodeResult::Type& NodeResult) const;
 
    AIMODULE_API virtual bool CanNotifyDecoratorsOnActivation(FBehaviorTreeSearchData& SearchData, int32 ChildIdx) const;
 
    AIMODULE_API virtual bool CanNotifyDecoratorsOnDeactivation(FBehaviorTreeSearchData& SearchData, int32 ChildIdx, EBTNodeResult::Type& NodeResult) const;
 
    AIMODULE_API virtual bool CanNotifyDecoratorsOnFailedActivation(FBehaviorTreeSearchData& SearchData, int32 ChildIdx, EBTNodeResult::Type& NodeResult) const;
 
    AIMODULE_API void NotifyDecoratorsOnActivation(FBehaviorTreeSearchData& SearchData, int32 ChildIdx) const;
 
    AIMODULE_API void NotifyDecoratorsOnDeactivation(FBehaviorTreeSearchData& SearchData, int32 ChildIdx, EBTNodeResult::Type& NodeResult, const bool bIsInSameActiveInstance) const;
 
    AIMODULE_API void NotifyDecoratorsOnFailedActivation(FBehaviorTreeSearchData& SearchData, int32 ChildIdx, EBTNodeResult::Type& NodeResult) const;
 
    AIMODULE_API int32 GetNextChild(FBehaviorTreeSearchData& SearchData, int32 LastChildIdx, EBTNodeResult::Type LastResult) const;
 
    AIMODULE_API void RequestDelayedExecution(UBehaviorTreeComponent& OwnerComp, EBTNodeResult::Type LastResult) const;
 
protected:
    virtual int32 GetNextChildHandler(struct FBehaviorTreeSearchData& SearchData, int32 PrevChild, EBTNodeResult::Type LastResult) const { return BTSpecialChild::ReturnToParent; }
 
    template<typename NotifyChildExecution, typename NotifyNodeActivation, typename NotifyNodeDeactivation,
            typename CanNotifyDecoratorsOnActivation, typename CanNotifyDecoratorsOnDeactivation, typename CanNotifyDecoratorsOnFailedActivation>
    void InitNotifyFlags(NotifyChildExecution, NotifyNodeActivation, NotifyNodeDeactivation,
                         CanNotifyDecoratorsOnActivation, CanNotifyDecoratorsOnDeactivation, CanNotifyDecoratorsOnFailedActivation)
    {
        bUseChildExecutionNotify = !std::is_same_v<decltype(&UBTCompositeNode::NotifyChildExecution), NotifyChildExecution>;
        bUseNodeActivationNotify = !std::is_same_v<decltype(&UBTCompositeNode::NotifyNodeActivation), NotifyNodeActivation>;
        bUseNodeDeactivationNotify = !std::is_same_v<decltype(&UBTCompositeNode::NotifyNodeDeactivation), NotifyNodeDeactivation>;
        bUseDecoratorsActivationCheck = !std::is_same_v<decltype(&UBTCompositeNode::CanNotifyDecoratorsOnActivation), CanNotifyDecoratorsOnActivation>;
        bUseDecoratorsDeactivationCheck = !std::is_same_v<decltype(&UBTCompositeNode::CanNotifyDecoratorsOnDeactivation), CanNotifyDecoratorsOnDeactivation>;
        bUseDecoratorsFailedActivationCheck = !std::is_same_v<decltype(&UBTCompositeNode::CanNotifyDecoratorsOnFailedActivation), CanNotifyDecoratorsOnFailedActivation>;
    }
};
 
#define INIT_COMPOSITE_NODE_NOTIFY_FLAGS() \
    do { \
    using NodeType = TRemovePointer<decltype(this)>::Type; \
    InitNotifyFlags(&NodeType::NotifyChildExecution,\
                    &NodeType::NotifyNodeActivation,\
                    &NodeType::NotifyNodeDeactivation, \
                    &NodeType::CanNotifyDecoratorsOnActivation,\
                    &NodeType::CanNotifyDecoratorsOnDeactivation,\
                        &NodeType::CanNotifyDecoratorsOnFailedActivation); \
        } while (false)
 
// Inlines
 
inline UBTNode* UBTCompositeNode::GetChildNode(int32 Index) const
{
    return Children.IsValidIndex(Index) ?
        (Children[Index].ChildComposite ?
            static_cast<UBTNode*>(Children[Index].ChildComposite) :
            static_cast<UBTNode*>(Children[Index].ChildTask)) :
        nullptr;
}
 
inline int32 UBTCompositeNode::GetChildrenNum() const
{
    return Children.Num();
}
 
inline uint16 UBTCompositeNode::GetLastExecutionIndex() const
{
    return LastExecutionIndex;
}
 
inline bool UBTCompositeNode::IsApplyingDecoratorScope() const
{
    return bApplyDecoratorScope;
}