Debug Terminal

Introduction

The debug terminal is for developers to run commands while the game is running. It can be toggled in and out of view using the F1 key. When visible, the terminal is displayed in the bottom-left of the screen. Commands can be typed into the terminal using the keyboard.

The terminal uses the Command Pattern to action commands entered into the terminal.

Key Components

1. Terminal - Maintains the state of the terminal : Terminal.
2. Terminal Input Component - :KeyboardTerminalInputComponent.
3. Terminal Display - Displays the terminal's UI: TerminalDisplay.
4. Command - Defines actions to be taken when the command is triggered: e.g. DebugCommand.

Usage

Commands are composed of a name and an instance of Command and must be added to the commands map in Terminal.java using addCommand(). The following is an example for adding a debug command:

addCommand("debug", new DebugCommand());

When the name of the command followed by valid arguments is entered into the terminal, the command is actioned. As an example, the "debug" command accepts the arguments "on" and "off". So debug on or debug off would be valid commands.

Behind the Scenes