Struct SettingsEvent

pub struct SettingsEvent<Channel: ACBounds> { /* private fields */ }

An event for changing the settings of a channel

Including track specific settings

Example

use bevy_audio_controller::prelude::*;

fn main() {
    App::new()
        .add_plugins(AudioControllerPlugin)
        .add_systems(Startup, setup)
        .run();
}

fn setup(mut ew: EventWriter<SettingsEvent<SfxChannel>>) {
    // Set the volume for the channel
    let vol_event = SfxChannel::settings_event().with_volume(0.5);

    // Set the default playback settings for the channel
    let default_settings_event =
        SfxChannel::settings_event().with_settings(PlaybackSettings::DESPAWN);

    // Sets (and overwrites!) the playback settings for all tracks in your assets folder for the channel
    let all_track_settings_event = SfxChannel::settings_event()
        .with_settings(PlaybackSettings::REMOVE)
        .all();

    // Set the playback settings for a specific track in the channel
    let track_settings_event = SfxChannel::settings_event()
        .with_settings(PlaybackSettings::LOOP)
        .with_track(AudioFiles::BackgroundOGG);

    ew.send_batch(vec![
        vol_event,
        default_settings_event,
        all_track_settings_event,
        track_settings_event,
    ]);
}

Implementations

impl<Channel: ACBounds> SettingsEvent<Channel>

pub fn new() -> Self

pub fn with_volume(self, volume: Volume) -> Self

Sets the volume for the channel

pub fn with_settings(self, settings: PlaybackSettings) -> Self

When called on its own without with_track or all, this sets the default PlaybackSettings for the channel

pub fn with_delay_mode(self, delay_mode: DelayMode) -> Self

When called on its own without with_track or all, this sets the default DelayMode for the channel

pub fn with_track(self, id: AudioFiles) -> Self

Instead applies the specified setting or delay_mode to a specific track

pub fn all(self) -> Self

Instead applies the specified setting or delay_mode to every track in the channel

Trait Implementations

impl<Channel: ACBounds> Event for SettingsEvent<Channel>

where Self: Send + Sync + 'static,

const AUTO_PROPAGATE: bool = false

When true, this event will always attempt to propagate when triggered, without requiring a call to Trigger::propagate.

type Traversal = ()

The component that describes which Entity to propagate this event to next, when propagation is enabled.

fn register_component_id(world: &mut World) -> ComponentId

Generates the ComponentId for this event type.

fn component_id(world: &World) -> Option<ComponentId>

Fetches the ComponentId for this event type, if it has already been generated.