SCR_ServerListComponent Interface Reference

Inheritance diagram for SCR_ServerListComponent:

Public Member Functions
override void	HandlerAttached (Widget w)
void	UpdateRooms (array< Room > rooms, bool animated=false)
array< SCR_ServerBrowserEntryComponent >	GetRoomEntries ()
Public Member Functions inherited from SCR_ButtonListViewComponent
override void	HandlerAttached (Widget w)
array< SCR_ButtonComponent >	GetButtons ()
Public Member Functions inherited from SCR_ListViewComponent
override void	HandlerAttached (Widget w)
override bool	OnUpdate (Widget w)
void	UpdateEntries (bool animated=false)
	Fill entries with data.
void	SetScrollbarVisible (bool visible)
void	FocusFirstAvailableEntry ()
	Find first available entry and focus it.
void	SetScrollbar (SCR_ScrollBarComponent scrollbar)
void	ActivateScrolling (bool activate)
	Activate scrolling with input action.
void	UpdateScrollbar ()
array< Widget >	GetEntryWidgets ()
float	ScrollableEntriesCount ()
	Return how many entries can be scrolled.
Widget	FirstAvailableEntry ()
	Return first that is visible and enabled.

Protected Member Functions
override void	SetupEntryBehavior (Widget entry)
	Setup server entry component behavior
override void	FillEntry (Widget w)
	Fill server entry with room data.
override void	ClearServerList ()
	Clear widgets from server list.
Room	RoomByWidget (Widget w)
void	OnRoomEntryFocus (SCR_ScriptedWidgetComponent entry)
	Call this when entry in list is focused.
void	OnRoomEntryClick (SCR_ServerBrowserEntryComponent entry)
Protected Member Functions inherited from SCR_ButtonListViewComponent
override void	SetupEntryBehavior (Widget entry)
	Setup server entry component behavior
void	OnEntryFocus (Widget w)
	Call this when entry in list is focused.
Protected Member Functions inherited from SCR_ListViewComponent
void	AccessingHandlers ()
	Get reference to all needed component for handling.
void	CreateEntriesWidgets ()
	Create server entries widget.
void	PostCheck ()
void	CreateEntry ()
int	CalculateLimit ()
	Calulate entry limit number from list size and entry size.
float	EntryFractionFromViewPos (float viewPos, float scrollPos)
	Get fraction of whole entry in percents from positon in list view in percent based on scroll postion EntryFractionFromViewPos(1, ) = how much of entry is missing from bottom view
void	CheckEntrySize ()
	Get size of widget entry used in list.
void	SetupEntryBehavior (Widget entry)
	Empty functions for setting up widget entry beavhior actions, callbacks, etc.
void	FillEntry (Widget w)
	Empty function for filling entries with data Override this to fill entries with data
void	ScrollOffsetMove (float scrollPos)
	Modify offset size to fake scrolling by scroll position.
void	ScrollWheelMove ()
	Scroll list based on input action.
void	StayOnLastEntry ()
	Kepp focus on last entry on scroll.
void	ScrollList (float step, float input)
float	ScrollMove (float step, float inputMove)
void	ChangeFocusWithoutAnimation (Widget w)
void	AnimateEntryOpacity (Widget w, int delay, float animTime, float opacityEnd, float opacityStart=-1)
	Setup opacity animation.
void	OpacityAnimation (Widget w, int time, float opacityEnd)
void	ClearServerList ()
	Clear widgets from server list.
void	OnMenuDown ()
	Scrolling with up/down buttons outside of list view Focus is focus rest widget
void	OnMenuUp ()
	Check stepping over limit up.

Protected Attributes
ref array< SCR_ServerBrowserEntryComponent >	m_aRoomEntries = new array<SCR_ServerBrowserEntryComponent>
ref array< Room >	m_aRooms = new array<Room>
Protected Attributes inherited from SCR_ButtonListViewComponent
ref array< SCR_ButtonComponent >	m_aButtons = new array<SCR_ButtonComponent>
Protected Attributes inherited from SCR_ListViewComponent
ResourceName	m_sEntry
string	m_sScrollAction
bool	m_bAutomaticEntriesLimit
int	m_iEntriesLimit
int	m_iEntriesBottomPadding
float	m_fScrollMove
float	m_fAnimationAppearTime
Widget	m_wVerticalList
SizeLayoutWidget	m_wSizeScrollOffset
Widget	m_wFocusRest
ref array< Widget >	m_aEntryWidgets = new array<Widget>
SCR_ScrollBarComponent	m_Scrollbar
float	m_fScrollPosition = 0
float	m_iLastScrollPosition = 0
float	m_iEntriesCount = 0
float	m_fEntryWidgetHeight
int	m_iFocusedEntryId = 0
bool	m_bIscrollActive
bool	m_bAnimateListAppearing
bool	m_bCreateList = false

Additional Inherited Members
Public Attributes inherited from SCR_ButtonListViewComponent
ref ScriptInvoker	m_OnEntryFocus = new ScriptInvoker
Public Attributes inherited from SCR_ListViewComponent
Widget	m_wRoot
Static Public Attributes inherited from SCR_ListViewComponent
const string	WIDGET_VERTICAL_LIST = "VList"
const string	WIDGET_SIZE_SCROLL_OFFSET = "SizeScrollOffset"
const string	WIDGET_FOCUS_REST = "BtnFocusRest"
const int	ENTRY_FIRST = 0

Member Function Documentation

ClearServerList()

override void SCR_ServerListComponent.ClearServerList ( )

protected

Clear widgets from server list.

Implements SCR_ListViewComponent.

FillEntry()

override void SCR_ServerListComponent.FillEntry ( Widget  w )

protected

Fill server entry with room data.

Implements SCR_ListViewComponent.

GetRoomEntries()

array< SCR_ServerBrowserEntryComponent > SCR_ServerListComponent.GetRoomEntries

(

)

HandlerAttached()

override void SCR_ServerListComponent.HandlerAttached

(

Widget

w

)

Implements SCR_ButtonListViewComponent.

OnRoomEntryClick()

void SCR_ServerListComponent.OnRoomEntryClick ( SCR_ServerBrowserEntryComponent  entry )

protected

OnRoomEntryFocus()

void SCR_ServerListComponent.OnRoomEntryFocus ( SCR_ScriptedWidgetComponent  entry )

protected

Call this when entry in list is focused.

RoomByWidget()

Room SCR_ServerListComponent.RoomByWidget ( Widget  w )

protected

SetupEntryBehavior()

override void SCR_ServerListComponent.SetupEntryBehavior ( Widget  entry )

protected

Setup server entry component behavior

Implements SCR_ButtonListViewComponent.

UpdateRooms()

void SCR_ServerListComponent.UpdateRooms	(	array< Room >	rooms,
		bool	animated = false
	)

Member Data Documentation

m_aRoomEntries

ref array<SCR_ServerBrowserEntryComponent> SCR_ServerListComponent.m_aRoomEntries = new array<SCR_ServerBrowserEntryComponent>

protected

m_aRooms

ref array<Room> SCR_ServerListComponent.m_aRooms = new array<Room>

protected

---

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

• Game/UI/Menu/ServerBrowser/SCR_ServerListComponent.c