SCR_WLibComponentBase Interface Reference

Base class for all final Reforger interactive elements. More...

Inheritance diagram for SCR_WLibComponentBase:

Public Member Functions
override void	HandlerAttached (Widget w)
override bool	OnClick (Widget w, int x, int y, int button)
override bool	OnMouseEnter (Widget w, int x, int y)
override bool	OnFocus (Widget w, int x, int y)
void	SetHoverSound (string soundHover)
void	SetClickedSound (string soundClicked)
string	GetHoverSound ()
string	GetClickedSound ()
void	SetEnabled (bool enabled, bool animate=true)
void	SetVisible (bool visible, bool animate=true)
bool	IsEnabled ()
void	SetMouseOverToFocus (bool mouseOverToFocus)
void	SetDisabledOpacity (float newDisabledOpacity)
void	SetData (Managed data)
	Store custom data.
Managed	GetData ()
	Get stored data.
Public Member Functions inherited from SCR_ScriptedWidgetComponent
Widget	GetRootWidget ()
bool	IsVisible ()

Static Public Member Functions
static bool	SetTexture (ImageWidget widget, ResourceName texture, string image="")
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.

Static Public Attributes
static const float	START_ANIMATION_RATE = 10001
static const float	START_ANIMATION_PERIOD = 250

Protected Member Functions
void	OnEnabled (bool animate)
void	OnDisabled (bool animate)
bool	IsChildWidget (Widget parent, Widget child)
void	SetAnimationRate ()
void	PlaySound (string sound)

Protected Attributes
string	m_sSoundHovered
string	m_sSoundClicked
string	m_sSoundContainerClosed
float	m_fAnimationTime
bool	m_bMouseOverToFocus
float	m_fDisabledOpacity
float	m_fAnimationRate
ref Managed	m_UserData
Protected Attributes inherited from SCR_ScriptedWidgetComponent
Widget	m_wRoot

Additional Inherited Members
Public Attributes inherited from SCR_ScriptedWidgetComponent
ref ScriptInvoker	m_OnClick = new ScriptInvoker

Detailed Description

Base class for all final Reforger interactive elements.

Member Function Documentation

GetClickedSound()

string SCR_WLibComponentBase.GetClickedSound

(

)

GetData()

Managed SCR_WLibComponentBase.GetData

(

)

Get stored data.

Returns

data if set, null otherwise

GetHoverSound()

string SCR_WLibComponentBase.GetHoverSound

(

)

HandlerAttached()

override void SCR_WLibComponentBase.HandlerAttached

(

Widget

w

)

Implements SCR_ScriptedWidgetComponent.

Implemented in SCR_AddonLinePresetComponent, SCR_ButtonBaseComponent, SCR_ButtonCheckerComponent, SCR_ButtonComponent, SCR_ButtonImageComponent, SCR_ButtonLegendComponent, SCR_ButtonSpecializationProgressComponent, SCR_ButtonSplitComponent, SCR_ButtonTextComponent, SCR_ChangeableComponentBase, SCR_ComboBoxComponent, SCR_ComboBoxIconComponent, SCR_ContentEntryComponent, SCR_DeployButton, SCR_DeployButtonBase, SCR_EditBoxComponent, SCR_EditBoxSearchComponent, SCR_FactionButton, SCR_GroupButton, SCR_GroupFlagImageComponent, SCR_ImageGalleryButtonComponent, SCR_ImagePickerComponent, SCR_InputButtonComponent, SCR_InventorySpinBoxComponent, SCR_LoadingCircleComponent, SCR_LoadoutButton, SCR_ModdedScenarioComponent, SCR_ModEntryComponent, SCR_MultipleStatesButtonComponent, SCR_PagingButtonComponent, SCR_SaveImageGalleryPickerComponent, SCR_ScrollBarComponent, SCR_ScrollBarHandleComponent, SCR_SelectableButtonComponent, SCR_SelectableTileButtonComponent, SCR_ServerDetailEntryComponent, SCR_ServerSortingComponent, SCR_SliderComponent, SCR_SpinBoxComponent, SCR_SpinBoxPagingComponent, SCR_TaskListEntryHandler, SCR_TaskPlayerListEntryHandler, SCR_ToolboxComponent, SCR_ToolboxMultilineComponent, SCR_ToolMenuButtonComponent, and SCR_WidgetHintComponent.

IsChildWidget()

bool SCR_WLibComponentBase.IsChildWidget ( Widget parent, Widget child )

protected

IsEnabled()

bool SCR_WLibComponentBase.IsEnabled

(

)

OnClick()

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

Implements SCR_ScriptedWidgetComponent.

