Struct CompiledTriggers

pub struct CompiledTriggers<Event: TriggerEvent> { /* private fields */ }

A compiled collection of triggers.

This is the central type for using the event trigger action system. Execute events via Self::execute_event, Self::execute_events and Self::execute_owned_events, and collect actions via Self::consume_action and Self::consume_all_actions.

Implementations

impl<Event: TriggerEvent> CompiledTriggers<Event>

pub fn execute_event(&mut self, event: &Event)

Execute the given event.

The event is executed right away, and all resulting actions are stored in an internal action queue, waiting to be retrieved via Self::consume_action or Self::consume_all_actions.

pub fn execute_events<'events>( &mut self, events: impl IntoIterator<Item = &'events Event>, )

where Event: 'events,

Execute the given events.

The event is executed right away, and all resulting actions are stored in an internal action queue, waiting to be retrieved via Self::consume_action or Self::consume_all_actions.

pub fn execute_owned_events(&mut self, events: impl IntoIterator<Item = Event>)

Execute the given owned events.

The event is executed right away, and all resulting actions are stored in an internal action queue, waiting to be retrieved via Self::consume_action or Self::consume_all_actions.

This method is no different from Self::execute_events, except that it drops the given events after execution.

pub fn consume_action(&mut self) -> Option<Event::Action>

Consume an action from the action queue, if there is one.

pub fn consume_all_actions( &mut self, ) -> impl '_ + Iterator<Item = Event::Action>

Consume all action from the action queue.

If the returned iterator is dropped before all actions are consumed, the remaining actions are dropped quietly.

pub fn progress(&self, handle: TriggerHandle) -> Option<(f64, f64)>

Returns the progress of the given trigger as (current_progress, required_progress).

When current_progress reaches required_progress, then the trigger triggers.

Trait Implementations

impl<Event: Clone + TriggerEvent> Clone for CompiledTriggers<Event>

where Event::Action: Clone,

fn clone(&self) -> CompiledTriggers<Event>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Event: Debug + TriggerEvent> Debug for CompiledTriggers<Event>

where Event::Action: Debug,

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

Formats the value using the given formatter.