This component handles server entry and visiualization of server data. More...

Inheritance diagram for SCR_ServerBrowserEntryComponent:

Public Member Functions
override void	HandlerAttached (Widget w)

override void	OnTooltipShow (SCR_ScriptedWidgetTooltip tooltip)

override void	UpdateModularButtons ()

override bool	OnFocus (Widget w, int x, int y)

override bool	OnFocusLost (Widget w, int x, int y)

void	SetRoomInfo (Room room)
	Set room and display room info in entry.

void	EmptyVisuals (bool enable)
	Set button visuals and behaviour.

void	SetModsManager (SCR_RoomModsManager modsManager)

Room	GetRoomInfo ()

bool	GetIsModded ()

bool	GetIsEnabled (out bool versionMismatch, out bool unjoinable)

Public Member Functions inherited from SCR_BrowserListMenuEntryComponent
override void	HandlerAttached (Widget w)

override void	UpdateModularButtons ()

bool	SetFavorite (bool favorite)

bool	IsFavorite ()

ScriptInvokerBrowserListMenuEntry	GetOnFavorite ()

Public Member Functions inherited from SCR_ListMenuEntryComponent
override void	HandlerAttached (Widget w)

override void	HandlerDeattached (Widget w)

override bool	OnClick (Widget w, int x, int y, int button)

override bool	OnDoubleClick (Widget w, int x, int y, int button)

override bool	OnFocus (Widget w, int x, int y)

override bool	OnFocusLost (Widget w, int x, int y)

override bool	OnMouseEnter (Widget w, int x, int y)

void	AnimateOpacity (int delay, float animationTime, float opacityEnd, float opacityStart=-1)
	Animate whole widget opacity.

bool	IsInnerButtonInteraction ()

bool	IsFocused ()

bool	IsAvailable ()

ScriptInvokerString	GetOnMouseInteractionButtonClicked ()

ScriptInvokerScriptedWidgetComponent	GetOnFocus ()

ScriptInvokerScriptedWidgetComponent	GetOnFocusLost ()

ScriptInvokerScriptedWidgetComponent	GetOnMouseEnter ()

Public Member Functions inherited from SCR_ScriptedWidgetComponent
override void	HandlerAttached (Widget w)

override bool	OnClick (Widget w, int x, int y, int button)

Widget	GetRootWidget ()

bool	IsVisible ()

Protected Member Functions
void	OnJoinInteractionButtonClicked ()

void	SetCellText (string cellName, string str, string widgetName="Content")
	Set text in cell by it's widget name.

void	DisplayPing (int ping)
	Display number of current ping and add icon and color.

void	DisplayQueue ()

void	CheckRoomProperties ()
	Check properties and assign state of room.

void	DisplayServerProperties ()
	Create property images based on room setup.

string	GetDownloadSizeMessage ()

void	OnServerDetailModsLoaded ()

void	UpdateTooltipJoinDownloadSizeMessage ()

Protected Member Functions inherited from SCR_BrowserListMenuEntryComponent
void	OnFavoriteClicked (SCR_ModularButtonComponent comp)

Protected Member Functions inherited from SCR_ListMenuEntryComponent
void	OnTooltipShow (SCR_ScriptedWidgetTooltip tooltip)

void	OnInnerButtonHover ()

void	OnInnerButtonLeave ()

void	EnableTextAnimations (bool enable)
	Apply behavior on all potentially longer entry text.

void	HandleTextAnimation (SCR_HorizontalScrollAnimationComponent anim, bool enable)
	Handle animation enabled-disabling enable = false restarts positions.

void	UpdateModularButtons ()

void	OpacityAnimation (int time, float opacityEnd)

Protected Attributes
int	m_iPingLimit

string	m_sTooltipDownloadIcon

float	m_fTooltipDownloadIconScale

ref array< ref ServerBrowserEntryProperty >	m_aPingStates

Room	m_RoomInfo

SCR_EServerEntryProperty	m_iProperties

SCR_RoomModsManager	m_ModsManager

string	m_sPatchSize

bool	m_bIsPatchSizeLoaded

int	m_iHighestPing

TextWidget	m_wQueue

Widget	m_wHorizontalContent

Widget	m_wLoading

Widget	m_wUnjoinableIcon

ImageWidget	m_wImgPing

Widget	m_wImageModded

