Class NodeLink2 Extends GraphModifier

void Apply ()

Disconnects and then reconnects the link to the graph.

If you have moved the link or otherwise modified it you need to call this method to apply those changes.

void DrawGizmos ()

void OnPostScan ()

Called right after all graphs have been scanned.

NodeLink2 GetNodeLink (

GraphNode

node

The node to get the link for.

)

Returns the link component associated with the specified node.

Transform EndTransform

Transform StartTransform

float costFactor = 1.0f

The connection will be this times harder/slower to traverse.

A cost factor of 1 means that the link is equally expensive as moving the same distance on the normal navmesh. But a cost factor greater than 1 means that it is proportionally more expensive.

You should not use a cost factor less than 1 unless you also change the AstarPath.heuristicScale field (A* Inspector -> Settings -> Pathfinding) to at most the minimum cost factor that you use anywhere in the scene (or disable the heuristic altogether). This is because the pathfinding algorithm assumes that paths are at least as costly as walking just the straight line distance to the target, and if you use a cost factor less than 1, that assumption is no longer true. What then happens is that the pathfinding search may ignore some links because it doesn't even think to search in that direction, even if they would have lead to a lower path cost.

Read more about this at https://en.wikipedia.org/wiki/Admissible_heuristic.

Transform end

End position of the link.

GraphMask graphMask = -1

Which graphs this link is allowed to connect.

The link will always connect the nodes closest to the start and end points on the graphs that it is allowed to connect.

IOffMeshLinkHandler onTraverseOffMeshLink

Callback to be called when an agent starts traversing an off-mesh link.

The handler will be called when the agent starts traversing an off-mesh link. It allows you to to control the agent for the full duration of the link traversal.

Use the passed context struct to get information about the link and to control the agent.

using UnityEngine;
using Pathfinding;
using System.Collections;
using Pathfinding.ECS;

namespace Pathfinding.Examples {
public class FollowerJumpLink : MonoBehaviour, IOffMeshLinkHandler, IOffMeshLinkStateMachine {
// Register this class as the handler for off-mesh links when the component is enabled
void OnEnable() => GetComponent<NodeLink2>().onTraverseOffMeshLink = this;
void OnDisable() => GetComponent<NodeLink2>().onTraverseOffMeshLink = null;

IOffMeshLinkStateMachine IOffMeshLinkHandler.GetOffMeshLinkStateMachine(AgentOffMeshLinkTraversalContext context) => this;

void IOffMeshLinkStateMachine.OnFinishTraversingOffMeshLink (AgentOffMeshLinkTraversalContext context) {
Debug.Log("An agent finished traversing an off-mesh link");
}

void IOffMeshLinkStateMachine.OnAbortTraversingOffMeshLink () {
Debug.Log("An agent aborted traversing an off-mesh link");
}

IEnumerable IOffMeshLinkStateMachine.OnTraverseOffMeshLink (AgentOffMeshLinkTraversalContext ctx) {
var start = (Vector3)ctx.link.relativeStart;
var end = (Vector3)ctx.link.relativeEnd;
var dir = end - start;

// Disable local avoidance while traversing the off-mesh link.
// If it was enabled, it will be automatically re-enabled when the agent finishes traversing the link.
ctx.DisableLocalAvoidance();

// Move and rotate the agent to face the other side of the link.
// When reaching the off-mesh link, the agent may be facing the wrong direction.
while (!ctx.MoveTowards(
position: start,
rotation: Quaternion.LookRotation(dir, ctx.movementPlane.up),
gravity: true,
slowdown: true).reached) {
yield return null;
}

var bezierP0 = start;
var bezierP1 = start + Vector3.up*5;
var bezierP2 = end + Vector3.up*5;
var bezierP3 = end;
var jumpDuration = 1.0f;

// Animate the AI to jump from the start to the end of the link
for (float t = 0; t < jumpDuration; t += ctx.deltaTime) {
ctx.transform.Position = AstarSplines.CubicBezier(bezierP0, bezierP1, bezierP2, bezierP3, Mathf.SmoothStep(0, 1, t / jumpDuration));
yield return null;
}
}
}
}


You can alternatively set the corresponding property property on the agent ( FollowerEntity.onTraverseOffMeshLink) to specify a callback for a all off-mesh links.

bool oneWay = false

Make a one-way connection.

PathfindingTag pathfindingTag = 0

The tag to apply to the link.

This can be used to exclude certain agents from using the link, or make it more expensive to use.

EventType

GraphModifier event type.

void FindAllModifiers ()

void OnGraphsPostUpdate ()

Called after graphs have been updated using GraphUpdateObjects or navmesh cutting.

This is among other times called after graphs have been scanned, updated using GraphUpdateObjects, navmesh cuts, or GraphUpdateScene components.

Area recalculations (see HierarchicalGraph) have been done at this stage so things like PathUtilities.IsPathPossible will work.

Use OnGraphsPostUpdateBeforeAreaRecalculation instead if you are modifying the graph in any way, especially connections and walkability. This is because if you do this then area recalculations

void OnGraphsPostUpdateBeforeAreaRecalculation ()

Called after graphs have been updated.

This is among other times called after graphs have been scanned, updated using GraphUpdateObjects, navmesh cuts, or GraphUpdateScene components.

Use this if you are modifying any graph connections or walkability.

void OnGraphsPreUpdate ()

Called before graphs are updated using GraphUpdateObjects.

void OnLatePostScan ()

Called at the end of the scanning procedure.

This is the absolute last thing done by Scan.

void OnPostCacheLoad ()

Called after cached graphs have been loaded.

When using cached startup, this event is analogous to OnLatePostScan and implementing scripts should do roughly the same thing for both events.

void OnPostGraphLoad ()

Called after a graph has been deserialized and loaded.

This will be called often outside of play mode. Make sure to check Application.isPlaying if appropriate.

void OnPreScan ()

Called right before graphs are going to be scanned.

void TriggerEvent (

GraphModifier.EventType

type

)

Triggers an event for all active graph modifiers.

void Awake ()

void ContextApplyForce ()

List<T> GetModifiersOfType<T> ()

Color GizmosColor = new Color(206.0f/255.0f, 136.0f/255.0f, 48.0f/255.0f, 0.5f)

Color GizmosColorSelected = new Color(235.0f/255.0f, 123.0f/255.0f, 32.0f/255.0f, 1.0f)

void OnDestroy ()

void OnDisable ()

Removes this modifier from list of active modifiers.

void OnEnable ()

Adds this modifier to list of active modifiers.

void OnUpdate (

NodeLink2[]	components
int	count

)

void OnUpgradeSerializedData (

refMigrations	migrations
bool	unityThread

)

Handle serialization backwards compatibility.

void RemoveLink ()

void Reset ()

Handle serialization backwards compatibility.

void TryAddLink ()

void UpgradeSerializedData (

bool

isUnityThread

)

bool isActive

True if the link is connected to the graph.

This will be true if the link has been successfully connected to the graph, and false if it either has failed, or if the component/gameobject is disabled.

When the component is enabled, the link will be scheduled to be added to the graph, it will not take effect immediately. This means that this property will return false until the next time graph updates are processed (usually later this frame, or next frame). To ensure the link is refreshed immediately, you can call AstarPath.active.FlushWorkItems.

OffMeshLinks.OffMeshLinkSource linkSource

IOffMeshLinkHandler onTraverseOffMeshLinkHandler

ulong uniqueID

Unique persistent ID for this component, used for serialization.

Dictionary<ulong,GraphModifier> usedIDs = new Dictionary<ulong, GraphModifier>()

Maps persistent IDs to the component that uses it.