1. Epic GamesDeveloper
  3. FAIMoveRequest

FAIMoveRequest

API > API/Runtime > API/Runtime/AIModule

References

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

Syntax

struct FAIMoveRequest

Variables

  Type Name Description
Protected variable float AcceptanceRadius Pathfollowing: required distance to goal to complete move
Protected variable uint32: 1 bAllowPartialPath Pathfinding: allow using incomplete path going toward goal but not reaching it
Protected variable uint32: 1 bApplyCostLimitFromHeuristic Pathfinding: if set - the pathfind query cost will be limited based on the heuristic between the start and end location (c.f. CostLimitFactor and MinimumCostLimit).
Protected variable uint32: 1 bCanStrafe Pathfollowing: keep focal point at move goal
Protected variable uint32: 1 bInitialized Move goal is an actor
Protected variable uint32: 1 bMoveToActor Move goal is an actor
Protected variable uint32: 1 bProjectGoalOnNavigation Pathfinding: goal location will be projected on navigation data before use
Protected variable uint32: 1 bReachTestIncludesAgentRadius Pathfollowing: acceptance radius needs to be increased by agent radius (stop on overlap vs exact point)
Protected variable uint32: 1 bReachTestIncludesGoalRadius Pathfollowing: acceptance radius needs to be increased by goal actor radius
Protected variable uint32: 1 bRequireNavigableEndLocation Pathfinding: if set - require the end location to be linked to the navigation data
Protected variable uint32: 1 bUsePathfinding Pathfinding: if set - regular pathfinding will be used, if not - direct path between two points
Protected variable float CostLimitFactor Pathfinding: this multiplier is used to compute a max node cost allowed to the open list (cost limit = CostLimitFactor*InitialHeuristicEstimate)
Protected variable TSubclassOf< UNavigationQueryFilter > FilterClass Pathfinding: navigation filter to use
Protected variable TWeakObjectPtr< AActor > GoalActor Move goal: actor
Protected variable FVector GoalLocation Move goal: location
Protected variable float MinimumCostLimit Pathfinding: minimum cost limit clamping value (in cost units) used to allow large deviation in short paths
Protected variable FCustomMoveSharedPtr UserData Custom user data: structure
Protected variable int32 UserFlags Custom user data: flags

Constructors

  Type Name Description
Public function    
Public function  

FAIMoveRequest ( const AActor* InGoalActor
)

  
Public function  

FAIMoveRequest ( const FVector& InGoalLocation
)

  

Functions

  Type Name Description
Public function Const bool  
Public function Const float  
Public function Const float  
Public function Const FVector Retrieves request's requested destination location, GoalActor's location or GoalLocation, depending on the request itself
Public function Const AActor *  
Public function Const FVector  
Public function Const float  
Public function Const TSubclassOf< UNavigationQueryFilter >  
Public function Const const FCustomMoveSharedPtr &  
Public function Const int32  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool

IsValid ()

 The request should be either set up to move to a location, of go to a valid actor
Public function FAIMoveRequest &

SetAcceptanceRadius ( float Radius
)

  
Public function FAIMoveRequest &

SetAllowPartialPath ( bool bAllowPartial
)

  
Public function FAIMoveRequest &

SetApplyCostLimitFromHeuristic ( bool bApply,
float InCostLimitFactor,
float InMinimumCostLimit
)

 Defines if the underlying pathfind query should limit its exploration based on the navigation cost
Public function FAIMoveRequest &

SetCanStrafe ( bool bStrafe
)

  
Public function void

SetGoalActor ( const AActor* InGoalActor
)

  
Public function void

SetGoalLocation ( const FVector& InGoalLocation
)

  
Public function FAIMoveRequest &  
Public function FAIMoveRequest &

SetProjectGoalLocation ( bool bProject
)

  
Public function FAIMoveRequest &

SetReachTestIncludesAgentRadius ( bool bIncludeRadius
)

  
Public function FAIMoveRequest &

SetReachTestIncludesGoalRadius ( bool bIncludeRadius
)

  
Public function FAIMoveRequest &

SetRequireNavigableEndLocation ( bool bRequire
)

  
Public function FAIMoveRequest &

SetUsePathfinding ( bool bPathfinding
)

  
Public function FAIMoveRequest &

SetUserData ( const FCustomMoveSharedPtr& InUserData
)

  
Public function FAIMoveRequest &

SetUserFlags ( int32 InUserFlags
)

  
Public function Const FString  
Public function Const bool

UpdateGoalLocation ( const FVector& NewLocation
)

  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page