ORK 4 RPG Framework Logo
  • ORK 4 GUIDE
    • Documentation
    • Tutorials
    • Extensions
    • API
  • ORK 3 GUIDE
    • Documentation
    • Tutorials
    • API
  • Support
  • Forum
  • Get ORK

ORK 4 Documentation

  • Getting Started
    • Welcome
    • First Steps (Unity)
  • Features
    • The Status System
    • Schematics
    • Schematic Nodes
    • Dialogue Importer
    • Variables
    • Selected Data
  • Components
    • Battle Components
    • Combatant Components
    • Control Components
    • Cursor Prefab Components
    • Game Starters
    • Interactable Components
    • Move AI Components
    • Scene Setup Components
  • Editor
    • The ORK 4 Editor
    • Sections & Sub-Sections
    • Node Editor
    • Schematic Editor
    • Asset Sources
    • Unity Overlay Toolbar
  • Section: System
    • System Settings
    • Languages
    • Organizer Types
    • Game States & Conditions
    • General Condition Templates
    • Object Pools
    • Prefab Savers
    • Scene Connections
  • Section: Controls
    • Game Controls
    • Interaction Settings
    • Player Controls
    • Camera Controls
    • Input Keys
    • Control Maps
    • Camera Positions
    • Battle Camera
  • Section: Gameplay
    • Game Settings
    • Formulas
    • Difficulties
    • Shortcut Slots & Settings
    • Custom Settings & Global Custom Settings
    • Global Machines
    • Machine Templates
  • Section: Status
    • Status Values
    • Status Effects
    • Attack Modifiers
    • Defence Modifiers
    • Abilities & Ability Developments
    • Status Developments
    • Research Trees
    • Damage Types
    • Status Bonuses & Templates
    • Status Condition Templates
  • Section: Inventory
    • Inventory Settings
    • Inventory Containers
    • Currencies
    • Items
    • AI Rulesets
    • Crafting Recipes
    • Equipment Slots & Slot Set Templates
    • Equipment & Available Equipment Templates
    • Shops
    • Loot
  • Section: Combatants
    • Combatants
    • Combatant Groups
    • Class Slots
    • Classes
    • Factions & Faction Benefits
    • Animations
    • Move AIs
    • Formations
    • Action Combos
  • Section: Battles
    • Battle Systems
    • Turn Based Battles
    • Active Time Battles
    • Real Time Battles
    • Phase Battles
    • Battle Spots
    • Battle AIs
    • Battle Actions Settings
    • Special Commands Settings
    • Target Settings
    • Target Selection Templates
    • Battle Range Templates
    • Battle Grid Settings
    • Battle Grid Highlights
    • Battle Grid Cell Types
    • Battle Grid Formations
  • Section: Content
    • Content Types
    • Music
    • Sound Templates
    • Areas
    • Teleports
    • Quests & Quest Tasks
    • Logs & Log Texts
    • Object Contents
  • Section: UI
    • UI Settings
    • UI Layers
    • UI Layouts
    • UI Boxes
    • HUDs
    • Notifications
    • Cursor Settings
  • Section: Menus
    • Start Menu
    • Save Game Settings
    • Option Categories
    • Menu Screens
    • Menu Requirements
    • Battle Menus
    • Loot Dialogues
    • Item Collection
    • Combatant Selections
    • Quantity Selections
    • Shop Layouts
  • Section: Texts
    • Text Settings
    • Formatting Settings
    • Flying Texts
    • Use Cost Display
    • Status Preview Display
    • Bonus Display
    • Status Change Display
    • Console Settings & Console Types
    • Text Codes
  • Sections: Editor
    • Editor Settings
    • Backups
    • Variables
    • Plugins
  • Scripting
    • Access Handler
    • Custom Nodes
    • Custom Save Data
    • Custom Component Save Data

