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 > UAIPerceptionSystem

Light Theme

Dark Theme

UAIPerceptionSystem

By design checks perception between hostile teams

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UAISubsystem

UAIPerceptionSystem

References

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

Syntax

class UAIPerceptionSystem : public UAISubsystem

Remarks

By design checks perception between hostile teams

Variables

	Name	Description
uint32: 1	bHandlePawnNotification
TArray< FDelaye...	DelayedStimuli
AIPerception::F...	ListenerContainer
float	NextStimuliAgingTick	Timestamp of the next stimuli aging
float	PerceptionAgingRate
TMap< const AAc...	RegisteredStimuliSources	Not a UPROPERTY on purpose so that we have a control over when stuff gets removed from the map
TArray< UAISens...	Senses
TArray< FPercep...	SourcesToRegister
FActorEndPlaySi...	StimuliSourceEndPlayDelegate

Constructors

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

Functions

	Name	Description
bool	AgeStimuli ( const float Amount )	Returns true if aging resulted in tagging any of the listeners to process its stimuli (
bool	DeliverDelayedStimuli ( EDelayedStimulusSorting Sorting )	Sorts DelayedStimuli and delivers all the ones that are no longer "in the future"
UAIPerceptio...	GetCurrent ( UObject* WorldContextObject )
UAIPerceptio...	GetCurrent ( UWorld& World )
AIPerception...	GetListenersMap()
TSubclassOf<...	GetSenseClassForStimulus ( UObject* WorldContextObject, const FAIStimulus& Stimulus )
bool	IsSenseInstantiated ( const FAISenseID& SenseID )
void	MakeNoiseImpl ( AActor* NoiseMaker, float Loudness, APawn* NoiseInstigator, const FVector& NoiseLocation, float MaxRange, FName Tag )
void	OnEvent ( const FEventClass& Event )
void	OnEvent ( UWorld* World, const FEventClass& Event )
void	OnEventsBatch ( const TArray< FEventClass >& Event... )
void	OnListenerConfigUpdated ( FAISenseID SenseID, const UAIPerceptionComponent& List... )
void	OnListenerForgetsActor ( const UAIPerceptionComponent& List..., AActor& ActorToForget )
void	OnListenerForgetsAll ( const UAIPerceptionComponent& List... )
void	OnListenerRemoved ( const FPerceptionListener& Updated... )
void	OnListenerUpdate ( const FPerceptionListener& Updated... )
void	OnNewListener ( const FPerceptionListener& NewList... )
void	OnNewPawn ( APawn& Pawn )
void	OnPerceptionStimuliSourceEndPlay ( AActor* Actor, EEndPlayReason::Type EndPlayReason )
void	PerformSourceRegistration()
void	RegisterAllPawnsAsSourcesForSense ( FAISenseID SenseID )	Iterates over all pawns and registeres them as a source for sense indicated by SenseID.
void	RegisterDelayedStimulus ( FPerceptionListenerID ListenerId, float Delay, AActor* Instigator, const FAIStimulus& Stimulus )
bool	RegisterPerceptionStimuliSource ( UObject* WorldContextObject, TSubclassOf< UAISense > Sense, AActor* Target )
FAISenseID	RegisterSenseClass ( TSubclassOf< UAISense > SenseClass )
void	RegisterSource ( AActor& SourceActor )	Registers given actor as a source for all registered senses
void	RegisterSource ( AActor& SourceActor )	Registers a source of given sense's stimuli
void	RegisterSource ( FAISenseID SenseID, AActor& SourceActor )	Requests registration of a given actor as a perception data source for specified sense
void	RegisterSourceForSenseClass ( TSubclassOf< UAISense > Sense, AActor& Target )
void	ReportEvent ( UAISenseEvent* PerceptionEvent )
void	ReportPerceptionEvent ( UObject* WorldContextObject, UAISenseEvent* PerceptionEvent )
void	StartPlay()
void	UnregisterListener ( UAIPerceptionComponent& Listener )
void	UnregisterSource ( AActor& SourceActor, const TSubclassOf< UAISense > Sense )	Unregisters given actor from the list of active stimuli sources
void	UpdateListener ( UAIPerceptionComponent& Listener )	Registers listener if not registered

Overridden from FTickableObjectBase

		Name	Description
	TStatId	GetStatId()	Return the stat id to use for this tickable
	void	Tick ( float DeltaTime )	FTickableGameObject begin.

Classes

	Name	Description
	FDelayedStimulus
	FPerceptionSourceRegistration

Enums

	Name	Description
	EDelayedStimulusSorting

Deprecated Variables

		Name	Description
	uint32: 1	bStimuliSourcesRefreshRequired	This property will be removed in future versions. UnregisterSource is called by AActor.OnEndPlay delegate and will perform the cleanup.

Deprecated Functions

		Name	Description
	void	AgeStimuli()	Parameterless AgeStimuli has been deprecated, please use the other AgeStimuli flavor. To get behavior identical to the old one calls AgeStimuli(PerceptionAgingRate).

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss