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

Update Input to ButtonInput in a couple places at keyboard input docs (#12284)

Browse Source 
# Objective

Correct references to `Input` into `ButtonInput` in the keyboard input
docs since it was renamed in 0.13.

## Solution

Change the type used in the keyboard input docs from `Input` to
`ButtonInput`.
This commit is contained in:
TrialDragon 2024-03-03 16:52:47 -08:00 committed by GitHub
parent 983da7677a
commit 541a321a3d
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
crates/bevy_input/src/keyboard.rs
View File

@ -86,7 +86,7 @@ use bevy_reflect::{ReflectDeserialize, ReflectSerialize};
/// ## Usage /// ## Usage
/// ///
/// The event is consumed inside of the [`keyboard_input_system`] /// The event is consumed inside of the [`keyboard_input_system`]
/// to update the [`Input<KeyCode>`](ButtonInput<KeyCode>) resource. /// to update the [`ButtonInput<KeyCode>`](ButtonInput<KeyCode>) resource.
#[derive(Event, Debug, Clone, PartialEq, Eq, Reflect)] #[derive(Event, Debug, Clone, PartialEq, Eq, Reflect)]
#[reflect(Debug, PartialEq)] #[reflect(Debug, PartialEq)]
#[cfg_attr( #[cfg_attr(
@ -162,7 +162,7 @@ pub enum NativeKeyCode {
/// ///
/// ## Usage /// ## Usage
/// ///
/// It is used as the generic `T` value of an [`ButtonInput`] to create a `Res<Input<KeyCode>>`. /// It is used as the generic `T` value of an [`ButtonInput`] to create a `Res<ButtonInput<KeyCode>>`.
/// ///
/// Code representing the location of a physical key /// Code representing the location of a physical key
/// This mostly conforms to the UI Events Specification's [`KeyboardEvent.code`] with a few /// This mostly conforms to the UI Events Specification's [`KeyboardEvent.code`] with a few