Skip to main content

Introduction

This component provides the ability to display a list of Items.

"Item List UI"

Fields#

NameDescription
SourceDetermine if source is a Direct Reference or in the Tool Registry
KeyKey used to find source
MenuObject providing menu for items
Menu Open TypeMethod of showing the menu
Menu Move TypeSet how to reposition the menu on open
Menu Button NameButton used to open menu
Menu KeyKey used to open menu
Scroll RectTransform to place prefabs inside
Selected Item UIUI displaying details of the selected item
FiltersList of filter/sort plugins
Category SourceUI element providing selected category
On Active Display ChangedEvent raised when the active display UI changes
On Selection ChangedEvent raised when selection changes
On Item AddedEvent raised when an item is loaded by the active display
On Item RemovedEvent raised when an item is removed by the active display
On Item ClickEvent raised when the item is clicked
On Item Double ClickEvent raised when the item is double-clicked
On DropEvent raised when an item is dropped on this one

Properties#

NameDescription
contentGets the RectTransform used for housing data
contentScrollRectScrollRect housing content (if any)
directListGet/Set a direct list of items to display
itemSourceGet/Set an Item Source to load data from
itemContainerGet/Set an Item Container to load data from
lockInputGets/Sets if input is locked
referenceListGet/Set a direct list of item references to display
activeDisplayGets the currently active display
selectedIndexGets/Sets the selected index

Methods#

NameDescription
AddSortFilterPluginAdd a new Sort/Filter plugin
ClearClear all items
CycleSortCycle between sort mods
GetSortFilterPluginGet Sort/Filter plugin of type T
ReloadReload the data
SetSortSet the sort mode by index
SplitStackSplit the current item stack into two stacks
CycleViewCycle between available UI Displays
GetSelectedItemGet the selected item of type T
SetSelectedItemSet the selected item of type T