Ara
Download

Search or run a command

Jump to a section or open an Ara link.

Struct · Ara

NavLink

Authored off-mesh connection in world space (jump, ladder or scripted passage).

public struct NavLink : IComponent<NavLink>

Properties

TypeIndex

public static uint TypeIndex { get; }

Stable engine component index.

Fields

Id

public uint Id;

Stable nonzero connection ID.

Default: 0.

Start

public Vector3 Start;

Start endpoint in world space.

Unit: m. Default: [0,0,0].

End

public Vector3 End;

End endpoint in world space.

Unit: m. Default: [0,0,0].

Radius

public float Radius;

Maximum horizontal attachment distance.

Unit: m. Range: [0.001, 100]. Default: 0.5.

Area

public byte Area;

Traversal area index, from 0 through 15.

Range: [0, 15]. Default: 0.

Bidirectional

public bool Bidirectional;

Whether traversal is allowed in both directions.

Default: true.

Enabled

public bool Enabled;

Whether the connection is available to the baker.

Default: true.

Kind

public LinkKind Kind;

How agents traverse it: drives traversal motion, gating and animation hooks.

Default: "walk".

Duration

public float Duration;

Traversal time in seconds; 0 derives it from length and agent speed.

Unit: s. Range: [0, 600]. Default: 0.

ArcHeight

public float ArcHeight;

Jump apex above the straight start-end line, in metres (jumps only).

Unit: m. Range: [0, 100]. Default: 0.5.

Methods

Access

public static ref NavLink Access(Entity entity, bool write);

No description yet.

Insert

public static void Insert(in Commands commands, Entity entity, in NavLink value);

No description yet.

Contains

public static bool Contains(Entity entity);

No description yet.