Struct cvars_console::Console

pub struct Console {
    pub prompt: String,
    pub history: Vec<HistoryLine>,
    pub history_view_end: usize,
    /* private fields */
}

Engine-independant parts of the in-game console.

Fields

prompt: String

The current contents of the prompt.

Should always be kept in sync with what’s displayed in the UI.

history: Vec<HistoryLine>

Input and output history.

You should prepend input lines with “> “ or something similar when displaying them.

history_view_end: usize

Where we are in the history view when scrolling using page up and down keys.

This index is one past the last line to be displayed at the bottom so that you can use it as the high end of a range.

Implementations

impl Console

pub fn new() -> Self

Create a new console backend.

pub fn history_back(&mut self)

Go back in command history.

Save the prompt so that users can go back in history, then come back to present and get what they typed back.

pub fn history_forward(&mut self)

Go forward in command history.

Restore the saved prompt if get to the end.

pub fn history_scroll_up(&mut self, count: usize)

Scroll up in the history view.

pub fn history_scroll_down(&mut self, count: usize)

Scroll down in the history view.

pub fn enter(&mut self, cvars: &mut dyn SetGet)

The user pressed enter - process the line of text

pub fn print<S: Into<String>>(&mut self, text: S)

Print a line in the console and save it to history as output.

Trait Implementations

impl Clone for Console

fn clone(&self) -> Console

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Console

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Console

fn default() -> Console

Returns the “default value” for a type.