Class NavigationSystemV1

Navigation System V1

Inheritance

System.Object

UObject

NavigationSystemBase

NavigationSystemV1

Inherited Members

UObject.TransientPackage

UObject.CastTo<T>(UObject)

UObject.CastTo(UObject, Type)

UObject.RemoveObject(UObject)

UObject.MakeObjectArrayField<T>(NativeArray*)

UObject.NotImplemented<T>()

UObject.Construct()

UObject.GetHashCode()

UObject.GetName()

UObject.ToString()

UObject.Name

UObject._None

UObject.None

UObject.ObjPointer

UObject.LoadObjectFromClass(Class, UObject, String, String, LoadFlags, PackageMap, Boolean)

UObject.LoadClass(Class, UObject, String, String, LoadFlags, PackageMap)

UObject.GetPropertyFor<T>(Name)

UObject.ExecuteUbergraph

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

Namespace: UE4.NavigationSystem

Assembly: UE4DotNet.dll

Syntax

public class NavigationSystemV1 : NavigationSystemBase

Properties

| Improve this Doc View Source

AbstractNavData

special navigation data for managing direct paths, not part of NavDataSet!

Declaration

public NavigationData AbstractNavData { get; set; }

Property Value

Type	Description
NavigationData

| Improve this Doc View Source

ActiveTilesUpdateInterval

Minimal time, in seconds, between active tiles set update

Declaration

public float ActiveTilesUpdateInterval { get; set; }

Property Value

Type	Description
System.Single

| Improve this Doc View Source

bAllowClientSideNavigation

Declaration

public bool bAllowClientSideNavigation { get; set; }

Property Value

Type	Description
System.Boolean

| Improve this Doc View Source

bAutoCreateNavigationData

Declaration

public bool bAutoCreateNavigationData { get; set; }

Property Value

Type	Description
System.Boolean

| Improve this Doc View Source

bGenerateNavigationOnlyAroundNavigationInvokers

Declaration

public bool bGenerateNavigationOnlyAroundNavigationInvokers { get; set; }

Property Value

Type	Description
System.Boolean

| Improve this Doc View Source

bInitialBuildingLocked

Declaration

public bool bInitialBuildingLocked { get; set; }

Property Value

Type	Description
System.Boolean

| Improve this Doc View Source

bShouldDiscardSubLevelNavData

Declaration

public bool bShouldDiscardSubLevelNavData { get; set; }

Property Value

Type	Description
System.Boolean

| Improve this Doc View Source

bSkipAgentHeightCheckWhenPickingNavData

Declaration

public bool bSkipAgentHeightCheckWhenPickingNavData { get; set; }

Property Value

Type	Description
System.Boolean

| Improve this Doc View Source

bSpawnNavDataInNavBoundsLevel

Declaration

public bool bSpawnNavDataInNavBoundsLevel { get; set; }

Property Value

Type	Description
System.Boolean

| Improve this Doc View Source

bSupportRebuilding

Declaration

public bool bSupportRebuilding { get; set; }

Property Value

Type	Description
System.Boolean

| Improve this Doc View Source

bTickWhilePaused

Declaration

public bool bTickWhilePaused { get; set; }

Property Value

Type	Description
System.Boolean

| Improve this Doc View Source

CrowdManagerClass

Crowd Manager Class

Declaration

public SubclassOf<CrowdManagerBase> CrowdManagerClass { get; }

Property Value

Type	Description
SubclassOf<CrowdManagerBase>

| Improve this Doc View Source

DefaultObject

Get UE4 Default Object for this Class

Declaration

public static NavigationSystemV1 DefaultObject { get; }

Property Value

Type	Description
NavigationSystemV1

| Improve this Doc View Source

DirtyAreasUpdateFreq

update frequency for dirty areas on navmesh

Declaration

public float DirtyAreasUpdateFreq { get; set; }

Property Value

Type	Description
System.Single

| Improve this Doc View Source

MainNavData

Main Nav Data

Declaration

public NavigationData MainNavData { get; set; }

Property Value

Type	Description
NavigationData

| Improve this Doc View Source

NavDataRegistrationQueue

Nav Data Registration Queue

Declaration

public ObjectArrayField<NavigationData> NavDataRegistrationQueue { get; }

Property Value

Type	Description
ObjectArrayField<NavigationData>

| Improve this Doc View Source

NavDataSet

