HUDs are used to display information of the player or add interactable functionality.
HUDs are found in UI > HUDs.
General Settings #
The general settings define settings used by all HUDs.
HUD Settings #
Define timeouts for cycling through status effects and checking combatant affiliation for HUD displays (e.g. in case a combatant changes factions, leading to a HUD being displayed or not).
Raycast Settings #
Define the raycast settings used by HUDs and object contents to determine if the cursor is over an object instance.
Turn Flash Settings #
Optionally flash the HUD of a combatant who start’s their turn.
Schematics #
Define the default schematics for HUDs.
HUDs can use schematics to animate opening or closing them, e.g. to fade them in/out and move or scale them. See examples in this tutorial.
Additionally, you can use conditional schematics when defined conditions are valid or invalid. This can be used to e.g. scale up the HUD of a combatant who’s currently in turn and scale it down when it’s not in turn.
The HUD is available as local selected data via the data key ui. The HUD’s content (user) is available as local selected data via the data key action.
Status Value UI #
Define the default status value UI used by all status values. Individual status values can override the default setup with a custom one.
Displaying a list of status values usually uses a UI setup of a status value. The actual setup depends on the used UI module, e.g. in Unity the Unity UI module will use a prefab for this. See this tutorial for example setups.
You can set up different UI setups by using UI keys. The default UI setup (without key) is used if no matching key is found. This allows you to have differently styled status values in parts of the UI. E.g. a player HUD could show a value bar, while a stats menu could just display names and values.
Status Effect UI #
Define the default status effect UI used by all status effects. Individual status effects can override the default setup with a custom one.
Displaying a list of status effects usually uses a UI setup of a status effect. The actual setup depends on the used UI module, e.g. in Unity the Unity UI module will use a prefab for this. See this tutorial for example setups.
You can set up different UI setups by using UI keys. The default UI setup (without key) will be used if no matching key is found. This allows you to have differently styled status effects in parts of the UI. E.g. a player HUD could show only the icons, while a stats menu could just display names.
Research Item UI #
Define the default research item UI used by all research items. Individual content types, research trees and research items can override the default setup with a custom one.
Displaying a research item in menu screens or HUDs can use a UI setup of the research item. The actual setup depends on the used UI module, e.g. in Unity the Unity UI module will use a prefab for this.
You can set up different UI setups by using UI keys. The default UI setup (without key) will be used if no matching key is found. This allows you to have differently styled displays in parts of the UI. E.g. a HUD showing the player’s currently in-research items with a value bar showing the duration, while a menu screen shows a more detailed setup.
HUDs #
asdf
HUD Type #
The following HUD types are available.
Battle Actions #
Displays the battle actions currently registered with the system in the order they’re added, e.g. scheduled, casting and active actions.
A HUD is created for each individual action, using the action as the HUD user.
Combatant #
Displays information about combatants.
Each combatant is displayed in it’s own individual HUD.
Combatant Object #
Displays information about combatant at the position of the combatant’s object instance.
Each combatant is displayed in it’s own individual HUD.
Console #
Displays the in-game console. Please note that console HUDs use a regular UI box to display content.
Control #
Control HUDs are intended for creating virtual controls like on-screen buttons and joysticks.
However, virtual controls can be added to any HUD and UI box.
Information #
Displays information, e.g. game time, variables, etc.
Information HUDs can either be displayed on their own or based on a user (e.g. an object, the player, etc.) and display information based on that.
When the HUD has a user, it can also be displayed based on the user’s object position on screen.
Interaction #
Interaction HUDs are used to display information of available interactions, either from within the player’s Interaction Controller or below the mouse cursor.
The HUD can optionally be displayed at the position of the interaction or player (i.e. on-screen position of their objects). Information displayed within the HUD depends on the displayed interaction, e.g. using a Object Content component on an interaction allows defining content information like name or description and use that in the HUD.
Latest Turn #
Displays the combatant that has the latest turn until the next combatant’s turn comes up.
The HUD will only be displayed in running battles.
Navigation Bar #
Displays a navigation bar, e.g. cardinal directions, nearby interactions, etc.
Object #
Displays information at the position of an object instance.
Quest #
Displays a list of quests, their tasks and requirements.
Quest task requirements can also display their quantities using value bars.
Timebar #
Displays a timebar with individual HUDs for each combatant, moving along the timebar to represent their current timebar value. The HUD is only visible during battles using the Active Time type battle system.
Tooltip #
Tooltip HUDs display information of the current tooltip content.
The tooltip content is whatever is currently below the cursor (or a locked content from some UI selection), e.g. an object with content information (e.g. the object of a combatant or using Object Content components) or a part of a UI that has a tooltip (e.g. a button displayed for an item).
Turn Order #
Displays the turn order of Turn Based battles (i.e. the order in which combatants perform their actions).
The HUD will only be displayed in running Turn Based battles.
Display Conditions #
Displaying a HUD can depend on certain conditions.
You can define Game State and Variable conditions that have to be valid to display the HUD.
Some HUD types can also have additional settings, e.g. interaction HUDs can be limited to certain organizer types.
Showing HUDs #
If a HUD is displayed automatically is defined by it’s Auto Display setting. Additionally, you can toggle displaying the HUD on/off using the Toggle Key settings.
When not displayed automatically, you can call a HUD using a Call HUD node in a schematic.
You can also use an Add HUD (to Object) component to add a HUD instance for the object it’s attached to.
HUDs as Templates #
You’ll often use a HUD as a template, e.g. to add content information to a button or provide combatant information in menus.
When a HUD is only used as a template, make sure to disable Auto Display in the HUD’s settings. You can also ignore any display conditions and other settings of the HUD that doesn’t relate to displayed content. E.g. a Combatant type HUD doesn’t have to define for which combatants (player, enemy, etc.) it’d be dispalyed when used as a template.
UI System Types #
Defining the actual position, size, style and content of a HUD depends on the used UI system type (see UI settings documentation for details).
Unity UI #
Using Unity UI in Unity uses prefabs with a HUD component (for regular HUDs) or HUD Content Provider component (for HUDs only used as templates) at it’s root.
You can create a ready to use setup via the scene view’s context menu: ORK Framework > HUD has different layout variants available.

