UAIBPLib Class Reference

#include <AIBPLib.h>

Inheritance diagram for UAIBPLib:

Static Public Member Functions
static EAISense	GetSenseFromStimulus (const FAIStimulus &Stimulus)
static FString	FactionToString (const EFactionType Faction)
static uint8	GetTeamIDFromFaction (const EFactionType Faction)
static EFactionType	GetFactionFromTeamID (const uint8 TeamID)
static EAIActionType	GetActionTypeFromTag (const FName &Tag)
static FName	GetActionTagFromType (const EAIActionType ActionType)
static ERelationshipStatus	GetRelationshipStatus (const float TrustLevel, const float HostilityLevel)
static UDataTable *	LoadFactionDataTableFromGameState (const UObject *WorldContextObject)
static FFactionRelationshipTotal	GetFactionRelationshipTotal (const UObject *WorldContextObject, const EFactionType Faction, bool &bSuccess, UDataTable *DataTable=nullptr)
static FFactionRelationship	GetFactionRelationship (const UObject *WorldContextObject, const EFactionType Faction, const EFactionType TargetFaction, bool &bSuccess, UDataTable *DataTable=nullptr)
static bool	GetIsFactionHostile (const UObject *WorldContextObject, const EFactionType Faction, const EFactionType TargetFaction, bool &bSuccess, UDataTable *DataTable=nullptr)
static ETeamAttitude::Type	GetAttitudeToActor (const FGenericTeamId &OwnerID, const AActor *TargetActor, bool &bSuccess)
static ETeamAttitude::Type	GetAttitudeToActor (const FGenericTeamId &OwnerID, const AActor *TargetActor)
static ETeamAttitude::Type	GetAttitudeActorToActor (const AActor *OwnerActor, const AActor *TargetActor, bool &bSuccess)
static void	ReportTouchEvent (AActor *InTouchReceiver, AActor *InOtherActor, const FVector &EventLocation)
static void	ReportTeamEvent (AActor *InBroadcaster, AActor *InEnemy, const FVector &InLastKnowLocation, const float EventRange, const float PassedInfoAge, const float InStrength)

Member Function Documentation

FactionToString()

FString UAIBPLib::FactionToString ( const EFactionType Faction )

static

{
    SCOPE_CYCLE_COUNTER(STATGROUP_AIToolKit_BPLib);
    TRACE_CPUPROFILER_EVENT_SCOPE(UAIBPLib::FactionToString);
    switch (Faction)
    {
    case EFactionType::Default:
        return FString("Default");
    case EFactionType::Alliance:
        return FString("Alliance");
    case EFactionType::Militia:
        return FString("Militia");
    case EFactionType::Vipers:
        return FString("Vipers");
    case EFactionType::Jackals:
        return FString("Jackals");
    case EFactionType::TheBrotherhood:
        return FString("TheBrotherhood");
    case EFactionType::Robots:
        return FString("Robots");
    case EFactionType::ChurchOfTheMachine:
        return FString("ChurchOfTheMachine");
    case EFactionType::Zombies:
        return FString("Zombies");
    default:
        return FString("Default");
    }
}

GetActionTagFromType()

FName UAIBPLib::GetActionTagFromType ( const EAIActionType ActionType )

static

{
    SCOPE_CYCLE_COUNTER(STATGROUP_AIToolKit_BPLib);
    TRACE_CPUPROFILER_EVENT_SCOPE(UAIBPLib::GetActionTagFromType);
    switch (ActionType)
    {
    case EAIActionType::Default:
        return FName("Default");
    case EAIActionType::Patrol:
        return FName("Patrol");
    case EAIActionType::PatrolTaken:
        return FName("PatrolTaken");
    case EAIActionType::JoinGroup:
        return FName("JoinGroup");
    case EAIActionType::Attack:
        return FName("Attack");
    case EAIActionType::Help:
        return FName("Help");
    case EAIActionType::Retreat:
        return FName("Retreat");
    case EAIActionType::Flank:
        return FName("Flank");
    case EAIActionType::Search:
        return FName("Search");
    case EAIActionType::Investigate:
        return FName("Investigate");
    case EAIActionType::Alert:
        return FName("Alert");
    case EAIActionType::Protect:
        return FName("Protect");
    case EAIActionType::TargetLost:
        return FName("TargetLost");
    case EAIActionType::TargetDown:
        return FName("TargetDown");
    case EAIActionType::TargetFound:
        return FName("TargetFound");
        break;
    }
    return FName("Default");
}

