Settings / Configuration

This section breaks down all of the settings and configuration available for the Hud Feed List

The HudFeedList inspector

HudFeedTitleConfiguration

An object that encapsulates all of the configuration options for the HudFeedTitle

• TransitionStyle: Determines how the title will be shown and hidden. Can use FadeInOut or Animator

  • FadeInOut: A simple fade animation.

  • Animator: Tells the config that an Animator will be used for custom animations. For more information on setting up custom animations see Creating List Item Animations

• FadeInOutTime: If TransitionStyle is set to FadeInOut this value will be used as the fade time

• FadeInOutEaseType: The ease method used by the FadeInOut transition

• AlwaysVisible: If true the HudFeedTitle object will always be enabled and visible regardless of whether there are items presented. If false the HudFeedTitle will only be displayed while there are items presented in the list.

• TitleObject: A reference to the HudFeedTitle gameObject

HudFeedListConfiguration

An object that encapsulates all of the configuration options for the HudFeedList

• Orientation: Determines the orientation/direction in which items are added and pushed onto the list. TopDown or BottomUp

• ListAddStyle: The style in which items are added to the list. Append or Push

  • Append: Adds the next item to the end of the list. In TopDown orientation this will add it to the bottom. In BottomUp orientation this will add the item to the top of the list.

  • Push: This style pushes all existing items away from the origin to make room for the next item and adds the next item to the "start" of the list. In TopDown orientation it will push all items down and add the item to the top. In BottomUp orientation this will push all items up and add the item to the bottom.

• ItemSpacing: The space between each list item

• PushTime: The time it takes to push an item up to make room for the next queued item.

• FillModeEnabled: If true, when list items disappear the space is filled by other list items. If false it has no effect on behaviour.

• UseVisibleLimit: This setting can be used to limit the number of items that can be presented at a time. If false, queued items are immediately pushed to the UI

• VisibleLimit: If UseVisibleLimit is true this is the number of items that can be presented at a time.

• ListItemPrefabs: Is a list of type ListItemConfiguration. A list of keys and item prefab pairs. This allows a single HudFeedList to display multiple types of items/info. See ListItemConfiguration below for more info.

• ItemContainer: A reference to the list container. This allows for the container and HudFeedList to be different objects.

ListItemConfiguration

Contains the configuration details of individual list item types. Used as an embedded list in HudFeedListConfiguration.

• Key: The unique key used to identify this list item type.

• Prefab: The prefab or 'Prototype Cell' that all list items will instantiate from

• TimeToLive: The time the list item is active in the list

• TransitionStyle: Determines how the list item will be added/removed from the list

• FadeInOutTime: If TransitionStyle is set to FadeInOut this value will be used as the fade time

• FadeInOutEaseType: The ease method used by the FadeInOut transition

• Pin: When list item is added to a list it will stay in its original position for its duration. It will also take priority and be presented at the top (In TopDown orientation) or the bottom (in BottomUp orientation)