Struct amethyst_ui::UiSoundSystem

pub struct UiSoundSystem { /* fields omitted */ }

Handles any dispatches UiPlaySoundActions and plays the received sounds through the set Output.

Methods

impl UiSoundSystem

pub fn new(event_reader: ReaderId<UiPlaySoundAction>) -> Self

Constructs a default UiSoundSystem. Since the event_reader will automatically be fetched when the system is set up, this should always be used to construct the UiSoundSystem.

Trait Implementations

impl Debug for UiSoundSystem

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

Formats the value using the given formatter.

impl<'system_desc_a, 'system_desc_b> SystemDesc<'system_desc_a, 'system_desc_b, UiSoundSystem> for UiSoundSystemDesc

fn build(self, world: &mut World) -> UiSoundSystem

Builds and returns a System.

impl<'s> System<'s> for UiSoundSystem

type SystemData = (Write<'s, EventChannel<UiPlaySoundAction>>, Read<'s, AssetStorage<Source>>, Option<Read<'s, Output>>)

The resource bundle required to execute this system.

fn run(&mut self, (sound_events, audio_storage, audio_output): Self::SystemData)

Executes the system with the required system data.

fn running_time(&self) -> RunningTime

Returns a hint how long the system needs for running. This is used to optimize the way they're executed (might allow more parallelization).

fn accessor(&'b self) -> AccessorCow<'a, 'b, Self>

Return the accessor from the [SystemData].

fn setup(&mut self, world: &mut World)

Sets up the World using Self::SystemData::setup.

fn dispose(self, world: &mut World)

Performs clean up that requires resources from the World. This commonly removes components from world which depend on external resources.