Class Ticker | Package Manager UI website
docs.unity3d.com
    Show / Hide Table of Contents

    Class Ticker

    Inheritance
    System.Object
    Ticker
    Namespace: Unity.UIWidgets.scheduler
    Syntax
    public class Ticker

    Constructors

    Ticker(TickerCallback, Func<String>)

    Declaration
    public Ticker(TickerCallback onTick, Func<string> debugLabel = null)
    Parameters
    Type Name Description
    TickerCallback onTick
    System.Func<System.String> debugLabel

    Properties

    isActive

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

    isTicking

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

    muted

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

    scheduled

    Declaration
    protected bool scheduled { get; }
    Property Value
    Type Description
    System.Boolean

    shouldScheduleTick

    Declaration
    protected bool shouldScheduleTick { get; }
    Property Value
    Type Description
    System.Boolean

    Methods

    absorbTicker(Ticker)

    Declaration
    public void absorbTicker(Ticker originalTicker)
    Parameters
    Type Name Description
    Ticker originalTicker

    dispose()

    Declaration
    public virtual void dispose()

    scheduleTick(Boolean)

    Declaration
    protected void scheduleTick(bool rescheduling = false)
    Parameters
    Type Name Description
    System.Boolean rescheduling

    start()

    Declaration
    public TickerFuture start()
    Returns
    Type Description
    TickerFuture

    stop(Boolean)

    Declaration
    public void stop(bool canceled = false)
    Parameters
    Type Name Description
    System.Boolean canceled

    ToString()

    Declaration
    public override string ToString()
    Returns
    Type Description
    System.String
    Overrides
    System.Object.ToString()

    toString(Boolean)

    Declaration
    public string toString(bool debugIncludeStack = false)
    Parameters
    Type Name Description
    System.Boolean debugIncludeStack
    Returns
    Type Description
    System.String

    unscheduleTick()

    Declaration
    protected void unscheduleTick()
    Back to top
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023