SF Tool Documentation
Search Results for

    Show / Hide Table of Contents

    Class Timer

    Inheritance
    System.Object
    Timer
    Namespace: SF
    Assembly: cs.temp.dll.dll
    Syntax
    public class Timer

    Constructors

    Timer(Action)

    Declaration
    public Timer(Action onTimerComplete = null)
    Parameters
    Type Name Description
    Action onTimerComplete

    Timer(Single, Action)

    Declaration
    public Timer(float startingTime, Action onTimerComplete = null)
    Parameters
    Type Name Description
    System.Single startingTime
    Action onTimerComplete

    Fields

    RemainingTime

    Declaration
    public float RemainingTime
    Field Value
    Type Description
    System.Single

    StartingTime

    Declaration
    public float StartingTime
    Field Value
    Type Description
    System.Single

    Methods

    ResetTimer()

    Declaration
    public void ResetTimer()

    StartTimerAsync()

    Starts an async timer that when completed raises the SF.Timer._onTimerComplete event.

    Declaration
    public async Awaitable<bool> StartTimerAsync()
    Returns
    Type Description
    Awaitable<System.Boolean>

    True when the timer is finished or false while the timer is currently counting down.

    StopTimer()

    Declaration
    public void StopTimer()

    UpdateTimerAsync()

    Tells the timer to start updating and counting down asynchronously and invokes the SF.Timer._onTimerComplete event when the timer reaches zero.

    Declaration
    public async Awaitable UpdateTimerAsync()
    Returns
    Type Description
    Awaitable
    In This Article
    Back to top Generated by DocFX