Struct StateMachine 

pub struct StateMachine { /* private fields */ }

State machine component.

Entities with this component will have components (the states) added and removed based on the transitions that you add. Build one with StateMachine::default, StateMachine::trans, and other methods.

Implementations

impl StateMachine

pub fn with_state<S: Clone + Component>(self) -> Self

Registers a state. This is only necessary for states that are not used in any transitions.

pub fn trans<S: EntityState, Marker>( self, trigger: impl IntoTrigger<Marker>, state: impl Clone + Component, ) -> Self

Adds a transition to the state machine. When the entity is in the state given as a type parameter, and the given trigger occurs, it will transition to the state given as a function parameter. Elide the Marker type parameter with _. Transitions have priority in the order they are added.

pub fn trans_builder<Prev: EntityState, Trig: IntoTrigger<TrigMarker>, Next: Clone + Component, TrigMarker, BuildMarker>( self, trigger: Trig, builder: impl IntoSystem<Trans<Prev, <<Trig::Trigger as EntityTrigger>::Out as TriggerOut>::Ok>, Next, BuildMarker>, ) -> Self

Adds a transition builder to the state machine. When the entity is in Prev state, and Trig occurs, the given builder will be run on Trig::Ok. If the builder returns Some(Next), the machine will transition to that Next state.

pub fn on_enter_to<Prev: EntityState, Next: EntityState>( self, on_enter: impl 'static + Fn(&mut EntityCommands<'_>) + Send + Sync, ) -> Self

Adds an on-enter event to the state machine. Whenever the state machine transitions from the given previous state to the given next state, it will run the event.

pub fn on_enter<Next: EntityState>( self, on_enter: impl 'static + Fn(&mut EntityCommands<'_>) + Send + Sync, ) -> Self

Adds an on-enter event to the state machine. Whenever the state machine transitions from any previous state to the given next state, it will run the event.

pub fn on_exit_from<Prev: EntityState, Next: EntityState>( self, on_exit: impl 'static + Fn(&mut EntityCommands<'_>) + Send + Sync, ) -> Self

Adds an on-enter event to the state machine. Whenever the state machine transitions from the given previous state to the given next state, it will run the event.

pub fn on_exit<Prev: EntityState>( self, on_exit: impl 'static + Fn(&mut EntityCommands<'_>) + Send + Sync, ) -> Self

Adds an on-exit event to the state machine. Whenever the state machine transitions from the given previous state to any next state, it will run the event.

pub fn command_on_enter_to<Prev: EntityState, Next: EntityState>( self, command: impl Clone + Command + Sync, ) -> Self

Adds an on-enter command to the state machine. Whenever the state machine transitions from the given previous state to the given next state, it will run the command.

pub fn command_on_enter<Next: EntityState>( self, command: impl Clone + Command + Sync, ) -> Self

Adds an on-enter command to the state machine. Whenever the state machine transitions from any previous state to the given next state, it will run the command.

pub fn command_on_exit_from<Prev: EntityState, Next: EntityState>( self, command: impl Clone + Command + Sync, ) -> Self

Adds an on-exit command to the state machine. Whenever the state machine transitions from the given previous state to the given next state, it will run the command.

pub fn command_on_exit<Prev: EntityState>( self, command: impl Clone + Command + Sync, ) -> Self

Adds an on-exit command to the state machine. Whenever the state machine transitions from the given previous state to any next state, it will run the command.

pub fn set_trans_logging(self, log_transitions: bool) -> Self

Sets whether transitions are logged to the console

Trait Implementations

impl Component for StateMachine

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 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_replace() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_replace 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]

impl Default for StateMachine

fn default() -> Self

Returns the “default value” for a type.