Jazz2::UI::InGameConsole class

#include <Jazz2/UI/InGameConsole.h>

In-game console.

Developer/cheat console overlaid on the level. It shows a scrollable log of messages classified by MessageLevel and accepts typed commands with a navigable input history.

Base classes

class Canvas

Canvas.

Public static functions

static void Clear()

Clears the console and its history.

Constructors, destructors, conversion operators

InGameConsole(LevelHandler* levelHandler)

Creates a new instance.

~InGameConsole()

Public functions

void OnInitialized()

Called when the console is fully initialized.

void OnUpdate(float timeMult) override

Called every frame to update the node state.

auto OnDraw(RenderQueue& renderQueue) -> bool override

Called when the node needs to be drawn, returning true if a command was added.

void OnKeyPressed(const KeyboardEvent& event)

Called when a key is pressed.

void OnTextInput(const TextInputEvent& event)

Called when text is entered.

auto IsVisible() const -> bool

Returns true if the console is visible.

void Show()

Shows the console.

void Hide()

Hides the console.

void WriteLine(MessageLevel level, String line)

Writes a line to the console history.