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

UBrainComponent

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UActorComponent

UBrainComponent

	UBehaviorTreeComponent
	UHTNBrainComponent

References

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

Syntax

class UBrainComponent :
public UActorComponent,
public IAIResourceInterface

Variables

	Name	Description
AAIController &...	AIOwner
UBlackboardComp...	BlackboardComp	Blackboard component
TArray< FAIMess...	MessageObservers	Active message observers
TArray< FAIMess...	MessagesToProcess	This is a temp contraption to implement delayed messages delivering until proper AI messaging is implemented
FAIResourceLock	ResourceLock	Used to keep track of which subsystem requested this AI resource be locked

Constructors

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

Functions

	Name	Description
void	CacheBlackboardComponent ( UBlackboardComponent* BBComp )	END UActorComponent overrides caches BlackboardComponent's pointer to be used with this brain component
void	Cleanup()	AI logic won't be needed anymore, stop all activity and run cleanup
void	DescribeSelfToVisLog ( FVisualLogEntry* Snapshot )
AAIControlle...	GetAIOwner()
UBlackboardC...	GetBlackboardComponent()
const UBlack...	GetBlackboardComponent()
FString	GetDebugInfoString()
void	HandleMessage ( const FAIMessage& Message )
bool	IsPaused()
bool	IsRunning()
void	PauseLogic ( const FString& Reason )	Pause logic and blackboard updates.
void	RequestLogicRestartOnUnlock()	To be called in case we want to restart AI logic while it's still being locked.
void	RestartLogic()	Restarts currently running or previously ran brain logic.
EAILogicResu...	ResumeLogic ( const FString& Reason )	Resumes paused brain logic. MUST be called by child implementations!
void	StartLogic()	Starts brain logic. If brain is already running, will not do anything.
void	StopLogic ( const FString& Reason )	Stops currently running brain logic.

Overridden from UActorComponent

	Name	Description
void	InitializeComponent()	BEGIN UActorComponent overrides
void	OnRegister()	Called when a component is registered, after Scene is set, but before CreateRenderState_Concurrent or OnCreatePhysicsState are called.
void	TickComponent ( float DeltaTime, enum ELevelTick TickType, FActorComponentTickFunction* T... )	Function called every frame on this ActorComponent.

Overridden from IAIResourceInterface

	Name	Description
void	ClearResourceLock ( EAIRequestPriority::Type LockSource )	Clear resource lock of the given origin
void	ForceUnlockResource()	Force-clears all locks on resource
bool	IsResourceLocked()	Check whether resource is currently locked
void	LockResource ( EAIRequestPriority::Type LockSource )	If resource is lockable lock it with indicated priority

Constants

Name	Description
AIMessage_MoveFinished	Static names to be used with SendMessage.
AIMessage_QueryFinished
AIMessage_RepathFailed

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

Take our survey

Dismiss