UBTS_CheckWeapon Class Reference

This class is a Behavior Tree service node that checks the state of a weapon for an AI character. More...

#include <BTS_CheckWeapon.h>

Inheritance diagram for UBTS_CheckWeapon:

Classes
struct	FCheckWeaponMemory

Public Member Functions
	UBTS_CheckWeapon ()

Public Attributes
FBlackboardKeySelector	bHasWeapon
FBlackboardKeySelector	bNeedToReload
FBlackboardKeySelector	bOutOfAmmo
FBlackboardKeySelector	WeaponFireMode
FBlackboardKeySelector	WeaponFireRate
bool	bCheckHasWeapon = true
bool	bCheckNeedToReload = true
bool	bCheckAmmo = true
bool	bCheckFireMode = true
bool	bCheckFireRate = true
bool	bDebuggingMode = false

Protected Member Functions
virtual void	TickNode (UBehaviorTreeComponent &OwnerComp, uint8 *NodeMemory, float DeltaSeconds) override
virtual FString	GetStaticDescription () const override
virtual uint16	GetInstanceMemorySize () const override

Detailed Description

This class is a Behavior Tree service node that checks the state of a weapon for an AI character.

Will Only Update what is Selected

Constructor & Destructor Documentation

UBTS_CheckWeapon()

UBTS_CheckWeapon::UBTS_CheckWeapon

(

)

{
    NodeName = TEXT("Check Weapon");
    INIT_SERVICE_NODE_NOTIFY_FLAGS();
 
#if WITH_EDITOR
    bDebuggingMode = true;
#endif // WITH_EDITOR
}

Member Function Documentation

GetInstanceMemorySize()

uint16 UBTS_CheckWeapon::GetInstanceMemorySize ( ) const

overrideprotectedvirtual

{
    return sizeof(FCheckWeaponMemory);
}

GetStaticDescription()

FString UBTS_CheckWeapon::GetStaticDescription ( ) const

overrideprotectedvirtual

{
    FString Description;
    Description += FString::Printf(TEXT("\nChecking:"));
    if(bCheckHasWeapon)
    {
        Description += FString::Printf(TEXT("\nCharacter has Weapon"));
    }
    if(bCheckNeedToReload)
    {
        Description += FString::Printf(TEXT("\nNeed to Reload"));
    }
    if(bCheckAmmo)
    {
        Description += FString::Printf(TEXT("\nIf Out Of Ammo"));
    }
    if(bCheckFireMode)
    {
        Description += FString::Printf(TEXT("\nFire Mode"));
    }
    if(bCheckFireRate)
    {
        Description += FString::Printf(TEXT("\nFire Rate"));
    }
    if(bDebuggingMode)
    {
        Description += FString::Printf(TEXT("\n DEBUG ACTIVE"));
    }
    if(!bOutOfAmmo.SelectedKeyName.IsValid() && bCheckAmmo)
    {
        Description += FString::Printf(TEXT("\nbOutOfAmmo: Not SET"));
    }
    if(!bHasWeapon.SelectedKeyName.IsValid() && bCheckHasWeapon)
    {
        Description += FString::Printf(TEXT("\nbHasWeapon: Not SET"));
    }
    if(!bNeedToReload.SelectedKeyName.IsValid() && bCheckNeedToReload)
    {
        Description += FString::Printf(TEXT("\nbNeedToReload: Not SET"));
    }
    if(!WeaponFireMode.SelectedKeyName.IsValid() && bCheckFireMode)
    {
        Description += FString::Printf(TEXT("\nWeaponFireMode: Not SET"));
    }
    if(!WeaponFireRate.SelectedKeyName.IsValid() && bCheckFireRate)
    {
        Description += FString::Printf(TEXT("\nWeaponFireRate: Not SET"));
    }
    return Description;
}

TickNode()

void UBTS_CheckWeapon::TickNode ( UBehaviorTreeComponent & OwnerComp, uint8 * NodeMemory, float DeltaSeconds )

overrideprotectedvirtual

