Learn more about displaying a combatant’s or class’s available abilities in your HUDs (and other UI).
This documentation focuses on listing a abilities in a HUD. The actual ability is displayed via the ability’s Shortcut UI setup, see the HUD shortcut documentation for details.
Unity UI #
The Unity UI module displays abilities using HUD components.
Display text content information (e.g. name, values, etc.) using ORK HUD Status Text Content components (e.g. Ability or Shortcut status type, see the HUD text content documentation for details).
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 Cast Time or Level Points value types (see the HUD value bar content documentation for details).
HUD Ability List #
Use a HUD Ability List component to add a combatant’s or class’s abilities. You can define which abilities are listed:
- base attacks
- counter attack
- class ability
- active abilities
- passive abilities
- temporary abilities
Additionally you can limit the display to abilities of defined ability types.
The component creates an ability using the Shortcut UI setup of the ability, or a defined prefab in the component.
The prefab (coming from ability’s shortcut UI or a defined prefab) requires a HUD Content Provider component at it’s root. The HUD Ability List component sets the content provider’s user (content) as the individual ability. The content provider further distributes the information to any content component on it.
You can use layout components to arrange the listed abilities. E.g. use a Vertical Layout Group component to arrange the abilities 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 ability lists: ORK Framework > HUD > Ability > Ability List (variants with and without layout groups)
The HUD Ability List component requires a combatant or class as displayed content. When a combatant is the HUD’s (or content provider’s) user, the combatant’s abilities are listed. If a class is the user, the abilities of that class will be listed (only the already learned abilities of the class).