Core.SetActiveTimedFunctionPeriodic

Sets whether a Timed Function is periodic for executing repeatedly at intervals.

Description

If a Timed Function is set to Periodic, then it will recur according to the Period interval, defined in seconds.

Example Usage (C#)


//Setting a Timed Function to be Periodic.

public bool Invoke() {
bool success = _core.SetActiveTimedFunctionPeriodic("TimedFunctionName", true);
return true;
}

Parameters

string

methodName

The name of the Method in SILVIA’s internal scripts to find.

bool

periodic

The boolean value true or false indicating whether the function should be Periodic.

Returns

A bool representing the success of the operation. Returns false if no Timed Function found under that name.

See Also

  • Core.GetActiveTimedFunctionsArePeriodic