Class SchedulerExecutableLibrary

Namespace

Ceres.Flow.Utilities

Assembly

Ceres.Flow.dll

Provides scheduler timer and frame counter helpers for Flow graphs.

[CeresGroup("Scheduler")]
public class SchedulerExecutableLibrary : ExecutableFunctionLibrary

Inheritance

object

ExecutableFunctionLibrary

SchedulerExecutableLibrary

Inherited Members

ExecutableFunctionLibrary.RegisterExecutableFunctionPtr<TLibrary>(string, int, void*)

ExecutableFunctionLibrary.RegisterExecutableFunctionFileInfo<TLibrary>(string, int, string, int)

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

SchedulerExecutableLibrary()

public SchedulerExecutableLibrary()

Methods

CollectExecutableFunctions()

Collect all static executable functions in this library

protected override void CollectExecutableFunctions()

Flow_SchedulerCancel(SchedulerHandle)

Cancels a scheduled task if the handle is valid.

[ExecutableFunction(IsScriptMethod = true)]
[CeresLabel("Cancel Scheduler")]
public static void Flow_SchedulerCancel(SchedulerHandle handle)

Parameters

handle SchedulerHandle

Flow_SchedulerDelay(float, EventDelegate, EventDelegate<float>, TickFrame, bool, bool)

Schedules a timer and invokes callbacks as it updates and completes.

[ExecutableFunction]
[CeresLabel("Schedule Timer By Event")]
public static SchedulerHandle Flow_SchedulerDelay(float delaySeconds, EventDelegate onComplete, EventDelegate<float> onUpdate, TickFrame tickFrame, bool isLooped, bool ignoreTimeScale)

Parameters

delaySeconds float

onComplete EventDelegate

onUpdate EventDelegate<float>

tickFrame TickFrame

isLooped bool

ignoreTimeScale bool

Returns

SchedulerHandle

Flow_SchedulerWaitFrame(int, EventDelegate, EventDelegate<int>, TickFrame, bool)

Schedules a frame counter and invokes callbacks as it updates and completes.

[ExecutableFunction(SearchAliases = "Schedule FrameCounter By Event, FrameCounter")]
[CeresLabel("Schedule Frame Counter By Event")]
public static SchedulerHandle Flow_SchedulerWaitFrame(int frame, EventDelegate onComplete, EventDelegate<int> onUpdate, TickFrame tickFrame, bool isLooped)

Parameters

frame int

onComplete EventDelegate

onUpdate EventDelegate<int>

tickFrame TickFrame

isLooped bool

Returns

SchedulerHandle