HUDs: Equipment

Table of Contents

Learn more about displaying a combatant’s equipped equipment in your HUDs (and other UI).

This documentation focuses on listing a combatant’s equipment slots and their current equipment in a HUD. The actual equipment is displayed via the equipment’s Shortcut UI setup, see the HUD shortcut documentation for details.

Unity UI #

The Unity UI module displays equipment slots and their equipment using HUD components.

Display text content information (e.g. name, values, etc.) using ORK HUD Status Text Content components (Equipment status type, see the HUD text content documentation for details). You can also display information of the equipment slot via the Equipment status type.

You can also display numerical information via value bars using ORK HUD Value Bar Content or ORK HUD Icon Bar Content components, e.g. the Durability or Level Points value types (see the HUD value bar content documentation for details).

HUD Equipment List #

Use a HUD Equipment List component to add a combatant’s equipment slots and their equipment. You can either display all equipment slots of the combatant or only defined equipment slots .

The component creates an equipment slot using the Shortcut UI setup of it’s equipment, or a defined prefab for an empty slot.

The prefab (coming from equipment’s shortcut UI or a defined prefab) requires a HUD Content Provider component at it’s root. The HUD Equipment List component sets the content provider’s user (content) as the individual equipment slot. The content provider further distributes the information to any content component on it.

You can use layout components to arrange the listed equipment slots. E.g. use a Vertical Layout Group component to arrange the equipment slots in a vertical list. See Unity’s documentation on UI setup and layout groups for details on this.

The context menu in the scene hierarchy has quick setup commands for equipment lists: ORK Framework > HUD > Equipment > Equipment List (variants with and without layout groups)

The HUD Equipment List component requires a combatant as displayed content.