RealDocs UE 5.6

AIModule

4 views

87 entries in this module.

class Classes (7)

AAIController BP The base controller class for AI-driven pawns. UBehaviorTree A data asset that defines an AI's decision-making logic as a tree of composites, tasks, decorators, and services. UBehaviorTreeComponent The runtime component that executes a UBehaviorTree asset. UBlackboardComponent BP A component that stores key-value pairs for AI decision-making. UBTDecorator The base class for Behavior Tree decorator nodes. UBTService The base class for Behavior Tree service nodes. UBTTaskNode The base class for Behavior Tree leaf nodes that perform actions.

function Global Functions (77)

AAIController — UE_DEPRECATED_FORGAME annotations deprecated A compiler-warning macro applied to deprecated virtual functions in AAIController. AAIController::ActorsPerceptionUpdated Called by UAIPerceptionComponent when perception of one or more actors changes. AAIController::AreAIIgnoringPlayers Returns whether the global AI-ignore-players flag is currently set. AAIController::BuildPathfindingQuery Constructs an FPathFindingQuery from a move request and the current pawn's agent properties. AAIController::ClaimTaskResource BP Claims a gameplay task resource at the controller level, preventing any GameplayTask from using that resource until it is explicitly released via UnclaimTaskResource. AAIController::ClearFocus Clears the focus actor and focal point for the specified priority slot. AAIController::DisplayDebug Draws AI-specific debug information (behavior tree state, path, focus, perception) onto the HUD canvas when the 'AI' debug category is active via the `showdebug AI` console command. AAIController::FindPathForMoveRequest Executes pathfinding for a move request and stores the resulting path. AAIController::GetAIPerceptionComponent BP Returns the UAIPerceptionComponent attached to this controller. AAIController::GetBlackboardComponent Returns the Blackboard component associated with this controller, or null if UseBlackboard has not been called. AAIController::GetBrainComponent Returns the UBrainComponent currently driving this controller's AI logic, or null if none is active. AAIController::GetCurrentMoveRequestID Returns the FAIRequestID of the movement request currently being processed by the PathFollowingComponent. AAIController::GetDebugIcon Returns the path to the icon texture used when rendering this AI controller in the in-game AI debug display (`showdebug AI`). AAIController::GetDefaultNavigationFilterClass Returns the navigation query filter class assigned to this controller. AAIController::GetFocalPoint BP Returns the world-space position the controller is currently focused on, resolved across all priority levels. AAIController::GetFocalPointForPriority Returns the world-space focal point stored at the given priority slot, or FAISystem::InvalidLocation if no focus has been set at that priority. AAIController::GetFocalPointOnActor BP Returns the world-space point on the given actor that the controller should look at. AAIController::GetFocusActor BP Returns the actor currently set as this controller's focus target, or null if focus is on a static position or is unset. AAIController::GetFocusActorForPriority Returns the actor set as the focus target at the specified priority slot, or nullptr if no actor focus has been assigned at that priority. AAIController::GetGameplayTaskAvatar Returns the visual/physical avatar for gameplay tasks — the currently possessed pawn. AAIController::GetGameplayTaskDefaultPriority Returns the default priority for gameplay tasks initiated by this AI controller. AAIController::GetGameplayTaskOwner Returns the actor that owns the gameplay task — always the AI controller itself. AAIController::GetGameplayTasksComponent Returns the cached UGameplayTasksComponent for this controller, used to manage and run UGameplayTask instances. AAIController::GetGenericTeamId Returns the team ID assigned to this AI controller. AAIController::GetImmediateMoveDestination BP Returns the world-space position of the end point of the current path segment being followed. AAIController::GetMoveStatus BP Returns the current movement state of the PathFollowingComponent — Idle, Waiting, Paused, or Moving. AAIController::GetPathFollowingAgent Returns a pointer to the IPathFollowingAgentInterface implementation — in practice, the PathFollowingComponent cast to that interface. AAIController::GetPathFollowingComponent BP Returns the PathFollowingComponent subobject responsible for executing movement along a nav path. AAIController::GetPerceptionComponent Returns the UAIPerceptionComponent attached to this controller, satisfying the IAIPerceptionListenerInterface contract. AAIController::GrabDebugSnapshot Populates a Visual Logger snapshot with the controller's current AI state (path, focus, perception), enabling replay and analysis in the Visual Logger editor tool. AAIController::HasPartialPath BP Returns true if the PathFollowingComponent is currently following a partial path — one that does not reach the actual goal because the destination is unreachable. AAIController::IsFollowingAPath Returns true if the PathFollowingComponent currently has an active path being followed. AAIController::K2_ClearFocus BP Clears the controller's focus target and focal point at Gameplay priority. AAIController::K2_SetFocalPoint BP Sets the controller's focus to a fixed world-space position rather than a tracked actor. AAIController::K2_SetFocus BP Sets this controller's focus to a specific actor so the pawn continuously rotates toward it each tick. AAIController::LineOfSightTo Performs a line-trace from the controller's eye position to the target actor to determine visibility. AAIController::MoveTo The core move dispatch function — builds a path and passes it to the PathFollowingComponent. AAIController::MoveToActor BP Commands the AI to move toward a specified actor, continuously updating the destination as the goal moves. AAIController::MoveToLocation BP Commands the AI to navigate to a fixed world-space location. AAIController::OnGameplayTaskActivated Called when a gameplay task owned by this controller transitions to the active state. AAIController::OnGameplayTaskDeactivated Called when a gameplay task owned by this controller transitions out of the active state, either because it finished, was paused, or was cancelled. AAIController::OnGameplayTaskInitialized Called by the GameplayTasks system when a task owned by this controller is initialized. AAIController::OnGameplayTaskResourcesClaimed Called by the GameplayTasks component whenever resource ownership changes on this controller. AAIController::OnMoveCompleted Called by the engine when the current movement request finishes, is aborted, or is blocked. AAIController::PauseMove Temporarily halts the active path-following move without cancelling it, provided the active request ID matches RequestToPause. AAIController::PostInitializeComponents Called after all components are initialized. AAIController::PostRegisterAllComponents Called after all components have been registered with the world. AAIController::PreparePathfinding deprecated Deprecated since UE 4. AAIController::RequestMove Hands an already-computed path to the PathFollowingComponent and starts movement. AAIController::RequestPathAndMove deprecated Deprecated since UE 4. AAIController::Reset Called when the game is reset (e. AAIController::ResumeMove Resumes the last AI-paused move request if its ID matches RequestToResume. AAIController::RunBehaviorTree BP Starts executing the given Behavior Tree asset on this controller. AAIController::SetFocalPoint Sets a world-space position as the focal point at the given priority. AAIController::SetFocus Sets an actor as the AI's focus target at the given priority slot. AAIController::SetGenericTeamId Assigns a team ID to this AI controller, implementing the IGenericTeamAgentInterface. AAIController::SetMoveBlockDetection BP Enables or disables movement block detection on the PathFollowingComponent. AAIController::SetPathFollowingComponent BP Replaces the active PathFollowingComponent with a different one. AAIController::SetPawn Called internally when the controlled pawn changes. AAIController::SetPerceptionComponent Assigns an existing UAIPerceptionComponent to this controller, replacing the default one. AAIController::ShouldPostponePathUpdates Returns true when the navigation system should defer recalculating this agent's path. AAIController::ShouldSyncBlackboardWith Called by the Blackboard system to determine whether this controller permits data synchronization from another UBlackboardComponent. AAIController::StopMovement Immediately aborts any active move request and stops path following. AAIController::SuggestTossVelocity Computes a launch velocity that will arc a projectile from Start to End under gravity at the given speed. AAIController::Tick Called every frame. AAIController::ToggleAIIgnorePlayers Toggles a global static flag that makes all AI controllers ignore player pawns. AAIController::UnclaimTaskResource BP Releases a gameplay task resource previously claimed at the controller level via ClaimTaskResource. AAIController::UpdateControlRotation Updates the controller's control rotation each tick to face the current focal point. AAIController::UseBlackboard BP Binds a Blackboard data asset to this controller, creating a UBlackboardComponent if one does not already exist. UAIBlueprintHelperLibrary::SimpleMoveToActor BP Instructs a controller's pawn to move toward an actor using the navigation system. UAIBlueprintHelperLibrary::SimpleMoveToLocation BP Instructs a controller's pawn to move to a world location using the navigation system, with no callback or complex setup. UBlackboardComponent::GetValueAsFloat BP Returns the float value stored under the given blackboard key. UBlackboardComponent::GetValueAsObject Returns the UObject stored under the given blackboard key, or null if the key doesn't exist or holds no value. UBlackboardComponent::GetValueAsVector BP Returns the FVector stored under the given blackboard key. UBlackboardComponent::SetValueAsFloat BP Writes a float value to a blackboard key, which can then be read by behavior tree tasks and decorators. UBlackboardComponent::SetValueAsObject Writes a UObject reference to a blackboard key. UBlackboardComponent::SetValueAsVector BP Writes an FVector to a blackboard key.

property Properties (3)

AAIController::BrainComponent BP The component responsible for driving this controller's AI logic, typically a UBehaviorTreeComponent. AAIController::PerceptionComponent The perception component that feeds sensory data (sight, hearing, damage) to this controller. AAIController::ReceiveMoveCompleted BP Multicast delegate fired when the current movement request finishes.