Implemented in SCR_ButtonBaseComponent, SCR_ButtonCheckerComponent, SCR_ButtonLegendComponent, SCR_ButtonSpecializationProgressComponent, SCR_DeployButtonBase, SCR_GroupTileButton, SCR_ImageGalleryButtonComponent, SCR_InputButtonComponent, SCR_InventoryNavigationButtonBack, SCR_MultipleStatesButtonComponent, SCR_PagingButtonComponent, SCR_SelectableButtonComponent, SCR_SelectableTileButtonComponent, and SCR_TaskListEntryHandler.

OnDisabled()

void SCR_WLibComponentBase.OnDisabled ( bool animate )

protected

Implemented in SCR_ComboBoxComponent, and SCR_InputButtonComponent.

OnEnabled()

void SCR_WLibComponentBase.OnEnabled ( bool animate )

protected

Implemented in SCR_ComboBoxComponent, and SCR_InputButtonComponent.

OnFocus()

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

Implemented in SCR_AddonLinePresetComponent, SCR_ButtonBaseComponent, SCR_ButtonComponent, SCR_ButtonLegendComponent, SCR_ChangeableComponentBase, SCR_ComboBoxComponent, SCR_DeployButtonBase, SCR_EditBoxComponent, SCR_GroupTileButton, SCR_InventorySpinBoxComponent, SCR_LoadoutButton, SCR_ModdedScenarioComponent, SCR_ModEntryComponent, SCR_MultipleStatesButtonComponent, SCR_SelectableButtonComponent, SCR_SelectableTileButtonComponent, SCR_SliderComponent, SCR_SpawnPointSpinBox, SCR_SpinBoxComponent, SCR_TaskListEntryHandler, SCR_TaskPlayerListEntryHandler, and SCR_ToolboxComponent.

OnMouseEnter()

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

Implemented in SCR_ButtonBaseComponent, SCR_ButtonComponent, SCR_ButtonImageComponent, SCR_ButtonLegendComponent, SCR_ButtonSpecializationProgressComponent, SCR_ButtonSplitComponent, SCR_ButtonTextComponent, SCR_ChangeableComponentBase, SCR_EditBoxSearchComponent, SCR_InputButtonComponent, SCR_MultipleStatesButtonComponent, SCR_PagingButtonComponent, SCR_ScrollBarHandleComponent, SCR_SelectableButtonComponent, SCR_SelectableTileButtonComponent, SCR_TaskPlayerListEntryHandler, and SCR_ToolboxComponent.

PlaySound()

void SCR_WLibComponentBase.PlaySound ( string sound )

protected

SetAnimationRate()

void SCR_WLibComponentBase.SetAnimationRate ( )

protected

SetClickedSound()

void SCR_WLibComponentBase.SetClickedSound

(

string

soundClicked

)

SetData()

void SCR_WLibComponentBase.SetData

(

Managed

data

)

Store custom data.

Parameters

[in]

data

SetDisabledOpacity()

void SCR_WLibComponentBase.SetDisabledOpacity

(

float

newDisabledOpacity

)

SetEnabled()

void SCR_WLibComponentBase.SetEnabled	(	bool	enabled,
		bool	animate = true )

Implemented in SCR_DeployButtonBase, SCR_InputButtonComponent, and SCR_PagingButtonComponent.

SetHoverSound()

void SCR_WLibComponentBase.SetHoverSound

(

string

soundHover

)

SetMouseOverToFocus()

void SCR_WLibComponentBase.SetMouseOverToFocus

(

bool

mouseOverToFocus

)

SetTexture()

static bool SCR_WLibComponentBase.SetTexture ( ImageWidget widget, ResourceName texture, string image = "" )

static

SetVisible()

void SCR_WLibComponentBase.SetVisible	(	bool	visible,
		bool	animate = true )

Implemented in SCR_WidgetHintComponent.

Member Data Documentation

m_bMouseOverToFocus

bool SCR_WLibComponentBase.m_bMouseOverToFocus

protected

m_fAnimationRate

float SCR_WLibComponentBase.m_fAnimationRate

protected

m_fAnimationTime

float SCR_WLibComponentBase.m_fAnimationTime

protected

m_fDisabledOpacity

float SCR_WLibComponentBase.m_fDisabledOpacity

protected

m_sSoundClicked

string SCR_WLibComponentBase.m_sSoundClicked

protected

m_sSoundContainerClosed

string SCR_WLibComponentBase.m_sSoundContainerClosed

protected

m_sSoundHovered

string SCR_WLibComponentBase.m_sSoundHovered

protected

m_UserData

ref Managed SCR_WLibComponentBase.m_UserData

protected

START_ANIMATION_PERIOD

const float SCR_WLibComponentBase.START_ANIMATION_PERIOD = 250

static

START_ANIMATION_RATE

const float SCR_WLibComponentBase.START_ANIMATION_RATE = 10001

static

---

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

• Game/UI/Components/WidgetLibrary/SCR_WLibComponentBase.c