Widget	m_wJoinButton

Widget	m_wPasswordButton

Widget	m_wVersionWarningIcon

SCR_ModularButtonComponent	m_JoinButton

SCR_ModularButtonComponent	m_PasswordButton

Protected Attributes inherited from SCR_BrowserListMenuEntryComponent
ref SCR_ModularButtonComponent	m_FavoriteButton

bool	m_bFavorite

ref ScriptInvokerBrowserListMenuEntry	m_OnFavorite

Protected Attributes inherited from SCR_ListMenuEntryComponent
ref array< ref SCR_HorizontalScrollAnimationComponent >	m_aScrollAnimations = {}

bool	m_bInnerButtonInteraction

ref array< SCR_ModularButtonComponent >	m_aMouseButtons = {}

SCR_ModularButtonComponent	m_MainModularButton

bool	m_bUnavailable

bool	m_bFocused

SCR_ScriptedWidgetTooltip	m_CurrentTooltip

ref ScriptInvokerString	m_OnMouseInteractionButtonClicked

ref ScriptInvokerScriptedWidgetComponent	m_OnFocus

ref ScriptInvokerScriptedWidgetComponent	m_OnFocusLost

ref ScriptInvokerScriptedWidgetComponent	m_OnMouseEnter

Protected Attributes inherited from SCR_ScriptedWidgetComponent
Widget	m_wRoot

Static Protected Attributes
const string	LAYOUT_CONTENT = "HorizontalLayout"

const string	LAYOUT_LOADING = "Loading"

const string	TEXT_WIDGET_QUEUE = "Queue"

const string	BUTTON_JOIN = "JoinButton"

const string	BUTTON_PASSWORD = "PasswordButton"

const string	ICON_WARNING = "VersionWarningIcon"

const string	ICON_UNJOINABLE = "JoinWarningIcon"

const string	ICON_MODDED = "ImageModded"

const string	ICON_PING = "ImgPing"

const string	FRAME_NAME = "FrameName"

const string	FRAME_SCENARIO = "FrameScenario"

const string	TOOLTIP_JOIN = "Join"

const string	TOOLTIP_VERSION_MISMATCH = "VersionMismatch"

Static Protected Attributes inherited from SCR_BrowserListMenuEntryComponent
static const string	BUTTON_FAVORITE = "FavoriteButton"

Additional Inherited Members
Static Public Member Functions inherited from SCR_ScriptedWidgetComponent
static SCR_ScriptedWidgetComponent	GetComponent (TypeName componentType, string name, Widget parent, bool searchAllChildren=true)
	Base method for component lookup through the widget library.

Public Attributes inherited from SCR_ScriptedWidgetComponent
ref ScriptInvoker	m_OnClick = new ScriptInvoker

Detailed Description

This component handles server entry and visiualization of server data.

Member Function Documentation

◆ CheckRoomProperties()

void SCR_ServerBrowserEntryComponent.CheckRoomProperties ( )

protected

Check properties and assign state of room.

◆ DisplayPing()

void SCR_ServerBrowserEntryComponent.DisplayPing ( int ping )

protected

Display number of current ping and add icon and color.

Parameters

[in] ping

◆ DisplayQueue()

void SCR_ServerBrowserEntryComponent.DisplayQueue ( )

protected

◆ DisplayServerProperties()

void SCR_ServerBrowserEntryComponent.DisplayServerProperties ( )

protected

Create property images based on room setup.

◆ EmptyVisuals()

void SCR_ServerBrowserEntryComponent.EmptyVisuals ( bool enable )

Set button visuals and behaviour.

Parameters

[in] enable

◆ GetDownloadSizeMessage()

string SCR_ServerBrowserEntryComponent.GetDownloadSizeMessage ( )

protected

◆ GetIsEnabled()

bool SCR_ServerBrowserEntryComponent.GetIsEnabled	(	out bool	versionMismatch,
		out bool	unjoinable
	)

Parameters

[out]	versionMismatch
[out]	unjoinable

Returns

◆ GetIsModded()

bool SCR_ServerBrowserEntryComponent.GetIsModded ( )

Returns

◆ GetRoomInfo()

Room SCR_ServerBrowserEntryComponent.GetRoomInfo ( )

Returns

◆ HandlerAttached()

override void SCR_ServerBrowserEntryComponent.HandlerAttached ( Widget w )

