RealDocs UE 5.6

AIModule

4 views

192 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 (181)

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. UBehaviorTreeComponent::AddCooldownTagDuration BP Sets or extends a gameplay-tag-keyed cooldown that Cooldown decorators elsewhere in the tree can check via the tag, without needing a dedicated blackboard key. UBehaviorTreeComponent::AddReferencedObjects Reports extra UObject references held by the behavior tree instance stack to the garbage collector. UBehaviorTreeComponent::Cleanup Tears down the running tree: removes all instances, clears node memory, and resets internal execution state. UBehaviorTreeComponent::DescribeActiveTasks Returns a string listing the names of all currently active task nodes, including any running in parallel, across the whole instance stack. UBehaviorTreeComponent::DescribeActiveTrees Returns a string listing the behavior tree assets running on the instance stack, from the root tree down through any pushed dynamic subtrees. UBehaviorTreeComponent::DescribeSelfToVisLog Writes a summary of the tree's current state (active tasks, running trees) into the given Visual Logger snapshot so it shows up when replaying the log in the Visual Logger tool. UBehaviorTreeComponent::EndFrame Static hook called once per frame to flush accumulated behavior tree search timing into the FramePro/CSV profiler. UBehaviorTreeComponent::FindInstanceContainingNode Searches the current instance stack for the subtree that owns the given node and returns its instance index. UBehaviorTreeComponent::FindTemplateNode Given an instanced runtime node, returns the shared template node it was created from. UBehaviorTreeComponent::ForEachChildTask Invokes the given functor once for every task node in every running instance on the stack. UBehaviorTreeComponent::GetAccumulatedTickDeltaTime Returns the total delta time accumulated for the current tick, accounting for any frames that were skipped due to ScheduleNextTick throttling. UBehaviorTreeComponent::GetActiveInstanceIdx Returns the index of the instance currently on top of the stack — the subtree that owns the active node. UBehaviorTreeComponent::GetActiveNode Returns the currently executing node in the active instance on top of the stack — typically the task currently running. UBehaviorTreeComponent::GetCurrentTree Returns the behavior tree asset for the currently active instance on the stack. UBehaviorTreeComponent::GetDebugInfoString Returns a human-readable summary of the brain component's current state, overriding UBrainComponent's base implementation with behavior-tree-specific details such as the active tree and current task. UBehaviorTreeComponent::GetNodeMemory Returns a pointer to the raw per-instance memory block allocated for a node, as configured by that node's GetInstanceMemorySize. UBehaviorTreeComponent::GetRootTree Returns the behavior tree asset at the bottom of the instance stack — the tree that was originally started with StartTree, regardless of any dynamic subtrees pushed on top of it. UBehaviorTreeComponent::GetTagCooldownEndTime BP Returns the world time at which the given cooldown tag's duration ends, or 0. UBehaviorTreeComponent::GetTaskStatus Returns the current runtime status of the given task node — Active, Aborting, or Inactive. UBehaviorTreeComponent::HandleMessage Routes an incoming FAIMessage to the message observers registered via RegisterMessageObserver, resuming any latent task waiting on it. UBehaviorTreeComponent::IsAbortPending Returns true if the component is waiting for one or more latent task aborts to finish before it can apply a pending execution change. UBehaviorTreeComponent::IsAuxNodeActive Returns true if the given auxiliary node (a ticking decorator or service) is currently registered and active on the running tree. UBehaviorTreeComponent::IsExecutingBranch Returns true if the active node is currently executing somewhere underneath the given node (optionally restricted to one specific child branch). UBehaviorTreeComponent::IsInstanceStackEmpty Returns true if the instance stack has no running behavior tree instances — no tree has been started, or the tree has fully stopped and been cleaned up. UBehaviorTreeComponent::IsPaused Returns true if the tree is running but execution requests are currently being postponed because PauseLogic was called. UBehaviorTreeComponent::IsRestartPending Returns true if there is a pending execution request that will switch the tree to a higher-priority node rather than simply continuing to the next sibling. UBehaviorTreeComponent::IsRunning Returns true if the behavior tree logic is currently active and processing execution requests. UBehaviorTreeComponent::OnTaskFinished Notifies the tree that a task has finished its latent execution (or been aborted), triggering the next execution search. UBehaviorTreeComponent::ProcessExecutionRequest Runs the pending execution search and applies its results — the step that turns a queued RequestExecution/RequestBranchEvaluation call into an actual change of active node. UBehaviorTreeComponent::RegisterMessageObserver Sets up an observer that resumes a task's latent execution when a matching FAIMessage is broadcast to this component. UBehaviorTreeComponent::RegisterParallelTask Adds a task to the component's internal list of active parallel-running tasks, used for tracking tasks executing under a parallel composite node. UBehaviorTreeComponent::RequestBranchActivation Requests that the branch guarded by the given decorator be activated, typically because the decorator's condition just started passing. UBehaviorTreeComponent::RequestBranchDeactivation Requests that the branch guarded by the given decorator be deactivated. UBehaviorTreeComponent::RequestBranchEvaluation Requests a new execution search starting from the given decorator's branch, used when a decorator's condition changes outside the tree's normal tick, e. UBehaviorTreeComponent::RequestExecution Low-level entry point for triggering a new execution search from a specific composite node. UBehaviorTreeComponent::RestartTree Restarts execution from the root node of the currently running tree, either by re-evaluating in place or by fully stopping and starting it again. UBehaviorTreeComponent::ScheduleExecutionUpdate Flags the component to process its pending execution flow update on the next tick instead of running it immediately. UBehaviorTreeComponent::ScheduleNextTick Requests when the behavior tree component should next process a full tick, letting the tree throttle its own update frequency instead of always running every frame. UBehaviorTreeComponent::SetCSVTickStatName Sets a custom CSV profiler stat name to attribute this behavior tree component's tick cost to in CSV profiling captures, instead of a generic default label. UBehaviorTreeComponent::SetDynamicSubtree BP Assigns a behavior tree asset to a RunBehaviorDynamic task in the running tree identified by InjectTag, allowing subtrees to be swapped in at runtime without restarting the whole tree. UBehaviorTreeComponent::StartTree Begins executing the given behavior tree asset from its root node. UBehaviorTreeComponent::StopTree Stops execution of the currently running tree, aborting the active task and clearing all tree instances. UBehaviorTreeComponent::TickComponent Drives execution flow processing and ticks active tasks/services/decorators for the running behavior tree each frame. UBehaviorTreeComponent::UninitializeComponent Overrides UActorComponent::UninitializeComponent to tear down the behavior tree instance stack and release runtime node memory before the component is destroyed. UBehaviorTreeComponent::UnregisterAuxNodesInBranch Unregisters all auxiliary nodes (decorators and services) attached anywhere under the given composite node's branch. UBehaviorTreeComponent::UnregisterAuxNodesInRange Unregisters all auxiliary nodes whose execution index falls strictly between FromIndex and ToIndex. UBehaviorTreeComponent::UnregisterAuxNodesUpTo Unregisters all auxiliary nodes (decorators and services) whose execution index is less important than the given index. UBehaviorTreeComponent::UnregisterMessageObserversFrom Removes all message observers previously registered for the given task via RegisterMessageObserver. UBehaviorTreeComponent::UnregisterParallelTask Removes a task from the internal list of active parallel tasks, undoing a prior RegisterParallelTask call. UBlackboardComponent::CacheBrainComponent Stores a pointer to the given brain component so it can be retrieved later via GetBrainComponent, used for communication back to the tree that owns this blackboard. UBlackboardComponent::ClearValue BP Resets the value stored under the given blackboard key to its type's default/unset state, notifying any registered observers if the value changed. UBlackboardComponent::CompareKeyValues Compares the values stored under two keys using KeyType's comparison logic, returning Less, Equal, or Greater. UBlackboardComponent::CopyKeyValue Copies the raw value stored under SourceKeyID into DestinationID and returns true if the copy succeeded. UBlackboardComponent::DescribeKeyValue Returns a human-readable description of the value stored under KeyName, formatted according to Mode. UBlackboardComponent::DescribeSelfToVisLog Appends the blackboard's current key/value state to a Visual Logger snapshot, so it shows up in the Visual Logger tool alongside other AI debug data. UBlackboardComponent::GetBlackboardAsset Returns the blackboard data asset currently in use by this component, defining its available keys and their types. UBlackboardComponent::GetBrainComponent Returns the behavior tree (or other brain) component associated with this blackboard, as previously set via CacheBrainComponent. UBlackboardComponent::GetDebugInfoString Builds a multi-line debug string describing every key and its current value, formatted according to Mode. UBlackboardComponent::GetKeyID Converts a blackboard key name into its numeric FKey ID, which is the form used by the fast RegisterObserver, GetValue, and SetValue overloads. UBlackboardComponent::GetKeyName Returns the name of the blackboard key with the given ID, as defined on the blackboard data asset. UBlackboardComponent::GetKeyRawData Returns a raw pointer to the key's value bytes inside the blackboard's internal value buffer, for direct low-level access. UBlackboardComponent::GetKeyType Returns the UBlackboardKeyType subclass (Bool, Int, Float, Object, Vector, and so on) used to store the value under the given key. UBlackboardComponent::GetLocationFromEntry BP Resolves a world location from the given blackboard key, whether it's a Vector key or an Object/Actor key, and writes it to ResultLocation. UBlackboardComponent::GetNumKeys Returns the number of key entries defined on the blackboard's data asset, including keys inherited from parent blackboard assets. UBlackboardComponent::GetRotationFromEntry BP Resolves a rotation from the given blackboard key, whether it's a Rotator key or an Object/Actor key, and writes it to ResultRotation. UBlackboardComponent::GetValue Reads the value stored under the given key, decoded as the type described by the TDataClass template argument. UBlackboardComponent::GetValueAsBool BP Returns the boolean value stored under the given blackboard key. UBlackboardComponent::GetValueAsClass BP Returns the UClass value stored under the given blackboard key. UBlackboardComponent::GetValueAsEnum BP Returns the raw enum value stored under the given blackboard key as a uint8. UBlackboardComponent::GetValueAsFloat BP Returns the float value stored under the given blackboard key. UBlackboardComponent::GetValueAsInt BP Returns the integer value stored under the given blackboard key. UBlackboardComponent::GetValueAsName BP Returns the FName 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::GetValueAsRotator BP Returns the FRotator value stored under the given blackboard key. UBlackboardComponent::GetValueAsString BP Returns the string value stored under the given blackboard key. UBlackboardComponent::GetValueAsVector BP Returns the FVector stored under the given blackboard key. UBlackboardComponent::HasValidAsset Returns true if the component currently has a valid, initialized blackboard data asset assigned. UBlackboardComponent::InitializeBlackboard Sets up the component to use the given blackboard data asset, allocating value storage for its keys. UBlackboardComponent::InitializeComponent Overrides UActorComponent::InitializeComponent to set up the blackboard's default asset (DefaultBlackboardAsset) if one hasn't already been assigned via InitializeBlackboard. UBlackboardComponent::IsCompatibleWith Returns true if the given blackboard data asset can be used with this component, meaning it matches or derives from the currently assigned asset. UBlackboardComponent::IsKeyInstanceSynced Returns true if the key is marked as instance-synced, meaning its value is automatically mirrored across all blackboard components sharing the same asset. UBlackboardComponent::IsKeyOfType Returns true if the named key's underlying value type matches the given UBlackboardKeyType subclass, specified as the template argument. UBlackboardComponent::IsValidKey Checks whether KeyID refers to a valid entry in the component's blackboard asset. UBlackboardComponent::IsVectorValueSet BP Returns true if the vector value under the given key has actually been set (rather than left at its default invalid state). UBlackboardComponent::PauseObserverNotifications Suspends dispatch of blackboard change notifications; any key changes made while paused are queued rather than immediately broadcast to observers. UBlackboardComponent::RegisterObserver Registers a delegate that fires whenever the value under the given key changes, the mechanism behind behavior tree decorator observer aborts. UBlackboardComponent::ResumeObserverNotifications Resumes dispatch of blackboard change notifications after a matching call to PauseObserverNotifications, optionally flushing any queued changes. UBlackboardComponent::SetValue Sets the value under the given key using the raw templated key-type API, notifying observers if the value actually changed. UBlackboardComponent::SetValueAsBool BP Sets the boolean value stored under the given blackboard key, notifying any registered observers if the value changed. UBlackboardComponent::SetValueAsClass BP Sets the UClass value stored under the given blackboard key, notifying any registered observers if the value changed. UBlackboardComponent::SetValueAsEnum BP Sets the raw enum value stored under the given blackboard key, notifying any registered observers if the value changed. UBlackboardComponent::SetValueAsFloat BP Writes a float value to a blackboard key, which can then be read by behavior tree tasks and decorators. UBlackboardComponent::SetValueAsInt BP Sets the integer value stored under the given blackboard key, notifying any registered observers if the value changed. UBlackboardComponent::SetValueAsName BP Sets the FName value stored under the given blackboard key, notifying any registered observers if the value changed. UBlackboardComponent::SetValueAsObject Writes a UObject reference to a blackboard key. UBlackboardComponent::SetValueAsRotator BP Sets the FRotator value stored under the given blackboard key, notifying any registered observers if the value changed. UBlackboardComponent::SetValueAsString BP Sets the string value stored under the given blackboard key, notifying any registered observers if the value changed. UBlackboardComponent::SetValueAsVector BP Writes an FVector to a blackboard key. UBlackboardComponent::UninitializeComponent Overrides UActorComponent::UninitializeComponent to tear down the blackboard's allocated key values and release observers when the component is uninitialized. UBlackboardComponent::UnregisterObserver Removes a single previously registered observer delegate for the given key, identified by the handle returned from RegisterObserver. UBlackboardComponent::UnregisterObserversFrom Removes every observer delegate that was registered with the given owner object, regardless of which key each one watched. UBTTaskNode::FinishLatentAbort Call this to signal that a task previously returned InProgress from AbortTask has finished cleaning up and the tree can continue evaluation. UBTTaskNode::FinishLatentTask Call this to complete a task that previously returned InProgress from ExecuteTask, such as one waiting on an async operation or a timer. UBTTaskNode::OnGameplayTaskDeactivated Called by the gameplay task system when a UGameplayTask owned by this behavior tree task deactivates, allowing the BT task to react and potentially finish itself. UBTTaskNode::ReceivedMessage The message observer hook invoked when a task registered interest in a message type via WaitForMessage and a matching message arrives. UBTTaskNode::ShouldIgnoreRestartSelf Returns whether a pending task search should be discarded if it re-selects this same task while it is already running. UBTTaskNode::WrappedAbortTask Internal wrapper the behavior tree runtime calls instead of AbortTask directly, resolving instanced nodes before aborting. UBTTaskNode::WrappedExecuteTask Internal wrapper the behavior tree runtime calls instead of ExecuteTask directly, so that instanced nodes resolve to the correct object before executing. UBTTaskNode::WrappedOnTaskFinished Internal wrapper the runtime calls to invoke OnTaskFinished on an instanced node when a task completes. UBTTaskNode::WrappedTickTask Internal wrapper the runtime calls to invoke TickTask on an instanced node, but only if the task requested ticking.

property Properties (4)

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. UBTTaskNode::Services The list of service nodes attached directly to this task in the behavior tree editor.