Class FixedRateUtils
Namespace: Unity.Entities
Syntax
public static class FixedRateUtilsMethods
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 specific fixed rate, using the provided timestep. The group will always be ticked exactly once, and the delta time during that update will be the given timestep. The group's elapsed time 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 timestep update call |
| Single | timestep | The duration of each fixed timestep (in seconds). The timestep valuewill be clamped to the range [0.0001f ... 10.0f]. |
EnableFixedRateWithCatchUp(ComponentSystemGroup, Single)
Configure the given ComponentSystemGroup to update at a specific fixed rate, using the provided 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 timestep update call |
| Single | timestep | The duration of each fixed timestep (in seconds). The timestep value will be clamped to the range [0.0001f ... 10.0f]. |