Implement pausing

Author: benfrankel

src/animation.rs

@@ -3,10 +3,29 @@ pub mod offset;
 pub mod transition;
 
 use bevy::prelude::*;
-use bevy_tweening::TweeningPlugin;
+use bevy_tweening::*;
+use pyri_state::prelude::*;
+
+use crate::core::pause::Pause;
 
 pub(super) fn plugin(app: &mut App) {
     app.add_plugins(TweeningPlugin);
+    app.add_systems(
+        StateFlush,
+        Pause.on_edge(unpause_tweens::<Sprite>, pause_tweens::<Sprite>),
+    );
 
     app.add_plugins((backup::plugin, offset::plugin, transition::plugin));
 }
+
+fn unpause_tweens<C: Component>(mut tween_query: Query<&mut Animator<C>>) {
+    for mut tween in &mut tween_query {
+        tween.state = AnimatorState::Playing;
+    }
+}
+
+fn pause_tweens<C: Component>(mut tween_query: Query<&mut Animator<C>>) {
+    for mut tween in &mut tween_query {
+        tween.state = AnimatorState::Paused;
+    }
+}

src/core.rs

@@ -5,6 +5,7 @@ pub mod audio;
 pub mod camera;
 #[cfg(feature = "dev")]
 pub mod debug;
+pub mod pause;
 pub mod physics;
 pub mod state;
 pub mod theme;
@@ -38,11 +39,13 @@ pub(super) fn plugin(app: &mut App) {
         camera::plugin,
         #[cfg(feature = "dev")]
         debug::plugin,
-        theme::plugin,
+        pause::plugin,
         physics::plugin,
+        theme::plugin,
     ));
 }
 
+// TODO: This would fit better in `game.rs`.
 /// Game logic system ordering in the [`Update`] schedule.
 #[derive(SystemSet, Clone, Eq, PartialEq, Hash, Debug)]
 pub enum UpdateSet {
@@ -89,6 +92,7 @@ impl Configure for UpdateSet {
     }
 }
 
+// TODO: This would fit better in `animation.rs`.
 /// [`Transform`] post-processing system ordering in the [`PostUpdate`] schedule.
 #[derive(SystemSet, Clone, Eq, PartialEq, Hash, Debug)]
 pub enum PostTransformSet {
@@ -120,6 +124,7 @@ impl Configure for PostTransformSet {
     }
 }
 
