Class PeriodicUpdate

Inheritance
System.Object
PeriodicUpdate
PeriodicUpdateSpatial
Namespace: Eco.Shared.Utils
Assembly: Eco.Shared.dll
Syntax
[Serialized]
public class PeriodicUpdate : Object

Constructors

PeriodicUpdate()

Declaration
public PeriodicUpdate()

PeriodicUpdate(Double, Boolean, Boolean)

Create a timer that will return true to DoUpdate every X seconds. If 'startReady' is false, then it will wait until the time elapses before the first trigger.

Declaration
public PeriodicUpdate(double interval, bool useRealTime = true, bool startReady = true)
Parameters
Type Name Description
System.Double interval
System.Boolean useRealTime
System.Boolean startReady

Fields

GetSimTime

Declaration
public static Func<double> GetSimTime
Field Value
Type Description
System.Func<System.Double>

NextTickTime

Declaration
[Serialized]
public double NextTickTime
Field Value
Type Description
System.Double

Period

Declaration
[Serialized]
public double Period
Field Value
Type Description
System.Double

Properties

DoUpdate

Declaration
public bool DoUpdate { get; }
Property Value
Type Description
System.Boolean

Time

Declaration
public double Time { get; }
Property Value
Type Description
System.Double

TimeTillNext

Declaration
public double TimeTillNext { get; }
Property Value
Type Description
System.Double

Methods

Reset()

Update the next tick time to be 'period' away.

Declaration
public void Reset()

SetToTriggerNextTick()

Declaration
public void SetToTriggerNextTick()

Extension Methods