Struct cvars_console_fyrox::FyroxConsole

pub struct FyroxConsole { /* private fields */ }

In-game console for the Fyrox game engine.

Implementations

impl FyroxConsole

pub fn new(ui: &mut UserInterface) -> Self

Create a new console. Build its UI but keep it closed.

pub fn resized(&mut self, ui: &mut UserInterface, width: f32, height: f32)

Call this when the window is resized.

pub fn ui_message( &mut self, ui: &mut UserInterface, cvars: &mut impl SetGet, msg: &UiMessage )

Call this for every Fyrox UI message. The console will only react to them if it’s open.

Example

while let Some(msg) = engine.user_interface.poll_message() {
    console.ui_message(&msg);
    // ... Whatever else you do with UI messages ...
}

pub fn is_open(&self) -> bool

Returns true if the console is currently open.

pub fn open(&mut self, ui: &mut UserInterface, was_mouse_grabbed: bool)

Open the console.

If your game grabs the mouse, you can save the previous state here and get it back when closing.

pub fn close(&mut self, ui: &mut UserInterface) -> bool

Close the console. Returns whether the mouse was grabbed before opening the console.

It’s #[must_use] so you don’t accidentally forget to restore it. You can safely ignore it if you don’t grab the mouse.