1. Epic GamesDeveloper
  3. AAIController

AAIController

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

API > API/Runtime > API/Runtime/AIModule

Inheritance Hierarchy

References

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

Syntax

UCLASS (ClassGroup=AI, BlueprintType, Blueprintable, MinimalAPI)  
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

  Type Name Description
Public variable UProperty Category, EditAnywhere BlueprintReadWrite uint32: 1 bAllowStrafe Is strafing allowed during movement?
Protected variable UProperty Category, Meta BlueprintReadOnly TObjectPtr< UBlackboardComponent > Blackboard Blackboard
Public variable UProperty uint32: 1 bLOSflag Used for alternating LineOfSight traces
Public variable UProperty Category BlueprintReadWrite TObjectPtr< UBrainComponent > BrainComponent Component responsible for behaviors.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite uint32: 1 bSetControlRotationFromPawnOrientation Copy Pawn rotation to ControlRotation, if there is no focus point.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite uint32: 1 bSkipExtraLOSChecks Skip extra line of sight traces to extremities of target being checked.
Protected variable UProperty Category, EditAnywhere BlueprintReadWrite uint32: 1 bStartAILogicOnPossess By default AI's logic does not start when controlled Pawn is possessed.
Protected variable UProperty Category, EditAnywhere BlueprintReadWrite uint32: 1 bStopAILogicOnUnposses By default AI's logic gets stopped when controlled Pawn is unpossessed.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite uint32: 1 bWantsPlayerState Specifies if this AI wants its own PlayerState.
Protected variable UProperty TObjectPtr< UGameplayTasksComponent > CachedGameplayTasksComponent  
Protected variable UProperty Category, EditAnywhere BlueprintReadWrite TSubclassOf< UNavigationQueryFilter > DefaultNavigationFilterClass  
Protected variable FFocusKnowledge FocusInformation  
Public variable UProperty Category visibledefaultsonly TObjectPtr< UAIPerceptionComponent > PerceptionComponent  
Public variable FPathFindingQuery & Query  
Public variable UProperty Meta BlueprintAssignable FAIMoveCompletedSignature ReceiveMoveCompleted Blueprint notification that we've completed the current movement request
Public variable EPathFollowingResult::Type Result  

Constructors

  Type Name Description
Public function  

AAIController ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function Virtual void

ActorsPerceptionUpdated ( const TArray< AActor* >& UpdatedActors
)

 Notifies AIController of changes in given actors' perception
Public function Static bool  
Public function Const bool

BuildPathfindingQuery ( const FAIMoveRequest& MoveRequest,
FPathFindingQuery& Query
)

 Helper function for creating pathfinding query for this agent from move request data
Public function UFunction BlueprintCallable, Category void

ClaimTaskResource ( TSubclassOf< UGameplayTaskResource > ResourceClass
)

  
Protected function Virtual void  
Public function Virtual void Clears Focus for given priority, will also clear FocalPoint as a result
Public function Virtual void

DisplayDebug ( UCanvas* Canvas,
const FDebugDisplayInfo& DebugDisplay,
float& YL,
float& YPos
)

  
Public function Virtual Const void Finds path for given move request
Public function Const UDEPRECATED_PawnActionsComponent * DEPRECATED.
Public function Const const UAIPerceptionComponent *  
Public function UFunction BlueprintPure, Category UAIPerceptionComponent *  
Public function Const const UBlackboardComponent *  
Public function UBlackboardComponent *  
Public function Const UBrainComponent *  
Public function Const FAIRequestID Returns the Move Request ID for the current move
Public function Virtual Const FString Debug/dev-time
Public function Const TSubclassOf< UNavigationQueryFilter >  
Public function Const UFunction Meta blueprintgetter UDEPRECATED_PawnActionsComponent *  
Public function Const UFunction BlueprintCallable, Category FVector Retrieve the final position that controller should be looking at.
Public function Const FVector  
Public function Virtual Const UFunction BlueprintCallable, Category FVector

