1. Epic GamesDeveloper
  3. UNavMovementComponent

UNavMovementComponent

NavMovementComponent defines base functionality for MovementComponents that move any 'agent' that may be involved in AI pathfinding.

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

Inheritance Hierarchy

References

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

Syntax

UCLASS (Abstract, Config=Engine, MinimalAPI)  
class UNavMovementComponent :  
    public UMovementComponent ,  
    public INavMovementInterface

Remarks

NavMovementComponent defines base functionality for MovementComponents that move any 'agent' that may be involved in AI pathfinding.

Variables

  Type Name Description
Public variable UProperty FMovementProperties MovementState Expresses runtime state of character's movement.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite FNavAgentProperties NavAgentProps Properties that define how the component can move.
Protected variable UProperty Category, EditAnywhere FNavMovementProperties NavMovementProperties  

Constructors

  Type Name Description
Public function  

UNavMovementComponent ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function void Clears fixed braking distance
Public function Virtual Const FVector Returns location of controlled actor's "feet" meaning center of bottom of collision bounding box
Public function Virtual Const FBasedPosition Returns based location of controlled actor
Public function Const FVector Returns location of controlled actor - meaning center of collision bounding box
Public function Const FVector Returns navigation location of controlled actor
Public function Const FTransform Returns the full world-coordinates transform of the associated scene component (the UpdatedComponent)
Public function Const bool Returns true if component is allowed to jump
Public function void

SetJumpAllowed ( bool bAllowed
)

 Sets whether this component is allowed to jump
Public function void

SetUpdateNavAgentWithOwnersCollisions ( bool bUpdateWithOwner
)

  
Public function Const bool  

Overridden from UMovementComponent

  Type Name Description
Public function Virtual void Overridden to also call StopActiveMovement().

Overridden from UObject

  Type Name Description
Public function Virtual void Handles reading, writing, and reference collecting using FArchive.

Overridden from INavMovementInterface

  Type Name Description
Public function Virtual Const bool Returns true if path following can start
Public function Virtual 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 Virtual Const FVector Returns location of controlled actor's "feet" meaning center of bottom of collision bounding box
Public function Virtual Const FBasedPosition Returns based location of controlled actor
Public function Virtual Const FVector Get forward vector of the object being driven by nav movement
Public function Virtual Const FVector Returns location of controlled actor - meaning center of collision bounding box
Public function Virtual Const float Get maximum movement speed of the agent
Public function Virtual FNavAgentProperties & Returns the NavAgentProps
Public function Virtual Const const FNavAgentProperties & Returns the NavAgentProps(const)
Public function Virtual Const const FNavMovementProperties & Returns the NavMovementProps(const)
Public function Virtual FNavMovementProperties * Get Nav movement props struct this component uses
Public function Virtual Const UObject * Get the owner of the object consuming nav movement
Public function Virtual IPathFollowingAgentInterface * Get path following agent this interface uses
Public function Virtual Const const IPathFollowingAgentInterface * Get path following agent this interface uses(const)
Public function Virtual Const void

GetSimpleCollisionCylinder ( float& CollisionRadius,
float& CollisionHalfHeight
)

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

RequestDirectMove ( const FVector& MoveVelocity,
bool bForceMaxSpeed
)

 Path following: request new velocity
Public function Virtual void

RequestPathMove ( const FVector& MoveInput
)

 Path following: request new move input (normal vector = full strength)
Public function Virtual void Resets runtime movement state to character's movement capabilities
Public function Virtual void Set the path following agent this interface uses.
Public function Virtual void

UpdateNavAgent ( const UObject& ObjectToUpdateFrom
)

 Set nav agent properties from an object

Deprecated Variables

  Type Name Description
Protected variable uint8: 1 bStopMovementAbortPaths_DEPRECATED If set, StopActiveMovement call will abort current path following request
Protected variable UProperty Meta uint8: 1 bUpdateNavAgentWithOwnersCollision_DEPRECATED If set to true NavAgentProps' radius and height will be updated with Owner's collision capsule size
Protected variable UProperty Meta GlobalConfig uint8: 1 bUseAccelerationForPaths_DEPRECATED If set, pathfollowing will control character movement via acceleration values.
Protected variable UProperty Meta uint8: 1 bUseFixedBrakingDistanceForPaths_DEPRECATED If set, FixedPathBrakingDistance will be used for path following deceleration
Protected variable UProperty Meta float FixedPathBrakingDistance_DEPRECATED Braking distance override used with acceleration driven path following (bUseAccelerationForPaths)

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page