UBTTask_PlayMontage Class Reference

#include <BTTask_PlayMontage.h>

Inheritance diagram for UBTTask_PlayMontage:

Classes
struct	FBTTaskPlayMontageMemory

Public Member Functions
	UBTTask_PlayMontage ()

Public Attributes
UAnimMontage *	Montage = nullptr
float	PlayRate = 1.0f
float	InTimeToStartMontageAt = 0.0f
bool	bStopAllMontages = true

Protected Member Functions
virtual EBTNodeResult::Type	ExecuteTask (UBehaviorTreeComponent &OwnerComp, uint8 *NodeMemory) override
virtual EBTNodeResult::Type	AbortTask (UBehaviorTreeComponent &OwnerComp, uint8 *NodeMemory) override
virtual void	TickTask (UBehaviorTreeComponent &OwnerComp, uint8 *NodeMemory, float DeltaSeconds) override
virtual uint16	GetInstanceMemorySize () const override
virtual FString	GetStaticDescription () const override

Detailed Description

A behavior tree task node that plays an animation montage on an AI character.

Constructor & Destructor Documentation

UBTTask_PlayMontage()

UBTTask_PlayMontage::UBTTask_PlayMontage

(

)

{
    NodeName = TEXT("Play Montage");
    INIT_TASK_NODE_NOTIFY_FLAGS();
}

Member Function Documentation

AbortTask()

EBTNodeResult::Type UBTTask_PlayMontage::AbortTask ( UBehaviorTreeComponent & OwnerComp, uint8 * NodeMemory )

overrideprotectedvirtual

{
    return EBTNodeResult::Aborted;
}

ExecuteTask()

EBTNodeResult::Type UBTTask_PlayMontage::ExecuteTask ( UBehaviorTreeComponent & OwnerComp, uint8 * NodeMemory )

overrideprotectedvirtual

{
    TRACE_CPUPROFILER_EVENT_SCOPE(UBTTask_PlayMontage::ExecuteTask);
    SCOPE_CYCLE_COUNTER(STATGROUP_AIToolKit_Behaviors);
    SCOPE_CYCLE_COUNTER(STATGROUP_AIToolKit_Tasks);
 
    FBTTaskPlayMontageMemory* PlayMontageMemory = reinterpret_cast<FBTTaskPlayMontageMemory*>(NodeMemory);
    if(PlayMontageMemory == nullptr){return EBTNodeResult::Failed;}
    PlayMontageMemory->StartTime = GetWorld()->GetTimeSeconds();
    IAIActionsInterface* AIActions = Cast<IAIActionsInterface>(OwnerComp.GetAIOwner());
    if(AIActions != nullptr)
    {
        if(Montage != nullptr)
        {
            PlayMontageMemory->DelayDuration = AIActions->PlayAnimationMontage(Montage, PlayRate, InTimeToStartMontageAt, bStopAllMontages);
            return EBTNodeResult::InProgress;
        }
    }
    return EBTNodeResult::Failed;
}

GetInstanceMemorySize()

uint16 UBTTask_PlayMontage::GetInstanceMemorySize ( ) const

overrideprotectedvirtual

{
    return sizeof(FBTTaskPlayMontageMemory);
}

GetStaticDescription()

FString UBTTask_PlayMontage::GetStaticDescription ( ) const

overrideprotectedvirtual

{
    FString Description;// = Super::GetStaticDescription();
    if(Montage != nullptr)
    {
        Description += FString::Printf(TEXT("\nMontage: %s"), *Montage->GetName());
        Description += FString::Printf(TEXT("\nPlayRate %i"), FMath::RoundToInt(PlayRate));
        Description += FString::Printf(TEXT("\nTime To Start At %i"), FMath::RoundToInt(InTimeToStartMontageAt));
        Description += FString::Printf(TEXT("\nStop All Montages: %s"), bStopAllMontages ? TEXT("True") : TEXT("False"));
    }
    else
    {
        Description += FString::Printf(TEXT("\nMontage: NULL"));
    }
 
    return Description;
}

TickTask()

void UBTTask_PlayMontage::TickTask ( UBehaviorTreeComponent & OwnerComp, uint8 * NodeMemory, float DeltaSeconds )

overrideprotectedvirtual

{
    TRACE_CPUPROFILER_EVENT_SCOPE(UBTTask_PlayMontage::TickTask);
    SCOPE_CYCLE_COUNTER(STATGROUP_AIToolKit_Behaviors);
    SCOPE_CYCLE_COUNTER(STATGROUP_AIToolKit_Tasks);
 
    Super::TickTask(OwnerComp, NodeMemory, DeltaSeconds);
    const FBTTaskPlayMontageMemory* PlayMontageMemory = reinterpret_cast<FBTTaskPlayMontageMemory*>(NodeMemory);
    if(PlayMontageMemory == nullptr){FinishLatentTask(OwnerComp, EBTNodeResult::Failed);}
 
    if (GetWorld()->GetTimeSeconds() - PlayMontageMemory->StartTime >= PlayMontageMemory->DelayDuration)
    {
        FinishLatentTask(OwnerComp, EBTNodeResult::Succeeded);
    }
}

Member Data Documentation

bStopAllMontages

bool UBTTask_PlayMontage::bStopAllMontages = true

InTimeToStartMontageAt

float UBTTask_PlayMontage::InTimeToStartMontageAt = 0.0f

Montage

UAnimMontage* UBTTask_PlayMontage::Montage = nullptr

PlayRate

float UBTTask_PlayMontage::PlayRate = 1.0f

---

The documentation for this class was generated from the following files:

• T:/Unreal/Unreal Projects/SpaceAdventure52/SpaceAdventure/Plugins/AIToolKit/Source/AIToolKit/Public/Behavior/Tasks/BTTask_PlayMontage.h
• T:/Unreal/Unreal Projects/SpaceAdventure52/SpaceAdventure/Plugins/AIToolKit/Source/AIToolKit/Private/Behavior/Tasks/BTTask_PlayMontage.cpp