Steam
Classes | Public Member Functions | Protected Member Functions | Protected Attributes | Properties | List of all members
LapinerTools.Steam.UI.SteamWorkshopItemNode Class Reference

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.

Classes

class  ItemDataSetEventArgs
 
class  SendMessageInitData
 Internal class used by SteamWorkshopUIBrowse to pass Steam item data to the SteamWorkshopItemNode class. More...
 

Public Member Functions

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...
 

Protected Member Functions

virtual void Start ()
 
virtual void OnDestroy ()
 
virtual void OnPlayBtn ()
 
virtual void Subscribe ()
 
virtual void Unsubscribe ()
 
virtual void AddFavorite ()
 
virtual void RemovedFavorite ()
 
virtual void VoteUp ()
 
virtual void VoteDown ()
 
virtual void OnItemInstalled (WorkshopItemEventArgs p_itemArgs)
 
virtual System.Action< WorkshopItemEventArgsOnItemUpdated (Selectable p_focusWhenDone)
 
virtual void SetNavigationTargetsHorizontal (Selectable[] p_horizontalNavOrder)
 
virtual void SetNavigationTargetsVertical (Selectable p_current, Selectable[] p_verticalNavOrder)
 
virtual IEnumerator SetNavigationTargetsVertical ()
 
virtual void SetAutomaticNavigation (Selectable p_selectable)
 
virtual IEnumerator ShowDownloadProgress ()
 
virtual IEnumerator DownloadPreview (string p_URL)
 

Protected Attributes

Text m_textName
 
Text m_textDescription
 
Text m_textVotes
 
Button m_btnVotesUp
 
Button m_btnVotesUpActive
 
Button m_btnVotesDown
 
Button m_btnVotesDownActive
 
Text m_textFavorites
 
Button m_btnFavorites
 
Button m_btnFavoritesActive
 
Text m_textSubscriptions
 
Text m_textDownloadProgress
 
Button m_btnSubscriptions
 
Button m_btnSubscriptionsActive
 
RawImage m_image
 
Image m_selectionImage
 
Button m_btnDownload
 
Button m_btnPlay
 
Button m_btnDelete
 
bool m_useExplicitNavigation = true
 
bool m_improveNavigationFocus = true
 
SendMessageInitData m_data = null
 
ScrollRect m_parentScroller = null
 
WWW m_pendingImageDownload = null
 
bool isDestroyed = false
 

Properties

RawImage Image [get]
 

Detailed Description

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.

Member Function Documentation

◆ 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
datamouse 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
p_datais of type SendMessageInitData. Contains the Steam data of the item.

◆ 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

Member Data Documentation

◆ 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

SendMessageInitData LapinerTools.Steam.UI.SteamWorkshopItemNode.m_data = null
protected

◆ 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

Property Documentation

◆ Image

RawImage LapinerTools.Steam.UI.SteamWorkshopItemNode.Image
get

The documentation for this class was generated from the following file: