Skip to content

Event driven cursor visibility #43

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Event driven cursor visibility #43

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
634e6f8
Update lib.rs
sebastienwood Jun 28, 2025
3d6e6fb
Update lib.rs
sebastienwood Jun 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
77 changes: 66 additions & 11 deletions src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,7 @@ mod gamepad;
mod mouse;

use bevy::{
prelude::*,
window::{CursorGrabMode, PrimaryWindow},
prelude::*, window::{CursorGrabMode, PrimaryWindow}
};
use gamepad::GamePadPlugin;
use mouse::MousePlugin;
Expand All @@ -22,6 +21,11 @@ pub struct ThirdPersonCameraPlugin;
#[derive(SystemSet, Debug, Clone, PartialEq, Eq, Hash)]
pub struct CameraSyncSet;

#[derive(Event)]
pub struct CursorLockEvent {
pub locked: bool,
}

impl Plugin for ThirdPersonCameraPlugin {
fn build(&self, app: &mut App) {
app.add_plugins((MousePlugin, GamePadPlugin))
Expand All @@ -30,7 +34,11 @@ impl Plugin for ThirdPersonCameraPlugin {
(
aim.run_if(aim_condition),
toggle_x_offset.run_if(toggle_x_offset_condition),
toggle_cursor.run_if(toggle_cursor_condition),
//toggle_cursor.run_if(toggle_cursor_condition),
handle_cursor_lock_events.run_if(
toggle_cursor_condition,
),
cursor_lock_toggle,
),
)
.add_systems(
Expand All @@ -39,6 +47,7 @@ impl Plugin for ThirdPersonCameraPlugin {
.before(TransformSystem::TransformPropagate)
.in_set(CameraSyncSet),
);
app.add_event::<CursorLockEvent>();
}
}

Expand Down Expand Up @@ -415,17 +424,55 @@ fn toggle_x_offset(
.clamp(-cam.offset.offset_copy.0, cam.offset.offset_copy.0);
}

fn toggle_cursor(
// fn toggle_cursor(
// mut cam_q: Query<&mut ThirdPersonCamera>,
// keys: Res<ButtonInput<KeyCode>>,
// mut window_q: Query<&mut Window, With<PrimaryWindow>>,
// ) {
// let Ok(mut cam) = cam_q.single_mut() else {
// return;
// };

// if keys.just_pressed(cam.cursor_lock_key) {
// cam.cursor_lock_active = !cam.cursor_lock_active;
// }

// if let Ok(mut window) = window_q.single_mut() {
// if cam.cursor_lock_active {
// window.cursor_options.grab_mode = CursorGrabMode::Locked;
// window.cursor_options.visible = false;
// } else {
// window.cursor_options.grab_mode = CursorGrabMode::None;
// window.cursor_options.visible = true;
// }
// }
// }

// checks if the toggle cursor functionality is enabled
fn toggle_cursor_condition(cam_q: Query<&ThirdPersonCamera>) -> bool {
let Ok(cam) = cam_q.single() else {
return true;
};
cam.cursor_lock_toggle_enabled
}

fn handle_cursor_lock_events(
mut events: EventReader<CursorLockEvent>,
mut cam_q: Query<&mut ThirdPersonCamera>,
keys: Res<ButtonInput<KeyCode>>,
mut window_q: Query<&mut Window, With<PrimaryWindow>>,
) {
let Ok(mut cam) = cam_q.single_mut() else {
return;
};

if keys.just_pressed(cam.cursor_lock_key) {
cam.cursor_lock_active = !cam.cursor_lock_active;
if events.len() > 1 {
warn!("Multiple CursorLockEvent detected");
}

// Ensure there is a single event to process
for event in events.read() {
info!("CursorLockEvent: locked={}", event.locked);
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd say this ought to be debug level, I personally hate when plugins force info level prints unless I want them

cam.cursor_lock_active = event.locked;
}

if let Ok(mut window) = window_q.single_mut() {
Expand All @@ -439,10 +486,18 @@ fn toggle_cursor(
}
}

// checks if the toggle cursor functionality is enabled
fn toggle_cursor_condition(cam_q: Query<&ThirdPersonCamera>) -> bool {
pub fn cursor_lock_toggle(
mut events_q: EventWriter<CursorLockEvent>,
keys: Res<ButtonInput<KeyCode>>,
cam_q: Query<&ThirdPersonCamera>,
) {
let Ok(cam) = cam_q.single() else {
return true;
return;
};
cam.cursor_lock_toggle_enabled

if keys.just_pressed(cam.cursor_lock_key) {
events_q.write(CursorLockEvent {
locked: !cam.cursor_lock_active,
});
}
}