Enum avian3d::schedule::TimestepMode

pub enum TimestepMode {
    Fixed {
        delta: Duration,
        overstep: Duration,
        max_delta_overstep: Duration,
    },
    FixedOnce {
        delta: Duration,
    },
    Variable {
        max_delta: Duration,
    },
}

The type of timestep used for the Time<Physics> clock.

Variants

Fixed

Fixed timestep: The physics simulation will be advanced by a fixed delta amount of time every frame until the accumulated overstep value has been consumed. This means that physics can run 0, 1, 2 or more times per frame based on how long the previous frames took.

To avoid “death spirals” where each frame takes longer and longer to simulate, overstep can only be advanced by max_delta_overstep during a single frame.

A fixed timestep allows consistent behavior across different machines and frame rates.

Fields

delta: Duration

The amount of time that the simulation should be advanced by during a step.

overstep: Duration

The amount of accumulated time. The simulation will consume it in steps of delta to try to catch up to real time.

max_delta_overstep: Duration

The maximum amount of time that can be added to overstep during a single frame. Lower values help prevent “death spirals” where each frame takes longer and longer to simulate.

Defaults to 1.0 / 60.0 seconds (60 Hz).

FixedOnce

Fixed delta, once per frame: The physics simulation will be advanced by a fixed delta amount of time once per frame. This should only be used in cases where you can guarantee a fixed number of executions, like in FixedUpdate or on a server.

Fields

delta: Duration

The amount of time that the simulation should be advanced by during a step.

Variable

Variable timestep: The physics simulation will be advanced by Time::delta_seconds().min(max_delta) seconds at each Bevy tick. Frame rate will affect the simulation result.

Fields

max_delta: Duration

The maximum amount of time the physics simulation can be advanced at once. This makes sure that the simulation doesn’t break when the delta time is large.

A good default is 1.0 / 60.0 seconds (60 Hz).

Trait Implementations

impl Clone for TimestepMode

fn clone(&self) -> TimestepMode

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for TimestepMode

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for TimestepMode

fn default() -> Self

Returns the “default value” for a type.

impl Enum for TimestepMode

where Self: Any + Send + Sync, Duration: FromReflect + TypePath + RegisterForReflection,

fn field(&self, __name_param: &str) -> Option<&dyn Reflect>

Returns a reference to the value of the field (in the current variant) with the given name.

fn field_at(&self, __index_param: usize) -> Option<&dyn Reflect>

Returns a reference to the value of the field (in the current variant) at the given index.

fn field_mut(&mut self, __name_param: &str) -> Option<&mut dyn Reflect>

Returns a mutable reference to the value of the field (in the current variant) with the given name.

fn field_at_mut(&mut self, __index_param: usize) -> Option<&mut dyn Reflect>

Returns a mutable reference to the value of the field (in the current variant) at the given index.

fn index_of(&self, __name_param: &str) -> Option<usize>

Returns the index of the field (in the current variant) with the given name.

fn name_at(&self, __index_param: usize) -> Option<&str>

Returns the name of the field (in the current variant) with the given index.

fn iter_fields(&self) -> VariantFieldIter<'_>

Returns an iterator over the values of the current variant’s fields.

fn field_len(&self) -> usize

Returns the number of fields in the current variant.

fn variant_name(&self) -> &str

The name of the current variant.

fn variant_index(&self) -> usize

The index of the current variant.

fn variant_type(&self) -> VariantType

The type of the current variant.

fn clone_dynamic(&self) -> DynamicEnum

fn is_variant(&self, variant_type: VariantType) -> bool

Returns true if the current variant’s type matches the given one.

fn variant_path(&self) -> String

Returns the full path to the current variant.

impl FromReflect for TimestepMode

where Self: Any + Send + Sync, Duration: FromReflect + TypePath + RegisterForReflection,

fn from_reflect(__param0: &dyn Reflect) -> Option<Self>

Constructs a concrete instance of Self from a reflected value.

fn take_from_reflect( reflect: Box<dyn Reflect> ) -> Result<Self, Box<dyn Reflect>>

Attempts to downcast the given value to Self using, constructing the value using from_reflect if that fails.

impl GetTypeRegistration for TimestepMode

where Self: Any + Send + Sync, Duration: FromReflect + TypePath + RegisterForReflection,

fn get_type_registration() -> TypeRegistration

Returns the default TypeRegistration for this type.

fn register_type_dependencies(registry: &mut TypeRegistry)

Registers other types needed by this type.

impl PartialEq for TimestepMode

fn eq(&self, other: &TimestepMode) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Reflect for TimestepMode

where Self: Any + Send + Sync, Duration: FromReflect + TypePath + RegisterForReflection,

fn get_represented_type_info(&self) -> Option<&'static TypeInfo>

Returns the TypeInfo of the type represented by this value.

fn into_any(self: Box<Self>) -> Box<dyn Any>

Returns the value as a Box<dyn Any>.

fn as_any(&self) -> &dyn Any

Returns the value as a &dyn Any.

fn as_any_mut(&mut self) -> &mut dyn Any

Returns the value as a &mut dyn Any.

fn into_reflect(self: Box<Self>) -> Box<dyn Reflect>

Casts this type to a boxed reflected value.

fn as_reflect(&self) -> &dyn Reflect

Casts this type to a reflected value.

fn as_reflect_mut(&mut self) -> &mut dyn Reflect

Casts this type to a mutable reflected value.

fn clone_value(&self) -> Box<dyn Reflect>

Clones the value as a Reflect trait object.

fn set( &mut self, __value_param: Box<dyn Reflect> ) -> Result<(), Box<dyn Reflect>>

Performs a type-checked assignment of a reflected value to this value.

fn try_apply(&mut self, __value_param: &dyn Reflect) -> Result<(), ApplyError>

Tries to apply a reflected value to this value.

fn reflect_kind(&self) -> ReflectKind

Returns a zero-sized enumeration of “kinds” of type.

fn reflect_ref(&self) -> ReflectRef<'_>

Returns an immutable enumeration of “kinds” of type.

fn reflect_mut(&mut self) -> ReflectMut<'_>

Returns a mutable enumeration of “kinds” of type.

fn reflect_owned(self: Box<Self>) -> ReflectOwned

Returns an owned enumeration of “kinds” of type.

fn reflect_hash(&self) -> Option<u64>

Returns a hash of the value (which includes the type).

fn reflect_partial_eq(&self, value: &dyn Reflect) -> Option<bool>

Returns a “partial equality” comparison result.

fn debug(&self, f: &mut Formatter<'_>) -> Result

Debug formatter for the value.

fn apply(&mut self, value: &(dyn Reflect + 'static))

Applies a reflected value to this value.

fn serializable(&self) -> Option<Serializable<'_>>

Returns a serializable version of the value.

fn is_dynamic(&self) -> bool

Indicates whether or not this type is a dynamic type.

impl TypePath for TimestepMode

where Self: Any + Send + Sync,

fn type_path() -> &'static str

Returns the fully qualified path of the underlying type.

fn short_type_path() -> &'static str

Returns a short, pretty-print enabled path to the type.

fn type_ident() -> Option<&'static str>

Returns the name of the type, or None if it is anonymous.

fn crate_name() -> Option<&'static str>

Returns the name of the crate the type is in, or None if it is anonymous.

fn module_path() -> Option<&'static str>

Returns the path to the module the type is in, or None if it is anonymous.

impl Typed for TimestepMode

where Self: Any + Send + Sync, Duration: FromReflect + TypePath + RegisterForReflection,

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.

impl Copy for TimestepMode

impl StructuralPartialEq for TimestepMode