The SteamWorkshopUIBrowse class will use the SteamWorkshopItemNode class to display single items in the list. The WorkshopItemListEntry prefab has this script attached. The WorkshopItemListEntry prefab is referenced by the SteamWorkshopItemBrowser prefab. There are two options to customize the item UI:
1. Listen to SteamWorkshopUIBrowse.OnItemDataSet event and modify UI when it is triggered.
2. Derive from this class to customize the item UI. Keep in mind to change the script component of the WorkshopItemListEntry prefab to your deriving class. Override SteamWorkshopItemNode.uMyGUI_TreeBrowser_InitNode to apply your customization, e.g. new entries such as highscores.
More...
Inherits MonoBehaviour, and IScrollHandler.
|
virtual void | uMyGUI_TreeBrowser_InitNode (object p_data) |
| Called from the SteamWorkshopUIBrowse class to initialze the item UI and everytime the item data is updated. More...
|
|
virtual void | OnScroll (PointerEventData data) |
| Internal method implementing the IScrollHandler interface. Required for mouse wheel scrolling of the item list. More...
|
|
virtual void | Select () |
| Selects the download or the play button. Nothing is selected when the download is active. In this case the play button will be selected when the download is finished. More...
|
|
The SteamWorkshopUIBrowse class will use the SteamWorkshopItemNode class to display single items in the list. The WorkshopItemListEntry prefab has this script attached. The WorkshopItemListEntry prefab is referenced by the SteamWorkshopItemBrowser prefab. There are two options to customize the item UI:
1. Listen to SteamWorkshopUIBrowse.OnItemDataSet event and modify UI when it is triggered.
2. Derive from this class to customize the item UI. Keep in mind to change the script component of the WorkshopItemListEntry prefab to your deriving class. Override SteamWorkshopItemNode.uMyGUI_TreeBrowser_InitNode to apply your customization, e.g. new entries such as highscores.
◆ AddFavorite()
virtual void LapinerTools.Steam.UI.SteamWorkshopItemNode.AddFavorite |
( |
| ) |
|
|
protectedvirtual |
◆ DownloadPreview()
virtual IEnumerator LapinerTools.Steam.UI.SteamWorkshopItemNode.DownloadPreview |
( |
string |
p_URL | ) |
|
|
protectedvirtual |
◆ OnDestroy()
virtual void LapinerTools.Steam.UI.SteamWorkshopItemNode.OnDestroy |
( |
| ) |
|
|
protectedvirtual |
◆ OnItemInstalled()
virtual void LapinerTools.Steam.UI.SteamWorkshopItemNode.OnItemInstalled |
( |
WorkshopItemEventArgs |
p_itemArgs | ) |
|
|
protectedvirtual |
◆ OnItemUpdated()
virtual System.Action<WorkshopItemEventArgs> LapinerTools.Steam.UI.SteamWorkshopItemNode.OnItemUpdated |
( |
Selectable |
p_focusWhenDone | ) |
|
|
protectedvirtual |
◆ OnPlayBtn()
virtual void LapinerTools.Steam.UI.SteamWorkshopItemNode.OnPlayBtn |
( |
| ) |
|
|
protectedvirtual |
◆ OnScroll()
virtual void LapinerTools.Steam.UI.SteamWorkshopItemNode.OnScroll |
( |
PointerEventData |
data | ) |
|
|
virtual |
Internal method implementing the IScrollHandler interface. Required for mouse wheel scrolling of the item list.
- Parameters
-
data | mouse wheel event data. |
◆ RemovedFavorite()
virtual void LapinerTools.Steam.UI.SteamWorkshopItemNode.RemovedFavorite |
( |
| ) |
|
|
protectedvirtual |
◆ Select()
virtual void LapinerTools.Steam.UI.SteamWorkshopItemNode.Select |
( |
| ) |
|
|
virtual |
Selects the download or the play button. Nothing is selected when the download is active. In this case the play button will be selected when the download is finished.
◆ SetAutomaticNavigation()
virtual void LapinerTools.Steam.UI.SteamWorkshopItemNode.SetAutomaticNavigation |
( |
Selectable |
p_selectable | ) |
|
|
protectedvirtual |
◆ SetNavigationTargetsHorizontal()
virtual void LapinerTools.Steam.UI.SteamWorkshopItemNode.SetNavigationTargetsHorizontal |
( |
Selectable [] |
p_horizontalNavOrder | ) |
|
|
protectedvirtual |
◆ SetNavigationTargetsVertical() [1/2]
virtual void LapinerTools.Steam.UI.SteamWorkshopItemNode.SetNavigationTargetsVertical |
( |
Selectable |
p_current, |
|
|
Selectable [] |
p_verticalNavOrder |
|
) |
| |
|
protectedvirtual |
◆ SetNavigationTargetsVertical() [2/2]
virtual IEnumerator LapinerTools.Steam.UI.SteamWorkshopItemNode.SetNavigationTargetsVertical |
( |
| ) |
|
|
protectedvirtual |
◆ ShowDownloadProgress()
virtual IEnumerator LapinerTools.Steam.UI.SteamWorkshopItemNode.ShowDownloadProgress |
( |
| ) |
|
|
protectedvirtual |
◆ Start()
virtual void LapinerTools.Steam.UI.SteamWorkshopItemNode.Start |
( |
| ) |
|
|
protectedvirtual |
◆ Subscribe()
virtual void LapinerTools.Steam.UI.SteamWorkshopItemNode.Subscribe |
( |
| ) |
|
|
protectedvirtual |
◆ uMyGUI_TreeBrowser_InitNode()
virtual void LapinerTools.Steam.UI.SteamWorkshopItemNode.uMyGUI_TreeBrowser_InitNode |
( |
object |
p_data | ) |
|
|
virtual |
Called from the SteamWorkshopUIBrowse class to initialze the item UI and everytime the item data is updated.
- Parameters
-
◆ Unsubscribe()
virtual void LapinerTools.Steam.UI.SteamWorkshopItemNode.Unsubscribe |
( |
| ) |
|
|
protectedvirtual |
◆ VoteDown()
virtual void LapinerTools.Steam.UI.SteamWorkshopItemNode.VoteDown |
( |
| ) |
|
|
protectedvirtual |
◆ VoteUp()
virtual void LapinerTools.Steam.UI.SteamWorkshopItemNode.VoteUp |
( |
| ) |
|
|
protectedvirtual |
◆ isDestroyed
bool LapinerTools.Steam.UI.SteamWorkshopItemNode.isDestroyed = false |
|
protected |
◆ m_btnDelete
Button LapinerTools.Steam.UI.SteamWorkshopItemNode.m_btnDelete |
|
protected |
◆ m_btnDownload
Button LapinerTools.Steam.UI.SteamWorkshopItemNode.m_btnDownload |
|
protected |
◆ m_btnFavorites
Button LapinerTools.Steam.UI.SteamWorkshopItemNode.m_btnFavorites |
|
protected |
◆ m_btnFavoritesActive
Button LapinerTools.Steam.UI.SteamWorkshopItemNode.m_btnFavoritesActive |
|
protected |
◆ m_btnPlay
Button LapinerTools.Steam.UI.SteamWorkshopItemNode.m_btnPlay |
|
protected |
◆ m_btnSubscriptions
Button LapinerTools.Steam.UI.SteamWorkshopItemNode.m_btnSubscriptions |
|
protected |
◆ m_btnSubscriptionsActive
Button LapinerTools.Steam.UI.SteamWorkshopItemNode.m_btnSubscriptionsActive |
|
protected |
◆ m_btnVotesDown
Button LapinerTools.Steam.UI.SteamWorkshopItemNode.m_btnVotesDown |
|
protected |
◆ m_btnVotesDownActive
Button LapinerTools.Steam.UI.SteamWorkshopItemNode.m_btnVotesDownActive |
|
protected |
◆ m_btnVotesUp
Button LapinerTools.Steam.UI.SteamWorkshopItemNode.m_btnVotesUp |
|
protected |
◆ m_btnVotesUpActive
Button LapinerTools.Steam.UI.SteamWorkshopItemNode.m_btnVotesUpActive |
|
protected |
◆ m_data
◆ m_image
RawImage LapinerTools.Steam.UI.SteamWorkshopItemNode.m_image |
|
protected |
◆ m_improveNavigationFocus
bool LapinerTools.Steam.UI.SteamWorkshopItemNode.m_improveNavigationFocus = true |
|
protected |
◆ m_parentScroller
ScrollRect LapinerTools.Steam.UI.SteamWorkshopItemNode.m_parentScroller = null |
|
protected |
◆ m_pendingImageDownload
WWW LapinerTools.Steam.UI.SteamWorkshopItemNode.m_pendingImageDownload = null |
|
protected |
◆ m_selectionImage
Image LapinerTools.Steam.UI.SteamWorkshopItemNode.m_selectionImage |
|
protected |
◆ m_textDescription
Text LapinerTools.Steam.UI.SteamWorkshopItemNode.m_textDescription |
|
protected |
◆ m_textDownloadProgress
Text LapinerTools.Steam.UI.SteamWorkshopItemNode.m_textDownloadProgress |
|
protected |
◆ m_textFavorites
Text LapinerTools.Steam.UI.SteamWorkshopItemNode.m_textFavorites |
|
protected |
◆ m_textName
Text LapinerTools.Steam.UI.SteamWorkshopItemNode.m_textName |
|
protected |
◆ m_textSubscriptions
Text LapinerTools.Steam.UI.SteamWorkshopItemNode.m_textSubscriptions |
|
protected |
◆ m_textVotes
Text LapinerTools.Steam.UI.SteamWorkshopItemNode.m_textVotes |
|
protected |
◆ m_useExplicitNavigation
bool LapinerTools.Steam.UI.SteamWorkshopItemNode.m_useExplicitNavigation = true |
|
protected |
◆ Image
RawImage LapinerTools.Steam.UI.SteamWorkshopItemNode.Image |
|
get |
The documentation for this class was generated from the following file: