Component Info

HUD Feed List - Overview

This is the main component of the package. It is what manages how, when and for how long list items are presented. It has several public methods that you can use and is highly configurable.

Public Methods

void Enqueue(string key, object item)

Adds an item to the internal queue. The key parameter is associated with the type of list item to present. The key must match a key defined in the ListItemConfiguration

The object that will get passed to the HudFeedListItem component's SetData method. The list item method SetData can then be used to set component values on the list item.

void ClearHudList(bool animated)

Clears all presented items from the HudFeedList, regardless of whether they are pinned or have timeToLive > 0. When the animated property is true it will call each presenting item's Exit animation before removing them from the list. If animated is false it will clear the list instantly.

void ClearQueue()

Clears the internal queue of any items that have yet to be presented

void HideList(bool animated)

Hides all presented items in the HudFeedList. When animated property is true it will call each presenting item's Exit animation before they are hidden. If animated is false it will instantly hide all items. If the list is using a HudFeedTitle it will call its Hide(animated) method as well.

void ShowList(bool animated)

Shows all presented items in the HudFeedList. When animated property is true it will call each presenting item's Revealanimation. If animated is false it will instantly show all items. If the list is using a HudFeedTitle it will call its Show(animated) method as well.

void PauseQueue(bool paused)

Sets whether the internal queue is paused. When the queue is paused it will continue to queue up items but will not present/display them.

void SetPause(bool paused)

Sets whether the HudFeedList's Update method runs. This pauses all adding, removing and updating list items (such as their TimeToLive).