APatrolPath Class Reference

#include <PatrolPath.h>

Inheritance diagram for APatrolPath:

Public Member Functions
	APatrolPath ()
virtual bool	GetTimeToWait (float &WaitMin, float &WaitMax) const override
virtual AActor *	GetNextPatrolPointActor (bool &bIsBridgeAvailable) const override
virtual AActor *	GetNextBridgePatrolPointActor () const override
virtual AActor *	GetPreviousPatrolPointActor (bool &bIsBridgeAvailable) const override
virtual float	GetRadius () const override
virtual bool	GetIsDeadEnd () const override
virtual void	SetGravityEnabled (const bool bValue) override
virtual FString	GetObjectDisplayName () const override
virtual FInteractionData	GetInteractionData () const override
virtual bool	GetIsCharacter () const override
virtual void	OnFinishSpawning () override

Protected Member Functions
virtual void	BeginPlay () override
virtual bool	SetInteractionHidden (const EInteractionType Interaction, const bool bValue) override
virtual void	SetOnlyInteractionVisible (const EInteractionType Interaction) override
virtual bool	SetInteractionAvailable (const EInteractionType Interaction, const bool bValue) override
virtual bool	SetInteractionHold (const EInteractionType Interaction, const bool bValue) override
virtual TArray< FInteractionType >	GetVisibleInteractions () const override
virtual bool	GetInteraction (FInteractionType &Type, const EInteractionType Interaction) const override
virtual bool	GetDefaultInteraction (FInteractionType &Type) const override

Protected Attributes
class UAIPerceptionStimuliSourceComponent *	AIStimuliComponent
class USplineComponent *	SplineComponent
FInteractionData	InteractionData = FInteractionData(EInteractionType::None, EAIStimuliType::PatrolPath)
FLinearColor	PathColor = FLinearColor::Blue
int32	PathGroup = 1
float	Radius = 50.0f
bool	bDebuggingMode = false

Constructor & Destructor Documentation

APatrolPath()

APatrolPath::APatrolPath

(

)

{
    PrimaryActorTick.bCanEverTick = false;
 
    AIStimuliComponent = CreateDefaultSubobject<UAIPerceptionStimuliSourceComponent>(TEXT("Stimuli Component"));
    AIStimuliComponent->RegisterForSense(UAISenseConfig_Sight::StaticClass());
 
    SplineComponent = CreateDefaultSubobject<USplineComponent>(TEXT("Spline Component"));
    RootComponent = SplineComponent;
}

Member Function Documentation

BeginPlay()

void APatrolPath::BeginPlay ( )

overrideprotectedvirtual

{
    Super::BeginPlay();
    AIStimuliComponent->RegisterWithPerceptionSystem(); 
}

GetDefaultInteraction()

virtual bool APatrolPath::GetDefaultInteraction ( FInteractionType & Type ) const

inlineoverrideprotectedvirtual

    {return InteractionData.GetDefaultInteraction(Type);}

GetInteraction()

virtual bool APatrolPath::GetInteraction ( FInteractionType & Type, const EInteractionType Interaction ) const

inlineoverrideprotectedvirtual

    {return InteractionData.GetInteraction(Type, Interaction);}

GetInteractionData()

virtual FInteractionData APatrolPath::GetInteractionData ( ) const

inlineoverridevirtual

{ return InteractionData;};

GetIsCharacter()

virtual bool APatrolPath::GetIsCharacter ( ) const

inlineoverridevirtual

{return false;};

GetIsDeadEnd()

bool APatrolPath::GetIsDeadEnd ( ) const

overridevirtual

Implements IPatrolInterface.

{
    return false;
}

GetNextBridgePatrolPointActor()

AActor * APatrolPath::GetNextBridgePatrolPointActor ( ) const

overridevirtual

Implements IPatrolInterface.

{
    return nullptr;
}

GetNextPatrolPointActor()

AActor * APatrolPath::GetNextPatrolPointActor ( bool & bIsBridgeAvailable ) const

overridevirtual

Implements IPatrolInterface.

{
    return nullptr;
}

GetObjectDisplayName()

virtual FString APatrolPath::GetObjectDisplayName ( ) const

inlineoverridevirtual

{return "Patrol Path";};

GetPreviousPatrolPointActor()

AActor * APatrolPath::GetPreviousPatrolPointActor ( bool & bIsBridgeAvailable ) const

overridevirtual

Implements IPatrolInterface.

{
    return nullptr;
}

GetRadius()

virtual float APatrolPath::GetRadius ( ) const

inlineoverridevirtual

Reimplemented from IPatrolInterface.

{return Radius;};

GetTimeToWait()

bool APatrolPath::GetTimeToWait ( float & WaitMin, float & WaitMax ) const

overridevirtual

Implements IPatrolInterface.

{
    return true;
}

GetVisibleInteractions()

virtual TArray< FInteractionType > APatrolPath::GetVisibleInteractions ( ) const

inlineoverrideprotectedvirtual

    {return InteractionData.GetVisibleInteractions();}

OnFinishSpawning()

void APatrolPath::OnFinishSpawning ( )

overridevirtual

{
 
}

SetGravityEnabled()

virtual void APatrolPath::SetGravityEnabled ( const bool bValue )

inlineoverridevirtual

{return;};

SetInteractionAvailable()

virtual bool APatrolPath::SetInteractionAvailable ( const EInteractionType Interaction, const bool bValue )

inlineoverrideprotectedvirtual

    {return InteractionData.SetInteractionAvailable(Interaction, bValue);}

SetInteractionHidden()

virtual bool APatrolPath::SetInteractionHidden ( const EInteractionType Interaction, const bool bValue )

inlineoverrideprotectedvirtual

Interaction Data Manipulation, so Actors can change there Interaction Data struct from BP

    {return InteractionData.SetInteractionHidden(Interaction, bValue);};

SetInteractionHold()

virtual bool APatrolPath::SetInteractionHold ( const EInteractionType Interaction, const bool bValue )

inlineoverrideprotectedvirtual

    {return InteractionData.SetInteractionHold(Interaction, bValue);}

SetOnlyInteractionVisible()

virtual void APatrolPath::SetOnlyInteractionVisible ( const EInteractionType Interaction )

inlineoverrideprotectedvirtual

    {InteractionData.SetOnlyInteractionVisible(Interaction);}

Member Data Documentation

AIStimuliComponent

class UAIPerceptionStimuliSourceComponent* APatrolPath::AIStimuliComponent

protected

bDebuggingMode

bool APatrolPath::bDebuggingMode = false

protected

InteractionData

FInteractionData APatrolPath::InteractionData = FInteractionData(EInteractionType::None, EAIStimuliType::PatrolPath)

protected

PathColor

FLinearColor APatrolPath::PathColor = FLinearColor::Blue

protected

PathGroup

int32 APatrolPath::PathGroup = 1

protected

Radius

float APatrolPath::Radius = 50.0f

protected

SplineComponent

class USplineComponent* APatrolPath::SplineComponent

protected

---

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

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