{
    TRACE_CPUPROFILER_EVENT_SCOPE(UBTS_CheckWeapon::TickNode);
    SCOPE_CYCLE_COUNTER(STATGROUP_AIToolKit_Behaviors);
    SCOPE_CYCLE_COUNTER(STATGROUP_AIToolKit_Services);
 
    Super::TickNode(OwnerComp, NodeMemory, DeltaSeconds);
    FCheckWeaponMemory* SelectTargetMemory = reinterpret_cast<FCheckWeaponMemory*>(NodeMemory);
    if(SelectTargetMemory == nullptr){return;}
    if(OwnerComp.GetAIOwner() == nullptr){UE_LOG(LogAIToolKit, Error, TEXT("AI Owner NULL in BTS_CheckWeapon Object"))return;}
    const IAIActionsInterface* AIActions = Cast<IAIActionsInterface>(OwnerComp.GetAIOwner());
    if(AIActions != nullptr)
    {
        SelectTargetMemory->bHasWeapon = AIActions->GetHasWeapon();
        SelectTargetMemory->WeaponFireMode = AIActions->GetWeaponFireMode();
        SelectTargetMemory->bOutOfAmmo = AIActions->CheckAmmo(SelectTargetMemory->bNeedToReload);
        SelectTargetMemory->WeaponFireRate = AIActions->GetWeaponFireRate();
        if(bDebuggingMode)
        {
            FString DebugString;
            DebugString += FString::Printf(TEXT("Fire Mode: %i"), SelectTargetMemory->WeaponFireMode);
            DebugString += FString::Printf(TEXT("Fire Rate: %.2f"), SelectTargetMemory->WeaponFireRate);
            if(SelectTargetMemory->bHasWeapon)
            {
                DebugString += FString::Printf(TEXT(" Has Weapon"));
            }
            if(SelectTargetMemory->bOutOfAmmo)
            {
                DebugString += FString::Printf(TEXT(" Out Of Ammo"));
            }
            if(SelectTargetMemory->bNeedToReload)
            {
                DebugString += FString::Printf(TEXT(" Need To Reload"));
            }
            DrawDebugString(GetWorld(),OwnerComp.GetAIOwner()->GetTargetLocation(), DebugString, nullptr, FColor::White, 1.0f);
            UE_LOG(LogAIToolKit, Warning, TEXT("%s"), *DebugString);
        }
        //-     @TODO in the Blackboard, Set Blackboard Wait Time (FireRate * x) then stop fire if in auto   //
        UBlackboardComponent* BlackboardComp = OwnerComp.GetBlackboardComponent();
        if(BlackboardComp != nullptr )
        {
            if(bCheckHasWeapon)
            {
                BlackboardComp->SetValueAsBool(bHasWeapon.SelectedKeyName, SelectTargetMemory->bHasWeapon);
            }
            if(bCheckNeedToReload)
            {
                BlackboardComp->SetValueAsBool(bNeedToReload.SelectedKeyName, SelectTargetMemory->bNeedToReload);
            }
            if(bCheckAmmo)
            {
                BlackboardComp->SetValueAsBool(bOutOfAmmo.SelectedKeyName, SelectTargetMemory->bOutOfAmmo);
            }
            if(bCheckFireMode)
            {
                BlackboardComp->SetValueAsEnum(WeaponFireMode.SelectedKeyName, SelectTargetMemory->WeaponFireMode);
            }
            if(bCheckFireRate)
            {
                BlackboardComp->SetValueAsFloat(WeaponFireRate.SelectedKeyName, SelectTargetMemory->WeaponFireRate);
            }
        }
    }
}

Member Data Documentation

bCheckAmmo

bool UBTS_CheckWeapon::bCheckAmmo = true

bCheckFireMode

bool UBTS_CheckWeapon::bCheckFireMode = true

bCheckFireRate

bool UBTS_CheckWeapon::bCheckFireRate = true

bCheckHasWeapon

bool UBTS_CheckWeapon::bCheckHasWeapon = true

bCheckNeedToReload

bool UBTS_CheckWeapon::bCheckNeedToReload = true

bDebuggingMode

bool UBTS_CheckWeapon::bDebuggingMode = false

bHasWeapon

FBlackboardKeySelector UBTS_CheckWeapon::bHasWeapon

bNeedToReload

FBlackboardKeySelector UBTS_CheckWeapon::bNeedToReload

bOutOfAmmo

FBlackboardKeySelector UBTS_CheckWeapon::bOutOfAmmo

WeaponFireMode

FBlackboardKeySelector UBTS_CheckWeapon::WeaponFireMode

WeaponFireRate

FBlackboardKeySelector UBTS_CheckWeapon::WeaponFireRate

---

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

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