Class Clock

Namespace: Gamelogic.Extensions

Assembly: Gamelogic.Extensions.dll

Represents a clock that expires after a given time.

[Version(1, 2, 0)]
public class Clock

Inheritance: object

Clock

Inherited Members: object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods: ObjectExtensions.ThrowIfNull(object, string)

Remarks

To use this clock, instantiate it, call Reset with the right time value, and call Update it each frame.

Any class that wants to be notified of events need to implement the IClockListener interface, and subscribe to events using the AddListener method. A listener can be removed with the RemoveListener event.

Clocks can be paused independently of Time.timeScale using the Pause method (and started again using Unpause).

Constructors

Clock(): Initializes a new instance of the Clock class.

Properties

IsDone: Gets a value indicating whether this instance is done.

IsPaused: Gets a value indicating whether this clock is paused.

Time: The current time on this clock in seconds as a float.

TimeInSeconds: Gets the time in seconds of this clock as an integer.

Methods

AddTime(float): Adds time to this clock. This will extend the time the clock expires by the given amount.

Pause(): Pauses this clock.

Reset(float): Resets the clock to the specified stat time.

Unpause(): Unpauses this clock.

Update(float): Call this method repeatedly to update the time (typically, in a component's Update method).

Events

OnClockExpired: Occurs when the clock expired.