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

update documentation on AudioSink (#9332)

Browse Source 
# Objective

When an `AudioSink` is removed from an entity, the audio player will
automatically start any `AudioSource` still attached, which normally is
the one used to start playback in the first place.

## Solution

Long story short, the default behavior is restarting the audio, and this
commit documents that.

---

## Changelog

Fixed documentation on `AudioSink` to clarify removal behavior.
This commit is contained in:
Ray Redondo 2023-08-03 07:46:44 -05:00 committed by GitHub
parent b6a2fc5d80
commit 42098192c2
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
crates/bevy_audio/src/sinks.rs
View File

@ -71,6 +71,10 @@ pub trait AudioSinkPlayback {
/// Use [`AudioBundle`][crate::AudioBundle] to trigger that to happen. /// Use [`AudioBundle`][crate::AudioBundle] to trigger that to happen.
/// ///
/// You can use this component to modify the playback settings while the audio is playing. /// You can use this component to modify the playback settings while the audio is playing.
///
/// If this component is removed from an entity, and an [`AudioSource`][crate::AudioSource] is
/// attached to that entity, that [`AudioSource`][crate::AudioSource] will start playing. If
/// that source is unchanged, that translates to the audio restarting.
#[derive(Component)] #[derive(Component)]
pub struct AudioSink { pub struct AudioSink {
// This field is an Option in order to allow us to have a safe drop that will detach the sink. // This field is an Option in order to allow us to have a safe drop that will detach the sink.
@ -128,6 +132,10 @@ impl AudioSinkPlayback for AudioSink {
/// Use [`SpatialAudioBundle`][crate::SpatialAudioBundle] to trigger that to happen. /// Use [`SpatialAudioBundle`][crate::SpatialAudioBundle] to trigger that to happen.
/// ///
/// You can use this component to modify the playback settings while the audio is playing. /// You can use this component to modify the playback settings while the audio is playing.
///
/// If this component is removed from an entity, and a [`AudioSource`][crate::AudioSource] is
/// attached to that entity, that [`AudioSource`][crate::AudioSource] will start playing. If
/// that source is unchanged, that translates to the audio restarting.
#[derive(Component)] #[derive(Component)]
pub struct SpatialAudioSink { pub struct SpatialAudioSink {
// This field is an Option in order to allow us to have a safe drop that will detach the sink. // This field is an Option in order to allow us to have a safe drop that will detach the sink.