Add the ability to debug draw blastzones & update blastzone formatting

Reviewed-on: #68
Co-authored-by: Álex Román Núñez <eirexe@eirteam.moe>

src/camera/mod.rs

@@ -5,7 +5,7 @@ use bevy_ggrs::GgrsFrameTiming;
 
 use crate::{
     debug_tools::DebugSettings,
-    fighter::{manifest::FighterManifest, motion::sample_presentation_translation},
+    fighter::{manifest::FighterManifest, motion::{sample_presentation_translation_with_snap, FighterPresentationSnap}},
     stage::manifest::StageCameraProfile,
 };
 
@@ -313,6 +313,7 @@ fn update_match_camera(
             &crate::fighter::motion::FighterPreviousTranslation,
             &crate::fighter::Fighter,
             &crate::fighter::FighterFacingDirection,
+            &FighterPresentationSnap,
             &mut FighterCameraExtents,
         ),
         With<crate::player::Player>,
@@ -329,16 +330,17 @@ fn update_match_camera(
     let subjects = fighters
         .iter_mut()
         .map(
-            |(translation, previous_translation, fighter, facing, mut extents)| {
+            |(translation, previous_translation, fighter, facing, presentation_snap, mut extents)| {
                 let manifest = manifests
                     .get(&fighter.manifest)
                     .expect("Fighter manifest should be valid");
                 fighter_subject_bounds(
-                    sample_presentation_translation(
+                    sample_presentation_translation_with_snap(
                         *previous_translation,
                         *translation,
                         timing.overstep_fraction(),
                         debug_settings.motion_sampling,
+                        *presentation_snap,
                     ),
                     manifest.camera,
                     *facing,
@@ -465,6 +467,7 @@ fn debug_draw_camera(
             &crate::fighter::motion::FighterPreviousTranslation,
             &crate::fighter::Fighter,
             &crate::fighter::FighterFacingDirection,
+            &FighterPresentationSnap,
             &FighterCameraExtents,
         ),
         With<crate::player::Player>,
@@ -486,15 +489,16 @@ fn debug_draw_camera(
             Color::srgb(1.0, 0.5, 0.0),
         );
         draw_rectangle(&mut gizmos, camera.frame, Color::srgb(1.0, 1.0, 0.0));
-        for (translation, previous_translation, fighter, _facing, extents) in &fighters {
+        for (translation, previous_translation, fighter, _facing, presentation_snap, extents) in &fighters {
             let manifest = manifests
                 .get(&fighter.manifest)
                 .expect("Fighter manifest should be valid");
-            let center = sample_presentation_translation(
+            let center = sample_presentation_translation_with_snap(
                 *previous_translation,
                 *translation,
                 timing.overstep_fraction(),
                 debug_settings.motion_sampling,
+                *presentation_snap,
             ) + Vec2::Y * manifest.camera.vertical_origin_offset.to_num::<f32>();
             draw_rectangle(
                 &mut gizmos,

src/debug_tools.rs

@@ -109,6 +109,7 @@ impl FighterDebugRowKind {
 enum DebugFlag {
     Network,
     Ecb,
+    BlastZones,
     StageCollision,
     AnimationBones,
     AttackHitboxes,
@@ -150,6 +151,10 @@ const FIGHTER_MENU: &[DebugMenuEntry] = &[
         label: "ECB",
         flag: DebugFlag::Ecb,
     },
+    DebugMenuEntry::Toggle {
+        label: "Blast Zones",
+        flag: DebugFlag::BlastZones,
+    },
     DebugMenuEntry::Toggle {
         label: "Animation bones",
         flag: DebugFlag::AnimationBones,
@@ -243,6 +248,7 @@ pub struct DebugSettings {
     pub frame_stepping: bool,
     pub network: bool,
     pub ecb: bool,
+    pub blast_zones: bool,
     pub stage_collision: bool,
     pub animation_bones: bool,
     pub attack_hitboxes: bool,
@@ -264,6 +270,7 @@ impl Default for DebugSettings {
             frame_stepping: false,
             network: false,
             ecb: false,
+            blast_zones: true,
             stage_collision: false,
             animation_bones: false,
             attack_hitboxes: false,
@@ -328,6 +335,7 @@ impl DebugSettings {
         match flag {
             DebugFlag::Network => self.network,
             DebugFlag::Ecb => self.ecb,
+            DebugFlag::BlastZones => self.blast_zones,
             DebugFlag::StageCollision => self.stage_collision,
             DebugFlag::AnimationBones => self.animation_bones,
             DebugFlag::AttackHitboxes => self.attack_hitboxes,
@@ -342,6 +350,7 @@ impl DebugSettings {
         match flag {
             DebugFlag::Network => self.network = !self.network,
             DebugFlag::Ecb => self.ecb = !self.ecb,
+            DebugFlag::BlastZones => self.blast_zones = !self.blast_zones,
             DebugFlag::StageCollision => self.stage_collision = !self.stage_collision,
             DebugFlag::AnimationBones => self.animation_bones = !self.animation_bones,
             DebugFlag::AttackHitboxes => self.attack_hitboxes = !self.attack_hitboxes,
@@ -884,6 +893,10 @@ pub fn stage_collision_enabled(settings: Res<DebugSettings>) -> bool {
     settings.stage_collision
 }
 
+pub fn blast_zones_enabled(settings: Res<DebugSettings>) -> bool {
+    settings.blast_zones
+}
+
 pub fn animation_bones_enabled(settings: Res<DebugSettings>) -> bool {
     settings.animation_bones
 }

src/fighter/mod.rs

@@ -29,7 +29,8 @@ pub use attributes::FighterAttributes;
 pub use ecb::FighterECB;
 pub use manifest::FighterId;
 pub use motion::{
-    FighterPreviousFacingDirection, FighterPreviousTranslation, FighterTranslation, FighterVelocity,
+    FighterPresentationSnap, FighterPreviousFacingDirection, FighterPreviousTranslation,
+    FighterTranslation, FighterVelocity,
 };
 pub use surface::FighterSurfaceState;
 
@@ -147,6 +148,10 @@ impl Plugin for FighterPlugin {
     fn build(&self, app: &mut App) {
         app.add_plugins(FighterAttackPlugin)
             // Every state gets a chance to interrupt itself, in priority order.
+            .add_systems(
+                GgrsSchedule,
+                motion::clear_fighter_presentation_snaps.in_set(GameplaySet::Input),
+            )
             .add_systems(
                 GgrsSchedule,
                 (
@@ -202,6 +207,8 @@ impl Plugin for FighterPlugin {
             .checksum_component_with_hash::<FighterTranslation>()
             .rollback_component_with_copy::<FighterPreviousTranslation>()
             .checksum_component_with_hash::<FighterPreviousTranslation>()
+            .rollback_component_with_copy::<FighterPresentationSnap>()
+            .checksum_component_with_hash::<FighterPresentationSnap>()
             .rollback_component_with_copy::<FighterPreviousFacingDirection>()
             .checksum_component_with_hash::<FighterPreviousFacingDirection>()
             .rollback_component_with_copy::<animation::FighterAnimationFrame>()
@@ -304,6 +311,7 @@ pub fn spawn_fighter(
                 FighterVelocity::default(),
                 FighterTranslation(spawn_position),
                 FighterPreviousTranslation(spawn_position),
+                FighterPresentationSnap::default(),
             ),
             visual_root,
             animations,

src/fighter/motion.rs

@@ -21,6 +21,11 @@ pub struct FighterVelocity(pub FGVec2);
 #[derive(Component, Deref, DerefMut, Default, Clone, Copy, Hash)]
 pub struct FighterPreviousTranslation(pub FGVec2);
 
+/// Marks a simulation frame whose position changed discontinuously for
+/// presentation purposes (for example, a landing correction).
+#[derive(Component, Default, Clone, Copy, Hash, Debug, PartialEq, Eq)]
+pub struct FighterPresentationSnap(pub bool);
+
 #[derive(Component, Deref, DerefMut, Default, Clone, Copy, Hash)]
 #[require(FighterPreviousTranslation)]
 pub struct FighterTranslation(pub FGVec2);
@@ -52,10 +57,31 @@ pub fn sample_presentation_translation(
     }
 }
 
+pub fn sample_presentation_translation_with_snap(
+    previous: FighterPreviousTranslation,
+    current: FighterTranslation,
+    overstep_fraction: f32,
+    mode: PresentationMotionMode,
+    snapped: FighterPresentationSnap,
+) -> Vec2 {
+    if snapped.0 {
+        Vec2::new(current.x.to_num(), current.y.to_num())
+    } else {
+        sample_presentation_translation(previous, current, overstep_fraction, mode)
+    }
+}
+
+pub fn clear_fighter_presentation_snaps(mut fighters: Query<&mut FighterPresentationSnap>) {
+    for mut snap in &mut fighters {
+        snap.0 = false;
+    }
+}
+
 pub fn apply_fighter_translation_to_visuals(
     query: Query<(
         &FighterTranslation,
         &FighterPreviousTranslation,
+        &FighterPresentationSnap,
         &FighterHitstopShake,
         &mut Transform,
     )>,
@@ -64,12 +90,13 @@ pub fn apply_fighter_translation_to_visuals(
     game_settings: Res<GameSettings>,
 ) {
     let overstep_fraction = timing.overstep_fraction();
-    for (translation, previous_translation, hitstop_shake, mut transform) in query {
-        let translation = sample_presentation_translation(
+    for (translation, previous_translation, presentation_snap, hitstop_shake, mut transform) in query {
+        let translation = sample_presentation_translation_with_snap(
             *previous_translation,
             *translation,
             overstep_fraction,
             debug_settings.motion_sampling,
+            *presentation_snap,
         );
         transform.translation = Vec3::new(
             translation.x,
@@ -169,6 +196,19 @@ mod tests {
         assert_eq!(position, Vec2::new(7.0, 14.0));
     }
 
+    #[test]
+    fn presentation_translation_uses_current_sample_after_snap() {
+        let position = sample_presentation_translation_with_snap(
+            FighterPreviousTranslation(FGVec2::new(FGi32::lit("2"), FGi32::lit("4"))),
+            FighterTranslation(FGVec2::new(FGi32::lit("6"), FGi32::lit("12"))),
+            0.25,
+            PresentationMotionMode::Extrapolation,
+            FighterPresentationSnap(true),
+        );
+
+        assert_eq!(position, Vec2::new(6.0, 12.0));
+    }
+
     #[test]
     fn snapshot_fighter_motion_copies_current_world_state() {
         let mut world = World::new();

src/fighter/state/air.rs

@@ -123,6 +123,7 @@ pub fn collision_interrupt(
     ctx.ecb.left -= diff;
     ctx.ecb.right -= diff;
     ctx.translation.0 = res.hit_position;
+    ctx.presentation_snap.0 = true;
     ctx.surface.land(res.line_id);
     Some(FighterState::Land(LandingState::create(landing_type)))
 }

src/fighter/state/ground.rs

@@ -376,6 +376,7 @@ mod tests {
             right: FGVec2::lit("0.5", "0.0"),
         };
         let previous_ecb = FighterPreviousECB::from(ecb);
+        let mut presentation_snap = crate::fighter::FighterPresentationSnap::default();
         let mut context = CollisionContext {
             translation: &mut translation,
             prev_translation: &previous_translation,
@@ -386,6 +387,7 @@ mod tests {
             prev_ecb: &previous_ecb,
             stage_collision: &stage_collision,
             leave_ground_ecb_lock_duration: 10,
+            presentation_snap: &mut presentation_snap,
             downward_stick_threshold: FGi32::ONE,
         };
 
@@ -429,6 +431,7 @@ mod tests {
             right: FGVec2::lit("0.5", "0.0"),
         };
         let previous_ecb = FighterPreviousECB::from(ecb);
+        let mut presentation_snap = crate::fighter::FighterPresentationSnap::default();
         let mut context = CollisionContext {
             translation: &mut translation,
             prev_translation: &previous_translation,
@@ -439,6 +442,7 @@ mod tests {
             prev_ecb: &previous_ecb,
             stage_collision: &stage_collision,
             leave_ground_ecb_lock_duration: 10,
+            presentation_snap: &mut presentation_snap,
             downward_stick_threshold: FGi32::ONE,
         };
 

src/fighter/state/mod.rs

@@ -20,6 +20,7 @@ use crate::fighter::{
     Fighter, FighterECB, FighterFacingDirection, FighterHitboxes, FighterHitstop,
     FighterHitstopShake, FighterHitstopShakeKind, FighterHitstopShakeRole,
     FighterPreviousTranslation, FighterSurfaceState, FighterTranslation, FighterVelocity,
+    FighterPresentationSnap,
 };
 use crate::fighter::surface::EcbLockPolicy;
 use crate::game_settings::GameSettings;
@@ -200,6 +201,7 @@ pub struct CollisionContext<'a> {
     pub prev_ecb: &'a FighterPreviousECB,
     pub stage_collision: &'a StageCollision,
     pub leave_ground_ecb_lock_duration: u32,
+    pub presentation_snap: &'a mut FighterPresentationSnap,
     pub downward_stick_threshold: FGi32,
 }
 
@@ -244,6 +246,7 @@ fighter_states! {
 pub struct FighterFrameQuery {
     pub translation: &'static mut FighterTranslation,
     pub prev_translation: &'static mut FighterPreviousTranslation,
+    pub presentation_snap: &'static mut FighterPresentationSnap,
     pub input: &'static mut FighterInput,
     pub hitboxes: &'static mut FighterHitboxes,
     pub velocity: &'static mut FighterVelocity,
@@ -354,6 +357,7 @@ impl<'w, 's> FighterFrameQueryItem<'w, 's> {
         CollisionContext {
             translation: &mut self.translation,
             prev_translation: &self.prev_translation,
+            presentation_snap: &mut self.presentation_snap,
             input: &self.input,
             velocity: &mut self.velocity,
             surface: &mut self.surface,

src/input/mod.rs

@@ -116,13 +116,12 @@ impl Plugin for FighterInputPlugin {
                     binding: GamepadBinding::Button(GamepadButton::North),
                     action: InputMapAction::Jump,
                 },
-                // shield/airdodge -- both shoulder buttons, Melee-style
                 GamepadInputMapElement {
-                    binding: GamepadBinding::Button(GamepadButton::LeftTrigger),
+                    binding: GamepadBinding::Button(GamepadButton::LeftTrigger2),
                     action: InputMapAction::Shield,
                 },
                 GamepadInputMapElement {
-                    binding: GamepadBinding::Button(GamepadButton::RightTrigger),
+                    binding: GamepadBinding::Button(GamepadButton::RightTrigger2),
                     action: InputMapAction::Shield,
                 },
                 // attack

src/match_runtime.rs

@@ -1,9 +1,14 @@
 //! Rollback-simulated state for an active match.
 
+use bevy::input::InputSystems;
 use bevy::prelude::*;
-use bevy_ggrs::prelude::*;
+use bevy_ggrs::{RunGgrsSystems, prelude::*};
 
-use crate::match_loading::{MatchConfig, MatchRules};
+use crate::{
+    AppState,
+    match_loading::{MatchConfig, MatchRules},
+    netcode::session::SessionConfig,
+};
 
 #[derive(Resource, Clone, Debug, Hash, PartialEq, Eq)]
 pub struct MatchState {
@@ -19,6 +24,11 @@ pub struct PlayerMatchState {
     pub deaths: u32,
 }
 
+#[derive(Resource, Debug, Default, Clone, Copy, PartialEq, Eq)]
+pub struct PauseState {
+    pub paused: bool,
+}
+
 impl MatchState {
     pub fn from_config(config: &MatchConfig) -> Self {
         let stocks_remaining = match &config.rules {
@@ -46,10 +56,56 @@ pub struct MatchRuntimePlugin;
 impl Plugin for MatchRuntimePlugin {
     fn build(&self, app: &mut App) {
         app.rollback_resource_with_clone::<MatchState>()
-            .checksum_resource_with_hash::<MatchState>();
+            .checksum_resource_with_hash::<MatchState>()
+            .init_resource::<PauseState>()
+            .configure_sets(PreUpdate, RunGgrsSystems.run_if(ggrs_should_run))
+            .add_systems(OnEnter(AppState::InMatch), reset_pause)
+            .add_systems(OnExit(AppState::InMatch), reset_pause)
+            .add_systems(
+                PreUpdate,
+                toggle_pause
+                    .after(InputSystems)
+                    .before(RunGgrsSystems)
+                    .run_if(in_state(AppState::InMatch)),
+            );
     }
 }
 
+pub fn ggrs_should_run(pause: Option<Res<PauseState>>) -> bool {
+    !pause.is_some_and(|pause| pause.paused)
+}
+
+fn toggle_pause(
+    key: Res<ButtonInput<KeyCode>>,
+    gamepads: Query<&Gamepad>,
+    session: Res<SessionConfig>,
+    mut pause: ResMut<PauseState>,
+    mut virtual_time: ResMut<Time<Virtual>>,
+) {
+    if session.is_multiplayer() {
+        return;
+    }
+
+    let pressed = key.just_pressed(KeyCode::Escape)
+        || gamepads
+            .iter()
+            .any(|gamepad| gamepad.just_pressed(GamepadButton::Start));
+    if !pressed {
+        return;
+    }
+
+    pause.paused = !pause.paused;
+    virtual_time.toggle();
+}
+
+fn reset_pause(
+    mut pause: ResMut<PauseState>,
+    mut virtual_time: ResMut<Time<Virtual>>,
+) {
+    pause.paused = false;
+    virtual_time.unpause();
+}
+
 #[cfg(test)]
 mod tests {
     use super::*;

src/menus/input.rs

@@ -226,7 +226,7 @@ fn gamepad_input(
                 input.accept.accumulate(&status);
             }
             MenuInputMapAction::Start => {
-                input.accept.accumulate(&status);
+                input.start.accumulate(&status);
             }
         }
     }

src/netcode/session.rs

@@ -42,6 +42,15 @@ pub enum SessionConfigError {
 }
 
 impl SessionConfig {
+    /// Returns whether this match has more than one remote participant.
+    pub fn is_multiplayer(&self) -> bool {
+        self.players.len() > 1
+            || self
+                .players
+                .iter()
+                .any(|player| matches!(player, PlayerConnection::Remote(_)))
+    }
+
     pub fn from_args(args: &Args, player_count: usize) -> Result<Self, SessionConfigError> {
         if player_count == 0 {
             return Err(SessionConfigError::NoPlayers);
@@ -196,6 +205,13 @@ mod tests {
             config.players,
             [PlayerConnection::Local, PlayerConnection::Local]
         );
+        assert!(config.is_multiplayer());
+    }
+
+    #[test]
+    fn single_local_player_is_not_multiplayer() {
+        let config = SessionConfig::from_args(&args(&["game", "--players", "1"]), 1).unwrap();
+        assert!(!config.is_multiplayer());
     }
 
     #[test]
@@ -207,6 +223,7 @@ mod tests {
         .unwrap();
         assert!(matches!(config.players[0], PlayerConnection::Local));
         assert!(matches!(config.players[1], PlayerConnection::Remote(_)));
+        assert!(config.is_multiplayer());
     }
 
     #[test]

src/stage/debug.rs

@@ -1,6 +1,12 @@
 use bevy::{color::palettes::css::RED, prelude::*};
 
-use crate::stage::line::StageCollision;
+use crate::{
+    match_loading::MatchConfig,
+    stage::{
+        line::StageCollision,
+        manifest::{StageManifest, StageManifestRegistry},
+    },
+};
 
 pub fn debug_draw_scene(mut gizmos: Gizmos, stage_collision: Res<StageCollision>) {
     for poly in stage_collision.stage_polys.iter() {
@@ -16,3 +22,25 @@ pub fn debug_draw_scene(mut gizmos: Gizmos, stage_collision: Res<StageCollision>
         }
     }
 }
+
+pub fn debug_draw_blast_zones(
+    mut gizmos: Gizmos,
+    stage_registry: Res<StageManifestRegistry>,
+    stage_manifests: Res<Assets<StageManifest>>,
+    match_config: Res<MatchConfig>,
+) {
+    let Some(stage_manifest_handle) = stage_registry.get(match_config.stage) else {
+        return;
+    };
+
+    let Some(stage_manifest) = stage_manifests.get(&stage_manifest_handle) else {
+        return;
+    };
+
+    let top_left = stage_manifest.blast_zone_top_left.to_vec2();
+    let bottom_right = stage_manifest.blast_zone_bottom_right.to_vec2();
+    let center = (top_left + bottom_right) / 2.0;
+    let size = (bottom_right - top_left).abs();
+
+    gizmos.rect(Vec3::new(center.x, center.y, 0.0), size, bevy::color::palettes::css::BLUE);
+}

src/stage/manifest.rs

@@ -7,14 +7,10 @@ use strum::IntoEnumIterator;
 use strum_macros::EnumIter;
 
 use crate::{
-    AppState,
-    game_settings::GameSettings,
-    math::vec::FGVec2,
-    stage::{
+    AppState, game_settings::GameSettings, math::{int::FGi32, vec::FGVec2}, stage::{
         StagePoly,
         line::{StageCollision, StagePolyLineSegmentType, StagePolyType},
-    },
-    texture_reference::TextureReference,
+    }, texture_reference::TextureReference,
 };
 use bevy::prelude::*;
 
@@ -87,6 +83,11 @@ pub struct StageManifest {
     pub icon: TextureReference,
     pub camera: StageCameraProfile,
     pub polygons: Vec<StagePolyDefinition>,
+
+    #[reflect(ignore)]
+    pub blast_zone_top_left: FGVec2,
+    #[reflect(ignore)]
+    pub blast_zone_bottom_right: FGVec2,
 }
 
 #[derive(Resource)]

src/stage/mod.rs

@@ -10,7 +10,7 @@ pub mod scene;
 
 pub use line::{StagePlaneIntersectResult, StagePoly};
 
-use crate::stage::{line::StageCollision, manifest::StageCameraProfile};
+use crate::{match_loading::MatchConfig, stage::{line::StageCollision, manifest::StageCameraProfile}};
 
 /// Owns the stage geometry: which scene gets spawned and how it is drawn.
 #[derive(Default)]
@@ -20,9 +20,14 @@ impl Plugin for StagePlugin {
     fn build(&self, app: &mut App) {
         app.add_systems(
             Update,
-            debug::debug_draw_scene
+            (
+                (debug::debug_draw_scene
                     .run_if(resource_exists::<line::StageCollision>)
-                .run_if(crate::debug_tools::stage_collision_enabled),
+                    .run_if(crate::debug_tools::stage_collision_enabled)),
+                (debug::debug_draw_blast_zones
+                    .run_if(resource_exists::<MatchConfig>)
+                    .run_if(crate::debug_tools::blast_zones_enabled),),
+            ),
         );
     }
 }

src/ui/mod.rs

@@ -3,7 +3,7 @@ use bevy::prelude::*;
 use crate::{
     AppState,
     match_loading::{MatchConfig, MatchRules},
-    match_runtime::MatchState,
+    match_runtime::{MatchState, PauseState},
 };
 
 pub mod battle_ui;
@@ -11,6 +11,9 @@ pub mod errors;
 pub mod fighter_info;
 pub mod stock_icon;
 
+#[derive(Component)]
+pub struct PauseOverlay;
+
 #[derive(Default)]
 pub struct InGameUIPlugin;
 
@@ -32,6 +35,54 @@ impl Plugin for InGameUIPlugin {
                             }
                     }),
                 ),
-            );
+            )
+            .add_systems(Update, sync_pause_overlay);
+    }
+}
+
+pub fn sync_pause_overlay(
+    pause: Res<PauseState>,
+    overlay: Query<Entity, With<PauseOverlay>>,
+    mut commands: Commands,
+) {
+    if !pause.is_changed() {
+        return;
+    }
+
+    if pause.paused {
+        if overlay.is_empty() {
+            commands.spawn((
+                PauseOverlay,
+                Node {
+                    position_type: PositionType::Absolute,
+                    left: px(0),
+                    right: px(0),
+                    top: px(0),
+                    bottom: px(0),
+                    align_items: AlignItems::Center,
+                    justify_content: JustifyContent::Center,
+                    flex_direction: FlexDirection::Column,
+                    ..default()
+                },
+                BackgroundColor(Color::srgba(0.0, 0.0, 0.0, 0.7)),
+                ZIndex(100),
+                children![
+                    (
+                        Text::new("Paused"),
+                        TextFont::from_font_size(crate::menus::style::H1_SIZE as f32),
+                        TextColor(Color::WHITE),
+                    ),
+                    (
+                        Text::new("Press Esc or Start to resume"),
+                        TextFont::from_font_size(crate::menus::style::TEXT_SIZE as f32),
+                        TextColor(Color::WHITE),
+                    ),
+                ],
+            ));
+        }
+    } else {
+        for entity in &overlay {
+            commands.entity(entity).despawn();
+        }
     }
 }