Enum bevy_kira_components::sources::audio_file::AudioFileEndBehavior

pub enum AudioFileEndBehavior {
    Nothing,
    RemoveComponents,
    Despawn {
        recursive: bool,
    },
}

Describe how the audio components (and entity) will react to the audio source reaching the end of the file.

Variants

Nothing

Do nothing. This is the default behavior.

RemoveComponents

Remove all components in the AudioFileBundle. This will also clean up audio resources.

Despawn

Despawn the entity as a whole. This is only useful for cases where the entity only serves as an audio source, will yeet your entity out of the world.

Fields

recursive: bool

Despawning this entity will also despawn all children.

Trait Implementations

impl Clone for AudioFileEndBehavior

fn clone(&self) -> AudioFileEndBehavior

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Component for AudioFileEndBehavior

where Self: Send + Sync + 'static,

const STORAGE_TYPE: StorageType = bevy::ecs::component::StorageType::SparseSet

A constant indicating the storage type used for this component.

fn register_component_hooks(_hooks: &mut ComponentHooks)

Called when registering this component, allowing mutable access to its [ComponentHooks].

impl Debug for AudioFileEndBehavior

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for AudioFileEndBehavior

fn default() -> AudioFileEndBehavior

Returns the “default value” for a type.

impl Copy for AudioFileEndBehavior