SCR_ListMenuEntryComponent Interface Reference

Inheritance diagram for SCR_ListMenuEntryComponent:

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

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

AnimateOpacity()

void SCR_ListMenuEntryComponent.AnimateOpacity	(	int	delay,
		float	animationTime,
		float	opacityEnd,
		float	opacityStart = -1
	)

Animate whole widget opacity.

EnableTextAnimations()

void SCR_ListMenuEntryComponent.EnableTextAnimations ( bool  enable )

protected

Apply behavior on all potentially longer entry text.

GetOnFocus()

ScriptInvokerScriptedWidgetComponent SCR_ListMenuEntryComponent.GetOnFocus

(

)

GetOnFocusLost()

ScriptInvokerScriptedWidgetComponent SCR_ListMenuEntryComponent.GetOnFocusLost

(

)

GetOnMouseEnter()

ScriptInvokerScriptedWidgetComponent SCR_ListMenuEntryComponent.GetOnMouseEnter

(

)

GetOnMouseInteractionButtonClicked()

ScriptInvokerString SCR_ListMenuEntryComponent.GetOnMouseInteractionButtonClicked

(

)

HandlerAttached()

override void SCR_ListMenuEntryComponent.HandlerAttached

(

Widget

w

)

Implements SCR_ScriptedWidgetComponent.

Implemented in SCR_ServerBrowserEntryComponent, SCR_AddonLineBaseComponent, SCR_BrowserListMenuEntryComponent, and SCR_ContentBrowser_ScenarioLineComponent.

HandlerDeattached()

override void SCR_ListMenuEntryComponent.HandlerDeattached

(

Widget

w

)

Implemented in SCR_AddonLineBaseComponent, and SCR_ContentBrowser_ScenarioLineComponent.

HandleTextAnimation()

void SCR_ListMenuEntryComponent.HandleTextAnimation ( SCR_HorizontalScrollAnimationComponent  anim, bool  enable  )

protected

Handle animation enabled-disabling enable = false restarts positions.

IsFocused()

bool SCR_ListMenuEntryComponent.IsFocused

(

)

IsInnerButtonInteraction()

bool SCR_ListMenuEntryComponent.IsInnerButtonInteraction

(

)

OnClick()

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

Implements SCR_ScriptedWidgetComponent.

Implemented in SCR_WorkshopAddonLineComponent.

OnDoubleClick()

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

OnFocus()

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

Implemented in SCR_AddonLineBaseComponent.

OnFocusLost()

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

Implemented in SCR_ServerBrowserEntryComponent, and SCR_AddonLineBaseComponent.

OnInnerButtonHover()

void SCR_ListMenuEntryComponent.OnInnerButtonHover ( )

protected

OnInnerButtonLeave()

void SCR_ListMenuEntryComponent.OnInnerButtonLeave ( )

protected

OnMouseEnter()

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

OnTooltipShow()

void SCR_ListMenuEntryComponent.OnTooltipShow ( SCR_ScriptedWidgetTooltip  tooltip )

protected

Implemented in SCR_ServerBrowserEntryComponent, SCR_AddonLineBaseComponent, and SCR_ContentBrowser_ScenarioLineComponent.

OpacityAnimation()

void SCR_ListMenuEntryComponent.OpacityAnimation ( int  time, float  opacityEnd  )

protected

UpdateModularButtons()

void SCR_ListMenuEntryComponent.UpdateModularButtons ( )

protected

Implemented in SCR_ServerBrowserEntryComponent, SCR_AddonLineBaseComponent, SCR_BrowserListMenuEntryComponent, and SCR_ContentBrowser_ScenarioLineComponent.

Member Data Documentation

m_aMouseButtons

ref array<SCR_ModularButtonComponent> SCR_ListMenuEntryComponent.m_aMouseButtons = {}

protected

m_aScrollAnimations

ref array<ref SCR_HorizontalScrollAnimationComponent> SCR_ListMenuEntryComponent.m_aScrollAnimations = {}

protected

m_bFocused

bool SCR_ListMenuEntryComponent.m_bFocused

protected

m_bInnerButtonInteraction

bool SCR_ListMenuEntryComponent.m_bInnerButtonInteraction

protected

m_bUnavailable

bool SCR_ListMenuEntryComponent.m_bUnavailable

protected

m_CurrentTooltip

SCR_ScriptedWidgetTooltip SCR_ListMenuEntryComponent.m_CurrentTooltip

protected

m_MainModularButton

SCR_ModularButtonComponent SCR_ListMenuEntryComponent.m_MainModularButton

protected

m_OnFocus

ref ScriptInvokerScriptedWidgetComponent SCR_ListMenuEntryComponent.m_OnFocus

protected

m_OnFocusLost

ref ScriptInvokerScriptedWidgetComponent SCR_ListMenuEntryComponent.m_OnFocusLost

protected

m_OnMouseEnter

ref ScriptInvokerScriptedWidgetComponent SCR_ListMenuEntryComponent.m_OnMouseEnter

protected

m_OnMouseInteractionButtonClicked

ref ScriptInvokerString SCR_ListMenuEntryComponent.m_OnMouseInteractionButtonClicked

protected

---

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

• Game/UI/Menu/Common/SCR_ListMenuEntryComponent.c