GetActionTypeFromTag()

EAIActionType UAIBPLib::GetActionTypeFromTag ( const FName & Tag )

static

{
    SCOPE_CYCLE_COUNTER(STATGROUP_AIToolKit_BPLib);
    TRACE_CPUPROFILER_EVENT_SCOPE(UAIBPLib::GetActionTypeFromTag);
    if(Tag == FName("Default"))
    {
        return EAIActionType::Default;
    }
    if(Tag == FName("Patrol"))
    {
        return EAIActionType::Patrol;
    }
    if(Tag == FName("PatrolTaken"))
    {
        return EAIActionType::PatrolTaken;
    }
    if(Tag == FName("JoinGroup"))
    {
        return EAIActionType::JoinGroup;
    }
    if(Tag == FName("Attack"))
    {
        return EAIActionType::Attack;
    }
    if(Tag == FName("Help"))
    {
        return EAIActionType::Help;
    }
    if(Tag == FName("Retreat"))
    {
        return EAIActionType::Retreat;
    }
    if(Tag == FName("Flank"))
    {
        return EAIActionType::Flank;
    }
    if(Tag == FName("Search"))
    {
        return EAIActionType::Search;
    }
    if(Tag == FName("Investigate"))
    {
        return EAIActionType::Investigate;
    }
    if(Tag == FName("Alert"))
    {
        return EAIActionType::Alert;
    }
    if(Tag == FName("Protect"))
    {
        return EAIActionType::Protect;
    }
    if(Tag == FName("TargetLost"))
    {
        return EAIActionType::TargetLost;
    }
    if(Tag == FName("TargetFound"))
    {
        return EAIActionType::TargetFound;
    }
    if(Tag == FName("TargetDown"))
    {
        return EAIActionType::TargetDown;
    }
    return EAIActionType::Default;
}

GetAttitudeActorToActor()

ETeamAttitude::Type UAIBPLib::GetAttitudeActorToActor ( const AActor * OwnerActor, const AActor * TargetActor, bool & bSuccess )

static

Get the Attitude of one actor to another, for Pawns with Controllers only

{
    SCOPE_CYCLE_COUNTER(STATGROUP_AIToolKit_BPLib);
    TRACE_CPUPROFILER_EVENT_SCOPE(UAIBPLib::GetAttitudeActorToActor);
    if(OwnerActor == nullptr){bSuccess = false; return ETeamAttitude::Neutral;}
    const APawn* OwnerPawn = Cast<APawn>(OwnerActor);
    if(OwnerPawn == nullptr || OwnerPawn->GetController() == nullptr){bSuccess = false; return ETeamAttitude::Neutral;}
    const IGenericTeamAgentInterface* TeamAgentInterface = Cast<IGenericTeamAgentInterface>(OwnerPawn->GetController());
    if(TeamAgentInterface == nullptr){bSuccess = false; return ETeamAttitude::Neutral;}
    return GetAttitudeToActor(TeamAgentInterface->GetGenericTeamId(), TargetActor, bSuccess);
}

GetAttitudeToActor() [1/2]

ETeamAttitude::Type UAIBPLib::GetAttitudeToActor ( const FGenericTeamId & OwnerID, const AActor * TargetActor )

static

{
    SCOPE_CYCLE_COUNTER(STATGROUP_AIToolKit_BPLib);
    TRACE_CPUPROFILER_EVENT_SCOPE(UAIBPLib::GetAttitudeToActor);
    if(TargetActor == nullptr){return ETeamAttitude::Neutral;}
    const APawn* TargetPawn = Cast<APawn>(TargetActor);
    if(TargetPawn == nullptr || TargetPawn->GetController() == nullptr){return ETeamAttitude::Neutral;}
    const IGenericTeamAgentInterface* TeamAgentInterface = Cast<IGenericTeamAgentInterface>(TargetPawn->GetController());
    if(TeamAgentInterface == nullptr){return ETeamAttitude::Neutral;}
    return FGenericTeamId::GetAttitude(OwnerID, TeamAgentInterface->GetGenericTeamId());
}

GetAttitudeToActor() [2/2]

ETeamAttitude::Type UAIBPLib::GetAttitudeToActor ( const FGenericTeamId & OwnerID, const AActor * TargetActor, bool & bSuccess )

static

Get the Attitude of one actor to another, for Pawns with Controllers only

