Class FixedRateUtils | Entities | 0.10.0-preview.6
docs.unity3d.com
    Show / Hide Table of Contents

    Class FixedRateUtils

    Inheritance
    Object
    FixedRateUtils
    Namespace: Unity.Entities
    Syntax
    public static class FixedRateUtils

    Methods

    DisableFixedRate(ComponentSystemGroup)

    Disable fixed rate updates on the given group, by setting the UpdateCallback to null.

    Declaration
    public static void DisableFixedRate(ComponentSystemGroup group)
    Parameters
    Type Name Description
    ComponentSystemGroup group

    The group whose UpdateCallback to set to null.

    EnableFixedRateSimple(ComponentSystemGroup, Single)

    Configure the given ComponentSystemGroup to update at a fixed timestep, given by timeStep. The group will always be ticked exactly once, and the time will be the given timeStep since the last time it was ticked. This clock will drift from actual elapsed wall clock time.

    Declaration
    public static void EnableFixedRateSimple(ComponentSystemGroup group, float timeStep)
    Parameters
    Type Name Description
    ComponentSystemGroup group

    The group whose UpdateCallback will be configured with a fixed time step update call

    Single timeStep

    The fixed time step (in seconds)

    EnableFixedRateWithCatchUp(ComponentSystemGroup, Single)

    Configure the given ComponentSystemGroup to update at a fixed timestep, given by timeStep. If the interval between the current time and the last update is bigger than the timestep, the group's systems will be updated more than once.

    Declaration
    public static void EnableFixedRateWithCatchUp(ComponentSystemGroup group, float timeStep)
    Parameters
    Type Name Description
    ComponentSystemGroup group

    The group whose UpdateCallback will be configured with a fixed time step update call

    Single timeStep

    The fixed time step (in seconds)

    In This Article
    • Methods
      • DisableFixedRate(ComponentSystemGroup)
      • EnableFixedRateSimple(ComponentSystemGroup, Single)
      • EnableFixedRateWithCatchUp(ComponentSystemGroup, Single)
    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