Nav Data Set

Declaration

public ObjectArrayField<NavigationData> NavDataSet { get; }

Property Value

Type	Description
ObjectArrayField<NavigationData>

| Improve this Doc View Source

StaticClass

Get UE4 Class

Declaration

public static Class StaticClass { get; }

Property Value

Type	Description
Class

Methods

| Improve this Doc View Source

FindPathToActorSynchronously(UObject, Vector, Actor, Single, Actor, SubclassOf<NavigationQueryFilter>)

Finds path instantly, in a FindPath Synchronously.

Declaration

public static NavigationPath FindPathToActorSynchronously(UObject WorldContextObject, Vector PathStart, Actor GoalActor, float TetherDistance, Actor PathfindingContext, SubclassOf<NavigationQueryFilter> FilterClass)

Parameters

Type	Name	Description
UObject	WorldContextObject
Vector	PathStart
Actor	GoalActor
System.Single	TetherDistance
Actor	PathfindingContext
SubclassOf<NavigationQueryFilter>	FilterClass

Returns

Type	Description
NavigationPath

Remarks

Main advantage over FindPathToLocationSynchronously is that the resulting path will automatically get updated if goal actor moves more than TetherDistance away from last path node @param PathfindingContext could be one of following: NavigationData (like Navmesh actor), Pawn or Controller. This parameter determines parameters of specific pathfinding query

| Improve this Doc View Source

FindPathToLocationSynchronously(UObject, Vector, Vector, Actor, SubclassOf<NavigationQueryFilter>)

Finds path instantly, in a FindPath Synchronously.

Declaration

public static NavigationPath FindPathToLocationSynchronously(UObject WorldContextObject, Vector PathStart, Vector PathEnd, Actor PathfindingContext, SubclassOf<NavigationQueryFilter> FilterClass)

Parameters

Type	Name	Description
UObject	WorldContextObject
Vector	PathStart
Vector	PathEnd
Actor	PathfindingContext
SubclassOf<NavigationQueryFilter>	FilterClass

Returns

Type	Description
NavigationPath

Remarks

@param PathfindingContext could be one of following: NavigationData (like Navmesh actor), Pawn or Controller. This parameter determines parameters of specific pathfinding query

| Improve this Doc View Source

GetNavigationSystem(UObject)

Blueprint functions

Declaration

public static NavigationSystemV1 GetNavigationSystem(UObject WorldContextObject)

Parameters

Type	Name	Description
UObject	WorldContextObject

Returns

Type	Description
NavigationSystemV1

| Improve this Doc View Source

GetPathCost(UObject, Vector, Vector, NavigationData, SubclassOf<NavigationQueryFilter>)

Potentially expensive. Use with caution. Consider using UPathFollowingComponent::GetRemainingPathCost instead

Declaration

public static (float, byte) GetPathCost(UObject WorldContextObject, Vector PathStart, Vector PathEnd, NavigationData NavData, SubclassOf<NavigationQueryFilter> FilterClass)

Parameters

Type	Name	Description
UObject	WorldContextObject
Vector	PathStart
Vector	PathEnd
NavigationData	NavData
SubclassOf<NavigationQueryFilter>	FilterClass

Returns

Type	Description
System.ValueTuple<System.Single, System.Byte>

| Improve this Doc View Source

GetPathLength(UObject, Vector, Vector, NavigationData, SubclassOf<NavigationQueryFilter>)

Potentially expensive. Use with caution

Declaration

public static (float, byte) GetPathLength(UObject WorldContextObject, Vector PathStart, Vector PathEnd, NavigationData NavData, SubclassOf<NavigationQueryFilter> FilterClass)

Parameters

Type	Name	Description
UObject	WorldContextObject
Vector	PathStart
Vector	PathEnd
NavigationData	NavData
SubclassOf<NavigationQueryFilter>	FilterClass

Returns

Type	Description
System.ValueTuple<System.Single, System.Byte>

| Improve this Doc View Source

GetRandomPointInNavigableRadius(UObject, Vector, Single, NavigationData, SubclassOf<NavigationQueryFilter>)

Get Random Point in Navigable Radius

Declaration

public static Vector GetRandomPointInNavigableRadius(UObject WorldContextObject, Vector Origin, float Radius, NavigationData NavData, SubclassOf<NavigationQueryFilter> FilterClass)

Parameters

