Debug Terminal

Introduction

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

The terminal uses the Command Pattern to action entered commands.

Key Components

1. Terminal - Maintains the state of the terminal and actions commands: Terminal.
2. Terminal Input Component - Processes input and triggers state changes in the terminal: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

The terminal can be toggled in and out of view using the F1 key.

Commands can be triggered by typing into the terminal and pressing enter. When the name of the command followed by valid arguments is entered, 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.The "weapon" command lets you switch the player's equipped weapon for testing. It accepts "knife", "sword", or "bow" as arguments. So weapon knife, weapon sword, or weapon bow would be valid commands (see the Weapons page for weapon-specific testing steps).

The "dialogue" and "cutscene" commands play a dialogue or cutscene file for testing, e.g. dialogue demo or cutscene demovideo (see Cutscenes and Dialogue). File names may contain letters, digits, _, - and ..

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

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