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

Light Theme

Dark Theme

UAISense

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UAISense

	UAISense_Blueprint
	UAISense_Damage
	UAISense_Hearing
	UAISense_Prediction
	UAISense_Sight
	UAISense_Team
	UAISense_Touch

References

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

Syntax

class UAISense : public UObject

Variables

	Name	Description
uint32: 1	bAutoRegisterAllPawnsAsSources	If true all newly spawned pawns will get auto registered as source for this sense.
uint32: 1	bNeedsForgettingNotification	This sense has some internal logic that requires it to be notified when a listener wants to forget an actor
uint32: 1	bWantsNewPawnNotification	Whether this sense is interested in getting notified about new Pawns being spawned this can be used for example for automated sense sources registration
EAISenseNotifyT...	NotifyType
FOnPerceptionLi...	OnListenerRemovedDelegate	If bound will be called when a FPerceptionListener's in removed from AIPerceptionSystem
FOnPerceptionLi...	OnListenerUpdateDelegate	If bound will be called when a FPerceptionListener's in AIPerceptionSystem change
FOnPerceptionLi...	OnNewListenerDelegate	If bound will be called when new FPerceptionListener gets registers with AIPerceptionSystem
friend	UAIPerceptionSystem

Constructors

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

Functions

	Name	Description
void	ForceSenseID ( FAISenseID SenseID )	To be called only for BP-generated classes
AIPerception...	GetListeners()	Returning pointer rather then a reference to prevent users from accidentally creating copies by creating non-reference local vars
UAIPerceptio...	GetPerceptionSystem()
FAISenseID	GetSenseID()
FAISenseID	GetSenseID()
FAISenseID	GetSenseID ( const TSubclassOf< UAISense > Sense... )
UWorld *	GetWorld()
void	HardcodeSenseID ( TSubclassOf< UAISense > SenseClass, FAISenseID HardcodedID )	Use with caution! Needs to be called before any senses get instantiated or listeners registered.
bool	NeedsNotificationOnForgetting()
void	OnListenerConfigUpdated ( const FPerceptionListener& Updated... )
void	OnListenerForgetsActor ( const FPerceptionListener& Listene..., AActor& ActorToForget )
void	OnListenerForgetsAll ( const FPerceptionListener& Listene... )
void	OnListenerRemoved ( const FPerceptionListener& Removed... )
void	OnListenerUpdate ( const FPerceptionListener& Updated... )
void	OnNewListener ( const FPerceptionListener& NewList... )
void	OnNewPawn ( APawn& NewPawn )	Gets called when perception system gets notified about new spawned pawn.
bool	ProgressTime ( float DeltaSeconds )
void	RegisterSource ( AActor& SourceActors )	Virtual void RegisterSources(TArray SourceActors) {}
void	RegisterWrappedEvent ( UAISenseEvent& PerceptionEvent )
void	RequestImmediateUpdate()	Will result in updating as soon as possible
void	RequestUpdateInSeconds ( float UpdateInSeconds )	Will result in updating in specified number of seconds
void	SetSenseID ( FAISenseID Index )
bool	ShouldAutoRegisterAllPawnsAsSources()
void	Tick()
void	UnregisterSource ( AActor& SourceActors )
float	Update()
FAISenseID	UpdateSenseID()
bool	WantsNewPawnNotification()
bool	WantsUpdateOnlyOnPerceptionValueChange()

Overridden from UObject

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

Constants

Name	Description
SuspendNextUpdate

Deprecated Variables

		Name	Description
	float	DefaultExpirationAge	This property will be removed in future versions. Use AISenseConfig::MaxAge instead.

Deprecated Functions

	Name	Description
void	CleanseInvalidSources()	This method is no longer used and will be removed in future versions. UnregisterSource is called by AActor.OnEndPlay delegate and will perform the cleanup.
FColor	GetDebugColor()	Function removed, use AISenseConfig.GetDebugColor() instead.
FString	GetDebugLegend()	Function removed, use AISenseConfig.DescribeSelfToGameplayDebugger() instead.
FString	GetDebugName()	Function removed, use AISenseConfig.GetSenseName() instead.
float	GetDefaultExpirationAge()	This method will be removed in future versions. Perception relies on AISenseConfig::MaxAge so the value returned is no longer used by the perception system.

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

Take our survey

Dismiss