Struct amethyst_ui::UiCreator

pub struct UiCreator<'a, C = NoCustomUi, W = u32> where
    C: ToNativeWidget<W>,
    W: WidgetId,  { /* fields omitted */ }

Ui Creator, wrapper around loading and creating a UI directly.

The recommended way of using this in States is with world.exec.

Type parameters:

• C: custom UI widget
• W: Type used for Widget IDs

Example:

let ui_handle = world.exec(|creator: UiCreator| {
    creator.create("renderable.ron", ())
});

Methods

impl<'a, C, W> UiCreator<'a, C, W> where
    C: ToNativeWidget<W> + for<'de> Deserialize<'de> + Send + Sync + 'static,
    W: WidgetId + DeserializeOwned, 

pub fn create<N, P>(&mut self, name: N, progress: P) -> Entity where
    N: Into<String>,
    P: Progress, 

Create a UI.

Will load a UI from the given ron file, create an Entity and load the UI with that Entity as the root of the UI hierarchy.

Parameters:

• name: Name of a ron asset in the UiFormat format
• progress: Progress tracker

Returns

The Entity that was created that will form the root of the loaded UI.

Trait Implementations

impl<'a, C, W> SystemData<'a> for UiCreator<'a, C, W> where
    C: ToNativeWidget<W>,
    W: WidgetId,
    UiLoader<'a, C, W>: SystemData<'a>,
    Entities<'a>: SystemData<'a>,
    WriteStorage<'a, Handle<UiPrefab<C::PrefabData, W>>>: SystemData<'a>, 

fn setup(world: &mut World)

Sets up the system data for fetching it from the World.

fn fetch(world: &'a World) -> Self

Fetches the system data from World. Note that this is only specified for one concrete lifetime 'a, you need to implement the SystemData trait for every possible lifetime.

fn reads() -> Vec<ResourceId>

Returns all read dependencies as fetched from Self::fetch.

fn writes() -> Vec<ResourceId>

Returns all write dependencies as fetched from Self::fetch.