Enum TnuaActionLifecycleDirective

pub enum TnuaActionLifecycleDirective {
    StillActive,
    Finished,
    Reschedule {
        after_seconds: Float,
    },
}

A decision by TnuaAction::apply that determines if the action should be continued or not.

Note that an action may continue (probably with different state) after no longer being fed, or stopped while still being fed. It’s up to the action, and it should be responsible with it.

Variants

StillActive

The action should continue in the next frame.

Finished

The action should not continue in the next frame.

If another action is pending, it will run in this frame. This means that two actions can run in the same frame, as long as the first is finished (or rescheduled)

If TnuaAction::apply returns this but the action is still being fed, it will not run again unless it stops being fed for one frame and then gets fed again. If this is not the desired behavior, TnuaActionLifecycleDirective::Reschedule should be used instead.

Reschedule

The action should not continue in the next frame, but if its still being fed it run again later. The rescheduled action will be considered a new action.

If another action is pending, it will run in this frame. This means that two actions can run in the same frame, as long as the first is rescheduled (or finished)

Fields

after_seconds: Float

Only reschedule the action after this much time has passed.

Trait Implementations

impl Clone for TnuaActionLifecycleDirective

fn clone(&self) -> TnuaActionLifecycleDirective

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TnuaActionLifecycleDirective

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

Formats the value using the given formatter.

impl PartialEq for TnuaActionLifecycleDirective

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Copy for TnuaActionLifecycleDirective

impl StructuralPartialEq for TnuaActionLifecycleDirective