Can't find any content

Error loading documents tree: Nothing found

  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

Remarks

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

Variables

  Type Name Description
Protected variable uint8: 1 bStopMovementAbortPaths If set, StopActiveMovement call will abort current path following request
Protected variable UProperty Category, EditAnywhere uint8: 1 bUpdateNavAgentWithOwnersCollision If set to true NavAgentProps' radius and height will be updated with Owner's collision capsule size
Protected variable UProperty Category, EditAnywhere GlobalConfig uint8: 1 bUseAccelerationForPaths If set, pathfollowing will control character movement via acceleration values.
Protected variable UProperty Category, EditAnywhere, Meta uint8: 1 bUseFixedBrakingDistanceForPaths If set, FixedPathBrakingDistance will be used for path following deceleration
Protected variable UProperty Category, EditAnywhere, Meta float FixedPathBrakingDistance Braking distance override used with acceleration driven path following (bUseAccelerationForPaths)
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.

Constructors

  Type Name Description
Public function  

UNavMovementComponent ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function Const bool Returns true if component can crouch
Public function Const bool Returns true if component can fly
Public function Const bool Returns true if component can jump
Public function Const bool Returns true if component can move along the ground (walk, drive, etc)
Public function Const bool Returns true if component can swim
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 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 FNavAgentProperties & Returns the NavAgentProps
Public function Const const FNavAgentProperties & Returns the NavAgentProps(const)
Public function Const const IPathFollowingAgentInterface *  
Public function IPathFollowingAgentInterface *  
Public function Virtual Const float

GetPathFollowingBrakingDistance ( float MaxSpeed
)

 Returns braking distance for acceleration driven path following
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 Const bool Returns true if component is allowed to jump
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 void Resets runtime movement state to character's movement capabilities
Public function void

SetFixedBrakingDistance ( float DistanceToEndOfPath
)

 Set fixed braking distance
Public function void

SetJumpAllowed ( bool bAllowed
)

 Sets whether this component is allowed to jump
Public function void  
Public function void

SetUpdateNavAgentWithOwnersCollisions ( bool bUpdateWithOwner
)

  
Public function Const bool  
Public function Virtual UFunction BlueprintCallable, Category void Stops applying further movement (usually zeros acceleration).
Public function UFunction BlueprintCallable, Category void Stops movement immediately (reset velocity) but keeps following current path
Public function void

UpdateNavAgent ( const AActor& InOwner
)

  
Public function void

UpdateNavAgent ( const UCapsuleComponent& CapsuleComponent
)

  
Public function Const bool  

Overridden from UMovementComponent

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

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page