1. Epic GamesDeveloper
  3. UNavMoverComponent

UNavMoverComponent

NavMoverComponent: Responsible for implementing INavMoveInterface with [UMoverComponent](API\Plugins\Mover\UMoverComponent) so pathfinding and other forms of navigation movement work.

API > API/Plugins > API/Plugins/Mover > API/Plugins/Mover/DefaultMovementSet

Inheritance Hierarchy

References

   
Module Mover
Header /Engine/Plugins/Experimental/Mover/Source/Mover/Public/DefaultMovementSet/NavMoverComponent.h
Include #include "DefaultMovementSet/NavMoverComponent.h"

Syntax

UCLASS (BlueprintType, Meta=(BlueprintSpawnableComponent))  
class UNavMoverComponent :  
    public UActorComponent ,  
    public INavMovementInterface

Remarks

NavMoverComponent: Responsible for implementing INavMoveInterface with UMoverComponent so pathfinding and other forms of navigation movement work. This component also caches the input given to it that is then consumed by the mover system. Note: This component relies on the parent actor having a MoverComponent as well. By default this component only has a reference to MoverComponent meaning we use other ways (such as gameplay tags for the active movement mode) to check for state rather than calling specific functions on the active MoverComponent.

Variables

  Type Name Description
Public variable UProperty Category BlueprintReadOnly bool bRequestedNavMovement Bool for keeping track of requested nav movement - is set to true when movement is requested, is false once nav movement was consumed
Public variable FRotator CachedLookInput  
Public variable FVector CachedNavMoveInputIntent  
Public variable FVector CachedNavMoveInputVelocity  
Public variable FRotator CachedTurnInput TODO: Not sure if we need these.
Public variable UProperty FMovementProperties MovementState Expresses runtime state of character's movement.
Public variable UProperty Category, EditAnywhere, Meta FNavAgentProperties NavAgentProps Properties that define how the component can move.
Protected variable UProperty Category, EditAnywhere BlueprintReadWrite FNavMovementProperties NavMovementProperties Associated properties for nav movement

Constructors

  Type Name Description
Public function    

Overridden from UActorComponent

  Type Name Description
Public function Virtual void Initializes the component.

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 UFunction BlueprintCallable, Category float Get the max speed of the movement component
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 bool Returns true if currently crouching
Public function Virtual Const bool Returns true if currently falling (not flying, in a non-fluid volume, and not on the ground)
Public function Virtual Const bool Returns true if currently flying (moving through a non-fluid volume without resting on the ground)
Public function Virtual Const 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 Overridden to also call StopActiveMovement().
Public function Virtual void

UpdateNavAgent ( const UObject& ObjectToUpdateFrom
)

 Set nav agent properties from an object

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page