Struct CommandPlugin 

pub struct CommandPlugin<I = (), O = ()> { /* private fields */ }

A command plugin. This registers:

• all commands registered to this plugin
• events with the supplied markers, which are () by default
• a dispatcher system to handle input events and dispatch commands.

Commands may be added with the CommandPlugin::register_command.
Argument types may be added with the CommandPlugin::register_argument.

Multiple instances of this plugin may be added to the same app, but the generic parameters I and O must differ from any other existing ones. The I parameter is used for the CommandInput event, and the O parameter is used for the CommandOutput event.

Other resources and registries used by this plugin are also parametrised with the I and O parameters.

Implementations

impl<I, O> CommandPlugin<I, O>

where I: Send + Sync + 'static, O: Send + Sync + 'static,

pub fn new() -> Self

Creates a new command plugin with no commands and no parsers.

To add the default help command, call CommandPlugin::with_default_commands.
To add the default arguments, call CommandPlugin::with_default_args.

pub fn register_command(&self, command: CommandBuilder) -> &Self

Register a command. The command handler will run on the Update schedule, as the dispatcher is registered to the same schedule.

pub fn register_argument<A: Argument>(&self) -> &Self

Register an argument.

pub fn with_default_commands(&self) -> &Self

Register the “default” commands to this plugin.

The default commands are:

• help: Provides a description and syntax for the command and its nodes

pub fn with_default_args(&self) -> &Self

Register the “default” argument types to this plugin.

The default argument types are the ones in the builtins::args module.

Trait Implementations

impl<I, O> Default for CommandPlugin<I, O>

where I: Send + Sync + 'static, O: Send + Sync + 'static,

fn default() -> Self

Returns the “default value” for a type.

impl<I, O> Plugin for CommandPlugin<I, O>

where I: Send + Sync + 'static, O: Send + Sync + 'static,

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

Configures the App to which this plugin is added.

fn ready(&self, _app: &App) -> bool

Has the plugin finished its setup? This can be useful for plugins that need something asynchronous to happen before they can finish their setup, like the initialization of a renderer. Once the plugin is ready, finish should be called.

fn finish(&self, _app: &mut App)

Finish adding this plugin to the App, once all plugins registered are ready. This can be useful for plugins that depends on another plugin asynchronous setup, like the renderer.

fn cleanup(&self, _app: &mut App)

Runs after all plugins are built and finished, but before the app schedule is executed. This can be useful if you have some resource that other plugins need during their build step, but after build you want to remove it and send it to another thread.

fn name(&self) -> &str

Configures a name for the Plugin which is primarily used for checking plugin uniqueness and debugging.

fn is_unique(&self) -> bool

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