AAIControllerBase Class Reference

#include <AIControllerBase.h>

Inheritance diagram for AAIControllerBase:

Public Member Functions
	AAIControllerBase ()
virtual FVector	GetPawnLocation () const override
virtual void	GetControllerViewPoint (FVector &out_Location, FRotator &out_Rotation) const override
virtual bool	SaveGame () override
virtual bool	LoadGame () override
virtual ETeamAttitude::Type	GetTeamAttitudeTowards (const AActor &Other) const override
virtual void	SetGenericTeamId (const FGenericTeamId &NewTeamID) override
virtual FGenericTeamId	GetGenericTeamId () const override

Protected Member Functions
virtual void	BeginPlay () override
virtual void	OnPossess (APawn *InPawn) override
int32	GetTeamID () const
void	LogDebugError (const FString &Message) const
void	LogDebugError (const FString &Message, const int32 Value) const
void	LogDebugError (const FString &Message, const float Value) const
void	LogDebugWarning (const FString &Message) const
void	LogDebugWarning (const FString &Message, const int32 Value) const
void	LogDebugWarning (const FString &Message, const float Value) const
void	LogDebugMessage (const FString &Message, const bool bWarning=false, const bool bError=false) const
void	LogDebugMessage (const FString &Message, const int32 Value, const bool bWarning=false, const bool bError=false) const
void	LogDebugMessage (const FString &Message, const float Value, const bool bWarning=false, const bool bError=false) const
void	LogDebugMessage (const FString &Message, const bool bValue, const bool bWarning, const bool bError) const
void	LogOnScreenMessage (const int32 Key, const FString &Message, FColor Color=FColor::Green) const
void	SetCategoryName (const FLogCategoryBase &Category)

Protected Attributes
FGenericTeamId	TeamID
TObjectPtr< UBehaviorTree >	Behaviour = nullptr
bool	bDebuggingMode = false

Private Attributes
FLogCategoryName	CategoryName = LogAIControllerBase.GetCategoryName()

Constructor & Destructor Documentation

AAIControllerBase()

AAIControllerBase::AAIControllerBase

(

)

{
    PrimaryActorTick.bCanEverTick = true;
}

Member Function Documentation

BeginPlay()

void AAIControllerBase::BeginPlay ( )

overrideprotectedvirtual

Reimplemented in AAIControllerCore, and AShipBrainController.

{
    Super::BeginPlay();
    
}

GetControllerViewPoint()

void AAIControllerBase::GetControllerViewPoint ( FVector & out_Location, FRotator & out_Rotation ) const

overridevirtual

Implements IControllerInterface.

{
    GetPlayerViewPoint(out_Location, out_Rotation);
}

GetGenericTeamId()

virtual FGenericTeamId AAIControllerBase::GetGenericTeamId ( ) const

inlineoverridevirtual

{return TeamID;};

GetPawnLocation()

FVector AAIControllerBase::GetPawnLocation ( ) const

overridevirtual

Implements IControllerInterface.

{
    return GetPawn()->GetActorLocation();
 
}

GetTeamAttitudeTowards()

ETeamAttitude::Type AAIControllerBase::GetTeamAttitudeTowards ( const AActor & Other ) const

overridevirtual

Reimplemented in AAIControllerCore.

{
    if(const APawn* OtherPawn = Cast<APawn>(&Other))
    {
        if(const IGenericTeamAgentInterface* TeamAgent = Cast<IGenericTeamAgentInterface>(OtherPawn->GetController()))
        {
            // const FGenericTeamId OtherTeamID = TeamAgent->GetGenericTeamId();
            // const EFactionType OtherPawnFaction = UAIBPLib::GetFactionFromTeamID(OtherTeamID);
            // bool bSuccess = false;
            // //- @TODO this should store on Begin, then not have to use the BPLib each time to update //
            // //- Game State should update any Characters of Relationship Changes      
            //
            // const FFactionRelationship Relationship = UAIBPLib::GetFactionRelationship(this, Faction, OtherPawnFaction, bSuccess);
            // if(bSuccess)
            // {
            //  switch (Relationship.RelationshipStatus)
            //  {
            //  case ERelationshipStatus::Friendly:
            //  case ERelationshipStatus::Allied:
            //      return ETeamAttitude::Friendly;
            //  case ERelationshipStatus::Default:
            //  case ERelationshipStatus::Neutral:
            //  case ERelationshipStatus::UnFriendly:
            //      return ETeamAttitude::Neutral;
            //  case ERelationshipStatus::Hostile:
            //  case ERelationshipStatus::Enemy:
            //      return ETeamAttitude::Hostile;
            //  }
            // }
        }
    }
    return ETeamAttitude::Neutral;  
}