Implements SCR_BrowserListMenuEntryComponent.

◆ OnFocus()

override bool SCR_ServerBrowserEntryComponent.OnFocus	(	Widget	w,
		int	x,
		int	y
	)

Implements SCR_ListMenuEntryComponent.

◆ OnFocusLost()

override bool SCR_ServerBrowserEntryComponent.OnFocusLost	(	Widget	w,
		int	x,
		int	y
	)

Implements SCR_ListMenuEntryComponent.

◆ OnJoinInteractionButtonClicked()

void SCR_ServerBrowserEntryComponent.OnJoinInteractionButtonClicked ( )

protected

◆ OnServerDetailModsLoaded()

void SCR_ServerBrowserEntryComponent.OnServerDetailModsLoaded ( )

protected

◆ OnTooltipShow()

override void SCR_ServerBrowserEntryComponent.OnTooltipShow ( SCR_ScriptedWidgetTooltip tooltip )

Implements SCR_ListMenuEntryComponent.

◆ SetCellText()

void SCR_ServerBrowserEntryComponent.SetCellText	(	string	cellName,
		string	str,
		string	widgetName = `"Content"`
	)

protected

Set text in cell by it's widget name.

Parameters

[in]	cellName
[in]	str

◆ SetModsManager()

void SCR_ServerBrowserEntryComponent.SetModsManager ( SCR_RoomModsManager modsManager )

Parameters

[in] modsManager

◆ SetRoomInfo()

void SCR_ServerBrowserEntryComponent.SetRoomInfo ( Room room )

Set room and display room info in entry.

Parameters

[in] room

◆ UpdateModularButtons()

override void SCR_ServerBrowserEntryComponent.UpdateModularButtons ( )

Implements SCR_BrowserListMenuEntryComponent.

◆ UpdateTooltipJoinDownloadSizeMessage()

void SCR_ServerBrowserEntryComponent.UpdateTooltipJoinDownloadSizeMessage ( )

protected

Member Data Documentation

◆ BUTTON_JOIN

const string SCR_ServerBrowserEntryComponent.BUTTON_JOIN = "JoinButton"

staticprotected

◆ BUTTON_PASSWORD

const string SCR_ServerBrowserEntryComponent.BUTTON_PASSWORD = "PasswordButton"

staticprotected

◆ FRAME_NAME

const string SCR_ServerBrowserEntryComponent.FRAME_NAME = "FrameName"

staticprotected

◆ FRAME_SCENARIO

const string SCR_ServerBrowserEntryComponent.FRAME_SCENARIO = "FrameScenario"

staticprotected

◆ ICON_MODDED

const string SCR_ServerBrowserEntryComponent.ICON_MODDED = "ImageModded"

staticprotected

◆ ICON_PING

const string SCR_ServerBrowserEntryComponent.ICON_PING = "ImgPing"

staticprotected

◆ ICON_UNJOINABLE

const string SCR_ServerBrowserEntryComponent.ICON_UNJOINABLE = "JoinWarningIcon"

staticprotected

◆ ICON_WARNING

const string SCR_ServerBrowserEntryComponent.ICON_WARNING = "VersionWarningIcon"

staticprotected

◆ LAYOUT_CONTENT

const string SCR_ServerBrowserEntryComponent.LAYOUT_CONTENT = "HorizontalLayout"

staticprotected

◆ LAYOUT_LOADING

const string SCR_ServerBrowserEntryComponent.LAYOUT_LOADING = "Loading"

staticprotected

◆ m_aPingStates

ref array<ref ServerBrowserEntryProperty> SCR_ServerBrowserEntryComponent.m_aPingStates

protected

◆ m_bIsPatchSizeLoaded

bool SCR_ServerBrowserEntryComponent.m_bIsPatchSizeLoaded

protected

◆ m_fTooltipDownloadIconScale

float SCR_ServerBrowserEntryComponent.m_fTooltipDownloadIconScale

protected

◆ m_iHighestPing

int SCR_ServerBrowserEntryComponent.m_iHighestPing

protected

◆ m_iPingLimit

int SCR_ServerBrowserEntryComponent.m_iPingLimit

protected

◆ m_iProperties

SCR_EServerEntryProperty SCR_ServerBrowserEntryComponent.m_iProperties

protected

◆ m_JoinButton