Type	Name	Description
UObject	WorldContextObject
Vector	Origin
System.Single	Radius
NavigationData	NavData
SubclassOf<NavigationQueryFilter>	FilterClass

Returns

Type	Description
Vector

| Improve this Doc View Source

GetRandomReachablePointInRadius(UObject, Vector, Single, NavigationData, SubclassOf<NavigationQueryFilter>)

Get Random Reachable Point in Radius

Declaration

public static Vector GetRandomReachablePointInRadius(UObject WorldContextObject, Vector Origin, float Radius, NavigationData NavData, SubclassOf<NavigationQueryFilter> FilterClass)

Parameters

Type	Name	Description
UObject	WorldContextObject
Vector	Origin
System.Single	Radius
NavigationData	NavData
SubclassOf<NavigationQueryFilter>	FilterClass

Returns

Type	Description
Vector

| Improve this Doc View Source

IsNavigationBeingBuilt(UObject)

Is Navigation Being Built

Declaration

public static bool IsNavigationBeingBuilt(UObject WorldContextObject)

Parameters

Type	Name	Description
UObject	WorldContextObject

Returns

Type	Description
System.Boolean

| Improve this Doc View Source

IsNavigationBeingBuiltOrLocked(UObject)

Is Navigation Being Built or Locked

Declaration

public static bool IsNavigationBeingBuiltOrLocked(UObject WorldContextObject)

Parameters

Type	Name	Description
UObject	WorldContextObject

Returns

Type	Description
System.Boolean

| Improve this Doc View Source

K2_GetRandomPointInNavigableRadius(UObject, Vector, Single, NavigationData, SubclassOf<NavigationQueryFilter>)

Generates a random location in navigable space within given radius of Origin.

Declaration

public static (Vector, bool) K2_GetRandomPointInNavigableRadius(UObject WorldContextObject, Vector Origin, float Radius, NavigationData NavData, SubclassOf<NavigationQueryFilter> FilterClass)

Parameters

Type	Name	Description
UObject	WorldContextObject
Vector	Origin
System.Single	Radius
NavigationData	NavData
SubclassOf<NavigationQueryFilter>	FilterClass

Returns

Type	Description
System.ValueTuple<Vector, System.Boolean>

Remarks

@return Return Value represents if the call was successful

| Improve this Doc View Source

K2_GetRandomReachablePointInRadius(UObject, Vector, Single, NavigationData, SubclassOf<NavigationQueryFilter>)

Generates a random location reachable from given Origin location.

Declaration

public static (Vector, bool) K2_GetRandomReachablePointInRadius(UObject WorldContextObject, Vector Origin, float Radius, NavigationData NavData, SubclassOf<NavigationQueryFilter> FilterClass)

Parameters

Type	Name	Description
UObject	WorldContextObject
Vector	Origin
System.Single	Radius
NavigationData	NavData
SubclassOf<NavigationQueryFilter>	FilterClass

Returns

Type	Description
System.ValueTuple<Vector, System.Boolean>

Remarks

@return Return Value represents if the call was successful

| Improve this Doc View Source

K2_ProjectPointToNavigation(UObject, Vector, NavigationData, SubclassOf<NavigationQueryFilter>, Vector)

Project a point onto the NavigationData

Declaration

public static (Vector, bool) K2_ProjectPointToNavigation(UObject WorldContextObject, Vector Point, NavigationData NavData, SubclassOf<NavigationQueryFilter> FilterClass, Vector QueryExtent)

Parameters

Type	Name	Description
UObject	WorldContextObject
Vector	Point
NavigationData	NavData
SubclassOf<NavigationQueryFilter>	FilterClass
Vector	QueryExtent

Returns

Type	Description
System.ValueTuple<Vector, System.Boolean>

| Improve this Doc View Source

NavigationRaycast(UObject, Vector, Vector, SubclassOf<NavigationQueryFilter>, Controller)

Performs navigation raycast on NavigationData appropriate for given Querier.

Declaration

public static (Vector, bool) NavigationRaycast(UObject WorldContextObject, Vector RayStart, Vector RayEnd, SubclassOf<NavigationQueryFilter> FilterClass, Controller Querier)

Parameters

Type	Name	Description
UObject	WorldContextObject
Vector	RayStart
Vector	RayEnd
SubclassOf<NavigationQueryFilter>	FilterClass
Controller	Querier

Returns

