Trait bevy_sequential_actions::ModifyActions

source · 
pub trait ModifyActions {

Show 13 methods    // Required methods
    fn start(&mut self, start: bool) -> &mut Self;
    fn order(&mut self, order: AddOrder) -> &mut Self;
    fn repeat(&mut self, repeat: Repeat) -> &mut Self;
    fn add(&mut self, action: impl Into<Box<dyn Action>>) -> &mut Self;
    fn add_sequence(
        &mut self,
        actions: impl DoubleEndedIterator<Item = Box<dyn Action>> + Send + Sync + 'static
    ) -> &mut Self;
    fn add_parallel(
        &mut self,
        actions: impl Iterator<Item = Box<dyn Action>> + Send + Sync + 'static
    ) -> &mut Self;
    fn add_linked(
        &mut self,
        f: impl FnOnce(&mut LinkedActionsBuilder) + Send + Sync + 'static
    ) -> &mut Self;
    fn execute(&mut self) -> &mut Self;
    fn next(&mut self) -> &mut Self;
    fn cancel(&mut self) -> &mut Self;
    fn pause(&mut self) -> &mut Self;
    fn skip(&mut self) -> &mut Self;
    fn clear(&mut self) -> &mut Self;

}
Expand description

Methods for modifying actions.

Required Methods§

source

fn start(&mut self, start: bool) -> &mut Self

Specify if the next action in the queue should start when new actions are added. The next action will only start if nothing is currently running. Default is true.

source

fn order(&mut self, order: AddOrder) -> &mut Self

Specify the queue order for actions to be added. Default is AddOrder::Back.

source

fn repeat(&mut self, repeat: Repeat) -> &mut Self

Specify the repeat configuration for actions to be added. Default is Repeat::None.

source

fn add(&mut self, action: impl Into<Box<dyn Action>>) -> &mut Self

Adds a single action to the queue.

source

fn add_sequence( &mut self, actions: impl DoubleEndedIterator<Item = Box<dyn Action>> + Send + Sync + 'static ) -> &mut Self

Adds a collection of actions to the queue that are executed sequentially, i.e. one by one.

source

fn add_parallel( &mut self, actions: impl Iterator<Item = Box<dyn Action>> + Send + Sync + 'static ) -> &mut Self

Adds a collection of actions to the queue that are executed in parallel, i.e. all at once.

source

fn add_linked( &mut self, f: impl FnOnce(&mut LinkedActionsBuilder) + Send + Sync + 'static ) -> &mut Self

Adds a collection of linked actions to the queue that are executed sequentially. Linked actions have the property that if any of them are canceled, then the remaining actions in the collection are ignored.

source

fn execute(&mut self) -> &mut Self

Starts the next action in the queue, but only if there is no action currently running.

source

fn next(&mut self) -> &mut Self

Starts the next action in the queue. Current action is stopped as canceled.

source

fn cancel(&mut self) -> &mut Self

Stops the current action as canceled. To resume the action queue, call next.

source

fn pause(&mut self) -> &mut Self

Stops the current action as paused. To resume the action queue, call next.

source

fn skip(&mut self) -> &mut Self

Skips the next action in the queue.

source

fn clear(&mut self) -> &mut Self

Clears the action queue. Current action is stopped as canceled.

Implementors§