Struct Nav

Namespace

Ofs

Assembly

Ofs.Api.dll

A navigator's answer to a NavStep: seek to a time, do nothing, or pass the step to the native resolution for its granularity.

public readonly struct Nav

Properties

None

Don't move the playhead (swallow the step).

public static Nav None { get; }

Property Value

Nav

Pass

Defer to the host's native resolution for this step's granularity.

public static Nav Pass { get; }

Property Value

Nav

Methods

Seek(ScriptAction)

Move the playhead to time seconds, keeping the current active axis.

public static Nav Seek(ScriptAction action)

Parameters

action ScriptAction

Returns

Nav

Seek(ScriptAction, StandardAxis)

Move the playhead to time seconds and make axis the active axis — the way the native ActionAllAxes step lands on a multi-axis action and activates whichever axis owns it. Use the plain Seek(double) when you don't need to switch axes; the active one is kept for you.

public static Nav Seek(ScriptAction action, StandardAxis axis)

Parameters

action ScriptAction

axis StandardAxis

Returns

Nav

Seek(double)

Move the playhead to time seconds, keeping the current active axis.

public static Nav Seek(double time)

Parameters

time double

Returns

Nav

Seek(double, StandardAxis)

Move the playhead to time seconds and make axis the active axis — the way the native ActionAllAxes step lands on a multi-axis action and activates whichever axis owns it. Use the plain Seek(double) when you don't need to switch axes; the active one is kept for you.

public static Nav Seek(double time, StandardAxis axis)

Parameters

time double

axis StandardAxis

Returns

Nav