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

Light Theme

Dark Theme

FAIMoveRequest

Windows

MacOS

Linux

References

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

Syntax

struct FAIMoveRequest

Variables

	Name	Description
float	AcceptanceRadius	Pathfollowing: required distance to goal to complete move
uint32: 1	bAllowPartialPath	Pathfinding: allow using incomplete path going toward goal but not reaching it
uint32: 1	bCanStrafe	Pathfollowing: keep focal point at move goal
uint32: 1	bInitialized	Move goal is an actor
uint32: 1	bMoveToActor	Move goal is an actor
uint32: 1	bProjectGoalOnNavigation	Pathfinding: goal location will be projected on navigation data before use
uint32: 1	bReachTestIncludesAgentRadius	Pathfollowing: acceptance radius needs to be increased by agent radius (stop on overlap vs exact point)
uint32: 1	bReachTestIncludesGoalRadius	Pathfollowing: acceptance radius needs to be increased by goal actor radius
uint32: 1	bUsePathfinding	Pathfinding: if set - regular pathfinding will be used, if not - direct path between two points
TSubclassOf< UN...	FilterClass	Pathfinding: navigation filter to use
AActor *	GoalActor	Move goal: actor
FVector	GoalLocation	Move goal: location
FCustomMoveShar...	UserData	Custom user data: structure
int32	UserFlags	Custom user data: flags

Constructors

	Name	Description
	FAIMoveRequest()
	FAIMoveRequest ( const AActor* InGoalActor )
	FAIMoveRequest ( const FVector& InGoalLocation )

Functions

	Name	Description
bool	CanStrafe()
float	GetAcceptanceRadius()
FVector	GetDestination()	Retrieves request's requested destination location, GoalActor's location or GoalLocation, depending on the request itself
AActor *	GetGoalActor()
FVector	GetGoalLocation()
TSubclassOf<...	GetNavigationFilter()
const FCusto...	GetUserData()
int32	GetUserFlags()
bool	IsMoveToActorRequest()
bool	IsProjectingGoal()
bool	IsReachTestIncludingAgentRadius()
bool	IsReachTestIncludingGoalRadius()
bool	IsUsingPartialPaths()
bool	IsUsingPathfinding()
bool	IsValid()	The request should be either set up to move to a location, of go to a valid actor
FAIMoveReque...	SetAcceptanceRadius ( float Radius )
FAIMoveReque...	SetAllowPartialPath ( bool bAllowPartial )
FAIMoveReque...	SetCanStrafe ( bool bStrafe )
void	SetGoalActor ( const AActor* InGoalActor )
void	SetGoalLocation ( const FVector& InGoalLocation )
FAIMoveReque...	SetNavigationFilter ( TSubclassOf< UNavigationQueryFilter... )
FAIMoveReque...	SetProjectGoalLocation ( bool bProject )
FAIMoveReque...	SetReachTestIncludesAgentRadius ( bool bIncludeRadius )
FAIMoveReque...	SetReachTestIncludesGoalRadius ( bool bIncludeRadius )
FAIMoveReque...	SetUsePathfinding ( bool bPathfinding )
FAIMoveReque...	SetUserData ( const FCustomMoveSharedPtr& InUser... )
FAIMoveReque...	SetUserFlags ( int32 InUserFlags )
FString	ToString()
bool	UpdateGoalLocation ( const FVector& NewLocation )

Deprecated Functions

		Name	Description
	bool	CanStopOnOverlap()	This function is deprecated, please use IsReachTestIncludingAgentRadius instead.
	FAIMoveReque...	SetStopOnOverlap ( bool bStop )	This function is deprecated, please use SetReachTestIncludesAgentRadius instead.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss