bevy_console 0.17.1

dev console for bevy
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52

use bevy::prelude::*;
use clap::Parser;

use crate as bevy_console;
use crate::{ConsoleCommand, ConsoleConfiguration, reply};

/// Prints available arguments and usage
#[derive(Parser, ConsoleCommand)]
#[command(name = "help")]
pub(crate) struct HelpCommand {
    /// Help for a given command
    command: Option<String>,
}

pub(crate) fn help_command(
    mut help: ConsoleCommand<HelpCommand>,
    mut config: ResMut<ConsoleConfiguration>,
) {
    match help.take() {
        Some(Ok(HelpCommand { command: Some(cmd) })) => match config.commands.get_mut(cmd.as_str())
        {
            Some(command_info) => {
                help.reply(command_info.render_long_help().to_string());
            }
            None => {
                reply!(help, "Command '{}' does not exist", cmd);
            }
        },
        Some(Ok(HelpCommand { command: None })) => {
            debug!("No command received in help");
            reply!(help, "Available commands:");
            let longest_command_name = config
                .commands
                .keys()
                .map(|name| name.len())
                .max()
                .unwrap_or(0);
            for (name, cmd) in &config.commands {
                let mut line = format!("  {name}{}", " ".repeat(longest_command_name - name.len()));
                line.push_str(&format!(
                    " - {}",
                    cmd.get_about()
                        .map(|about| about.to_string())
                        .unwrap_or_default()
                ));
                help.reply(line);
            }
            help.reply("");
        }
        _ => {}
    }
}