HUDs: Defence Modifiers

Learn more about displaying defence modifiers in your HUDs (and other UI).

Displaying a combatant’s defence modifiers can get a bit complex. Defence modifiers consist of multiple attributes, so you’ll have a list of defence modifiers, each displaying a list of attributes.

E.g. displaying defence modifiers Race and Size:

  • Race (Defence Modifier)
    • Human (Attribute)
    • Mammal (Attribute)
    • Insect (Attribute)
  • Size (Defence Modifier)
    • Small(Attribute)
    • Medium (Attribute)
    • Large (Attribute)

Beside listing the defence modifiers, their attributes and values, combatants also have assigned defence modifier attributes, e.g. a combatant is of race Human and size Medium. This is refered to as defence modifier ID.

Unity UI #

The Unity UI module displays defence modifiers and their attributes using HUD components.

Display text content information (e.g. name, values, etc.) using ORK HUD Status Text Content components. Use the Defence Modifier status type for the base modifier, the Defence Modifier Attribute status type for individual attributes of a modifier and Defence Modifier ID status type for a combatant’s defence modifier attributes (see the HUD text content documentation for details).

HUD Defence Modifier List #

Use a HUD Defence Modifier List component to add multiple defence modifiers. You can either display defined modifiers or those that are recognized as traits:

  • None
    Select the defence modifiers that will be displayed.
  • Strength
    Displays all defence modifiers that are recognized as strengths.
  • Weakness
    Displays all defence modifiers that are recognized as weaknesses.
  • Immunity
    Displays all defence modifiers that are recognized as immunities.
  • Recovery
    Displays all defence modifiers that are recognized as recoveries.

The component creates a defence modifier using a defined prefab. The prefab requires a HUD Content Provider component at it’s root. The HUD Defence Modifier List component sets the content provider’s user (content) as the individual defence modifier. The content provider further distributes the information to any content component on it.

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

The HUD Defence Modifier List component requires a combatant as displayed content.

HUD Defence Modifier Attribute List #

Use a HUD Defence Modifier Attribute List component to display the attributes of an defence modifiers.

The component creates a defence modifier attributes using a defined prefab. The prefab requires a HUD Content Provider component at it’s root. The HUD Defence Modifier Attribute List component sets the content provider’s user (content) as the individual defence modifier attribute. The content provider further distributes the information to any content component on it.

You can use layout components to arrange the listed attributes. E.g. use a Vertical Layout Group component to arrange the defence modifier attributes 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 defence modifier attribute lists: ORK Framework > HUD > Defence Modifier > Defence Modifier Attribute List (variants with and without layout groups)

The HUD Defence Modifier Attribute List component requires an defence modifier as displayed content.

HUD Defence Modifier ID List #

Use a HUD Defence Modifier ID List component to display the defence modifier attributes of a combatant (e.g. the race and size of the combatant).

The component creates a defence modifier attribute using a defined prefab. The prefab requires a HUD Content Provider component at it’s root. The HUD Defence Modifier ID List component sets the content provider’s user (content) as the individual defence modifier attribute. The content provider further distributes the information to any content component on it.

You can use layout components to arrange the listed attributes. E.g. use a Vertical Layout Group component to arrange the defence modifier attributes 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 defence modifier attribute lists: ORK Framework > HUD > Defence Modifier > Defence Modifier ID List (variants with and withough layout groups)

The HUD Defence Modifier ID List component requires a combatant as displayed content.

HUD Defence Modifier (single) #

Use a HUD Defence Modifier component to display a single, defined defence modifier. The component itself is a HUD Content Provider and doesn’t create a prefab of the displayed defence modifier.

Use this component if you only want to display a single defence modifier and skip using a prefab for this. Displaying the content uses ORK HUD Status Text Content components or HUD Defence Modifier Attribute List components to list the attributes of the defence modifier (which uses prefabs for the attributes).

The context menu in the scene hierarchy has quick setup commands for single defence modifiers: ORK Framework > HUD > Defence Modifier > Defence Modifier – Name (single)

The HUD Defence Modifier component requires a combatant as displayed content.

HUD Defence Modifier Attribute (single) #

Use a HUD Defence Modifier Attribute component to display a single, defined defence modifier attribute. The component itself is a HUD Content Provider and doesn’t create a prefab of the displayed defence modifier attribute.

Use this component if you only want to display a single attribute of a defence modifier and skip using a prefab for this. Displaying the content uses ORK HUD Status Text Content components.

The context menu in the scene hierarchy has quick setup commands for single defence modifier attributes: ORK Framework > HUD > Defence Modifier > Defence Modifier Attribute – Name+Value (single)

The HUD Defence Modifier Attribute component requires a combatant as displayed content.

HUD Defence Modifier ID (single) #

Use a HUD Defence Modifier ID component to display a single, defined defence modifier attribute of a combatant. The component itself is a HUD Content Provider and doesn’t create a prefab of the displayed defence modifier attribute.

Use this component if you only want to display a single defence modifier of a combatant and skip using a prefab for this. Displaying the content uses ORK HUD Status Text Content components.

The context menu in the scene hierarchy has quick setup commands for single defence modifier attributes: ORK Framework > HUD > Defence Modifier > Defence Modifier ID – Name+ID (single)

The HUD Defence Modifier ID component requires a combatant as displayed content.

HUD Defence Modifier (for prefabs) #

You often use prefabs to display a defence modifier, e.g. for HUD Defence Modifier List components.

The prefab requires a HUD Content Provider component at it’s root. Displaying the content uses ORK HUD Status Text Content components or HUD Defence Modifier Attribute List components to list the attributes of the defence modifier. Both reference the HUD Content Provider component as their content provider.

Listing multiple defence modifiers will often use layout groups to organize them. You can use a Layout Element component to define the prefab’s preferred width or height. Or use a Content Size Fitter component on it to adjust it’s size to the displayed attributes.

The context menu in the scene hierarchy has quick setup commands for defence modifier prefabs: ORK Framework > HUD > Defence Modifier > Defence Modifier – Name (for prefabs)

HUD Defence Modifier Attribute (for prefabs) #

You often use prefabs to display a defence modifier attribute, e.g. for HUD Defence Modifier Attribute List components.

The prefab requires a HUD Content Provider component at it’s root. Displaying the content uses ORK HUD Status Text Content components, which reference the HUD Content Provider component as their content provider.

Listing multiple defence modifier attributes will often use layout groups to organize them. You can use a Layout Element component to define the prefab’s preferred width or height.

The context menu in the scene hierarchy has quick setup commands for defence modifier attribute prefabs: ORK Framework > HUD > Defence Modifier > Defence Modifier Attribute – Name+Value (for prefabs)

HUD Defence Modifier ID (for prefabs) #

You often use prefabs to display a combatant’s defence modifiers, e.g. for HUD Defence Modifier ID List components.

The prefab requires a HUD Content Provider component at it’s root. Displaying the content uses ORK HUD Status Text Content components, which reference the HUD Content Provider component as their content provider.

Listing multiple defence modifier IDs will often use layout groups to organize them. You can use a Layout Element component to define the prefab’s preferred width or height.

The context menu in the scene hierarchy has quick setup commands for defence modifier attribute prefabs: ORK Framework > HUD > Defence Modifier > Defence Modifier ID – Name+ID (for prefabs)