GetFocalPointOnActor ( const AActor* Actor
)

 Retrieve the focal point this controller should focus to on given actor.
Public function Const UFunction BlueprintCallable, Category AActor * Get the focused actor.
Public function Const AActor *  
Public function Virtual Const AActor *

GetGameplayTaskAvatar ( const UGameplayTask* Task
)

  
Public function Virtual Const uint8  
Public function Virtual Const AActor *

GetGameplayTaskOwner ( const UGameplayTask* Task
)

  
Public function Const UGameplayTasksComponent *  
Public function Virtual Const UGameplayTasksComponent *

GetGameplayTasksComponent ( const UGameplayTask& Task
)

  
Public function Const UFunction BlueprintCallable, Category FVector Returns position of current path segment's end.
Public function Const UFunction BlueprintCallable, Category EPathFollowingStatus::Type Returns status of path following
Public function Virtual Const IPathFollowingAgentInterface *  
Public function Const UFunction BlueprintCallable, Category UPathFollowingComponent * Returns PathFollowingComponent subobject
Public function Virtual Const void

GrabDebugSnapshot ( FVisualLogEntry* Snapshot
)

  
Public function Const UFunction BlueprintCallable, Category bool Returns true if the current PathFollowingComponent's path is partial (does not reach desired destination).
Protected function Virtual bool

InitializeBlackboard ( UBlackboardComponent& BlackboardComp,
UBlackboardData& BlackboardAsset
)

  
Public function Virtual Const bool  
Public function UFunction BlueprintCallable, Category, Meta void Clears Focus, will also clear FocalPoint as a result
Public function UFunction BlueprintCallable, Category, Meta void

K2_SetFocalPoint ( FVector FP
)

 Set the position that controller should be looking at.
Public function UFunction BlueprintCallable, Category, Meta void

K2_SetFocus ( AActor* NewFocus
)

 Set Focus for actor, will set FocalPoint as a result.
Public function Virtual Const bool

LineOfSightTo ( const AActor* Other,
FVector ViewPoint,
bool bAlternateChecks
)

 Checks line to center and top of other actor
Public function Virtual FPathFollowingRequestResult

MoveTo ( const FAIMoveRequest& MoveRequest,
FNavPathSharedPtr* OutPath
)

 Makes AI go toward specified destination
Public function UFunction BlueprintCallable, Category, Meta EPathFollowingRequestResult::Type

MoveToActor ( AActor* Goal,
float AcceptanceRadius,
bool bStopOnOverlap,
bool bUsePathfinding,
bool bCanStrafe,
TSubclassOf< UNavigationQueryFilter > FilterClass,
bool bAllowPartialPath
)

 Makes AI go toward specified Goal actor (destination will be continuously updated), aborts any active path following
Public function UFunction BlueprintCallable, Category, Meta EPathFollowingRequestResult::Type

MoveToLocation ( const FVector& Dest,
float AcceptanceRadius,
bool bStopOnOverlap,
bool bUsePathfinding,
bool bProjectDestinationToNavigation,
bool bCanStrafe,
TSubclassOf< UNavigationQueryFilter > FilterClass,
bool bAllowPartialPath
)

 Makes AI go toward specified Dest location, aborts any active path following
Public function Virtual void

OnGameplayTaskActivated ( UGameplayTask& Task
)

  
Public function Virtual void

OnGameplayTaskDeactivated ( UGameplayTask& Task
)

  
Public function Virtual void

OnGameplayTaskInitialized ( UGameplayTask& Task
)

 Add empty overrides to fix linker errors if project implements a child class without adding GameplayTasks module dependency
Public function Virtual UFunction void

OnGameplayTaskResourcesClaimed ( FGameplayResourceSet NewlyClaimed,
FGameplayResourceSet FreshlyReleased
)

  
Public function Virtual void

OnMoveCompleted ( FAIRequestID RequestID,
const FPathFollowingResult& Result
)

 Called on completing current movement request
Protected function Virtual void