{
    SCOPE_CYCLE_COUNTER(STATGROUP_AIToolKit_BPLib);
    TRACE_CPUPROFILER_EVENT_SCOPE(UAIBPLib::GetAttitudeToActor);
    if(TargetActor == nullptr){bSuccess = false; return ETeamAttitude::Neutral;}
    const APawn* TargetPawn = Cast<APawn>(TargetActor);
    if(TargetPawn == nullptr || TargetPawn->GetController() == nullptr){bSuccess = false; return ETeamAttitude::Neutral;}
    const IGenericTeamAgentInterface* TeamAgentInterface = Cast<IGenericTeamAgentInterface>(TargetPawn->GetController());
    if(TeamAgentInterface == nullptr){bSuccess = false; return ETeamAttitude::Neutral;}
    return FGenericTeamId::GetAttitude(OwnerID, TeamAgentInterface->GetGenericTeamId());
}

GetFactionFromTeamID()

EFactionType UAIBPLib::GetFactionFromTeamID ( const uint8 TeamID )

static

{
    SCOPE_CYCLE_COUNTER(STATGROUP_AIToolKit_BPLib);
    TRACE_CPUPROFILER_EVENT_SCOPE(UAIBPLib::GetFactionFromTeamID);
    switch (TeamID)
    {
    case 0:
        return EFactionType::Default;
    case 200:
        return EFactionType::Alliance;
    case 201:
        return EFactionType::Militia;
    case 202:
        return EFactionType::Vipers;
    case 203:
        return EFactionType::Jackals;
    case 204: 
        return EFactionType::TheBrotherhood;
    case 205: 
        return EFactionType::Robots;
    case 206: 
        return EFactionType::ChurchOfTheMachine;
    case 207: 
        return EFactionType::Zombies;
    default:
        return EFactionType::Default;
    }
}

GetFactionRelationship()

FFactionRelationship UAIBPLib::GetFactionRelationship ( const UObject * WorldContextObject, const EFactionType Faction, const EFactionType TargetFaction, bool & bSuccess, UDataTable * DataTable = nullptr )

static

{
    SCOPE_CYCLE_COUNTER(STATGROUP_AIToolKit_BPLib);
    TRACE_CPUPROFILER_EVENT_SCOPE(UAIBPLib::GetFactionRelationship);
    bSuccess = false;
    const FFactionRelationshipTotal FactionRelationshipTotal = GetFactionRelationshipTotal(WorldContextObject, Faction, bSuccess, DataTable);
    if(!bSuccess){UE_LOG(LogAIToolKit, Warning, TEXT("GetFactionRelationshipTotal in GetFactionRelationship"));return FFactionRelationship::Empty();}
    for(const auto RelationShip : FactionRelationshipTotal.Relationships)
    {
        if(RelationShip.OtherFaction == TargetFaction)
        {
            return RelationShip;
        }
    }
    UE_LOG(LogAIToolKit, Warning, TEXT("GetFactionRelationshipTotal in GetFactionRelationship"));
    return FFactionRelationship::Empty();
}

GetFactionRelationshipTotal()

FFactionRelationshipTotal UAIBPLib::GetFactionRelationshipTotal ( const UObject * WorldContextObject, const EFactionType Faction, bool & bSuccess, UDataTable * DataTable = nullptr )

static

{
    SCOPE_CYCLE_COUNTER(STATGROUP_AIToolKit_BPLib);
    TRACE_CPUPROFILER_EVENT_SCOPE(UAIBPLib::GetFactionRelationshipTotal);
    bSuccess = false;
    if(!IsValid(DataTable))
    {
        UE_LOG(LogAIToolKit, Log, TEXT("Loading GameState Faction DataTable"));
        DataTable = LoadFactionDataTableFromGameState(WorldContextObject);
        if(!IsValid(DataTable))
        {
            return FFactionRelationshipTotal::Empty();
        }
    }
    const FString FactionName = FactionToString(Faction);
    FFactionRelationshipTotal* FactionRelationshipTotalPtr = DataTable->FindRow<FFactionRelationshipTotal>(FName(FactionName), "");
    if(FactionRelationshipTotalPtr == nullptr){UE_LOG(LogAIToolKit,Warning,TEXT("FactionRelationshipTotalPtr pointer null -GetFactionRelationshipTotal")); return FFactionRelationshipTotal::Empty();}
    bSuccess = true;
    return *FactionRelationshipTotalPtr;
}

GetIsFactionHostile()

bool UAIBPLib::GetIsFactionHostile ( const UObject * WorldContextObject, const EFactionType Faction, const EFactionType TargetFaction, bool & bSuccess, UDataTable * DataTable = nullptr )

