Struct bevy_quickmenu::QuickMenuPlugin

pub struct QuickMenuPlugin<S>where
    S: ScreenTrait + 'static,{ /* private fields */ }

The quickmenu plugin. It requires multiple generic parameters in order to setup. A minimal example. For a full explanation refer to the examples or the README.

#[derive(Debug, PartialEq, Eq, Clone, Copy, Hash)]
enum Actions {
    SoundOn,
    SoundOff,
}

#[derive(Debug)]
enum MyEvent { SoundChanged }

impl ActionTrait for Actions {
   type State = CustomState;
   type Event = MyEvent;
   fn handle(&self, state: &mut CustomState, event_writer: &mut EventWriter<MyEvent>) {
        // handle action
   }
}

#[derive(Debug, PartialEq, Eq, Clone, Copy, Hash)]
enum Screens {
    Root,
    Sound,
}

impl ScreenTrait for Screens {
    fn resolve(&self, state: &CustomState) -> Menu<Actions, Screens, CustomState> {
        root_menu(state)
    }
}

fn root_menu(_state: &CustomState) -> Menu<Actions, Screens, CustomState> {
    Menu {
        id: "root",
        entries: vec![
            MenuItem::headline("Sound Control"),
            MenuItem::action("Sound On", Actions::SoundOn),
            MenuItem::screen("Sound Off", Actions::SoundOff),
        ]
    }
}

#[derive(Debug, Clone)]
struct CustomState { sound_on: bool }

impl Plugin for MyApp {
  fn build(&self, app: &mut App) {
    app
        .add_event::<MyEvent>()
        .add_plugin(QuickMenuPlugin::<CustomState, Actions, Screens>::default())
  }
}

Implementations

impl<S> QuickMenuPlugin<S>where
    S: ScreenTrait + 'static,

pub fn new() -> Self

pub fn with_options(options: MenuOptions) -> Self

Trait Implementations

impl<State, A, S> Plugin for QuickMenuPlugin<S>where
    State: 'static + Send + Sync,
    A: ActionTrait<State = State> + 'static,
    S: ScreenTrait<Action = A, State = State> + 'static,

fn build(&self, app: &mut App)

Configures the [App] to which this plugin is added.

fn name(&self) -> &str

Configures a name for the [Plugin] which is primarily used for debugging.

fn is_unique(&self) -> bool

If the plugin can be meaningfully instantiated several times in an App, override this method to return false.