ORK 4 Tutorials

  • ORK 4 Unity Quickstart Tutorials (3D)
    • ORK 4 Unity Quickstart 3D
    • 01 Initial ORK Setup
    • 02 Player Setup
    • 03 Music & Scenes
    • 04 UI System Setup
    • 05 UI Boxes
    • 06 Flying Texts
    • 07 Status Values
    • 08 Status Effects
    • 09 First Abilities
    • 10 Fighter Setup
    • 11 First Enemies & Battle AI
    • 12 Battle System Setup
    • 13 Animating Battle Start and End
    • 14 Random Battles
    • 15 Animating Actions
    • 16 Player Battle HUD
    • 17 Elemental Attacks
    • 18 Animating More Actions
    • 19 Inventory & Loot
    • 20 Equipment
    • 21 Loot, Start Equipment & Viewers
    • 22 Magic Abilities
    • 23 Caster Setup
    • 24 More Enemies
    • 25 Start Menu & Save Games
    • 26 Menu Screens
    • 27 Interactions
    • 28 Item Collectors
    • Quickstart Extended
  • Battle Tutorials
    • Active Time Battles
    • Phase Battles
    • Real TT 01 Real Time Battles & Tab Targeting
    • Real TT 02 Control Map, Use Ranges & Battle Area
    • Real TT 03 Camera Control, Battle AI & Reuse Time
    • Real TT 04 Damage Detection, Action Animation & Player HUD
    • Real TT 05 Switch Player & Final Adjustments
    • Hit & Miss
    • Critical Hits
    • Cast Time
    • Reuse Time
    • Grid 01: Battle Grid Setup
    • Grid 02: Highlights
    • Grid 03: Cell Types
    • Grid 04: Move Command
    • Grid 05: Scene Grid Setup
    • Grid 06: Battle Ready
    • Grid 07 Use & Affect Ranges
    • Grid 08: Better Camera Control
  • Gameplay Tutorials
    • Multiple Interaction Controllers
    • Player Group Spawn & Follow
    • Spawn Hunting Enemies
    • Gamepad Controls (Unity Input System)
    • Combined Inputs
    • Control Map for Keyboard (Shortcuts)
    • Control Map for Gamepad (Shortcuts)
    • Quests 01: Menu Screen
    • Quests 02: Hunting
    • Quests 03: Collect Potion Materials
    • Quests 04: Collect Equipment Materials
    • Quests 05: Quest Mark HUDs
    • Crafting 01: Menu Screen
    • Crafting 02: Materials & Recipes
    • Crafting 03: Getting Materials
    • Crafting 04: Proficiency & Critical Outcome
    • Shop
    • Inventory Containers
  • Schematics Tutorials
    • UI Animation Schematics
    • Flying Text Animation Schematics
    • HUD Conditional Schematics
  • UI Tutorials
    • Unity UI: Initial Setup
    • Unity UI: Status Value UI Setup
    • Unity UI: Status Effect UI Setup
    • Unity UI: Shortcut UI Setup
    • Unity UI: Dragging Notification
    • Unity UI: Interaction HUD
    • Unity UI: Shortcut HUD
    • Unity UI: Turn Order HUD
    • Unity UI: Cast Time HUD
    • Unity UI: Quest HUD
    • Unity UI: Tooltip HUD
    • Unity UI: Move Range HUD
    • Menus 01 UI Box Setup
    • Menus 02 Template HUDs
    • Menus 03 Menu Setup
    • Menus 04 Main Menu
    • Menus 05 Inventory
    • Menus 06 Equipment
    • Menus 07 Ability
    • Menus 08 Group
    • Menus 09 Quest
    • Menus 10 Crafting
  • Module 01: Status System
    • Introduction to Modular Tutorials
    • M01.1: Status Values
      • Introduction to Status Values
      • Health
      • Mana
      • Barrier
      • Base Experience
      • Class Experience
      • Spendable Experience
      • Normal Stats
    • M01.2: Modifiers
      • Introduction to Modifiers
      • Element
      • Attack Type
      • Size
      • Race
    • M01.3: Status Effects
      • Introduction to Status Effects
      • Buffs
      • Debuffs
      • Poison
      • Regeneration
      • Blind
      • Stun
      • Sleep
      • Silence
      • Enchants
      • Charm
      • Doom
      • Reflect
  • Module 02: Actions
    • Introduction to Actions
    • M02.1: Formulas
      • Introduction to Formulas
      • Physical Damage Formula
      • Magical Damage Formula
      • Hit Chance
      • Critical Chance
    • M02.2: Abilities
      • Introduction to Abilities
      • Base Attack
      • Elemental Magic Spells
      • Steal Ability
      • Drain
      • Healing Spell
      • Cure
      • Buff Abilities
      • Debuff Abilities

ORK 4 Extensions

  • Plugins
    • Save Game Compression Plugin
  • Schematic Nodes
    • Footstepper Nodes (Unity)
  • Scripts
    • A* Pathfinding Movement Component (Unity)
    • PolyNav 2D Movement Component (Unity)
    • Cinemachine Camera Control Type (Unity)
    • Rewired Input Key (Unity)
    • Unity Legacy Input Key (Unity)
    • Core GameKit Wrapper (Unity)
    • Pool Boss Wrapper (Unity)
View Categories
  • Guide
  • ORK 4
  • ORK 4 Tutorials
  • UI Tutorials

Menus 02 Template HUDs

0:00 / 10:03
  • View as Markdown Open this page as plain Markdown (opens in a new tab)
  • Open in ChatGPT Ask questions about this page (opens in a new tab)
  • Open in Claude Ask questions about this page (opens in a new tab)
  • Open in Google AI Studio Ask questions about this page (Google account required) (opens in a new tab)

In this tutorial we’ll set up HUDs used as templates.

This tutorial is part 2 of a mini-series covering menu screens. You can find the start of this series here.

HUDs can be used as templates to be added to UI boxes (either directly or on buttons) – we’ll make use of this to display status information of our combatants in different ways.

We’ll set up 3 HUD templates:

  • template with portrait, name, level, status values (HP and MP), status effects
  • another variant of this, but including experience bar
  • listing all Normal type status values (for equipment change previews)

We’ll also set up 2 button prefabs:

  • an empty button prefab we’ll use in our menus to display a HUD template
  • a choice title button for the equipment menu, showing the slot beside the button (which shows the equipment).

This tutorial is based on the ORK 4 Unity Quickstart 3D tutorials, but can be used in any project.

As with all content when using Unity UI, we’ll set up prefabs. It’s best to do this in the UI Environment Scene, so open it.

Status Value UI and Status Effect UI #

Before setting up our templates, we need status value UI and status effect UI set up in our project.

If you haven’t done so yet, please follow the status value UI setup and status effect UI setup tutorials.

Combatant Info HUD Prefab #

We’ll start the HUD setup with a template that’ll be used as information in some menu screens, as well as the content for buttons in combatant selections (e.g. also for target selection in battle menus).

The HUD will display the combatant’s portrait, name, level, HP, MP and status effects.

Create a new HUD either using the scene hierarchy context menu (ORK Framework > HUD > HUD (Horizontal Layout)) or ORK toolbar (search for: HUD Horizontal).

HUD #

We’ll adjust the root HUD object.

Rect Transform #

  • Width
    Set to: 300
    This is just for making editing a bit easier and things better visible.
    The actual width of the HUD will be set whatever is displaying it, e.g. a UI box or input button.

UI Color Changer #

Remove the UI Color Changer component.

Usually, we’ll want this added to be able to change the color of the HUD, but this HUD is used as a template and displayed by UI boxes or inputs on them.

When used on inputs, the UI Color Changer of the HUD would interfere with the input’s color changer, preventing from using the input’s color for selection highlighting.

Content Size Fitter #

Add a Content Size Fitter component and change the following setting.

  • Vertical Fit
    Select: Preferred Size

Portrait #

Add a portrait either using the context menu on the HUD object (ORK Framework > HUD > Content > HUD: Portrait Content (Sprite)) or ORK toolbar (search for: HUD Portrait Sprite)

HUD Portrait Content #

The HUD Portrait Content component is used to define the portrait that will be displayed (via organizer type).

  • Organizer Type
    Select: Portrait

Layout Element #

Add a Layout Element component to the portrait’s object and change the following settings.

We’ll use a size of 128×128.

  • Preferred Width
    Enable
    Set the value to: 128
  • Preferred Height
    Enable
    Set the value to: 128

Child Object #

Add an empty child object to the HUD object and rename it to e.g. Status Information. We’ll use this to list the combatant’s status information vertically beside the portrait.

Add a Vertical Layout Group component to the child object and change the following settings.

  • Spacing
    Set to: 5
  • Control Child Size
    Enable Width and Height.
  • Child Force Expand
    Enable Width.
    Disable Height.

Status Text #

We’ll add the name and level of the combatant.

With the Status Information child object selected, use the context menu (ORK Framework > HUD > Content > HUD: Text Content) or ORK toolbar (search for: HUD Text).

HUD Text Content #

  • Content Type
    Select: Combatant Information
  • Default Content (Text)
    Set to: <name>, Level <level>

TextMesh Pro – Text (UI) #

Adjust the text to your liking, e.g. I’m using:

  • Font Size
    Set to: 20
  • Vertex Color
    Select a yellow color with full alpha value.

Status Value List #

We’ll add the status values HP and MP using status value UI with a value bar.

With the Status Information child object selected, use the context menu (ORK Framework > HUD > Status Value > Status Value List (Vertical Layout)) or ORK toolbar (search for: Status Value List Vertical).

HUD List Content #

  • List Type
    Select: Status Value
  • List Status Values
    Select: Defined

Change the already added Status Value 0 settings.

  • Status Value
    Select: HP

Click on Add Status Value.

  • Status Value
    Select: MP

The status value UI was set up in this tutorial, so we’ll use either the bar or bar_preview UI key.

  • UI Key
    Set to: bar or bar_preview

Status Effect List #

We’ll add the status effects of the combatant.

With the Status Information child object selected, use the context menu (ORK Framework > HUD > Status Effect > Status Effect List (Grid Layout)) or ORK toolbar (search for: Status Effect List Grid).

HUD List Content #

  • List Type
    Select: Status Effect
  • Count Limit
    Select: All
    This shows all status effects of the combatant.
  • Effect Origin
    Select: Current or Preview
    Which one you use should depend on which UI key you used for the status values.
    E.g. if your status values show previews, you most likely also want to have status effects show previews.
  • UI Key
    Leave empty.

Grid Layout Group #

  • Cell Size
    Set to: X=50, Y=50
  • Spacing
    Set to: X=5, Y=5

Create Prefab #

The finished HUD will look like this:

That’s it for this HUD prefab – create a prefab out of it and name it Combatant Information HUD.

Combatant Info EXP HUD Prefab #

With the HUD still open, we’ll now make a small adjustment and create another prefab.

Status Value List #

Select the HUD > Status Information > Status Value List child object and change the following settings in the HUD List Content component.

Click on Add Status Value.

  • Status Value
    Select: Experience

Create Prefab #

That’s it for this HUD prefab – create a new prefab (original or variant) out of it and name it Combatant Information EXP HUD.

Status Value Preview HUD #

Now, we’ll create a new HUD that’ll list all Normal type status values to show preview values (e.g. in the equipment menu).

Create a new HUD either using the scene hierarchy context menu (ORK Framework > HUD > HUD (Vertical Layout)) or ORK toolbar (search for: HUD Vertical).

HUD #

We’ll adjust the root HUD object.

Rect Transform #

  • Width
    Set to: 300
    Like the combatant info HUD, this is just for the setup.
    The HUD will adjust to where it’s used as a template.

UI Color Changer #

Remove the UI Color Changer component.

Vertical Layout Group #

  • Spacing
    Set to: 20

Content Size Fitter #

Add a Content Size Fitter component and change the following setting.

  • Vertical Fit
    Select; Preferred Size

Status Text #

We’ll add the name and level of the combatant.

With the Status Information child object selected, use the context menu (ORK Framework > HUD > Content > HUD: Text Content) or ORK toolbar (search for: HUD Text).

HUD Text Content #

  • Content Type
    Select: Combatant Information
  • Default Content (Text)
    Set to: <name>, Level <level>

TextMesh Pro – Text (UI) #

Adjust the text to your liking, e.g. I’m using:

  • Font Size
    Set to: 20
  • Vertex Color
    Select a yellow color with full alpha value.

Status Value List #

With the HUD object selected, use the context menu (ORK Framework > HUD > Status Value > Status Value List (Vertical Layout)) or ORK toolbar (search for: Status Value List Vertical).

HUD List Content #

  • List Type
    Select: Status Value
  • List Status Values
    Select: Status Value Type
  • Status Value Type
    Select: Normal
  • UI Key
    Set to: preview

Vertical Layout Group #

  • Spacing
    Set to 10.

Create Prefab #

The finished HUD will look like this:

That’s it for this HUD prefab – create a new prefab out of it and name it Status Value Preview HUD.

Empty Button Prefab #

We’ll set up the empty button – but we’ll not use the Empty Button variant from the context menu, as we still want the button to have an image, just no content.

