To use the Hiraeth Terminal System as a widget, you have two options:

1- Create the UI_Terminal Widget:

• Use the "Create Widget" function to create an instance of the UI_Terminal widget.
• Add the widget to the player viewport to make it visible.

Copy the following graph to get started:

2- Drag and Drop from UMG Palette:

Drag the UI_Terminal widget from the UMG palette located under the Hiraeth Terminal System category onto your canvas.

Customizing Default Variables:

After completing one of the above steps, you can customize the terminal's default variables, including:

• Default commands
• Help and error responses
• Password for authentication (if required)
• Default directory
• Theme
• Response delay between characters (in milliseconds)
• ...and more

You can use multiple terminals within the same widget. Each terminal can have its unique variables and directory.

To use the Hiraeth Terminal System as a World Actor, follow these steps:

1. Simply drag your custom instance or one of the example terminal actors provided with the system, such as BP_Terminal_01 or BP_Terminal_02 from the content browser into your world.
2. Set the default variables of the terminal actor according to your preferences.
    

Interacting with the Terminal Actor

The simplest method to interact with terminal world actors is as follows:

1. At your character's interaction event, obtain a reference to the hit actor.
2. Check if the hit actor implements the Hiraeth Terminal Interface using the “Does Implement Interface” function, If TRUE, call the HT Interact interface event.

NOTE: The HT Interact event triggers only for Terminal world actors and the PowerSwitch actor, which manages terminal power states. Automatic Possession: When the Interact event is triggered at terminal world actors the system automatically handles unpossessing your original character and possessing the terminal pawn.

Input and Character Re-possession:

-Use the Left Mouse Button to focus on the terminal.-Use Middle Mouse Button to Zoom.

-Move mouse Axis to Rotate. 

-Use the Right Mouse Button to leave the terminal and re-possess the original character.

IMPORTANT: Interacting with the terminal will unpossess your character (triggering the Event Unpossessed) and re-possess it on RMB (triggering the Event Possessed).

Ensure any custom logic tied to these events is accounted for in your implementation. Multiple Terminal Actors: It's possible to have as many terminal actors as needed. Each terminal actor can have its own unique ID and directory, enabling targeted interactions within the world environment.

In addition to the default variables found in the UI widget, the blueprint actor has the following extra variables:

It’s possible to create custom terminal instances using the BP_MasterTerminal blueprint.
This blueprint contains the terminal's Screen mesh, providing a foundation for adding custom terminal body and keyboard meshes.

Steps to Create A New Terminal Instance:

1- From the Content Browser, Go to:

Right click on the BP_MasterTerminal blueprint and select “Create Child Blueprint Class” to create a new terminal instance.

2- Add your custom terminal body and keyboard meshes to the new blueprint instance. Adjust the positioning and scaling of the screen to fit the terminal body.

3- Set the default variables specific to your terminal instance as needed.

Example Terminal Instances
The system includes two example terminal instances with different bodies to demonstrate customization options.

The BP_MasterTerminal has TurnOn and TurnOff functions. The UI_Terminal widget includes several event dispatchers which can be used to create custom gameplay interactions.

These event dispatchers are:

You can easily add new commands and responses at the DT_Commands datatable found at:

2- Click Add to add a new row.

3- Set the Command and the Response fields.

-Utilize placeholders such as: {command} (replaced with the entered command)

{name} (represents the name of the actor being interacted with).

Example Response
For instance, a response to the "Activate" command could be:

“Command {command} completed, {name} has been activated.”

Overriding Default Responses
You can override default responses set in the datatable on a per-actor basis.

To do so, follow these steps:

-Set OverrideDefaultResponses variable to TRUE: The "OverrideDefaultResponses" variable is found at the "GetActorData" interface function.

-Use TerminalBP Reference at the OnCommandReceived Interface: After implementing the "OnCommandReceived" interface event, use its TerminalBP reference to call the OverrideDefaultResponse function.

-Override Function Variables:
The override response function includes:
Response: Overrides the default response, utilizes placeholders {command} and {name}.
ResponseMaxDelay: Overrides the default response maximum delay.

-Unique Commands Datatable: Each Terminal instance can have its own unique commands datatable containing a unique set of commands and responses. To create a new set of commands and responses simply duplicate the DT_Commands datatable, add your new commands, then replace the Commands DT reference found at the Terminal widget or Terminal BP.

Directories:
Directories can be added to the Hiraeth Terminal System in two ways:

-Using BP_Directory Actor: Drag and drop the "BP_Directory" actor into the world. Set its default variables, identical to the Terminal BP actor variables. This method is particularly useful when utilizing the Terminal as a widget, eliminating the need for physical meshes.

-Using Terminal Actors: Add terminals to the world and assign a unique directory to each. Additionally, utilize the "BP_Directory" actor to add directories when using the Terminal in the world. This approach is beneficial in scenarios where a single terminal actor is available, but multiple directories must be accessed.

Files: Files can be integrated into the Hiraeth Terminal System using the following methods:

-Using BP_File Actor: Drag and drop the "BP_File" actor into the world. Set its default variables, including: -FileContent (text)-Name (text)-ID (string), -Directory (string).
This setup allows files to be downloaded using the "download " command.

-Use any Blueprint Actor as a File:
Transform any blueprint actor into a file by:

1- Implementing the Hiraeth Terminal Interface.
2- Setting the interface’s GetActorData function.
3- Implementing the OnCommandReceived interface event.
4- When the "download" command is received, override the default terminal response with your file's content.

To expand the visual options within the Hiraeth Terminal System, follow these steps to add a new theme:

1 - Open DT_Themes Datatable: Open the DT_Themes datatable where themes are managed.
2- Add New Theme: Add a new row to the datatable to represent the new theme.
3- Update Enum_Themes Enumeration: Add the name of the new theme to the Enum_Themes enumeration. This step ensures the new theme is recognized and accessible within the system.
4- Set Text and Background Colors: Once the new theme is added, set the desired text and background colors for the theme.

There are three default themes available, each emulating color combinations commonly found in terminals.

Interacting with other world actors or characters through the Hiraeth Terminal System can be achieved by following these steps:

1- Implement Hiraeth Terminal Interface:
At the actor class intended for interaction, implement the Hiraeth Terminal Interface.

2- Set GetActorData Variables:
Within the implemented interface, set the GetActorData variables, including the crucial ID variable. This step ensures proper identification and interaction with the target actor.

3- Implement OnCommandReceived Event:
Implement the OnCommandReceived event within the actor class. This event is triggered when the terminal sends a command specifically intended for this actor. 

4- Custom Logic and Responses:
Utilize the "SwitchOnString" node to create custom logic based on specific commands received by the actor.

Additionally, you can override default terminal responses using the Terminal BP reference, allowing for dynamic and tailored interactions based on gameplay requirements.

The Hiraeth Terminal Blueprint Interface offers a set of essential functions for interaction within the Hiraeth Terminal System. Here's a breakdown of each function: