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

Light Theme

Dark Theme

AAIController

AIController is the base class of controllers for AI-controlled Pawns.

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

AActor

AController

AAIController

	ADetourCrowdAIController
	AGridPathAIController

References

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

Syntax

class AAIController :
    public AController,
    public IAIPerceptionListenerInterface,
    public IGameplayTaskOwnerInterface,
    public IGenericTeamAgentInterface,
    public IVisualLoggerDebugSnapshotInterface

Remarks

AIController is the base class of controllers for AI-controlled Pawns.

Controllers are non-physical actors that can be attached to a pawn to control its actions. AIControllers manage the artificial intelligence for the pawns they control. In networked games, they only exist on the server.

Variables

	Name	Description
uint32: 1	bAllowStrafe	Is strafing allowed during movement?
UBlackboardComp...	Blackboard	Blackboard
uint32: 1	bLOSflag	Used for alternating LineOfSight traces
UBrainComponent...	BrainComponent	Component responsible for behaviors.
uint32: 1	bSetControlRotationFromPawnOrientation	Copy Pawn rotation to ControlRotation, if there is no focus point.
uint32: 1	bSkipExtraLOSChecks	Skip extra line of sight traces to extremities of target being checked.
uint32: 1	bStartAILogicOnPossess	By default AI's logic does not start when controlled Pawn is possessed.
uint32: 1	bStopAILogicOnUnposses	By default AI's logic gets stopped when controlled Pawn is unpossessed.
uint32: 1	bWantsPlayerState	Specifies if this AI wants its own PlayerState.
UGameplayTasksC...	CachedGameplayTasksComponent
TSubclassOf< UN...	DefaultNavigationFilterClass
FFocusKnowledge	FocusInformation
UAIPerceptionCo...	PerceptionComponent
FAIMoveComplete...	ReceiveMoveCompleted	Blueprint notification that we've completed the current movement request

Constructors

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

Functions

	Name	Description
void	ActorsPerceptionUpdated ( const TArray< AActor* >& Upda... )	Notifies AIController of changes in given actors' perception
bool	AreAIIgnoringPlayers()
bool	BuildPathfindingQuery ( const FAIMoveRequest& MoveRequest, FPathFindingQuery& Query )	Helper function for creating pathfinding query for this agent from move request data
void	ClaimTaskResource ( TSubclassOf< UGameplayTaskResource ... )
void	ClearFocus ( EAIFocusPriority::Type InPriority )	Clears Focus for given priority, will also clear FocalPoint as a result
void	FindPathForMoveRequest ( const FAIMoveRequest& MoveRequest, FPathFindingQuery& Query, FNavPathSharedPtr& OutPath )	Finds path for given move request
UPawnActions...	GetActionsComp()	Returns ActionsComp subobject
const UAIPer...	GetAIPerceptionComponent()
UAIPerceptio...	GetAIPerceptionComponent()
UBlackboardC...	GetBlackboardComponent()
const UBlack...	GetBlackboardComponent()
UBrainCompon...	GetBrainComponent()
FAIRequestID	GetCurrentMoveRequestID()	Returns the Move Request ID for the current move
FString	GetDebugIcon()	Debug/dev-time
TSubclassOf<...	GetDefaultNavigationFilterClass()
FVector	GetFocalPoint()	Retrieve the final position that controller should be looking at.
FVector	GetFocalPointForPriority ( EAIFocusPriority::Type InPriority )
FVector	GetFocalPointOnActor ( const AActor* Actor )	Retrieve the focal point this controller should focus to on given actor.
AActor *	GetFocusActor()	Get the focused actor.
AActor *	GetFocusActorForPriority ( EAIFocusPriority::Type InPriority )
UGameplayTas...	GetGameplayTasksComponent()
FVector	GetImmediateMoveDestination()	Returns position of current path segment's end.
EPathFollowi...	GetMoveStatus()	Returns status of path following
UPathFollowi...	GetPathFollowingComponent()	Returns PathFollowingComponent subobject
bool	HasPartialPath()	Returns true if the current PathFollowingComponent's path is partial (does not reach desired destination).
bool	InitializeBlackboard ( UBlackboardComponent& BlackboardCo..., UBlackboardData& BlackboardAsset )
void	K2_ClearFocus()	Clears Focus, will also clear FocalPoint as a result
void	K2_SetFocalPoint ( FVector FP )	Set the position that controller should be looking at.
void	K2_SetFocus ( AActor* NewFocus )	Set Focus for actor, will set FocalPoint as a result.
bool	LineOfSightTo ( const AActor* Other, FVector ViewPoint, bool bAlternateChecks )	Checks line to center and top of other actor
FPathFollowi...	MoveTo ( const FAIMoveRequest& MoveRequest, FNavPathSharedPtr* OutPath )	Makes AI go toward specified destination
EPathFollowi...	MoveToActor ( AActor* Goal, float AcceptanceRadius, bool bStopOnOverlap, bool bUsePathfinding, bool bCanStrafe, TSubclassOf< UNavigationQueryFilter..., bool bAllowPartialPath )	Makes AI go toward specified Goal actor (destination will be continuously updated), aborts any active path following
EPathFollowi...	MoveToLocation ( const FVector& Dest, float AcceptanceRadius, bool bStopOnOverlap, bool bUsePathfinding, bool bProjectDestinationToNavigatio..., bool bCanStrafe, TSubclassOf< UNavigationQueryFilter..., bool bAllowPartialPath )	Makes AI go toward specified Dest location, aborts any active path following
void	OnGameplayTaskResourcesClaimed ( FGameplayResourceSet NewlyClaimed, FGameplayResourceSet FreshlyRelease... )
void	OnMoveCompleted ( FAIRequestID RequestID, EPathFollowingResult::Type Result )
void	OnMoveCompleted ( FAIRequestID RequestID, const FPathFollowingResult& Result )	Called on completing current movement request
void	OnUsingBlackBoard ( UBlackboardComponent* Blackboa..., UBlackboardData* BlackboardAss... )
bool	PauseMove ( FAIRequestID RequestToPause )	If AI is currently moving due to request given by RequestToPause, then the move will be paused
bool	PerformAction ( UPawnAction& Action, EAIRequestPriority::Type Priority, UObject*const Instigator )	Actions.
bool	PreparePathfinding ( const FAIMoveRequest& MoveRequest, FPathFindingQuery& Query )
FAIRequestID	RequestMove ( const FAIMoveRequest& MoveRequest, FNavPathSharedPtr Path )	Passes move request and path object to path following
FAIRequestID	RequestPathAndMove ( const FAIMoveRequest& MoveRequest, FPathFindingQuery& Query )
bool	ResumeMove ( FAIRequestID RequestToResume )	Resumes last AI-performed, paused request provided it's ID was equivalent to RequestToResume
bool	RunBehaviorTree ( UBehaviorTree* BTAsset )	Starts executing behavior tree.
void	SetFocalPoint ( FVector NewFocus, EAIFocusPriority::Type InPriority )	Set FocalPoint for given priority as absolute position or offset from base.
void	SetFocus ( AActor* NewFocus, EAIFocusPriority::Type InPriority )	Set Focus actor for given priority, will set FocalPoint as a result.
void	SetMoveBlockDetection ( bool bEnable )	Updates state of movement block detection.
void	SetPathFollowingComponent ( UPathFollowingComponent* NewPF... )	Note that his function does not do any pathfollowing state transfer.
void	SetPerceptionComponent ( UAIPerceptionComponent& InPercepti... )
bool	ShouldSyncBlackboardWith ( const UBlackboardComponent& OtherB... )	Does this AIController allow given UBlackboardComponent sync data with it
bool	SuggestTossVelocity ( FVector& OutTossVelocity, FVector Start, FVector End, float TossSpeed, bool bPreferHighArc, float CollisionRadius, bool bOnlyTraceUp )	Computes a launch velocity vector to toss a projectile and hit the given destination.
void	ToggleAIIgnorePlayers()	Cheat/debugging functions.
void	UnclaimTaskResource ( TSubclassOf< UGameplayTaskResource ... )
void	UpdateControlRotation ( float DeltaTime, bool bUpdatePawn )	Update direction AI is looking based on FocalPoint
bool	UseBlackboard ( UBlackboardData* BlackboardAss..., UBlackboardComponent*& Blackbo... )	Makes AI use the specified Blackboard asset & creates a Blackboard Component if one does not already exist.