Use the scene hierarchy context menu (ORK Framework > UI Box > Input (Button) > UI Box: Choice Button) or ORK toolbar (search for: Choice Button).

Remove Child Objects #

Remove the Image and Text Child objects from the button.

Image (Optional) #

Select the Choice Button object and change the Image component.

  • Source Image
    Select: Button Simple

Layout Element #

  • Min Height
    Set to: 50

Create Prefab #

The button should look like this:

That’s it for this button prefab – create a prefab out of it and name it Empty Button.

Title Button Prefab #

As our last prefab, we’ll set up the title button, using a fixed width for the title to have all buttons align neatly.

Use the scene hierarchy context menu (ORK Framework > UI Box > Input (Button) > UI Box: Choice Title Button fixed Width) or ORK toolbar (search for: Choice Title Button fixed).

We can simply use the default setup without any changes. The title will have a fixed width of 200.

Create Prefab #

The button should look like this:

That’s it for this button prefab – create a prefab out of it and name it Choice Title Button.

HUD Setup #

Open the ORK editor and navigate to UI > HUDs, we’ll add 3 new HUDs.

All 3 HUDs will be used as templates, i.e. they’re not displayed on their own, so we can ignore most of their settings.

Combatant Information #

  • Name
    Set to: Template: Combatant Information
  • HUD Type
    Select: Combatant
  • Auto Display
    Disable

Unity UI #

  • UI Layer
    Select: HUDs
  • HUD Prefab
    Select: Combatant Information HUD

Combatant Information EXP #

Copy the Template: Combatant Information HUD and change the following settings.

  • Name
    Set to: Template: Combatant Information EXP

Unity UI #

  • HUD Prefab
    Select: Combatant Information EXP HUD

Status Value Preview #

Copy the Template: Combatant Information EXP HUD and change the following settings.

  • Name
    Set to: Template: Status Value Preview

Unity UI #

  • HUD Prefab
    Select the Status Value Preview HUD prefab.

Save Changes #

And that’s it!

Don’t forget to save your changes by clicking on Save Settings at the bottom of the editor.

The next part of the menus mini-series will set up the general menu related settings.

Table of Contents
  • Status Value UI and Status Effect UI
  • Combatant Info HUD Prefab
    • HUD
      • Rect Transform
      • UI Color Changer
      • Content Size Fitter
    • Portrait
      • HUD Portrait Content
      • Layout Element
    • Child Object
    • Status Text
      • HUD Text Content
      • TextMesh Pro - Text (UI)
    • Status Value List
      • HUD List Content
    • Status Effect List
      • HUD List Content
      • Grid Layout Group
    • Create Prefab
  • Combatant Info EXP HUD Prefab
    • Status Value List
    • Create Prefab
  • Status Value Preview HUD
    • HUD
      • Rect Transform
      • UI Color Changer
      • Vertical Layout Group
      • Content Size Fitter
    • Status Text
      • HUD Text Content
      • TextMesh Pro - Text (UI)
    • Status Value List
      • HUD List Content
      • Vertical Layout Group
    • Create Prefab
  • Empty Button Prefab
    • Remove Child Objects
    • Image (Optional)
    • Layout Element
    • Create Prefab
  • Title Button Prefab
    • Create Prefab
  • HUD Setup
    • Combatant Information
      • Unity UI
    • Combatant Information EXP
      • Unity UI
    • Status Value Preview
      • Unity UI
  • Save Changes
Sitemap
  • Showcase
  • ORK 4 Guide
    • Documentation
    • Tutorials
    • Extensions
    • API
  • ORK 3 Guide
    • Documentation
    • Tutorials
    • API
  • ORK 2 Hub
    • Tutorials
    • Plugins
    • API
  • Support
  • Forum
  • Get ORK
  • Contact
  • Blog
  • Makinom
  • gamingislove.com
Categories
  • News (75)
  • ORK 2 (137)
    • Tutorial (137)
      • Game tutorial (50)
      • Gameplay (32)
      • How-to (55)
  • Release (158)
Search

© 2015 Gaming is Love e.U.

Disclosure: This site may contain affiliate links, which means I may receive a commission if you click a link and purchase something that I have recommended. While clicking these links won’t cost you any money, they will help me fund my development projects while recommending great assets!