Class PathDestinationDef

Namespace
TDMaker.Core.Defs
Assembly
TDMaker.Core.dll

A validated-at-use authored path destination.

public sealed class PathDestinationDef
Inheritance
PathDestinationDef
Inherited Members

Constructors

PathDestinationDef(int, int, int, float, bool)

Creates a destination. Level-specific geometry is checked before any relationship or state is changed.

public PathDestinationDef(int pathIndex, int nodeIndex, int laneIndex = -1, float progress = 0, bool clearEffects = false)

Parameters

pathIndex int
nodeIndex int
laneIndex int
progress float
clearEffects bool

Properties

ClearEffects

Also dispels existing attached effects on transfer.

public bool ClearEffects { get; }

Property Value

bool

LaneIndex

Fixed lane, or -1 to preserve the source lane modulo destination lane count.

public int LaneIndex { get; }

Property Value

int

NodeIndex

Destination segment start node; must lie between entry and exit.

public int NodeIndex { get; }

Property Value

int

PathIndex

Destination path index.

public int PathIndex { get; }

Property Value

int

Progress

Fraction along the destination segment; exit nodes require zero.

public float Progress { get; }

Property Value

float