Package com.deco2800.game.ui.terminal

Class Terminal

java.lang.Object

com.deco2800.game.components.Component

com.deco2800.game.ui.terminal.Terminal

public class Terminal
extends Component

State tracker for a debug terminal. Any commands to be actioned through the terminal input should be added to the map of commands.

Field Summary

Fields inherited from class com.deco2800.game.components.Component

enabled, entity

Constructor Summary

Constructors

Constructor	Description
Terminal()
Terminal(Map<String,Command> commands)

Method Summary

Modifier and Type	Method	Description
void	addCommand(String name, Command command)	Adds a command to the list of valid terminal commands.
void	appendToMessage(char character)	Appends the character to the end of the entered message.
String	getEnteredMessage()
void	handleBackspace()	Removes the last character of the entered message.
boolean	isOpen()
boolean	processMessage()	Processes the completed message entered by the user.
void	setClosed()	Closes the terminal and clears the stored message.
void	setEnteredMessage(String text)	Sets the text shown on the terminal
void	setOpen()	Opens the terminal.
void	toggleIsOpen()	Toggles between the terminal being open and closed.

Methods inherited from class com.deco2800.game.components.Component

create, dispose, earlyUpdate, getEntity, setEnabled, setEntity, toString, triggerEarlyUpdate, triggerUpdate, update

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

Terminal

public Terminal()

Terminal

public Terminal(Map<String,Command> commands)

Method Details

getEnteredMessage

public String getEnteredMessage()

Returns:

message entered by user

isOpen

public boolean isOpen()

Returns:

console is open

toggleIsOpen

public void toggleIsOpen()

Toggles between the terminal being open and closed.

setOpen

public void setOpen()

Opens the terminal.

setClosed

public void setClosed()

Closes the terminal and clears the stored message.

addCommand

public void addCommand(String name,
 Command command)

Adds a command to the list of valid terminal commands.

Parameters:

name - command name

command - command

processMessage

public boolean processMessage()

Processes the completed message entered by the user. If the message corresponds to a valid command, the command will be actioned.

Returns:

true if command handled, false otherwise

appendToMessage

public void appendToMessage(char character)

Appends the character to the end of the entered message.

Parameters:

character - character to append

handleBackspace

public void handleBackspace()

Removes the last character of the entered message.

setEnteredMessage

public void setEnteredMessage(String text)

Sets the text shown on the terminal

Parameters:

text - Text to show