1. Epic GamesDeveloper
  3. UAsyncNavWalkingMode

UAsyncNavWalkingMode

AsyncNavWalkingMode: a default movement mode for traversing surfaces and movement bases by using an active navmesh when moving the actor rather than collision checks.

API > API/Plugins > API/Plugins/Mover

AsyncNavWalkingMode: a default movement mode for traversing surfaces and movement bases by using an active navmesh when moving the actor rather than collision checks. Note: This movement mode requires a NavMoverComponent be on the actor to function properly. This mode also contains some randomization to avoid navmesh look ups happening at the same time (which is fine for AI characters running on the server) but may cause issues if used on autonomous proxies. This mode simulates movement without actually modifying any scene component(s).

   
Name UAsyncNavWalkingMode
Type class
Header File /Engine/Plugins/Experimental/Mover/Source/Mover/Public/DefaultMovementSet/Modes/AsyncNavWalkingMode.h
Include Path #include "DefaultMovementSet/Modes/AsyncNavWalkingMode.h"

Syntax

UCLASS (MinimalAPI, Blueprintable, BlueprintType, Experimental)  
class UAsyncNavWalkingMode : public UBaseMovementMode

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UAsyncNavWalkingMode()

   DefaultMovementSet/Modes/AsyncNavWalkingMode.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
BehaviorOffNavMesh EOffNavMeshBehavior What should we do if we stray off the nav mesh? DefaultMovementSet/Modes/AsyncNavWalkingMode.h
  • Category="NavMesh Movement"
  • EditAnywhere
  • BlueprintReadWrite
bProjectNavMeshWalking bool Whether to raycast to underlying geometry to better conform navmesh-walking actors DefaultMovementSet/Modes/AsyncNavWalkingMode.h
  • Category="NavMesh Movement"
  • EditAnywhere
  • BlueprintReadWrite
bSlideAlongNavMeshEdge bool If attempting to stray off the nav mesh, should we slide along the edge instead? See @BehaviorOffNavMesh for cases where a sliding move can't be determined. DefaultMovementSet/Modes/AsyncNavWalkingMode.h
  • Category="NavMesh Movement"
  • EditAnywhere
  • BlueprintReadWrite
bSweepWhileNavWalking bool Whether or not the actor should sweep for collision geometry while walking. DefaultMovementSet/Modes/AsyncNavWalkingMode.h
  • Category="NavMesh Movement"
  • EditAnywhere
  • BlueprintReadWrite
CachedNavLocation FNavLocation Last known location projected on navmesh DefaultMovementSet/Modes/AsyncNavWalkingMode.h  
NavMeshProjectionHeightScaleDown float Scale of the total capsule height to use for projection from navmesh to underlying geometry in the downward direction. DefaultMovementSet/Modes/AsyncNavWalkingMode.h
  • Category="NavMesh Movement"
  • EditAnywhere
  • BlueprintReadWrite
  • Meta=(editcondition="bProjectNavMeshWalking", ClampMin="0", UIMin="0")
NavMeshProjectionHeightScaleUp float Scale of the total capsule height to use for projection from navmesh to underlying geometry in the upward direction. DefaultMovementSet/Modes/AsyncNavWalkingMode.h
  • Category="NavMesh Movement"
  • EditAnywhere
  • BlueprintReadWrite
  • Meta=(editcondition="bProjectNavMeshWalking", ClampMin="0", UIMin="0")
NavMeshProjectionInterpSpeed float Speed at which to interpolate agent navmesh offset between traces. DefaultMovementSet/Modes/AsyncNavWalkingMode.h
  • Category="NavMesh Movement"
  • EditAnywhere
  • BlueprintReadWrite
  • Meta=(editcondition="bProjectNavMeshWalking", ClampMin="0", UIMin="0")
NavMeshProjectionInterval float How often we should raycast to project from navmesh to underlying geometry DefaultMovementSet/Modes/AsyncNavWalkingMode.h
  • Category="NavMesh Movement"
  • EditAnywhere
  • BlueprintReadWrite
  • Meta=(editcondition="bProjectNavMeshWalking", ForceUnits="s")
NavMeshProjectionTimer float   DefaultMovementSet/Modes/AsyncNavWalkingMode.h
  • Transient

Functions

Public

Name Remarks Include Path Unreal Specifiers

virtual bool FindNavFloor ( const FVector& TestLocation,
FNavLocation& OutNavFloorLocation,
const INavigationDataInterface* NavData
) const

 Project a location to navmesh to find adjusted height. DefaultMovementSet/Modes/AsyncNavWalkingMode.h  

virtual void GenerateMove_Implementation ( const FMoverTickStartData& StartState,
const FMoverTimeStep& TimeStep,
FProposedMove& OutProposedMove
) const

   DefaultMovementSet/Modes/AsyncNavWalkingMode.h  

UObject * GetTurnGenerator()

 Returns the active turn generator. Note: you will need to cast the return value to the generator you expect to get, it can also be none. DefaultMovementSet/Modes/AsyncNavWalkingMode.h
  • BlueprintPure
  • Category=Mover

void SetTurnGeneratorClass ( TSubclassOf< UObject > TurnGeneratorClass
)

 Sets the active turn generator to use the class provided. Note: To set it back to the default implementation pass in none. DefaultMovementSet/Modes/AsyncNavWalkingMode.h
  • BlueprintCallable
  • Category=Mover

virtual void SimulationTick_Implementation ( const FSimulationTickParams& Params,
FMoverTickEndData& OutputState
)

   DefaultMovementSet/Modes/AsyncNavWalkingMode.h  

Overridden from UBaseMovementMode

Name Remarks Include Path Unreal Specifiers

virtual void Activate()

 These functions are called immediately when the state machine switches modes. DefaultMovementSet/Modes/AsyncNavWalkingMode.h  

Protected

Name Remarks Include Path Unreal Specifiers

void CaptureOutputState ( const FMoverDefaultSyncState& StartSyncState,
const FVector& FinalLocation,
const FRotator& FinalRotation,
const FMovementRecord& Record,
const FVector& AngularVelocityDegrees,
FMoverDefaultSyncState& OutputSyncState,
FMoverTickEndData& OutputState
) const

   DefaultMovementSet/Modes/AsyncNavWalkingMode.h  

virtual void FindBestNavMeshLocation ( const FVector& TraceStart,
const FVector& TraceEnd,
const FVector& CurrentFeetLocation,
const FVector& TargetNavLocation,
FHitResult& OutHitResult
) const

 Performs trace for ProjectLocationFromNavMesh DefaultMovementSet/Modes/AsyncNavWalkingMode.h  

const INavigationDataInterface * GetNavData()

 Get Navigation data for the actor. Returns null if there is no associated nav data. DefaultMovementSet/Modes/AsyncNavWalkingMode.h  

virtual FVector ProjectLocationFromNavMesh ( float DeltaSeconds,
const FVector& CurrentFeetLocation,
const FVector& TargetNavLocation,
float UpOffset,
float DownOffset
)

 Attempts to better align navmesh walking actors with underlying geometry (sometimes navmesh can differ quite significantly from geometry). DefaultMovementSet/Modes/AsyncNavWalkingMode.h  

Overridden from UBaseMovementMode

Name Remarks Include Path Unreal Specifiers

virtual void OnRegistered ( const FName ModeName
)

   DefaultMovementSet/Modes/AsyncNavWalkingMode.h  

virtual void OnUnregistered()

   DefaultMovementSet/Modes/AsyncNavWalkingMode.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page