Core.SetActiveTimedFunctionPeriod

Sets the Period length in seconds between recurrences of an active Timed Function.

Description

Timed Functions marked Periodic execute at intervals based on their Period values. This function can alter that value after the Timed Function has already been registered with the Core.

Example Usage (C#)


//Setting a new Period value for a 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

period

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

Returns

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

See Also

  • Core.SetActiveTimedFunctionMinPeriod

Silvia Core Manager