GetTeamID()

int32 AAIControllerBase::GetTeamID ( ) const

inlineprotected

{return (TeamID == FGenericTeamId::NoTeam) ? INDEX_NONE : (int32)TeamID;};

LoadGame()

bool AAIControllerBase::LoadGame ( )

overridevirtual

Implements ISaveLoad.

{
    const bool bComponentsLoaded = USaveLoadBPLib::LoadAllComponents(this);
    if(bComponentsLoaded == false)
    {
        LogDebugError("Load components Failed");
    }
    return true;
}

LogDebugError() [1/3]

void AAIControllerBase::LogDebugError ( const FString & Message ) const

protected

{
    TRACE_CPUPROFILER_EVENT_SCOPE(AAIControllerBase::LogDebugError);
    LogDebugMessage(Message, true, true);
}

LogDebugError() [2/3]

void AAIControllerBase::LogDebugError ( const FString & Message, const float Value ) const

protected

{
    LogDebugMessage(Message, Value, true, true);
}

LogDebugError() [3/3]

void AAIControllerBase::LogDebugError ( const FString & Message, const int32 Value ) const

protected

{
    LogDebugMessage(Message, Value, true, true);
}

LogDebugMessage() [1/4]

void AAIControllerBase::LogDebugMessage ( const FString & Message, const bool bValue, const bool bWarning, const bool bError ) const

protected

{
    LogDebugMessage(FString::Printf(TEXT("%s: %s"), *Message, bValue ? *FString("true") : *FString("false")), bWarning, bError);
}

LogDebugMessage() [2/4]

void AAIControllerBase::LogDebugMessage ( const FString & Message, const bool bWarning = false, const bool bError = false ) const

protected

{
    TRACE_CPUPROFILER_EVENT_SCOPE(AAIControllerBase::LogDebugMessage);
    if(bDebuggingMode == false && bError == false){return;}
    FOutputDevice* OutputDevice = GWarn;
    if(OutputDevice == nullptr){return;}
    FString NetModeString;
    switch(GetWorld()->GetNetMode())
    {
    case NM_Standalone:
        NetModeString = FString("SDL");
        break;
    case NM_DedicatedServer:
        NetModeString = FString("DServer");
        break;
    case NM_ListenServer:
        NetModeString = FString("LServer");
        break;
    case NM_Client:
        NetModeString = FString("Client");
        break;
    default:
        NetModeString = FString("Unknown");
        break;
    }
    const FString FullMessage = FString::Printf(TEXT("%s: %s::%s"), *NetModeString, *GetName(), *Message);
    if(bError)
    {
        OutputDevice->Log(CategoryName, ELogVerbosity::Error, FullMessage);
    }
    else if(bWarning)
    {
        OutputDevice->Log(CategoryName, ELogVerbosity::Warning, FullMessage);
    }
    else
    {
        OutputDevice->Log(CategoryName, ELogVerbosity::Log, FullMessage);
    }
 
}

LogDebugMessage() [3/4]

void AAIControllerBase::LogDebugMessage ( const FString & Message, const float Value, const bool bWarning = false, const bool bError = false ) const

protected

{
    LogDebugMessage(FString::Printf(TEXT("%s: %f"), *Message, Value), bWarning, bError);    
}

LogDebugMessage() [4/4]

void AAIControllerBase::LogDebugMessage ( const FString & Message, const int32 Value, const bool bWarning = false, const bool bError = false ) const

