Class Timer

Namespace

UILib.Behaviours

Assembly

UILib.dll

Runs a timer.

public class Timer : MonoBehaviour

Inheritance

object

Object

Component

Behaviour

MonoBehaviour

Timer

Derived

Fade

Inherited Members

MonoBehaviour.IsInvoking()

MonoBehaviour.CancelInvoke()

MonoBehaviour.Invoke(string, float)

MonoBehaviour.InvokeRepeating(string, float, float)

MonoBehaviour.CancelInvoke(string)

MonoBehaviour.IsInvoking(string)

MonoBehaviour.StartCoroutine(string)

MonoBehaviour.StartCoroutine(string, object)

MonoBehaviour.StartCoroutine(IEnumerator)

MonoBehaviour.StartCoroutine_Auto(IEnumerator)

MonoBehaviour.StopCoroutine(IEnumerator)

MonoBehaviour.StopCoroutine(Coroutine)

MonoBehaviour.StopCoroutine(string)

MonoBehaviour.StopAllCoroutines()

MonoBehaviour.print(object)

MonoBehaviour.Internal_CancelInvokeAll(MonoBehaviour)

MonoBehaviour.Internal_IsInvokingAll(MonoBehaviour)

MonoBehaviour.InvokeDelayed(MonoBehaviour, string, float, float)

MonoBehaviour.CancelInvoke(MonoBehaviour, string)

MonoBehaviour.IsInvoking(MonoBehaviour, string)

MonoBehaviour.IsObjectMonoBehaviour(Object)

MonoBehaviour.StartCoroutineManaged(string, object)

MonoBehaviour.StartCoroutineManaged2(IEnumerator)

MonoBehaviour.StopCoroutineManaged(Coroutine)

MonoBehaviour.StopCoroutineFromEnumeratorManaged(IEnumerator)

MonoBehaviour.GetScriptClassName()

MonoBehaviour.useGUILayout

Behaviour.enabled

Behaviour.isActiveAndEnabled

Component.GetComponent(Type)

Component.GetComponentFastPath(Type, IntPtr)

Component.GetComponent<T>()

Component.TryGetComponent(Type, out Component)

Component.TryGetComponent<T>(out T)

Component.GetComponent(string)

Component.GetComponentInChildren(Type, bool)

Component.GetComponentInChildren(Type)

Component.GetComponentInChildren<T>(bool)

Component.GetComponentInChildren<T>()

Component.GetComponentsInChildren(Type, bool)

Component.GetComponentsInChildren(Type)

Component.GetComponentsInChildren<T>(bool)

Component.GetComponentsInChildren<T>(bool, List<T>)

Component.GetComponentsInChildren<T>()

Component.GetComponentsInChildren<T>(List<T>)

Component.GetComponentInParent(Type)

Component.GetComponentInParent<T>()

Component.GetComponentsInParent(Type, bool)

Component.GetComponentsInParent(Type)

Component.GetComponentsInParent<T>(bool)

Component.GetComponentsInParent<T>(bool, List<T>)

Component.GetComponentsInParent<T>()

Component.GetComponents(Type)

Component.GetComponentsForListInternal(Type, object)

Component.GetComponents(Type, List<Component>)

Component.GetComponents<T>(List<T>)

Component.GetComponents<T>()

Component.CompareTag(string)

Component.SendMessageUpwards(string, object, SendMessageOptions)

Component.SendMessageUpwards(string, object)

Component.SendMessageUpwards(string)

Component.SendMessageUpwards(string, SendMessageOptions)

Component.SendMessage(string, object)

Component.SendMessage(string)

Component.SendMessage(string, object, SendMessageOptions)

Component.SendMessage(string, SendMessageOptions)

Component.BroadcastMessage(string, object, SendMessageOptions)

Component.BroadcastMessage(string, object)

Component.BroadcastMessage(string)

Component.BroadcastMessage(string, SendMessageOptions)

Component.transform

Component.gameObject

Component.tag

Object.m_CachedPtr

Object.OffsetOfInstanceIDInCPlusPlusObject

Object.objectIsNullMessage

Object.cloneDestroyedMessage

Object.GetInstanceID()

