Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > AIModule > Perception > UAIPerceptionComponent

Light Theme

Dark Theme

UAIPerceptionComponent

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

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UActorComponent

UAIPerceptionComponent

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

	Name	Description
TObjectPtr< AAI...	AIOwner
TSubclassOf< UA...	DominantSense	Indicated sense that takes precedence over other senses when determining sensed actor's location.
FAISenseID	DominantSenseID
TArray< float >	MaxActiveAge	Max age of stimulus to consider it "active" (e.g. target is visible)
FPerceptionUpda...	OnPerceptionUpdated	Might want to move these to special "BP_AIPerceptionComponent".
FActorPerceptio...	OnTargetPerceptionInfoUpdated	Notifies all bound objects that perception info has been updated for a given target.
FActorPerceptio...	OnTargetPerceptionUpdated	Notifies all bound objects that perception info has been updated for a given target.
FPerceptionChan...	PerceptionFilter
TArray< TObject...	SensesConfig
TArray< FStimul...	StimuliToProcess

Constructors

	Name	Description
	UAIPerceptionComponent ( const FObjectInitializer& ObjectIn... )

Functions

	Name	Description
bool	AgeStimuli ( const float ConstPerceptionAgingRat... )	Returns true if, as result of stimuli aging, this listener needs an update (like if some stimuli expired)
void	CleanUp()	Called to clean up on owner's end play or destruction
void	ConfigureSense ( UAISenseConfig& SenseConfig )
void	DescribeSelfToVisLog ( FVisualLogEntry* Snapshot )
void	ForgetActor ( AActor* ActorToForget )
void	ForgetAll()	Basically cleans up PerceptualData, resulting in loss of all previous perception
const FActor...	GetActorInfo ( const AActor& Actor )
FVector	GetActorLocation ( const AActor& Actor )
bool	GetActorsPerception ( AActor* Actor, FActorPerceptionBlueprintInfo& Inf... )	Retrieves whatever has been sensed about given actor
const AActor...	GetBodyActor()
void	GetCurrentlyPerceivedActors ( TSubclassOf< UAISense > SenseToUse, TArray< AActor* >& OutActors )	If SenseToUse is none all actors currently perceived in any way will get fetched
TSubclassOf<...	GetDominantSense()
FAISenseID	GetDominantSenseID()
bool	GetFilteredActors ( TFunctionRef< bool..., TArray< AActor* >& OutActors )	Retrieves all actors in PerceptualData matching the predicate.
const FActor...	GetFreshestTrace ( const FAISenseID Sense )	@note Will stop on first age 0 stimulus
void	GetHostileActors ( TArray< AActor* >& OutActors )
void	GetHostileActorsBySense ( TSubclassOf< UAISense > SenseToFilt..., TArray< AActor* >& OutActors )
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
FPerceptionL...	GetListenerId()
void	GetLocationAndDirection ( FVector& Location, FVector& Direction )
AActor *	GetMutableBodyActor()
void	GetPerceivedHostileActors ( TArray< AActor* >& OutActors )
void	GetPerceivedHostileActorsBySense ( const TSubclassOf< UAISense > Sense..., TArray< AActor* >& OutActors )
const FPerce...	GetPerceptionFilter()
const FActor...	GetPerceptualData()
FActorPercep...	GetPerceptualData()
FActorPercep...	GetPerceptualDataConstIterator()
FActorPercep...	GetPerceptualDataIterator()
const UAISen...	GetSenseConfig ( const FAISenseID& SenseID )
UAISenseConf...	GetSenseConfig ( const FAISenseID& SenseID )
TAISenseConf...	GetSensesConfigIterator()
FGenericTeam...	GetTeamIdentifier()
float	GetYoungestStimulusAge ( const AActor& Source )
void	HandleExpiredStimulus ( FAIStimulus& StimulusStore )	@note no need to call super implementation, it's there just for some validity checking
bool	HasActiveStimulus ( const AActor& Source, FAISenseID Sense )
bool	HasAnyActiveStimulus ( const AActor& Source )
bool	HasAnyCurrentStimulus ( const AActor& Source )
void	OnOwnerEndPlay ( AActor* Actor, EEndPlayReason::Type EndPlayReason )
void	ProcessStimuli()
void	RefreshStimulus ( FAIStimulus& StimulusStore, const FAIStimulus& NewStimulus )	Updates the stimulus entry in StimulusStore, if NewStimulus is more recent or stronger
void	RegisterStimulus ( AActor* Source, const FAIStimulus& Stimulus )
void	RemoveDeadData()
void	RequestStimuliListenerUpdate()	Notifies AIPerceptionSystem to update properties for this "stimuli listener"
void	SetDominantSense ( TSubclassOf< UAISense > InDominantS... )
void	SetSenseEnabled ( TSubclassOf< UAISense > SenseClass, const bool bEnable )	That this works only if given sense has been already configured for this component instance
void	UpdatePerceptionAllowList ( const FAISenseID Channel, const bool bNewValue )	Allows toggling senses on and off

Overridden from UActorComponent

		Name	Description
	void	OnRegister()	Called when a component is registered, after Scene is set, but before CreateRenderState_Concurrent or OnCreatePhysicsState are called.
	void	OnUnregister()	Called when a component is unregistered.

Overridden from UObject

		Name	Description
	void	BeginDestroy()	Called before destroying the object.
	void	PostInitProperties()	Called after the C++ constructor and after the properties have been initialized, including those loaded from config.

Classes

	Name	Description
	FStimulusToProcess

Typedefs

Name	Description
FActorPerceptionContainer
TActorPerceptionContainer
TAISenseConfigConstIterator

Constants

Name	Description
InitialStimuliToProcessArraySize

Deprecated Functions

	Name	Description
void	GetPerceivedActors ( TSubclassOf< UAISense > SenseToUse, TArray< AActor* >& OutActors )	GetPerceivedActors is deprecated. Use GetCurrentlyPerceivedActors or GetKnownPerceivedActors
void	UpdatePerceptionFilter ( FAISenseID Channel, bool bNewValue )	Function has been renamed and made public. Please use UpdatePerceptionAllowList instead
void	UpdatePerceptionWhitelist ( const FAISenseID Channel, const bool bNewValue )	Use UpdatePerceptionAllowList instead