+// TODO: This would fit better in `animation.rs`.
 /// [`Color`] post-processing system ordering in the [`PostUpdate`] schedule.
 #[derive(SystemSet, Clone, Eq, PartialEq, Hash, Debug)]
 pub enum PostColorSet {

src/core/camera.rs

@@ -1,9 +1,11 @@
 use bevy::core_pipeline::tonemapping::Tonemapping;
 use bevy::prelude::*;
 use bevy::render::camera::ScalingMode;
+use pyri_state::prelude::*;
 use serde::Deserialize;
 use serde::Serialize;
 
+use crate::core::pause::Pause;
 use crate::core::UpdateSet;
 use crate::util::prelude::*;
 
@@ -86,7 +88,7 @@ pub struct SmoothFollow {
 impl Configure for SmoothFollow {
     fn configure(app: &mut App) {
         app.register_type::<Self>();
-        app.add_systems(Update, apply_smooth_follow);
+        app.add_systems(Update, apply_smooth_follow.run_if(Pause::is_disabled));
     }
 }
 

src/core/pause.rs

@@ -0,0 +1,19 @@
+use bevy::prelude::*;
+use pyri_state::prelude::*;
+
+use crate::util::prelude::*;
+
+pub(super) fn plugin(app: &mut App) {
+    app.configure::<Pause>();
+}
+
+#[derive(State, Eq, PartialEq, Clone, Reflect, Default)]
+#[reflect(Resource)]
+pub struct Pause;
+
+impl Configure for Pause {
+    fn configure(app: &mut App) {
+        app.register_type::<Self>();
+        app.add_state::<Self>();
+    }
+}

src/core/physics.rs

@@ -1,9 +1,22 @@
 use avian2d::prelude::*;
 use bevy::prelude::*;
+use pyri_state::prelude::*;
+
+use crate::core::pause::Pause;
 
 pub(super) fn plugin(app: &mut App) {
     app.add_plugins(PhysicsPlugins::default().with_length_unit(PIXELS_PER_METER));
     app.insert_resource(Gravity::ZERO);
+
+    app.add_systems(StateFlush, Pause.on_edge(unpause_physics, pause_physics));
 }
 
 const PIXELS_PER_METER: f32 = 16.0;
+
+fn pause_physics(mut physics_time: ResMut<Time<Physics>>) {
+    physics_time.pause();
+}
+
+fn unpause_physics(mut physics_time: ResMut<Time<Physics>>) {
+    physics_time.unpause();
+}

src/game/actor/attack/input.rs

@@ -1,6 +1,8 @@
 use bevy::prelude::*;
 use leafwing_input_manager::prelude::*;
+use pyri_state::prelude::*;
 
+use crate::core::pause::Pause;
 use crate::core::UpdateSet;
 use crate::game::actor::attack::AttackController;
 use crate::util::prelude::*;
@@ -18,7 +20,12 @@ enum AttackAction {
 impl Configure for AttackAction {
     fn configure(app: &mut App) {
         app.add_plugins(InputManagerPlugin::<Self>::default());
-        app.add_systems(Update, record_attack_action.in_set(UpdateSet::RecordInput));
+        app.add_systems(
+            Update,
+            record_attack_action
+                .in_set(UpdateSet::RecordInput)
+                .run_if(Pause::is_disabled),
+        );
     }
 }
 

src/game/actor/facing.rs

@@ -1,8 +1,10 @@
 use bevy::ecs::system::EntityCommand;
 use bevy::prelude::*;
+use pyri_state::prelude::*;
 
 use crate::animation::backup::Backup;
 use crate::core::camera::CameraRoot;
+use crate::core::pause::Pause;
 use crate::core::theme::ThemeColor;
 use crate::core::window::WindowRoot;
 use crate::core::PostTransformSet;
@@ -47,7 +49,12 @@ pub struct FacePlayer;
 impl Configure for FacePlayer {
     fn configure(app: &mut App) {
         app.register_type::<Self>();
-        app.add_systems(Update, face_player.in_set(UpdateSet::SyncEarly));
+        app.add_systems(
+            Update,
+            face_player
+                .in_set(UpdateSet::SyncEarly)
+                .run_if(Pause::is_disabled),
+        );
     }
 }
 
@@ -70,7 +77,12 @@ pub struct FaceCursor;
 impl Configure for FaceCursor {
     fn configure(app: &mut App) {
         app.register_type::<Self>();
-        app.add_systems(Update, face_cursor.in_set(UpdateSet::SyncEarly));
+        app.add_systems(
+            Update,
+            face_cursor
+                .in_set(UpdateSet::SyncEarly)
+                .run_if(Pause::is_disabled),
+        );
     }
 }
 

src/game/actor/movement/input.rs

@@ -1,6 +1,8 @@
 use bevy::prelude::*;
 use leafwing_input_manager::prelude::*;
+use pyri_state::prelude::*;
 
+use crate::core::pause::Pause;
 use crate::core::UpdateSet;
 use crate::game::actor::movement::MovementController;
 use crate::util::prelude::*;
@@ -19,7 +21,9 @@ impl Configure for MovementAction {
         app.add_plugins(InputManagerPlugin::<Self>::default());
         app.add_systems(
             Update,
-            record_movement_action.in_set(UpdateSet::RecordInput),
+            record_movement_action
+                .in_set(UpdateSet::RecordInput)
+                .run_if(Pause::is_disabled),
         );
     }
 }

src/game/cleanup.rs

@@ -1,8 +1,10 @@
 use std::marker::PhantomData;
 
 use bevy::prelude::*;
+use pyri_state::prelude::*;
 
 use crate::core::camera::CameraRoot;
+use crate::core::pause::Pause;
 use crate::core::PostTransformSet;
 use crate::core::UpdateSet;
 use crate::game::combat::hit::OnHit;
@@ -20,11 +22,11 @@ pub struct DespawnOnHit;
 impl Configure for DespawnOnHit {
     fn configure(app: &mut App) {
         app.register_type::<Self>();
-        app.observe(despawn_on_hit);
+        app.observe(apply_despawn_on_hit);
     }
 }
 
-fn despawn_on_hit(
+fn apply_despawn_on_hit(
     trigger: Trigger<OnHit>,
     mut despawn: ResMut<LateDespawn>,
     despawn_query: Query<(), With<DespawnOnHit>>,
@@ -80,12 +82,14 @@ impl Configure for DespawnOnBeat {
         app.register_type::<Self>();
         app.add_systems(
             Update,
-            despawn_on_beat.in_set(UpdateSet::Update).run_if(on_beat(1)),
+            apply_despawn_on_beat
+                .in_set(UpdateSet::Update)
+                .run_if(on_beat(1)),
         );
     }
 }
 
-fn despawn_on_beat(
+fn apply_despawn_on_beat(
     mut despawn: ResMut<LateDespawn>,
     mut despawn_query: Query<(Entity, &mut DespawnOnBeat)>,
 ) {
@@ -104,17 +108,44 @@ pub struct DespawnOnTimer(pub Timer);
 impl Configure for DespawnOnTimer {
     fn configure(app: &mut App) {
         app.register_type::<Self>();
-        app.add_systems(Update, despawn_on_timer.in_set(UpdateSet::Update));
+        app.add_systems(
+            StateFlush,
+            Pause.on_edge(unpause_despawn_on_timer, pause_despawn_on_timer),
+        );
+        app.add_systems(
+            Update,
+            (
+                tick_despawn_on_timer.in_set(UpdateSet::TickTimers),
+                apply_despawn_on_timer.in_set(UpdateSet::Update),
+            ),
+        );
     }
 }
 
-fn despawn_on_timer(
-    time: Res<Time>,
+fn unpause_despawn_on_timer(mut timer_query: Query<&mut DespawnOnTimer>) {
+    for mut timer in &mut timer_query {
+        timer.0.unpause();
+    }
+}
+
+fn pause_despawn_on_timer(mut timer_query: Query<&mut DespawnOnTimer>) {
+    for mut timer in &mut timer_query {
+        timer.0.pause();
+    }
+}
+
+fn tick_despawn_on_timer(time: Res<Time>, mut timer_query: Query<&mut DespawnOnTimer>) {
+    for mut timer in &mut timer_query {
+        timer.0.tick(time.delta());
+    }
+}
+
+fn apply_despawn_on_timer(
     mut despawn: ResMut<LateDespawn>,
-    mut despawn_query: Query<(Entity, &mut DespawnOnTimer)>,
+    timer_query: Query<(Entity, &DespawnOnTimer)>,
 ) {
-    for (entity, mut timer) in &mut despawn_query {
-        if timer.0.tick(time.delta()).finished() {
+    for (entity, timer) in &timer_query {
+        if timer.0.finished() {
             despawn.recursive(entity);
         }
     }
@@ -131,7 +162,17 @@ pub struct RemoveOnTimer<C: Component + TypePath> {
 impl<C: Component + TypePath> Configure for RemoveOnTimer<C> {
     fn configure(app: &mut App) {
         app.register_type::<Self>();
-        app.add_systems(Update, remove_on_timer::<C>.in_set(UpdateSet::SyncLate));
+        app.add_systems(
+            StateFlush,
+            Pause.on_edge(unpause_remove_on_timer::<C>, pause_remove_on_timer::<C>),
+        );
+        app.add_systems(
+            Update,
+            (
+                tick_remove_on_timer::<C>.in_set(UpdateSet::TickTimers),
+                apply_remove_on_timer::<C>.in_set(UpdateSet::SyncLate),
+            ),
+        );
     }
 }
 
@@ -149,13 +190,33 @@ impl<C: Component + TypePath> RemoveOnTimer<C> {
     }
 }
 
-fn remove_on_timer<C: Component + TypePath>(
-    mut commands: Commands,
-    mut remove_query: Query<(Entity, &mut RemoveOnTimer<C>)>,
+fn tick_remove_on_timer<C: Component + TypePath>(
     time: Res<Time>,
+    mut timer_query: Query<&mut RemoveOnTimer<C>>,
 ) {
-    for (entity, mut remove) in &mut remove_query {
-        if remove.timer.tick(time.delta()).finished() {
+    for mut timer in &mut timer_query {
+        timer.timer.tick(time.delta());
+    }
+}
+
+fn unpause_remove_on_timer<C: Component + TypePath>(mut timer_query: Query<&mut RemoveOnTimer<C>>) {
+    for mut timer in &mut timer_query {
+        timer.timer.unpause();
+    }
+}
+
+fn pause_remove_on_timer<C: Component + TypePath>(mut timer_query: Query<&mut RemoveOnTimer<C>>) {
+    for mut timer in &mut timer_query {
+        timer.timer.pause();
+    }
+}
+
+fn apply_remove_on_timer<C: Component + TypePath>(
+    mut commands: Commands,
+    timer_query: Query<(Entity, &RemoveOnTimer<C>)>,
+) {
+    for (entity, timer) in &timer_query {
+        if timer.timer.finished() {
             commands.entity(entity).remove::<(C, RemoveOnTimer<C>)>();
         }
     }
@@ -174,7 +235,7 @@ impl<C: Component + TypePath> Configure for RemoveOnBeat<C> {
         app.register_type::<Self>();
         app.add_systems(
             Update,
-            remove_on_beat::<C>
+            apply_remove_on_beat::<C>
                 .in_set(UpdateSet::SyncLate)
                 .run_if(on_beat(1)),
         );
@@ -194,7 +255,7 @@ impl<C: Component + TypePath> RemoveOnBeat<C> {
     }
 }
 
-fn remove_on_beat<C: Component + TypePath>(
+fn apply_remove_on_beat<C: Component + TypePath>(
     mut commands: Commands,
     mut remove_query: Query<(Entity, &mut RemoveOnBeat<C>)>,
 ) {