Struct simpleterm::terminal::Terminal

pub struct Terminal {
    pub window: PistonWindow,
    pub bg_color: Color,
    pub fg_color: Color,
    pub font_size: FontSize,
    pub scanlines: bool,
    // some fields omitted
}

A terminal stores a PistonWindow, background and foreground colors, a font, fontsize, and glyph cache, and the current message and input strings.

Fields

window: PistonWindow

The window that displays our terminal. See PistonWindow.

bg_color: Color

The background color of our terminal.

fg_color: Color

The foreground color of our terminal.

font_size: FontSize

The font size of our terminal.

scanlines: bool

Whether or not to use scanlines

Implementations

impl Terminal

pub fn new(
    title: &str,
    bg: Color,
    fg: Color,
    font: &str,
    font_size: u32
) -> Terminal

Creates a new window with the given title, colors, and font info

let mut term: Terminal = Terminal::new("simpleterm test", DARK_GREY, GOLD, "LeagueSpartan-Regular.ttf", 32);

pub fn ask(&mut self, message: &str) -> String

Types out the given message, then waits for the user to type something and returns that input string.

let user_input: String = term.ask("This will wait for the user enter input!");

pub fn display_art(&mut self, art: &str, time: Duration)

Displays an ascii art string centered on the terminal. This uses 10pt font and a monospace font.

term.display_art(GEO, Duration::from_secs(2));

pub fn show(&mut self, message: &str, time: Duration)

Types out the given message, then waits for the given amount of time to continue.

term.show("This will wait for 1 second!", Duration::from_secs(1));

pub fn tell(&mut self, message: &str)

Types out the given message, then waits for the user to press Enter to continue.

term.tell("This will wait for the user to hit enter!");

pub fn resize(&mut self, new_size: Size)

Closes the current window and creates a new one with the given (x, y) Size.

term.resize((800, 600).into());

pub fn set_font(&mut self, font: &str, size: FontSize)

Loads a new font from the given font filename and sets the given font size

term.set_font("LeagueMono-Regular.ttf", 24);

pub fn set_colors(&mut self, bgc: Color, fgc: Color)

Changes the terminal's background and foreground to the given colors. The change will be apparent in the next text command.

term.set_colors(DARK_GREY, CRIMSON);