SCR_BrowserListMenuEntryComponent Interface Reference

Inheritance diagram for SCR_BrowserListMenuEntryComponent:

Public Member Functions
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	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
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
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

Member Function Documentation

GetOnFavorite()

ScriptInvokerBrowserListMenuEntry SCR_BrowserListMenuEntryComponent.GetOnFavorite

(

)

HandlerAttached()

override void SCR_BrowserListMenuEntryComponent.HandlerAttached

(

Widget

w

)

Implements SCR_ListMenuEntryComponent.

Implemented in SCR_ServerBrowserEntryComponent, and SCR_ContentBrowser_ScenarioLineComponent.

IsFavorite()

bool SCR_BrowserListMenuEntryComponent.IsFavorite

(

)

OnFavoriteClicked()

void SCR_BrowserListMenuEntryComponent.OnFavoriteClicked ( SCR_ModularButtonComponent  comp )

protected

SetFavorite()

bool SCR_BrowserListMenuEntryComponent.SetFavorite

(

bool

favorite

)

Implemented in SCR_ContentBrowser_GMSaveLineComponent, and SCR_ContentBrowser_ScenarioLineComponent.

UpdateModularButtons()

override void SCR_BrowserListMenuEntryComponent.UpdateModularButtons

(

)

Implements SCR_ListMenuEntryComponent.

Implemented in SCR_ServerBrowserEntryComponent, SCR_ContentBrowser_GMSaveLineComponent, and SCR_ContentBrowser_ScenarioLineComponent.

Member Data Documentation

BUTTON_FAVORITE

const string SCR_BrowserListMenuEntryComponent.BUTTON_FAVORITE = "FavoriteButton"

staticprotected

m_bFavorite

bool SCR_BrowserListMenuEntryComponent.m_bFavorite

protected

m_FavoriteButton

ref SCR_ModularButtonComponent SCR_BrowserListMenuEntryComponent.m_FavoriteButton

protected

m_OnFavorite

ref ScriptInvokerBrowserListMenuEntry SCR_BrowserListMenuEntryComponent.m_OnFavorite

protected

---

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

• Game/UI/Menu/ContentBrowser/Common/SCR_BrowserListMenuEntryComponent.c