OnPossess ( APawn* InPawn
)

  
Protected function Virtual void  
Protected function UFunction BlueprintImplementableEvent void

OnUsingBlackBoard ( UBlackboardComponent* BlackboardComp,
UBlackboardData* BlackboardAsset
)

  
Public function bool

PauseMove ( FAIRequestID RequestToPause
)

 If AI is currently moving due to request given by RequestToPause, then the move will be paused
Public function bool

PerformAction ( UDEPRECATED_PawnAction& Action,
EAIRequestPriority::Type Priority,
UObject*const Instigator
)

  
Public function Virtual void  
Public function Virtual void  
Public function Virtual FAIRequestID

RequestMove ( const FAIMoveRequest& MoveRequest,
FNavPathSharedPtr Path
)

 Passes move request and path object to path following
Public function Virtual void

Reset ()

  
Public function bool

ResumeMove ( FAIRequestID RequestToResume
)

 Resumes last AI-performed, paused request provided it's ID was equivalent to RequestToResume
Public function Virtual UFunction BlueprintCallable, Category bool Starts executing behavior tree.
Public function Virtual void

SetFocalPoint ( FVector NewFocus,
EAIFocusPriority::Type InPriority
)

 Set FocalPoint for given priority as absolute position or offset from base.
Public function Virtual void

SetFocus ( AActor* NewFocus,
EAIFocusPriority::Type InPriority
)

 Set Focus actor for given priority, will set FocalPoint as a result.
Public function UFunction BlueprintCallable, Category void

SetMoveBlockDetection ( bool bEnable
)

 Updates state of movement block detection.
Public function UFunction BlueprintCallable, Category void Note that this function does not do any pathfollowing state transfer.
Public function Virtual void

SetPawn ( APawn* InPawn
)

  
Public function void

SetPerceptionComponent ( UAIPerceptionComponent& InPerceptionComponent
)

  
Public function Virtual Const bool  
Public function Virtual Const bool

ShouldSyncBlackboardWith ( const UBlackboardComponent& OtherBlackboardComponent
)

 Does this AIController allow given UBlackboardComponent sync data with it
Public function Virtual void Aborts the move the controller is currently performing
Public function 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.
Public function Virtual void

Tick ( float DeltaTime
)

  
Public function Static void Cheat/debugging functions.
Public function Const  

UE_DEPRECATED_FORGAME (

  1. 13,
    "This function is now deprecated,
    please use FindPathForMoveRequest() for adjusting pathfinding or path postprocess."
    )
  
Public function Const  

UE_DEPRECATED_FORGAME (

  1. 13,
    "This function is now deprecated,
    please use FindPathForMoveRequest() for adjusting Query or BuildPathfindingQuery() for getting one."
    )
  
Public function  

UE_DEPRECATED_FORGAME (

  1. 13,
    "This function is now deprecated,
    please use version with EPathFollowingResultDetails parameter."
    )
  
Public function UFunction BlueprintCallable, Category void

UnclaimTaskResource ( TSubclassOf< UGameplayTaskResource > ResourceClass
)

  
Public function Virtual void

UpdateControlRotation ( float DeltaTime,
bool bUpdatePawn
)

 Update direction AI is looking based on FocalPoint
Public function UFunction BlueprintCallable, Category bool

UseBlackboard ( UBlackboardData* BlackboardAsset,
UBlackboardComponent*& BlackboardComponent
)

 Makes AI use the specified Blackboard asset & creates a Blackboard Component if one does not already exist.

Overridden from IAIPerceptionListenerInterface

  Type Name Description
Public function Virtual UAIPerceptionComponent *  

Overridden from IGenericTeamAgentInterface

  Type Name Description
Public function Virtual Const FGenericTeamId Retrieve team identifier in form of FGenericTeamId
Public function Virtual void

SetGenericTeamId ( const FGenericTeamId& TeamID
)

 Assigns Team Agent to given TeamID

Constants

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

See Also

https://docs.unrealengine.com/latest/INT/Gameplay/Framework/Controller/

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page