1. Epic GamesDeveloper
  3. UAIPerceptionComponent

UAIPerceptionComponent

AIPerceptionComponent is used to register as stimuli listener in AIPerceptionSystem and gathers registered stimuli.

API > API/Runtime > API/Runtime/AIModule > API/Runtime/AIModule/Perception

Inheritance Hierarchy

References

   
Module AIModule
Header /Engine/Source/Runtime/AIModule/Classes/Perception/AIPerceptionComponent.h
Include #include "Perception/AIPerceptionComponent.h"

Syntax

class UAIPerceptionComponent : public UActorComponent

Remarks

AIPerceptionComponent is used to register as stimuli listener in AIPerceptionSystem and gathers registered stimuli. UpdatePerception is called when component gets new stimuli (batched)

Variables

  Type Name Description
Protected variable TObjectPtr< AAIController > AIOwner  
Protected variable TSubclassOf< UAISense > DominantSense Indicated sense that takes precedence over other senses when determining sensed actor's location.
Protected variable FAISenseID DominantSenseID  
Protected variable TArray< float > MaxActiveAge Max age of stimulus to consider it "active" (e.g. target is visible)
Public variable FPerceptionUpdatedDelegate OnPerceptionUpdated Might want to move these to special "BP_AIPerceptionComponent".
Public variable FActorPerceptionForgetUpdatedDelegate OnTargetPerceptionForgotten Notifies all bound delegates that the perception info has been forgotten for a given target.
Public variable FActorPerceptionInfoUpdatedDelegate OnTargetPerceptionInfoUpdated Notifies all bound objects that perception info has been updated for a given target.
Public variable FActorPerceptionUpdatedDelegate OnTargetPerceptionUpdated Notifies all bound objects that perception info has been updated for a given target.
Protected variable FPerceptionChannelAllowList PerceptionFilter  
Protected variable TArray< TObjectPtr< UAISenseConfig > > SensesConfig  
Protected variable TArray< FStimulusToProcess > StimuliToProcess  

Constructors

  Type Name Description
Public function  

UAIPerceptionComponent ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function bool

AgeStimuli ( const float ConstPerceptionAgingRate
)

 Returns true if, as result of stimuli aging, this listener needs an update (like if some stimuli expired)
Protected function Virtual void

CleanUp ()

 Called to clean up on owner's end play or destruction
Public function void

ConfigureSense ( UAISenseConfig& SenseConfig
)

  
Public function Virtual Const void  
Public function void

ForgetActor ( AActor* ActorToForget
)

  
Public function void Basically cleans up PerceptualData, resulting in loss of all previous perception
Public function Const const FActorPerceptionInfo *

GetActorInfo ( const AActor& Actor
)

  
Public function Const FVector

GetActorLocation ( const AActor& Actor
)

  
Public function bool Retrieves whatever has been sensed about given actor
Public function Const const AActor *  
Public function Const void

GetCurrentlyPerceivedActors ( TSubclassOf< UAISense > SenseToUse,
TArray< AActor* >& OutActors
)

 If SenseToUse is none all actors currently perceived in any way will get fetched
Public function Const TSubclassOf< UAISense >  
Public function Const FAISenseID  
Public function Const bool

GetFilteredActors ( TFunctionRef< bool(const FActorPerceptionInfo&)> Predicate,
TArray< AActor* >& OutActors
)

 Retrieves all actors in PerceptualData matching the predicate.
Public function Const const FActorPerceptionInfo *

GetFreshestTrace ( const FAISenseID Sense
)

 Will stop on first age 0 stimulus
Public function Virtual Const void

GetHostileActors ( TArray< AActor* >& OutActors
)

  
Public function Const void

GetHostileActorsBySense ( TSubclassOf< UAISense > SenseToFilterBy,
TArray< AActor* >& OutActors
)

  
Public function Const void

GetKnownPerceivedActors ( TSubclassOf< UAISense > SenseToUse,
TArray< AActor* >& OutActors
)

 If SenseToUse is none all actors ever perceived in any way (and not forgotten yet) will get fetched
Public function Const FPerceptionListenerID  
Public function Const void

GetLocationAndDirection ( FVector& Location,
FVector& Direction
)

  
Public function AActor *  
Public function Const void  
Public function Const void

GetPerceivedHostileActorsBySense ( const TSubclassOf< UAISense > SenseToUse,
TArray< AActor* >& OutActors
)

  
Public function Const const FPerceptionChannelAllowList  
Protected function Const const FActorPerceptionContainer &  
Protected function FActorPerceptionContainer &  
Public function Const FActorPerceptionContainer::TConstIterator  
Public function FActorPerceptionContainer::TIterator  
Public function Const const UAISenseConfig *

GetSenseConfig ( const FAISenseID& SenseID
)

  
Public function UAISenseConfig *

GetSenseConfig ( const FAISenseID& SenseID
)

  
Public function Const TAISenseConfigConstIterator  
Public function Const FGenericTeamId  
Public function Const float

GetYoungestStimulusAge ( const AActor& Source
)

  
Protected function Virtual void

HandleExpiredStimulus ( FAIStimulus& StimulusStore
)

 No need to call super implementation, it's there just for some validity checking
Public function Const bool

HasActiveStimulus ( const AActor& Source,
FAISenseID Sense
)

  
Public function Const bool

HasAnyActiveStimulus ( const AActor& Source
)

  
Public function Const bool

HasAnyCurrentStimulus ( const AActor& Source
)

  
Public function void

OnOwnerEndPlay ( AActor* Actor,
EEndPlayReason::Type EndPlayReason
)

  
Public function void  
Protected function Virtual void

RefreshStimulus ( FAIStimulus& StimulusStore,
const FAIStimulus& NewStimulus
)

 Updates the stimulus entry in StimulusStore, if NewStimulus is more recent or stronger
Public function void

RegisterStimulus ( AActor* Source,
const FAIStimulus& Stimulus
)

  
Protected function void  
Public function void Notifies AIPerceptionSystem to update properties for this "stimuli listener"
Public function void

SetDominantSense ( TSubclassOf< UAISense > InDominantSense
)

  
Public function void

SetSenseEnabled ( TSubclassOf< UAISense > SenseClass,
const bool bEnable
)

 Note that this works only if given sense has been already configured for this component instance
Public function void

UpdatePerceptionAllowList ( const FAISenseID Channel,
const bool bNewValue
)

 Allows toggling senses on and off

Overridden from UActorComponent

  Type Name Description
Public function Virtual void Called when a component is registered, after Scene is set, but before CreateRenderState_Concurrent or OnCreatePhysicsState are called.
Public function Virtual void Called when a component is unregistered.

Overridden from UObject

  Type Name Description
Public function Virtual void Called before destroying the object.
Public function Virtual void Called after the C++ constructor and after the properties have been initialized, including those loaded from config.

Classes

  Type Name Description
Protected struct FStimulusToProcess    

Typedefs

Name Description
FActorPerceptionContainer  
TActorPerceptionContainer  
TAISenseConfigConstIterator  

Constants

Name Description
InitialStimuliToProcessArraySize  

Deprecated Functions

  Type Name Description
Public function void

UpdatePerceptionWhitelist ( const FAISenseID Channel,
const bool bNewValue
)

 Use UpdatePerceptionAllowList instead

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page