Struct heron_core::PhysicsTime

pub struct PhysicsTime { /* private fields */ }

Resource that controls the physics time scale

Example

fn main() {
    App::new()
        // ... Add plugins
        .insert_resource(PhysicsTime::new(0.5))
        // ... Add systems
        .run();
}

Implementations

impl PhysicsTime

pub fn new(scale: f32) -> Self

Create a new physics time for the given scale (which must be >= 0).

Panics

Panic if the scale is negative.

pub fn pause(&mut self)

Pause the physics emulation, avoiding heron systems to run.

pub fn resume(&mut self)

Resume the physics emulation

pub fn set_scale(&mut self, scale: f32)

Set the physics emulation time scale (must be positive)

Panics

Panic if the scale is negative

pub fn scale(&self) -> f32

Get the physics emulation time scale

pub fn get_scale(&self) -> f32

👎 Deprecated:

Please use ‘scale()’ instead

Get the physics emulation time scale

Trait Implementations

impl Clone for PhysicsTime

fn clone(&self) -> PhysicsTime

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PhysicsTime

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

Formats the value using the given formatter.

impl Default for PhysicsTime

fn default() -> Self

Returns the “default value” for a type.

impl Copy for PhysicsTime