forestia/bevy
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Prevent panic when multiple Enter inputs received in text_input example (#11872)

Browse Source 
# Objective

Presently, it is possible to cause the `text_input` example to panic by
pressing enter too quickly. This happens because, under these
circumstances, the `listen_keyboard_input_events` system spawns multiple
text entry entities where the `listen_received_character_events` system
expects there to only ever be one. As this is an example this PR aims to
highlight this risk and mitigate it.

## Solution

Modify the example so that if a text entry has been spawned already
during this run of the system then further Enter input events are
ignored this run.
This commit is contained in:
Sam Kirby 2024-02-19 16:51:27 +00:00 committed by GitHub
parent e50e848b58
commit 91b083bb05
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 18 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
examples/input/text_input.rs
View File

@ -4,6 +4,8 @@
//! Clicking toggle IME (Input Method Editor) support, but the font used as limited support of characters. //! Clicking toggle IME (Input Method Editor) support, but the font used as limited support of characters.
//! You should change the provided font with another one to test other languages input. //! You should change the provided font with another one to test other languages input.
use std::mem;
use bevy::{input::keyboard::KeyboardInput, prelude::*}; use bevy::{input::keyboard::KeyboardInput, prelude::*};
fn main() { fn main() {
@ -178,23 +180,29 @@ fn listen_received_character_events(
fn listen_keyboard_input_events( fn listen_keyboard_input_events(
mut commands: Commands, mut commands: Commands,
mut events: EventReader<KeyboardInput>, mut events: EventReader<KeyboardInput>,
mut edit_text: Query<(Entity, &mut Text), (Without<Node>, Without<Bubble>)>, mut edit_text: Query<&mut Text, (Without<Node>, Without<Bubble>)>,
) { ) {
for event in events.read() { for event in events.read() {
match event.key_code { match event.key_code {
KeyCode::Enter => { KeyCode::Enter => {
let (entity, text) = edit_text.single(); let mut text = edit_text.single_mut();
commands.entity(entity).insert(Bubble { if text.sections[0].value.is_empty() {
timer: Timer::from_seconds(5.0, TimerMode::Once), continue;
}); }
let old_value = mem::take(&mut text.sections[0].value);
commands.spawn(Text2dBundle { commands.spawn((
text: Text::from_section("".to_string(), text.sections[0].style.clone()), Text2dBundle {
..default() text: Text::from_section(old_value, text.sections[0].style.clone()),
}); ..default()
},
Bubble {
timer: Timer::from_seconds(5.0, TimerMode::Once),
},
));
} }
KeyCode::Backspace => { KeyCode::Backspace => {
edit_text.single_mut().1.sections[0].value.pop(); edit_text.single_mut().sections[0].value.pop();
} }
_ => continue, _ => continue,
} }