LapinerTools.Steam.UI.SteamLeaderboardsScoreEntryNode Class Reference

The SteamLeaderboardsUI class will use the SteamLeaderboardsScoreEntryNode class to display single items in the list. The LeaderboardListEntry prefab has this script attached. The LeaderboardListEntry prefab is referenced by the SteamLeaderboard prefab. There are two options to customize the item UI:
1. Listen to SteamLeaderboardsUI.OnEntryDataSet 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 LeaderboardListEntry prefab to your deriving class. Override SteamLeaderboardsScoreEntryNode.uMyGUI_TreeBrowser_InitNode to apply your customization, e.g. new entries such as a replay button. More...

Inherits MonoBehaviour, and IScrollHandler.

Classes
class	EntryDataSetEventArgs
class	SendMessageInitData
	Internal class used by SteamLeaderboardsUI to pass Steam score data to the SteamLeaderboardsScoreEntryNode class. More...

Public Member Functions
virtual void	uMyGUI_TreeBrowser_InitNode (object p_data)
	Called from the SteamLeaderboardsUI class to initialze the item UI. More...
virtual void	OnScroll (PointerEventData data)
	Internal method implementing the IScrollHandler interface. Required for mouse wheel scrolling of the item list. More...

Protected Member Functions
void	OnDestroy ()
virtual IEnumerator	LoadAvatarTexture (LeaderboardsScoreEntry p_entry)

Protected Attributes
Text	m_textRank
Text	m_textUserName
Text	m_textScore
RawImage	m_image
ScrollRect	m_parentScroller = null
Texture2D	m_avatarTexture = null

Properties
RawImage	Image [get]

Detailed Description

The SteamLeaderboardsUI class will use the SteamLeaderboardsScoreEntryNode class to display single items in the list. The LeaderboardListEntry prefab has this script attached. The LeaderboardListEntry prefab is referenced by the SteamLeaderboard prefab. There are two options to customize the item UI:
1. Listen to SteamLeaderboardsUI.OnEntryDataSet 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 LeaderboardListEntry prefab to your deriving class. Override SteamLeaderboardsScoreEntryNode.uMyGUI_TreeBrowser_InitNode to apply your customization, e.g. new entries such as a replay button.

Member Function Documentation

LoadAvatarTexture()

virtual IEnumerator LapinerTools.Steam.UI.SteamLeaderboardsScoreEntryNode.LoadAvatarTexture ( LeaderboardsScoreEntry  p_entry )

protectedvirtual

OnDestroy()

void LapinerTools.Steam.UI.SteamLeaderboardsScoreEntryNode.OnDestroy ( )

protected

OnScroll()

virtual void LapinerTools.Steam.UI.SteamLeaderboardsScoreEntryNode.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.

uMyGUI_TreeBrowser_InitNode()

virtual void LapinerTools.Steam.UI.SteamLeaderboardsScoreEntryNode.uMyGUI_TreeBrowser_InitNode ( object  p_data )

virtual

Called from the SteamLeaderboardsUI class to initialze the item UI.

Parameters

p_data

is of type SendMessageInitData. Contains the Steam data of the score entry.

Member Data Documentation

m_avatarTexture

Texture2D LapinerTools.Steam.UI.SteamLeaderboardsScoreEntryNode.m_avatarTexture = null

protected

m_image

RawImage LapinerTools.Steam.UI.SteamLeaderboardsScoreEntryNode.m_image

protected

m_parentScroller

ScrollRect LapinerTools.Steam.UI.SteamLeaderboardsScoreEntryNode.m_parentScroller = null

protected

m_textRank

Text LapinerTools.Steam.UI.SteamLeaderboardsScoreEntryNode.m_textRank

protected

m_textScore

Text LapinerTools.Steam.UI.SteamLeaderboardsScoreEntryNode.m_textScore

protected

m_textUserName

Text LapinerTools.Steam.UI.SteamLeaderboardsScoreEntryNode.m_textUserName

protected

Property Documentation

Image

RawImage LapinerTools.Steam.UI.SteamLeaderboardsScoreEntryNode.Image

get

---

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

• LapinerTools/Steam/Leaderboards/Scripts/UI/SteamLeaderboardsScoreEntryNode.cs