Struct Console 

pub struct Console {
    pub visible: bool,
    pub input: String,
    pub cursor: usize,
    pub log: VecDeque<LogLine>,
    pub scroll_offset: usize,
    /* private fields */
}

Fields

visible: bool

Whether the console window is visible.

input: String

Current input buffer.

cursor: usize

Cursor position in the input buffer (byte offset).

log: VecDeque<LogLine>

Output log (newest last).

scroll_offset: usize

Scroll offset: 0 = bottom (newest), N = scroll N lines up.

Implementations

impl Console

pub fn new() -> Self

pub fn register_command(&mut self, cmd: Command)

pub fn type_char(&mut self, c: char)

Insert a character at the cursor position.

pub fn backspace(&mut self)

Delete the character before the cursor (Backspace).

pub fn delete_forward(&mut self)

Delete the character at the cursor (Delete key).

pub fn cursor_left(&mut self)

Move cursor left by one character.

pub fn cursor_right(&mut self)

Move cursor right by one character.

pub fn cursor_home(&mut self)

Move cursor to start of input.

pub fn cursor_end(&mut self)

Move cursor to end of input.

pub fn clear_input(&mut self)

Clear the entire input line.

pub fn history_prev(&mut self)

Navigate to the previous command in history (up arrow).

pub fn history_next(&mut self)

Navigate to the next command in history (down arrow).

pub fn tab_complete(&mut self)

Attempt tab completion on the current input.

pub fn submit(&mut self) -> ConsoleAction

Submit the current input line. Returns any special engine actions.

pub fn scroll_up(&mut self, lines: usize)

pub fn scroll_down(&mut self, lines: usize)

pub fn scroll_to_bottom(&mut self)

pub fn scroll_to_top(&mut self)

pub fn visible_lines(&self) -> impl Iterator<Item = &LogLine>

Get the slice of log lines currently visible in the console window.

pub fn input_before_cursor(&self) -> &str

The input line split at the cursor for rendering a blinking cursor.

pub fn input_after_cursor(&self) -> &str

pub fn toggle(&mut self)

Toggle console visibility.

pub fn print(&mut self, line: LogLine)

Push a log line from external code.

pub fn println(&mut self, text: impl Into<String>)

pub fn print_warn(&mut self, text: impl Into<String>)

pub fn print_error(&mut self, text: impl Into<String>)

pub fn print_success(&mut self, text: impl Into<String>)

Trait Implementations

impl Default for Console

fn default() -> Self

Returns the “default value” for a type.