SCR_ModularButtonComponent SCR_ServerBrowserEntryComponent.m_JoinButton

protected

◆ m_ModsManager

SCR_RoomModsManager SCR_ServerBrowserEntryComponent.m_ModsManager

protected

◆ m_PasswordButton

SCR_ModularButtonComponent SCR_ServerBrowserEntryComponent.m_PasswordButton

protected

◆ m_RoomInfo

Room SCR_ServerBrowserEntryComponent.m_RoomInfo

protected

◆ m_sPatchSize

string SCR_ServerBrowserEntryComponent.m_sPatchSize

protected

◆ m_sTooltipDownloadIcon

string SCR_ServerBrowserEntryComponent.m_sTooltipDownloadIcon

protected

◆ m_wHorizontalContent

Widget SCR_ServerBrowserEntryComponent.m_wHorizontalContent

protected

◆ m_wImageModded

Widget SCR_ServerBrowserEntryComponent.m_wImageModded

protected

◆ m_wImgPing

ImageWidget SCR_ServerBrowserEntryComponent.m_wImgPing

protected

◆ m_wJoinButton

Widget SCR_ServerBrowserEntryComponent.m_wJoinButton

protected

◆ m_wLoading

Widget SCR_ServerBrowserEntryComponent.m_wLoading

protected

◆ m_wPasswordButton

Widget SCR_ServerBrowserEntryComponent.m_wPasswordButton

protected

◆ m_wQueue

TextWidget SCR_ServerBrowserEntryComponent.m_wQueue

protected

◆ m_wUnjoinableIcon

Widget SCR_ServerBrowserEntryComponent.m_wUnjoinableIcon

protected

◆ m_wVersionWarningIcon

Widget SCR_ServerBrowserEntryComponent.m_wVersionWarningIcon

protected

◆ TEXT_WIDGET_QUEUE

const string SCR_ServerBrowserEntryComponent.TEXT_WIDGET_QUEUE = "Queue"

staticprotected

◆ TOOLTIP_JOIN

const string SCR_ServerBrowserEntryComponent.TOOLTIP_JOIN = "Join"

staticprotected

◆ TOOLTIP_VERSION_MISMATCH

const string SCR_ServerBrowserEntryComponent.TOOLTIP_VERSION_MISMATCH = "VersionMismatch"

staticprotected

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

Game/UI/Components/ServerBrowser/SCR_ServerBrowserEntryComponent.c

Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ CheckRoomProperties()

◆ DisplayPing()

◆ DisplayQueue()

◆ DisplayServerProperties()

◆ EmptyVisuals()

◆ GetDownloadSizeMessage()

◆ GetIsEnabled()

◆ GetIsModded()

◆ GetRoomInfo()

◆ HandlerAttached()

◆ OnFocus()

◆ OnFocusLost()

◆ OnJoinInteractionButtonClicked()

◆ OnServerDetailModsLoaded()

◆ OnTooltipShow()

◆ SetCellText()

◆ SetModsManager()

◆ SetRoomInfo()

◆ UpdateModularButtons()

◆ UpdateTooltipJoinDownloadSizeMessage()

Member Data Documentation

◆ BUTTON_JOIN

◆ BUTTON_PASSWORD

◆ FRAME_NAME

◆ FRAME_SCENARIO

◆ ICON_MODDED

◆ ICON_PING

◆ ICON_UNJOINABLE

◆ ICON_WARNING

◆ LAYOUT_CONTENT

◆ LAYOUT_LOADING

◆ m_aPingStates

◆ m_bIsPatchSizeLoaded

◆ m_fTooltipDownloadIconScale

◆ m_iHighestPing

◆ m_iPingLimit

◆ m_iProperties

◆ m_JoinButton

◆ m_ModsManager

◆ m_PasswordButton

◆ m_RoomInfo

◆ m_sPatchSize

◆ m_sTooltipDownloadIcon

◆ m_wHorizontalContent

◆ m_wImageModded

◆ m_wImgPing

◆ m_wJoinButton

◆ m_wLoading

◆ m_wPasswordButton

◆ m_wQueue

◆ m_wUnjoinableIcon

◆ m_wVersionWarningIcon

◆ TEXT_WIDGET_QUEUE

◆ TOOLTIP_JOIN

◆ TOOLTIP_VERSION_MISMATCH