Struct amethyst_ui::UiButtonSystem

pub struct UiButtonSystem { /* fields omitted */ }

This system manages button mouse events. It changes images and text colors, as well as playing audio when necessary.

It's automatically registered with the UiBundle.

Methods

impl UiButtonSystem

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

Creates a new instance of this structure

Trait Implementations

impl Debug for UiButtonSystem

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, UiButtonSystem> for UiButtonSystemDesc

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

Builds and returns a System.

impl<'s> System<'s> for UiButtonSystem

type SystemData = (WriteStorage<'s, UiImage>, WriteStorage<'s, UiText>, ReadExpect<'s, ParentHierarchy>, Write<'s, EventChannel<UiButtonAction>>)

The resource bundle required to execute this system.

fn run(
    &mut self,
    (image_storage, text_storage, hierarchy, button_events): 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.