Struct StepTimer 

pub struct StepTimer { /* private fields */ }

Countdown/up timer over plain seconds, ticked once per fixed step.

Implementations

impl StepTimer

pub fn from_seconds(dur: f32, mode: TimerMode) -> Self

pub fn disarmed() -> Self

Disarmed timer (finished from birth).

pub fn tick(&mut self, dt: f32)

Advance by dt (read just_finished() / finished() afterwards; a finished Once never re-fires, so a repeat comes from re-arming).

pub fn just_finished(&self) -> bool

True only on the step the timer completed (cleared next step).

pub fn finished(&self) -> bool

Latching finished state (stays true for Once).

pub fn is_finished(&self) -> bool

Alias for call sites that read is_finished.

pub fn duration(&self) -> f32

pub fn elapsed_secs(&self) -> f32

pub fn remaining_secs(&self) -> f32

pub fn fraction(&self) -> f32

0..1 progress (1.0 for zero-duration timers).

pub fn remaining(&self) -> f32

Remaining seconds for countdown users.

pub fn reset(&mut self)

Re-arm to full duration.

pub fn set_duration(&mut self, dur: f32)

Re-arm with a new duration (elapsed preserved).

Trait Implementations

impl Clone for StepTimer

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Component for StepTimer

where Self: Send + Sync + 'static,

const STORAGE_TYPE: StorageType = bevy_ecs::component::StorageType::Table

A constant indicating the storage type used for this component.

type Mutability = Mutable

A marker type to assist Bevy with determining if this component is mutable, or immutable. Mutable components will have Component<Mutability = Mutable>, while immutable components will instead have Component<Mutability = Immutable>.

fn register_required_components( _requiree: ComponentId, required_components: &mut RequiredComponentsRegistrator<'_, '_>, )

Registers required components.

fn clone_behavior() -> ComponentCloneBehavior

Called when registering this component, allowing to override clone function (or disable cloning altogether) for this component.

fn relationship_accessor() -> Option<ComponentRelationshipAccessor<Self>>

Returns ComponentRelationshipAccessor required for working with relationships in dynamic contexts.

fn on_add() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_add ComponentHook for this Component if one is defined.

fn on_insert() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_insert ComponentHook for this Component if one is defined.

fn on_discard() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_discard ComponentHook for this Component if one is defined.

fn on_remove() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_remove ComponentHook for this Component if one is defined.

fn on_despawn() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_despawn ComponentHook for this Component if one is defined.

fn map_entities<E>(_this: &mut Self, _mapper: &mut E)

where E: EntityMapper,

Maps the entities on this component using the given EntityMapper. This is used to remap entities in contexts like scenes and entity cloning. When deriving Component, this is populated by annotating fields containing entities with #[entities]

const HAS_SUMMARY_TICK: bool = false

Set this constant to true if the component should track a summary tick.

impl Copy for StepTimer

impl Debug for StepTimer

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

Formats the value using the given formatter.

impl Default for StepTimer

fn default() -> Self

Disarmed (finished from birth): the “no timer” state.

impl<'de> Deserialize<'de> for StepTimer

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for StepTimer

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for StepTimer

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for StepTimer