Core.SetActiveTimedFunctionMinPeriod

Sets the Minimum Period length in seconds between recurrences of an active Timed Function. Works on Variable Timed Functions.

Description

Variable Timed Functions marked Periodic execute at intervals somewhere between their Minimum Period and Period values. This function can alter the Minimum Period value after the Timed Function has already been registered with the Core.

Example Usage (C#)


   //Setting a new Minimum Period value for a Variable Timed Function

public bool Invoke() { double newPeriod = 25f;
bool success = _core.SetActiveTimedFunctionPeriod("TimedFunctionName", newPeriod);
return true;
}

Parameters

string

methodName

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

double

minimumPeriod

The new Minimum Period value for the Variable Timed Function, in seconds.

Returns

A bool representing the success of the operation. Returns false if no Timed Function found under that name. Still sets Minimum Periods on Timed Functions that are not Variable, although they may not be used.

See Also

  • Core.GetActiveTimedFunctionsMinPeriods

Silvia Core Manager