Learn more about HUD content providers that are available in ORK.
Content providers are used to define the content that’s displayed by HUD elements. Learn more about content providers in this Makinom documentation.
The actual use of content providers depends on the used UI module.
Unity UI #
The Unity UI module uses components to add content providers.
Content components have a Content Provider field available to define which content provider they get their displayed content from.
The following content providers are available (in addition to Makinom’s own content providers).
Combatant #
HUD Action Combatant #
The HUD Action Combatant (Content Provider) component uses the user or target of a battle action as it’s content.
This content provider requires another content provider with a battle action as it’s user/content.
HUD Combatant Ability #
The HUD Combatant Ability (Content Provider) component uses a defined ability as it’s content.
The ability can be a combatant’s base attack, counter attack, class ability or a defined ability (if available to the combatant).
This content provider requires another content provider with a combatant as it’s user/content.
HUD Combatant Action #
The HUD Combatant Action (Content Provider) component uses the current, casting or next action of a combatant as it’s content.
This content provider requires another content provider with a combatant as it’s user/content.
HUD Combatant Item #
The HUD Combatant Item (Content Provider) component uses a defined item, equipment, crafting recipe, currency, AI behaviour or AI ruleset from a combatant’s inventory as it’s content.
The item/equipment/etc. has to be in the inventory of a combatant, unless Show Empty is enabled.
This content provider requires another content provider with a combatant as it’s user/content.
HUD Combatant Object #
The HUD Combatant Object (Content Provider) component uses a combatant from a defined game object as it’s content.
The combatant comes from a selected game object, e.g. a game object in the scene or a prefab the component is added to.
This content provider can be used on it’s own, even outside of HUDs, e.g. as part of a world space canvas on a combatant’s prefab.
HUD Combatant Status Effect #
The HUD Combatant Status Effect (Content Provider) component uses a defined status effect on a combatant as it’s content.
This content provider requires another content provider with a combatant as it’s user/content. The defined status effect has to be applied to the combatant.
HUD Combatant Target #
The HUD Combatant Target (Content Provider) component uses a combatant’s target as it’s content.
You can use the combatant’s last target, a group/individual target or combatants that attacked the combatant.
This content provider requires another content provider with a combatant as it’s user/content.
HUD Menu Shop User #
The HUD Menu Shop User (Content Provider) component uses the current user of an open menu screen or shop as it’s content.
This content provider can be used on it’s own, even outside of HUDs, e.g. as part of a UI box.
HUD Player Combatant #
The HUD Player Combatant (Content Provider) component uses the player or a defined player group member as it’s content.
This content provider can be used on it’s own, even outside of HUDs, e.g. as part of a UI box.
Slots #
HUD AI Behaviour Slot #
The HUD AI Behaviour Slot (Content Provider) component uses a defined AI behaviour slot of a combatant as it’s content.
This content provider requires another content provider with a combatant as it’s user/content.
HUD AI Ruleset Slot #
The HUD AI Ruleset Slot (Content Provider) component uses a defined AI ruleset slot of a combatant as it’s content.
This content provider requires another content provider with a combatant as it’s user/content.
HUD Class Slot #
The HUD Class Slot (Content Provider) component uses a defined class slot of a combatant as it’s content.
This content provider requires another content provider with a combatant as it’s user/content.
HUD Equipment Slot #
The HUD Equipment Slot (Content Provider) component uses a defined equipment slot of a combatant as it’s content.
This content provider requires another content provider with a combatant as it’s user/content.
HUD Shortcut Slot #
The HUD Shortcut Slot (Content Provider) component uses a defined shortcut slot of a combatant as it’s content.
This content provider requires another content provider with a combatant as it’s user/content.
Status #
HUD Attack Modifier #
The HUD Attack Modifier (Content Provider) component uses a defined attack modifier of a combatant as it’s content.
This content provider requires another content provider with a combatant as it’s user/content.
HUD Attack Modifier Attribute #
The HUD Attack Modifier Attribute (Content Provider) component uses a defined attack modifier attribute of a combatant as it’s content.
This content provider requires another content provider with a combatant as it’s user/content.
HUD Defence Modifier #
The HUD Defence Modifier (Content Provider) component uses a defined defence modifier of a combatant as it’s content.
This content provider requires another content provider with a combatant as it’s user/content.
HUD Defence Modifier Attribute #
The HUD Defence Modifier Attribute (Content Provider) component uses a defined defence modifier attribute of a combatant as it’s content.
This content provider requires another content provider with a combatant as it’s user/content.
HUD Defence Modifier ID #
The HUD Defence Modifier ID (Content Provider) component uses a defined defence modifier ID of a combatant as it’s content.
The defence modifier ID of a combatant is the current attribute that’s assigned to the combatant for the defined defence modifier.
This content provider requires another content provider with a combatant as it’s user/content.
HUD Shortcut #
The HUD Shortcut (Content Provider) component uses a defined shortcut of a combatant as it’s content.
Instead of a shortcut stored in a shortcut slot, this’ll try to get/create the shortcut based on the defined settings – e.g. an ability known to the combatant or an item in the combatant’s inventory.
This content provider requires another content provider with a combatant as it’s user/content.
HUD Status Value #
The HUD Status Value (Content Provider) component uses a defined status value of a combatant as it’s content.
This content provider requires another content provider with a combatant as it’s user/content.
Other #
HUD Quest #
The HUD Quest (Content Provider) component uses a defined quest as it’s content.
If the quest is displayed can also depend on defined states, e.g. the quest being active or not added to the player’s quests yet.
This content provider can be used on it’s own, even outside of HUDs, e.g. as part of an NPC game object’s world space canvas.