NavigationSystem

Documents the NavigationSystem class and its functions.

NOT DOCUMENTED We currently don't have information on how these functions work. They are being documented here for visibility.

Invoking NavigationSystem

To invoke the navigation system, use the following Global function:

ns = Game.NavigationSystem()

Sub-functions

AddObstacle

AddObstacle

AddObstacle(position : Vector4, radius : Float, height : Float, agentSize : NavGenAgentSize) : ref:NavigationObstacle;

Info & Usage

CalculatePath

CalculatePath

CalculatePath(startPoint : Vector4, endPoint : Vector4, agentSize : NavGenAgentSize, findPointTolerance : Float, optional costModCircle : ref:NavigationCostModCircle) : ref:NavigationPath;

Info & Usage

FindNavmeshPointAwayFromReferencePoint

FindNavmeshPointAwayFromReferencePoint

FindNavmeshPointAwayFromReferencePoint(pos : Vector4, refPos : Vector4, distance : Float, agentSize : NavGenAgentSize, out destination : Vector4, optional distanceTolerance : Float, optional angleTolerance : Float) : Bool;

Info & Usage

FindPointInBox

FindPointInBox

FindPointInBox(center : Vector4, extents : Vector4, agentSize : NavGenAgentSize, heightDetail : Bool) : NavigationFindPointResult;

Info & Usage

FindPointInSphere

FindPointInSphere

FindPointInSphere(center : Vector4, radius : Float, agentSize : NavGenAgentSize, heightDetail : Bool) : NavigationFindPointResult;

Info & Usage

FindPursuitPoint

FindPursuitPoint

FindPursuitPoint(pos : Vector4, dir : Vector4, radius : Float, navVisCheck : Bool, agentSize : NavGenAgentSize, out destination : Vector4) : Bool;

Info & Usage

FindPursuitPointRange

FindPursuitPointRange

FindPursuitPointRange(pos : Vector4, dir : Vector4, radiusMin : Float, radiusMax : Float, navVisCheck : Bool, agentSize : NavGenAgentSize, out destination : Vector4) : Bool;

Info & Usage

FindPursuitPointsRange

FindPursuitPointsRange

FindPursuitPointsRange(pos : Vector4, dir : Vector4, radiusMin : Float, radiusMax : Float, count : Int32, navVisCheck : Bool, agentSize : NavGenAgentSize, out results : array:Vector4) : Bool;

Info & Usage

FindWallInLine

FindWallInLine

FindWallInLine(startPoint : Vector4, endPoint : Vector4, agentSize : NavGenAgentSize, findPointTolerance : Float) : ref:NavigationFindWallResult;

Info & Usage

GetFurthestNavmeshPointBehind

GetFurthestNavmeshPointBehind

GetFurthestNavmeshPointBehind(origin : wref:Entity, querySphereRadius : Float, numberOfSpheres : Int32, out point : Vector4, optional offsetFromOrigin : Vector4, optional checkPathToOrigin : Bool, optional ratioCurveName : CName) : Bool;

Info & Usage

GetNearestNavmeshPointBehind

GetNearestNavmeshPointBehind

GetNearestNavmeshPointBehind(origin : wref:Entity, querySphereRadius : Float, numberOfSpheres : Int32, out point : Vector4, optional checkPathToOrigin : Bool) : Bool;

Info & Usage

GetNearestNavmeshPointBelow

GetNearestNavmeshPointBelow

GetNearestNavmeshPointBelow(origin : Vector4, querySphereRadius : Float, numberOfSpheres : Int32) : Vector4;

Info & Usage

HasPathForward

HasPathForward

HasPathForward(sourceObject : wref:GameObject, distance : Float) : Bool;

Info & Usage

HasPathFromAtoB

HasPathFromAtoB

HasPathFromAtoB(game : GameInstance, originPoint : Vector4, targetPoint : Vector4) : Bool;

Info & Usage

IsOnGround

IsOnGround

IsOnGround(target : ref:GameObject, optional queryLength : Float) : Bool;

Info & Usage

IsPointOnNavmesh

IsPointOnNavmesh

IsPointOnNavmesh(point : Vector4, optional tolerance : Float) : Bool;

Info & Usage

IsPointOnNavmesh

IsPointOnNavmesh

IsPointOnNavmesh(point : Vector4, tolerance : Vector4) : Bool;

Info & Usage

IsPointOnNavmesh

IsPointOnNavmesh

IsPointOnNavmesh(point : Vector4, tolerance : Vector4, out navmeshPoint : Vector4) : Bool;

Info & Usage

RemoveObstacle

RemoveObstacle

RemoveObstacle(obstacle : ref:NavigationObstacle);

Info & Usage

TryToFindNavmeshPointAroundPoint

TryToFindNavmeshPointAroundPoint

TryToFindNavmeshPointAroundPoint(originPosition : Vector4, originOrientation : Quaternion, probeDimensions : Vector4, numberOfSpheres : Int32, sphereDistanceFromOrigin : Float, out point : Vector4, optional checkPathToOrigin : Bool) : Bool;

Info & Usage