static

{
    SCOPE_CYCLE_COUNTER(STATGROUP_AIToolKit_BPLib);
    TRACE_CPUPROFILER_EVENT_SCOPE(UAIBPLib::GetIsFactionHostile);
    bSuccess = false;
    const FFactionRelationship FactionRelationship = GetFactionRelationship(WorldContextObject, Faction, TargetFaction, bSuccess, DataTable);
    if(!bSuccess){UE_LOG(LogAIToolKit, Warning, TEXT("GetFactionRelationship in GetIsFactionHostile"));return false;}
    return FactionRelationship.IsHostile();
}

GetRelationshipStatus()

ERelationshipStatus UAIBPLib::GetRelationshipStatus ( const float TrustLevel, const float HostilityLevel )

static

{
    SCOPE_CYCLE_COUNTER(STATGROUP_AIToolKit_BPLib);
    TRACE_CPUPROFILER_EVENT_SCOPE(UAIBPLib::GetRelationshipStatus);
    return GetRelationship(TrustLevel, HostilityLevel);
    // //- Hostility is higher or equal than 200.0f OR if Trust is below or equal -100.f    //
    // if(HostilityLevel >= AIRelationShipVars::HostilityLevelEnemy || TrustLevel <= AIRelationShipVars::TrustLevelEnemy)
    // {
    //  return ERelationshipStatus::Enemy;
    // }
    // //- Hostility is higher or equal than 100.0f OR  if Trust is below or equal -40.f //
    // if(HostilityLevel >= AIRelationShipVars::HostilityLevelHostile || TrustLevel <= AIRelationShipVars::TrustLevelHostile)
    // {
    //  return ERelationshipStatus::Hostile;
    // }
    //
    // //- If they have MAX Trust, & No Hostility   //
    // if(TrustLevel >= AIRelationShipVars::TrustLevelFriendly && HostilityLevel == AIRelationShipVars::HostilityLevelFriendly)
    // {
    //  return ERelationshipStatus::Friendly;
    // }
    // //- If above 40 Trust, & No Hostility    //
    // if(TrustLevel >= AIRelationShipVars::TrustLevelAllied && HostilityLevel == AIRelationShipVars::HostilityLevelAllied)
    // {
    //  return ERelationshipStatus::Allied;
    // }
    // //-  If Trust is above or equal 0 & Hostility is Lower or equal than 20  //
    // if(TrustLevel >= AIRelationShipVars::TrustLevelNeutral && HostilityLevel <= AIRelationShipVars::HostilityLevelNeutral)
    // {
    //  return ERelationshipStatus::Neutral;
    // }
    // //- Should cover everything else?    //
    // //-  If Trust is above Hostile (-40.f) & Hostility is Lower than Hostile (100.0f)    //
    // if(TrustLevel >= AIRelationShipVars::TrustLevelHostile && HostilityLevel <= AIRelationShipVars::HostilityLevelHostile)
    // {
    //  return ERelationshipStatus::UnFriendly;
    // }
    // return ERelationshipStatus::Default;
    // // //- if Trust is above -40 & Hostility is higher than 100.0f   //
    // // if(TrustLevel >= AIRelationShipVars::TrustLevelHostile && HostilityLevel >= AIRelationShipVars::HostilityLevelHostile)
    // // {
    // //   return ERelationshipStatus::Hostile;
    // // }
    // // //- if Trust is above -100.0f & Hostility is Higher than 200.0f   //
    // // if(TrustLevel >= AIRelationShipVars::TrustLevelEnemy && HostilityLevel >= AIRelationShipVars::HostilityLevelEnemy)
    // // {
    // //   return ERelationshipStatus::Enemy;
    // // }
    // // Handle any other case, possibly setting to Default or another status
}

GetSenseFromStimulus()

EAISense UAIBPLib::GetSenseFromStimulus ( const FAIStimulus & Stimulus )

static

