HUDs: AI Rulesets

Table of Contents

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

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

Unity UI #

The Unity UI module displays AI ruleset slots and their AI rulesets using HUD components.

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

HUD AI Ruleset List #

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

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

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

You can use layout components to arrange the listed AI ruleset slots. E.g. use a Vertical Layout Group component to arrange the 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 AI ruleset lists: ORK Framework > HUD > AI Ruleset > AI Ruleset List (variants with and without layout groups)

The HUD AI Ruleset List component requires a combatant as displayed content.