ed151e756c
# Objective What's that? Another PR for the grand migration to required components? This time, audio! ## Solution Deprecate `AudioSourceBundle`, `AudioBundle`, and `PitchBundle`, as per the [chosen proposal](https://hackmd.io/@bevy/required_components/%2Fzxgp-zMMRUCdT7LY1ZDQwQ). However, we cannot call the component `AudioSource`, because that's what the stored asset is called. I deliberated on a few names, like `AudioHandle`, or even just `Audio`, but landed on `AudioPlayer`, since it's probably the most accurate and "nice" name for this. Open to alternatives though. --- ## Migration Guide Replace all insertions of `AudioSoucreBundle`, `AudioBundle`, and `PitchBundle` with the `AudioPlayer` component. The other components required by it will now be inserted automatically. In cases where the generics cannot be inferred, you may need to specify them explicitly. For example: ```rust commands.spawn(AudioPlayer::<AudioSource>(asset_server.load("sounds/sick_beats.ogg"))); ```
45 lines
1.1 KiB
Rust
45 lines
1.1 KiB
Rust
#![expect(deprecated)]
|
|
|
|
use crate::{AudioSourceBundle, Decodable};
|
|
use bevy_asset::Asset;
|
|
use bevy_reflect::TypePath;
|
|
use rodio::{
|
|
source::{SineWave, TakeDuration},
|
|
Source,
|
|
};
|
|
|
|
/// A source of sine wave sound
|
|
#[derive(Asset, Debug, Clone, TypePath)]
|
|
pub struct Pitch {
|
|
/// Frequency at which sound will be played
|
|
pub frequency: f32,
|
|
/// Duration for which sound will be played
|
|
pub duration: core::time::Duration,
|
|
}
|
|
|
|
impl Pitch {
|
|
/// Creates a new note
|
|
pub fn new(frequency: f32, duration: core::time::Duration) -> Self {
|
|
Pitch {
|
|
frequency,
|
|
duration,
|
|
}
|
|
}
|
|
}
|
|
|
|
impl Decodable for Pitch {
|
|
type DecoderItem = <SineWave as Iterator>::Item;
|
|
type Decoder = TakeDuration<SineWave>;
|
|
|
|
fn decoder(&self) -> Self::Decoder {
|
|
SineWave::new(self.frequency).take_duration(self.duration)
|
|
}
|
|
}
|
|
|
|
/// Bundle for playing a bevy note sound
|
|
#[deprecated(
|
|
since = "0.15.0",
|
|
note = "Use the `AudioPlayer<Pitch>` component instead. Inserting it will now also insert a `PlaybackSettings` component automatically."
|
|
)]
|
|
pub type PitchBundle = AudioSourceBundle<Pitch>;
|