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
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119

#![doc = include_str ! ("../README.md")]
#![deny(missing_docs)]

use bevy::prelude::*;
pub use bevy_console_derive::ConsoleCommand;
use bevy_egui::{EguiPlugin, EguiPreUpdateSet, EguiPrimaryContextPass};
use console::{ConsoleCache, block_keyboard_input, block_mouse_input};
use trie_rs::TrieBuilder;

#[cfg(feature = "default-commands")]
use crate::commands::{
    clear::{ClearCommand, clear_command},
    exit::{ExitCommand, exit_command},
    help::{HelpCommand, help_command},
};

pub use crate::console::{
    AddConsoleCommand, Command, ConsoleCommand, ConsoleCommandEntered, ConsoleConfiguration,
    ConsoleOpen, NamedCommand, PrintConsoleLine,
};
pub use crate::log::*;

use crate::console::{ConsoleState, console_ui, receive_console_line};
pub use clap;

mod color;
#[cfg(feature = "default-commands")]
mod commands;
mod console;
mod log;
mod macros;
/// Console plugin.
pub struct ConsolePlugin;

#[derive(SystemSet, Debug, Hash, PartialEq, Eq, Clone)]
/// The SystemSet for console/command related systems
pub enum ConsoleSet {
    /// Systems configuring commands at startup, only once
    Startup,

    /// Systems operating the console UI (the input layer)
    ConsoleUI,

    /// Systems executing console commands (the functionality layer).
    /// All command handler systems are added to this set
    Commands,

    /// Systems running after command systems, which depend on the fact commands have executed beforehand (the output layer).
    /// For example a system which makes use of [`PrintConsoleLine`] messages should be placed in this set to be able to receive
    /// New lines to print in the same frame
    PostCommands,
}

/// Run condition which does not run any command systems if no command was entered
fn have_commands(commands: MessageReader<ConsoleCommandEntered>) -> bool {
    !commands.is_empty()
}

/// builds the predictive search engine for completions
fn init(config: Res<ConsoleConfiguration>, mut cache: ResMut<ConsoleCache>) {
    debug!("lib.rs:init");
    let mut trie_builder = TrieBuilder::new();
    for cmd in config.commands.keys() {
        trie_builder.push(cmd);
    }

    for completions in &config.arg_completions {
        trie_builder.push(completions.join(" "));
    }

    cache.commands_trie = Some(trie_builder.build());
}

impl Plugin for ConsolePlugin {
    fn build(&self, app: &mut App) {
        app.init_resource::<ConsoleConfiguration>()
            .init_resource::<ConsoleState>()
            .init_resource::<ConsoleOpen>()
            .init_resource::<ConsoleCache>()
            .add_message::<ConsoleCommandEntered>()
            .add_message::<PrintConsoleLine>();

        #[cfg(feature = "default-commands")]
        app.add_console_command::<ClearCommand, _>(clear_command)
            .add_console_command::<ExitCommand, _>(exit_command)
            .add_console_command::<HelpCommand, _>(help_command);

        // after per-command startup
        app.add_systems(Startup, init.after(ConsoleSet::Startup))
            .add_systems(
                PreUpdate,
                (block_mouse_input, block_keyboard_input)
                    .after(EguiPreUpdateSet::ProcessInput)
                    .before(EguiPreUpdateSet::BeginPass),
            )
            .add_systems(
                EguiPrimaryContextPass,
                (
                    console_ui.in_set(ConsoleSet::ConsoleUI),
                    receive_console_line.in_set(ConsoleSet::PostCommands),
                ),
            )
            .configure_sets(
                EguiPrimaryContextPass,
                (
                    ConsoleSet::Commands
                        .after(ConsoleSet::ConsoleUI)
                        .run_if(have_commands),
                    ConsoleSet::PostCommands.after(ConsoleSet::Commands),
                ),
            );

        // Don't initialize an egui plugin if one already exists.
        // This can happen if another plugin is using egui and was installed before us.
        if !app.is_plugin_added::<EguiPlugin>() {
            app.add_plugins(EguiPlugin::default());
        }
    }
}