SCR_PooledServerListComponent Class Reference

Pooled scrollable list with server entries handling. More...

Inheritance diagram for SCR_PooledServerListComponent:

Protected Member Functions
Widget	CreateEntry (Widget parent)
void	FillEntry (Widget w)
override void	MoveToTop ()
	Move list scroll to top.
void	SetCurrentPage (int page)
bool	IsPageLoaded (Widget wPage)
void	OnServerEntryFocusEnter (SCR_ScriptedWidgetComponent entry)
SCR_ServerBrowserEntryComponent	ServerEntryByWidget (Widget entryWidget, out int id)
void	SetRooms (array< Room > rooms, int allRoomsCount=-1, bool animate=false)
void	ShowEmptyRooms ()
void	UpdateLoadedPage ()
	Call this to verify currently displayed data are loaded.
bool	IsRoomLoaded (notnull SCR_ServerBrowserEntryComponent entry)
bool	IsEntryVisible (Widget entry)
array< SCR_ServerBrowserEntryComponent >	GetRoomEntries ()
int	GetLoadedPage ()
int	GetCurrentPage ()

Protected Attributes
ref array< SCR_ServerBrowserEntryComponent >	m_aRoomEntries = {}
ref array< Room >	m_aRooms = {}
int	m_iLoadedPage

Detailed Description

Pooled scrollable list with server entries handling.

Definition at line 2 of file SCR_PooledListServerComponent.c.

Member Function Documentation

CreateEntry()

Widget SCR_PooledServerListComponent::CreateEntry ( Widget parent )

inlineprotected

Definition at line 15 of file SCR_PooledListServerComponent.c.

FillEntry()

void SCR_PooledServerListComponent::FillEntry ( Widget w )

inlineprotected

Set server entry it's room data to display server info

Parameters

[in]

w

Definition at line 40 of file SCR_PooledListServerComponent.c.

GetCurrentPage()

int SCR_PooledServerListComponent::GetCurrentPage ( )

inlineprotected

Returns

Definition at line 336 of file SCR_PooledListServerComponent.c.

GetLoadedPage()

int SCR_PooledServerListComponent::GetLoadedPage ( )

inlineprotected

Returns

Definition at line 329 of file SCR_PooledListServerComponent.c.

GetRoomEntries()

array< SCR_ServerBrowserEntryComponent > SCR_PooledServerListComponent::GetRoomEntries ( )

inlineprotected

Returns

Definition at line 322 of file SCR_PooledListServerComponent.c.

IsEntryVisible()

bool SCR_PooledServerListComponent::IsEntryVisible ( Widget entry )

inlineprotected

Parameters

[in]

entry

Returns

true if entry not pass whole found server list

Definition at line 307 of file SCR_PooledListServerComponent.c.

IsPageLoaded()

bool SCR_PooledServerListComponent::IsPageLoaded ( Widget wPage )

inlineprotected

Definition at line 151 of file SCR_PooledListServerComponent.c.

IsRoomLoaded()

bool SCR_PooledServerListComponent::IsRoomLoaded ( notnull SCR_ServerBrowserEntryComponent entry )

inlineprotected

Return true if room of given entry is loaded Base on widget and current id check if it's in loaded servers batch

Parameters

[in]

entry

Returns

Definition at line 292 of file SCR_PooledListServerComponent.c.

MoveToTop()

override void SCR_PooledServerListComponent::MoveToTop ( )

inlineprotected

Move list scroll to top.

Definition at line 90 of file SCR_PooledListServerComponent.c.

OnServerEntryFocusEnter()

void SCR_PooledServerListComponent::OnServerEntryFocusEnter ( SCR_ScriptedWidgetComponent entry )

inlineprotected

Call this when focusing on server entry Show data about server

Parameters

[in]

entry

Definition at line 193 of file SCR_PooledListServerComponent.c.

ServerEntryByWidget()

SCR_ServerBrowserEntryComponent SCR_PooledServerListComponent::ServerEntryByWidget ( Widget entryWidget, out int id )

inlineprotected

Parameters

[in]	entryWidget
[out]	id

Returns

server entry owned by given entry widget root

Definition at line 219 of file SCR_PooledListServerComponent.c.

SetCurrentPage()

void SCR_PooledServerListComponent::SetCurrentPage ( int page )

inlineprotected

Definition at line 98 of file SCR_PooledListServerComponent.c.

SetRooms()

void SCR_PooledServerListComponent::SetRooms ( array< Room > rooms, int allRoomsCount = -1, bool animate = false )

inlineprotected

Parameters

[in]	rooms
[in]	allRoomsCount
[in]	animate

Definition at line 242 of file SCR_PooledListServerComponent.c.

ShowEmptyRooms()

void SCR_PooledServerListComponent::ShowEmptyRooms ( )

inlineprotected

Definition at line 262 of file SCR_PooledListServerComponent.c.

UpdateLoadedPage()

void SCR_PooledServerListComponent::UpdateLoadedPage ( )

inlineprotected

Call this to verify currently displayed data are loaded.

Definition at line 282 of file SCR_PooledListServerComponent.c.

Member Data Documentation

m_aRoomEntries

ref array<SCR_ServerBrowserEntryComponent> SCR_PooledServerListComponent::m_aRoomEntries = {}

protected

Definition at line 5 of file SCR_PooledListServerComponent.c.

m_aRooms

ref array<Room> SCR_PooledServerListComponent::m_aRooms = {}

protected

Definition at line 6 of file SCR_PooledListServerComponent.c.

m_iLoadedPage

int SCR_PooledServerListComponent::m_iLoadedPage

protected

Definition at line 8 of file SCR_PooledListServerComponent.c.

---

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

• scripts/Game/UI/Components/ServerBrowser/SCR_PooledListServerComponent.c