pub enum PauseMenuState {
Playing,
Paused,
Settings,
}Expand description
Bevy state enum that drives the pause menu lifecycle.
PauseMenuPlugin registers this as a Bevy State and transitions between
variants automatically. Your own systems should use run_if(in_state(…))
to participate in the pause flow.
§Variant transitions
| From | Trigger | To |
|---|---|---|
Playing | Escape key | Paused |
Paused | Resume button or Escape | Playing |
Paused | Settings button | Settings |
Settings | Back button | Paused |
§Gating gameplay systems
App::new()
.add_systems(Update,
my_gameplay_system.run_if(in_state(PauseMenuState::Playing)),
);Variants§
Playing
The game is running normally. Player input is active and the pause menu is not visible. This is the default starting state.
Paused
The game is paused. The pause menu overlay is displayed and gameplay
systems gated on Playing are inactive. The cursor is free.
Settings
The settings submenu is open. The pause menu overlay is replaced by the settings panel. FOV and SFX volume can be adjusted here.
Trait Implementations§
Source§impl Clone for PauseMenuState
impl Clone for PauseMenuState
Source§fn clone(&self) -> PauseMenuState
fn clone(&self) -> PauseMenuState
Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source. Read moreSource§impl Debug for PauseMenuState
impl Debug for PauseMenuState
Source§impl Default for PauseMenuState
impl Default for PauseMenuState
Source§fn default() -> PauseMenuState
fn default() -> PauseMenuState
Returns the “default value” for a type. Read more
impl Eq for PauseMenuState
Source§impl FreelyMutableState for PauseMenuState
impl FreelyMutableState for PauseMenuState
Source§fn register_state(schedule: &mut Schedule)
fn register_state(schedule: &mut Schedule)
This function registers all the necessary systems to apply state changes and run transition schedules
Source§impl Hash for PauseMenuState
impl Hash for PauseMenuState
Source§impl PartialEq for PauseMenuState
impl PartialEq for PauseMenuState
Source§impl States for PauseMenuState
impl States for PauseMenuState
Source§const DEPENDENCY_DEPTH: usize = 1
const DEPENDENCY_DEPTH: usize = 1
How many other states this state depends on.
Used to help order transitions and de-duplicate
ComputedStates, as well as prevent cyclical
ComputedState dependencies.impl StructuralPartialEq for PauseMenuState
Auto Trait Implementations§
impl Freeze for PauseMenuState
impl RefUnwindSafe for PauseMenuState
impl Send for PauseMenuState
impl Sync for PauseMenuState
impl Unpin for PauseMenuState
impl UnsafeUnpin for PauseMenuState
impl UnwindSafe for PauseMenuState
Blanket Implementations§
Source§impl<T, U> AsBindGroupShaderType<U> for T
impl<T, U> AsBindGroupShaderType<U> for T
Source§fn as_bind_group_shader_type(&self, _images: &RenderAssets<GpuImage>) -> U
fn as_bind_group_shader_type(&self, _images: &RenderAssets<GpuImage>) -> U
Return the
T ShaderType for self. When used in AsBindGroup
derives, it is safe to assume that all images in self exist.Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> ConditionalSend for Twhere
T: Send,
Source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
Source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Converts
Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>, which can then be
downcast into Box<dyn ConcreteType> where ConcreteType implements Trait.Source§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Converts
Rc<Trait> (where Trait: Downcast) to Rc<Any>, which can then be further
downcast into Rc<ConcreteType> where ConcreteType implements Trait.Source§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
Converts
&Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &Any’s vtable from &Trait’s.Source§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
Converts
&mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &mut Any’s vtable from &mut Trait’s.Source§impl<T> DowncastSend for T
impl<T> DowncastSend for T
impl<S, T> Duplex<S> for Twhere
T: FromSample<S> + ToSample<S>,
Source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
Source§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
Compare self to
key and return true if they are equal.Source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
Source§impl<S> FromSample<S> for S
impl<S> FromSample<S> for S
fn from_sample_(s: S) -> S
Source§impl<T> FromWorld for Twhere
T: Default,
impl<T> FromWorld for Twhere
T: Default,
Source§fn from_world(_world: &mut World) -> T
fn from_world(_world: &mut World) -> T
Creates Self using default().
Source§impl<T, W> HasTypeWitness<W> for Twhere
W: MakeTypeWitness<Arg = T>,
T: ?Sized,
impl<T, W> HasTypeWitness<W> for Twhere
W: MakeTypeWitness<Arg = T>,
T: ?Sized,
Source§impl<T> Identity for Twhere
T: ?Sized,
impl<T> Identity for Twhere
T: ?Sized,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
Source§fn in_current_span(self) -> Instrumented<Self> ⓘ
fn in_current_span(self) -> Instrumented<Self> ⓘ
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
Converts
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
Converts
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> IntoResult<T> for T
impl<T> IntoResult<T> for T
Source§fn into_result(self) -> Result<T, RunSystemError>
fn into_result(self) -> Result<T, RunSystemError>
Converts this type into the system output type.
impl<T> Settings for T
Source§impl<S> StateSet for Swhere
S: InnerStateSet,
impl<S> StateSet for Swhere
S: InnerStateSet,
Source§const SET_DEPENDENCY_DEPTH: usize = S::DEPENDENCY_DEPTH
const SET_DEPENDENCY_DEPTH: usize = S::DEPENDENCY_DEPTH
The total
DEPENDENCY_DEPTH of all
the states that are part of this StateSet, added together. Read moreSource§fn register_computed_state_systems_in_schedule<T>(schedule: &mut Schedule)where
T: ComputedStates<SourceStates = S>,
fn register_computed_state_systems_in_schedule<T>(schedule: &mut Schedule)where
T: ComputedStates<SourceStates = S>,
Sets up the systems needed to compute
T whenever any State in this
StateSet is changed.Source§fn register_sub_state_systems_in_schedule<T>(schedule: &mut Schedule)where
T: SubStates<SourceStates = S>,
fn register_sub_state_systems_in_schedule<T>(schedule: &mut Schedule)where
T: SubStates<SourceStates = S>,
Sets up the systems needed to compute whether
T exists whenever any State in this
StateSet is changed.Source§impl<T, U> ToSample<U> for Twhere
U: FromSample<T>,
impl<T, U> ToSample<U> for Twhere
U: FromSample<T>,
fn to_sample_(self) -> U
Source§impl<T> TypeData for T
impl<T> TypeData for T
Source§fn clone_type_data(&self) -> Box<dyn TypeData>
fn clone_type_data(&self) -> Box<dyn TypeData>
Creates a type-erased clone of this value.