protected

{
    LogDebugMessage(FString::Printf(TEXT("%s: %i"), *Message, Value), bWarning, bError);
}

LogDebugWarning() [1/3]

void AAIControllerBase::LogDebugWarning ( const FString & Message ) const

protected

{
    TRACE_CPUPROFILER_EVENT_SCOPE(AAIControllerBase::LogDebugWarning);
    LogDebugMessage(Message, true);
}

LogDebugWarning() [2/3]

void AAIControllerBase::LogDebugWarning ( const FString & Message, const float Value ) const

protected

{
    TRACE_CPUPROFILER_EVENT_SCOPE(AAIControllerBase::LogDebugWarning);
    LogDebugMessage(Message, Value, true);
}

LogDebugWarning() [3/3]

void AAIControllerBase::LogDebugWarning ( const FString & Message, const int32 Value ) const

protected

{
    TRACE_CPUPROFILER_EVENT_SCOPE(AAIControllerBase::LogDebugWarning);
    LogDebugMessage(Message, Value, true);
}

LogOnScreenMessage()

void AAIControllerBase::LogOnScreenMessage ( const int32 Key, const FString & Message, FColor Color = FColor::Green ) const

protected

{
    TRACE_CPUPROFILER_EVENT_SCOPE(AAIControllerBase::LogOnScreenMessage);
    if(bDebuggingMode)
    {
        GEngine->AddOnScreenDebugMessage(Key, 2.0f, Color,
            FString::Printf(TEXT(" %s  - in %s of %s"), ToCStr(Message), ToCStr(GetName()), ToCStr(GetOwner()->GetName())));
    }
}

OnPossess()

void AAIControllerBase::OnPossess ( APawn * InPawn )

overrideprotectedvirtual

Reimplemented in AAIControllerCore, and AShipBrainController.

{
    Super::OnPossess(InPawn);
}

SaveGame()

bool AAIControllerBase::SaveGame ( )

overridevirtual

Implements ISaveLoad.

{
    const bool bComponentsSaved = USaveLoadBPLib::SaveAllComponents(this);
    if(bComponentsSaved == false)
    {
        LogDebugError("Save components Failed");
    }
    return true;
}

SetCategoryName()

void AAIControllerBase::SetCategoryName ( const FLogCategoryBase & Category )

inlineprotected

{CategoryName = Category.GetCategoryName();};

SetGenericTeamId()

void AAIControllerBase::SetGenericTeamId ( const FGenericTeamId & NewTeamID )

overridevirtual

{
    if(HasAuthority())
    {
        const FGenericTeamId OldTeamID = TeamID;
 
        // MARK_PROPERTY_DIRTY_FROM_NAME(ThisClass, MyTeamID, this);
        TeamID = NewTeamID;
        if(bDebuggingMode){ UE_LOG(LogTemp, Error, TEXT("team %i"), NewTeamID.GetId());}
 
        // ConditionalBroadcastTeamChanged(this, OldTeamID, NewTeamID);
    }
    else
    {
        if(bDebuggingMode){UE_LOG(LogTemp, Error, TEXT("Cannot set team for %s on non-authority"), *GetPathName(this));}
    }
}

Member Data Documentation

bDebuggingMode

bool AAIControllerBase::bDebuggingMode = false

protected

Behaviour

TObjectPtr<UBehaviorTree> AAIControllerBase::Behaviour = nullptr

protected

CategoryName

FLogCategoryName AAIControllerBase::CategoryName = LogAIControllerBase.GetCategoryName()

private

TeamID

FGenericTeamId AAIControllerBase::TeamID

protected

---

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

• T:/Unreal/Unreal Projects/SpaceAdventure52/SpaceAdventure/Plugins/BaseHelpers/Source/BaseHelpers/Public/Character/AI/AIControllerBase.h
• T:/Unreal/Unreal Projects/SpaceAdventure52/SpaceAdventure/Plugins/BaseHelpers/Source/BaseHelpers/Private/Character/AI/AIControllerBase.cpp