Type	Description
System.ValueTuple<Vector, System.Boolean>

Remarks

@param Querier if not passed default navigation data will be used @param HitLocation if line was obstructed this will be set to hit location. Otherwise it contains SegmentEnd @return true if line from RayStart to RayEnd was obstructed. Also, true when no navigation data present

| Improve this Doc View Source

New(UObject, Name)

Spawn an object of this class

Declaration

public static NavigationSystemV1 New(UObject obj = null, Name name = default(Name))

Parameters

Type	Name	Description
UObject	obj
Name	name

Returns

Type	Description
NavigationSystemV1

| Improve this Doc View Source

OnNavigationBoundsUpdated(NavMeshBoundsVolume)

@todo document

Declaration

public void OnNavigationBoundsUpdated(NavMeshBoundsVolume NavVolume)

Parameters

Type	Name	Description
NavMeshBoundsVolume	NavVolume

| Improve this Doc View Source

ProjectPointToNavigation(UObject, Vector, NavigationData, SubclassOf<NavigationQueryFilter>, Vector)

Project Point to Navigation

Declaration

public static Vector ProjectPointToNavigation(UObject WorldContextObject, Vector Point, NavigationData NavData, SubclassOf<NavigationQueryFilter> FilterClass, Vector QueryExtent)

Parameters

Type	Name	Description
UObject	WorldContextObject
Vector	Point
NavigationData	NavData
SubclassOf<NavigationQueryFilter>	FilterClass
Vector	QueryExtent

Returns

Type	Description
Vector

| Improve this Doc View Source

RegisterNavigationInvoker(Actor, Single, Single)

Registers given actor as a "navigation enforcer" which means navigation system will make sure navigation is being generated in specified radius around it.

Declaration

public void RegisterNavigationInvoker(Actor Invoker, float TileGenerationRadius, float TileRemovalRadius)

Parameters

Type	Name	Description
Actor	Invoker
System.Single	TileGenerationRadius
System.Single	TileRemovalRadius

Remarks

@note: you need NavigationSystem's GenerateNavigationOnlyAroundNavigationInvokers to be set to true to take advantage of this feature

| Improve this Doc View Source

ResetMaxSimultaneousTileGenerationJobsCount()

Brings limit of simultaneous navmesh tile generation jobs back to Project Setting's default value

Declaration

public void ResetMaxSimultaneousTileGenerationJobsCount()

| Improve this Doc View Source

SetGeometryGatheringMode(ENavDataGatheringModeConfig)

Set Geometry Gathering Mode

Declaration

public void SetGeometryGatheringMode(ENavDataGatheringModeConfig NewMode)

Parameters

Type	Name	Description
ENavDataGatheringModeConfig	NewMode

| Improve this Doc View Source

SetMaxSimultaneousTileGenerationJobsCount(Int32)

will limit the number of simultaneously running navmesh tile generation jobs to specified number.

Declaration

public void SetMaxSimultaneousTileGenerationJobsCount(int MaxNumberOfJobs)

Parameters

Type	Name	Description
System.Int32	MaxNumberOfJobs

Remarks

@param MaxNumberOfJobs gets trimmed to be at least 1. You cannot use this function to pause navmesh generation

| Improve this Doc View Source

SimpleMoveToActor(Controller, Actor)

Simple Move to Actor

Declaration

public static void SimpleMoveToActor(Controller Controller, Actor Goal)

Parameters

Type	Name	Description
Controller	Controller
Actor	Goal

| Improve this Doc View Source

SimpleMoveToLocation(Controller, Vector)

Simple Move to Location

Declaration

public static void SimpleMoveToLocation(Controller Controller, Vector Goal)

Parameters

Type	Name	Description
Controller	Controller
Vector	Goal

| Improve this Doc View Source

UnregisterNavigationInvoker(Actor)

Removes given actor from the list of active navigation enforcers.

Declaration

public void UnregisterNavigationInvoker(Actor Invoker)

Parameters

Type	Name	Description
Actor	Invoker

Remarks

@see RegisterNavigationInvoker for more details

Operators

| Improve this Doc View Source

Implicit(IntPtr to NavigationSystemV1)

Convert from IntPtr to UObject

Declaration

public static implicit operator NavigationSystemV1(IntPtr p)

Parameters

Type	Name	Description
System.IntPtr	p

Returns

Type	Description
NavigationSystemV1