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

Light Theme

Dark Theme

FAIStimulus

Windows

MacOS

Linux

References

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

Syntax

struct FAIStimulus

Variables

	Name	Description
float	Age
uint32: 1	bExpired	This means the stimulus was originally created with a "time limit" and this time has passed.
uint32: 1	bSuccessfullySensed
uint32: 1	bWantsToNotifyOnlyOnValueChange
float	ExpirationAge
FVector	ReceiverLocation
FVector	StimulusLocation
float	Strength
FName	Tag
FAISenseID	Type

Constructors

	Name	Description
	FAIStimulus()	Default constructor
	FAIStimulus ( const UAISense& Sense, float StimulusStrength, const FVector& InStimulusLocation, const FVector& InReceiverLocation, FResult Result, FName InStimulusTag )	This is the recommended constructor. Use others if you know what you're doing.

Functions

		Name	Description
	bool	AgeStimulus ( float ConstPerceptionAgingRate )
	float	GetAge()
	FString	GetDebugDescription()
	bool	IsActive()
	bool	IsExpired()
	bool	IsValid()
	void	MarkExpired()
	void	MarkNoLongerSensed()
	FAIStimulus ...	SetExpirationAge ( float InExpirationAge )
	FAIStimulus ...	SetStimulusAge ( float StimulusAge )
	FAIStimulus ...	SetWantsNotifyOnlyOnValueChange ( bool InEnable )
	bool	WantsToNotifyOnlyOnPerceptionChange()
	bool	WasSuccessfullySensed()

Enums

	Name	Description
	FResult

Constants

Name	Description
NeverHappenedAge

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

Take our survey

Dismiss