{
    SCOPE_CYCLE_COUNTER(STATGROUP_AIToolKit_BPLib);
    TRACE_CPUPROFILER_EVENT_SCOPE(UAIBPLib::GetSenseFromStimulus);
 
    if(Stimulus.Type.Name == FName("Default__AISense_Sight"))
    {
        return EAISense::Sight;
    }
    if(Stimulus.Type.Name == FName("Default__AISense_Hearing"))
    {
        return EAISense::Hearing;
    }
    if(Stimulus.Type.Name == FName("Default__AISense_Damage"))
    {
        return EAISense::Damage;
    }
    if(Stimulus.Type.Name == FName("Default__AISense_Team"))
    {
        return EAISense::Team;
    }
    if(Stimulus.Type.Name == FName("Default__AISense_Prediction"))
    {
        return EAISense::Prediction;
    }
    if(Stimulus.Type.Name == FName("Default__AISense_Touch"))
    {
        return EAISense::Touch;
    }
    if(Stimulus.Type.Name == FName("Default__AISense_Actions"))
    {
        return EAISense::Action;
    }
    if(Stimulus.Type.Name == FName("Default__AISense_Custom"))
    {
        return EAISense::Custom;
    }
    return EAISense::Sight;
}

GetTeamIDFromFaction()

uint8 UAIBPLib::GetTeamIDFromFaction ( const EFactionType Faction )

static

{
    SCOPE_CYCLE_COUNTER(STATGROUP_AIToolKit_BPLib);
    TRACE_CPUPROFILER_EVENT_SCOPE(UAIBPLib::GetTeamIDFromFaction);
    switch (Faction)
    {
    case EFactionType::Default:
        return 0;
    case EFactionType::Alliance:
        return 200;
    case EFactionType::Militia:
        return 201;
    case EFactionType::Vipers:
        return 202;
    case EFactionType::Jackals:
        return 203;
    case EFactionType::TheBrotherhood:
        return 204;
    case EFactionType::Robots:
        return 205;
    case EFactionType::ChurchOfTheMachine:
        return 206;
    case EFactionType::Zombies:
        return 207;
    default:
        return 0;
    }
}

LoadFactionDataTableFromGameState()

UDataTable * UAIBPLib::LoadFactionDataTableFromGameState ( const UObject * WorldContextObject )

static

{
    SCOPE_CYCLE_COUNTER(STATGROUP_AIToolKit_BPLib);
    TRACE_CPUPROFILER_EVENT_SCOPE(UAIBPLib::LoadFactionDataTableFromGameState);
    IAIData* AIGameState = Cast<IAIData>(UGameplayStatics::GetGameState(WorldContextObject));
    if(AIGameState == nullptr){UE_LOG(LogAIToolKit, Warning, TEXT("AI Faction DataTable Failed in - LoadFromGameState UAIBPLib"));return nullptr;}
    return AIGameState->GetFactionRelationshipDataTable();
}

ReportTeamEvent()

void UAIBPLib::ReportTeamEvent ( AActor * InBroadcaster, AActor * InEnemy, const FVector & InLastKnowLocation, const float EventRange, const float PassedInfoAge, const float InStrength )

static

{
    SCOPE_CYCLE_COUNTER(STATGROUP_AIToolKit_BPLib);
    TRACE_CPUPROFILER_EVENT_SCOPE(UAIBPLib::ReportTeamEvent);
    if (InBroadcaster)
    {
        UAIPerceptionSystem* PerceptionSystem = UAIPerceptionSystem::GetCurrent(InBroadcaster);
        if (PerceptionSystem)
        {
            const FAITeamStimulusEvent Event = FAITeamStimulusEvent(InBroadcaster, InEnemy, InLastKnowLocation, EventRange, PassedInfoAge, InStrength);
            PerceptionSystem->OnEvent(Event);
        }
    }
}

ReportTouchEvent()

void UAIBPLib::ReportTouchEvent ( AActor * InTouchReceiver, AActor * InOtherActor, const FVector & EventLocation )

static

{
    SCOPE_CYCLE_COUNTER(STATGROUP_AIToolKit_BPLib);
    TRACE_CPUPROFILER_EVENT_SCOPE(UAIBPLib::ReportTouchEvent);
    if(InTouchReceiver == nullptr || InOtherActor == nullptr){return;}
    
    UAIPerceptionSystem* PerceptionSystem = UAIPerceptionSystem::GetCurrent(InTouchReceiver);
    if (PerceptionSystem)
    {
        const FAITouchEvent Event = FAITouchEvent(InTouchReceiver, InOtherActor, EventLocation);
        PerceptionSystem->OnEvent(Event);
    }
}

---

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

• T:/Unreal/Unreal Projects/SpaceAdventure52/SpaceAdventure/Plugins/AIToolKit/Source/AIToolKit/Public/BPLib/AIBPLib.h
• T:/Unreal/Unreal Projects/SpaceAdventure52/SpaceAdventure/Plugins/AIToolKit/Source/AIToolKit/Private/BPLib/AIBPLib.cpp