Object.GetHashCode()

Object.Equals(object)

Object.CompareBaseObjects(Object, Object)

Object.EnsureRunningOnMainThread()

Object.IsNativeObjectAlive(Object)

Object.GetCachedPtr()

Object.Instantiate(Object, Vector3, Quaternion)

Object.Instantiate(Object, Vector3, Quaternion, Transform)

Object.Instantiate(Object)

Object.Instantiate(Object, Transform)

Object.Instantiate(Object, Transform, bool)

Object.Instantiate<T>(T)

Object.Instantiate<T>(T, Vector3, Quaternion)

Object.Instantiate<T>(T, Vector3, Quaternion, Transform)

Object.Instantiate<T>(T, Transform)

Object.Instantiate<T>(T, Transform, bool)

Object.Destroy(Object, float)

Object.Destroy(Object)

Object.DestroyImmediate(Object, bool)

Object.DestroyImmediate(Object)

Object.FindObjectsOfType(Type)

Object.DontDestroyOnLoad(Object)

Object.DestroyObject(Object, float)

Object.DestroyObject(Object)

Object.FindSceneObjectsOfType(Type)

Object.FindObjectsOfTypeIncludingAssets(Type)

Object.FindObjectsOfType<T>()

Object.FindObjectOfType<T>()

Object.FindObjectsOfTypeAll(Type)

Object.CheckNullArgument(object, string)

Object.FindObjectOfType(Type)

Object.ToString()

Object.GetOffsetOfInstanceIDInCPlusPlusObject()

Object.CurrentThreadIsMainThread()

Object.Internal_CloneSingle(Object)

Object.Internal_CloneSingleWithParent(Object, Transform, bool)

Object.Internal_InstantiateSingle(Object, Vector3, Quaternion)

Object.Internal_InstantiateSingleWithParent(Object, Transform, Vector3, Quaternion)

Object.ToString(Object)

Object.GetName(Object)

Object.IsPersistent(Object)

Object.SetName(Object, string)

Object.DoesObjectWithInstanceIDExist(int)

Object.FindObjectFromInstanceID(int)

Object.ForceLoadFromInstanceID(int)

Object.Internal_InstantiateSingle_Injected(Object, ref Vector3, ref Quaternion)

Object.Internal_InstantiateSingleWithParent_Injected(Object, Transform, ref Vector3, ref Quaternion)

Object.name

Object.hideFlags

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetType()

object.MemberwiseClone()

Properties

onEnd

Invokes listeners when the timer finishes.

public UnityEvent onEnd { get; }

Property Value

UnityEvent

onIter

Invokes listeners on each iteration of the timer. The value passed to listeners is the current value of the timer.

public ValueEvent<float> onIter { get; }

Property Value

ValueEvent<float>

onStart

Invokes listeners whenever the timer is started.

public UnityEvent onStart { get; }

Property Value

UnityEvent

paused

Whether the timer should pause.

public bool paused { get; }

Property Value

bool

running

Whether the timer coroutine is currently running.

public bool running { get; }

Property Value

bool

timeScale

The time scale. By default this is 1. Scales how quickly the timer should run.

The higher this value, the faster the timer runs. The lower this value, the slower the timer runs.

public float timeScale { get; }

Property Value

float

timer

The current value of the timer.

public float timer { get; }

Property Value

float

Methods

PauseTimer(bool)

Pauses the timer.

If the timer is paused, the internal timer will no longer decrease, and any onIter listeners will no longer be invoked. Passing false will allow the timer to continue normal execution.

public void PauseTimer(bool pause = true)

Parameters

pause bool

Whether the timer should be paused

ReverseTimer()

Sets the timer to go in reverse of its current direction.

public void ReverseTimer()

SetTimeScale(float)

Sets the timeScale.

public void SetTimeScale(float timeScale)

Parameters

timeScale float

StartTimer(float, float)

Starts the timer. If the timer is already running, this will restart it.

Both the start and end time must be >= 0.

public void StartTimer(float startTime, float endTime = 0)

Parameters

startTime float

What time the timer should start at

endTime float

What time the timer should end at

StopTimer()

Stops the timer immediately.

public void StopTimer()