1. Epic GamesDeveloper
  3. INavMovementInterface

INavMovementInterface

API > API/Runtime > API/Runtime/Engine > API/Runtime/Engine/GameFramework

Inheritance Hierarchy

References

   
Module Engine
Header /Engine/Source/Runtime/Engine/Classes/GameFramework/NavMovementInterface.h
Include #include "GameFramework/NavMovementInterface.h"

Syntax

class INavMovementInterface

Functions

  Type Name Description
Public function Virtual Const bool Returns true if agent can crouch
Public function Virtual Const bool Returns true if agent can fly
Public function Virtual Const bool Returns true if agent can jump
Public function Virtual Const bool Returns true if agent can move along the ground (walk, drive, etc)
Public function Virtual Const bool Returns true if agent can swim
Public function Const bool Returns true if path following can start
Public function Const bool Check if current move target can be reached right now if positions are matching (e.g. performing scripted move and can't stop)
Public function Const FVector Returns location of controlled agent's "feet" meaning center of bottom of collision shape
Public function Const FBasedPosition Returns based location of controlled agent
Public function Const FVector Get forward vector of the object being driven by nav movement
Public function Const FVector Movement specific code but not specific to nav movement - could probably be pulled out into a separate interface if desired.
Public function Const UFunction BlueprintCallable, Category float Get maximum movement speed of the agent
Public function Const const FNavAgentProperties & Returns the NavAgentProperties(const) used by NavMovementInterface and PathFollowing
Public function FNavAgentProperties & Returns the NavAgentProperties used by NavMovementInterface and PathFollowing
Public function Const FVector Returns navigation location of controlled agent
Public function Const const FNavMovementProperties & Returns the Nav movement properties struct (const) used by NavMovementInterface and PathFollowing
Public function FNavMovementProperties * Returns the Nav movement properties struct used by NavMovementInterface and PathFollowing
Public function Const UObject * Get the owner of the object consuming nav movement
Public function IPathFollowingAgentInterface * Get path following agent this interface uses
Public function Const const IPathFollowingAgentInterface * Get path following agent this interface uses(const)
Public function Virtual Const float

GetPathFollowingBrakingDistance ( float MaxSpeed
)

 Returns braking distance for acceleration driven path following
Public function Const void

GetSimpleCollisionCylinder ( float& CollisionRadius,
float& CollisionHalfHeight
)

 Get axis-aligned cylinder around this agent, used for simple collision checks in nav movement
Public function Const FVector Returns collision extents vector for this object
Public function Const TObjectPtr< UObject > Get the Object this movement interface is updating
Public function Const UFunction BlueprintCallable, Category FVector Get the current velocity of the agent for nav movement
Public function Const UFunction BlueprintCallable, Category bool Returns true if currently crouching
Public function Const UFunction BlueprintCallable, Category bool Returns true if currently falling (not flying, in a non-fluid volume, and not on the ground)
Public function Const UFunction BlueprintCallable, Category bool Returns true if currently flying (moving through a non-fluid volume without resting on the ground)
Public function Const UFunction BlueprintCallable, Category bool Returns true if currently moving on the ground (e.g. walking or driving)
Public function Const UFunction BlueprintCallable, Category bool Returns true if currently swimming (moving through a fluid volume)
Public function UFunction BlueprintCallable, Category void

RequestDirectMove ( const FVector& MoveVelocity,
bool bForceMaxSpeed
)

 Path following: request movement through a velocity directly
Public function UFunction BlueprintCallable, Category void

RequestPathMove ( const FVector& MoveInput
)

 Path following: request movement through a new move input (normal vector = full strength)
Public function void Resets runtime movement state to default movement capabilities
Public function void

SetFixedBrakingDistance ( float DistanceToEndOfPath
)

 Set fixed braking distance
Public function void Set the path following agent this interface uses.
Public function Virtual UFunction BlueprintCallable, Category void Begin: Functions to be implemented here for shared functionality.
Public function void Stops movement by setting velocity to zero - Note: depending on the movement system this may take effect next tick
Public function Virtual UFunction BlueprintCallable, Category void Stops movement immediately (reset velocity) but keeps following current path
Public function void

UpdateNavAgent ( const UObject& ObjectToUpdateFrom
)

 Set nav agent properties from an object
Public function Const bool Returns true if acceleration should be used for path following

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page