Class StartEndModifier Extends PathModifier

Public

Adjusts start and end points of a path.

This modifier is included in the Seeker component and is always used if you are using a Seeker. When a path is calculated the resulting path will only be the positions of the nodes it passes through. However often you may not want to navigate to the center of a specific node but instead to a point on the surface of a node. This modifier will adjust the endpoints of the path.

Public Methods

Apply (path)

Main Post-Processing function.

Public

Public Variables

Order

Public

addPoints

Add points to the path instead of replacing them.

Public

adjustStartPoint

Will be called when a path is processed.

Public

exactEndPoint

How the end point of the path will be determined.

Public

exactStartPoint

How the start point of the path will be determined.

Public

mask

Public

useGraphRaycasting

Do a straight line check from the node's center to the point determined by the Exactness.

Public

useRaycasting

Do a straight line check from the node's center to the point determined by the Exactness.

Public

Public Enums

Exactness

Sets where the start and end points of a path should be placed.

Public

Inherited Public Members

Awake (seeker)

Public

OnDestroy (seeker)

Public

PreProcess (path)

Public

seeker

Public

Private/Protected Members

GetClampedPoint (from, to, hint)

Protected

Snap (path, mode, start, forceAddPoint, closestConnectionIndex)

Private

connectionBuffer

Private

connectionBufferAddDelegate

Private

SnapToNode	The point is snapped to the position of the first/last node in the path. Use this if your game is very tile based and you want your agents to stop precisely at the center of the nodes. If you recalculate the path while the agent is moving you may want the start point snapping to be ClosestOnNode and the end point snapping to be SnapToNode however as while an agent is moving it will likely not be right at the center of a node.
Original	The point is set to the exact point which was passed when creating the path request. Note that if a path was for example requested to a point inside an obstacle, then the last point of the path will be inside that obstacle, which is usually not what you want. Consider using the Exactness.ClosestOnNode option instead.
Interpolate	The point is set to the closest point on the line between either the two first points or the two last points. Usually you will want to use the NodeConnection mode instead since that is usually the behaviour that you really want. This mode exists mostly for compatibility reasons. Deprecated Use NodeConnection instead.
ClosestOnNode	The point is set to the closest point on the surface of the node. Note that some node types (point nodes) do not have a surface, so the "closest point" is simply the node's position which makes this identical to Exactness.SnapToNode. This is the mode that you almost always want to use in a free movement 3D world.
NodeConnection	The point is set to the closest point on one of the connections from the start/end node. This mode may be useful in a grid based or point graph based world when using the AILerp script. Note If you are using this mode with a PointGraph you probably also want to use the Connection mode for PointGraph.nearestNodeDistanceMode.

Class StartEndModifier Extends PathModifier

Public Methods

void Apply (

Path

path

)

Public Variables

int Order

bool addPoints

System.Func<Vector3> adjustStartPoint

Exactness exactEndPoint = Exactness.ClosestOnNode

See

Exactness exactStartPoint = Exactness.ClosestOnNode

See

LayerMask mask = -1

bool useGraphRaycasting

See

Version

bool useRaycasting

Version

Public Enums

Exactness

Deprecated

Note

Inherited Public Members

void Awake (

Seeker

seeker

)

void OnDestroy (

Seeker

seeker

)

void PreProcess (

Path

path

)

Seeker seeker

Private/Protected Members

Vector3 GetClampedPoint (

Vector3

from

Vector3

to

GraphNode

hint

)

Vector3 Snap (

ABPath

path

Exactness

mode

bool

start

out bool

forceAddPoint

out int

closestConnectionIndex

)

List<GraphNode> connectionBuffer

System.Action<GraphNode> connectionBufferAddDelegate

ABPath	path
Exactness	mode
bool	start
out bool	forceAddPoint
out int	closestConnectionIndex

Class StartEndModifier Extends PathModifier

Public Methods

void Apply ( Path path )

Public Variables

int Order

bool addPoints

System.Func<Vector3> adjustStartPoint

Exactness exactEndPoint = Exactness.ClosestOnNode

See

Exactness exactStartPoint = Exactness.ClosestOnNode

See

LayerMask mask = -1

bool useGraphRaycasting

See

Version

bool useRaycasting

Version

Public Enums

Exactness

Deprecated

Note

Inherited Public Members

void Awake ( Seeker seeker )

void OnDestroy ( Seeker seeker )

void PreProcess ( Path path )

Seeker seeker

Private/Protected Members

Vector3 GetClampedPoint ( Vector3 from Vector3 to GraphNode hint )

Vector3 Snap ( ABPath path Exactness mode bool start out bool forceAddPoint out int closestConnectionIndex )

List<GraphNode> connectionBuffer

System.Action<GraphNode> connectionBufferAddDelegate

void Apply (

Path

path

)

void Awake (

Seeker

seeker

)

void OnDestroy (

Seeker

seeker

)

void PreProcess (

Path

path

)

Vector3 GetClampedPoint (

Vector3

from

Vector3

to

GraphNode

hint

)

Vector3 Snap (

ABPath

path

Exactness

mode

bool

start

out bool

forceAddPoint

out int

closestConnectionIndex

)