Overridden from AController

	Name	Description
void	DisplayDebug ( UCanvas* Canvas, const FDebugDisplayInfo& DebugDisp..., float& YL, float& YPos )
void	OnPossess ( APawn* InPawn )	Overridable native function for when this controller possesses a pawn.
void	OnUnPossess()	Overridable native function for when this controller unpossesses its pawn.
void	SetPawn ( APawn* InPawn )	Setter for Pawn. Normally should only be used internally when possessing/unpossessing a Pawn.
void	StopMovement()	Aborts the move the controller is currently performing

Overridden from AActor

	Name	Description
void	PostInitializeComponents()	Overridden to create the player replication info and perform other mundane initialization tasks.
void	PostRegisterAllComponents()	Called after all the components in the Components array are registered, called both in editor and during gameplay
void	Reset()	Reset actor to initial state - used when restarting level without reloading.
void	Tick ( float DeltaSeconds )	Function called every frame on this Actor.

Overridden from INavAgentInterface

	Name	Description
IPathFollowi...	GetPathFollowingAgent()	Retrieves PathFollowingAgent for this NavAgent
bool	IsFollowingAPath()	Checks if the agent is actively following a navigation path
bool	ShouldPostponePathUpdates()	Allows delaying repath requests

Overridden from IAIPerceptionListenerInterface

		Name	Description
	UAIPerceptio...	GetPerceptionComponent()

Overridden from IGameplayTaskOwnerInterface

	Name	Description
AActor *	GetGameplayTaskAvatar ( const UGameplayTask* Task )	Get "body" of task's owner / default, having location in world (e.g. Owner = AIController, Avatar = Pawn)
uint8	GetGameplayTaskDefaultPriority()	Get default priority for running a task
AActor *	GetGameplayTaskOwner ( const UGameplayTask* Task )	Get owner of a task or default one when task is null
UGameplayTas...	GetGameplayTasksComponent ( const UGameplayTask& Task )	Finds tasks component for given GameplayTask, Task.GetGameplayTasksComponent() may not be initialized at this point!
void	OnGameplayTaskActivated ( UGameplayTask& Task )	Notify called after GameplayTask changes state to Active (initial activation or resuming)
void	OnGameplayTaskDeactivated ( UGameplayTask& Task )	Notify called after GameplayTask changes state from Active (finishing or pausing)
void	OnGameplayTaskInitialized ( UGameplayTask& Task )	Add empty overrides to fix linker errors if project implements a child class without adding GameplayTasks module dependency

Overridden from IGenericTeamAgentInterface

		Name	Description
	FGenericTeam...	GetGenericTeamId()	Retrieve team identifier in form of FGenericTeamId
	void	SetGenericTeamId ( const FGenericTeamId& TeamID )	Assigns Team Agent to given TeamID

Overridden from IVisualLoggerDebugSnapshotInterface

		Name	Description
	void	GrabDebugSnapshot ( FVisualLogEntry* Snapshot )

Constants

Name	Description
bAIIgnorePlayers	If true, AI controllers will ignore players.