SCR_WidgetHintComponent Interface Reference

Inheritance diagram for SCR_WidgetHintComponent:

Public Member Functions
override void	HandlerAttached (Widget w)
override void	SetVisible (bool visible, bool animate=true)
void	SetMessage (string message)
string	GetMessage ()
void	UseDefaultMessage ()
Public Member Functions inherited from SCR_WLibComponentBase
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)
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 Attributes
string	m_sWidgetIcon
string	m_sWidgetMessage
string	m_sWidgetBumper
string	m_sDefaultMessage
bool	m_bUseBumber
ImageWidget	m_wIcon
TextWidget	m_wMessage
Widget	m_wBumper
Protected Attributes inherited from SCR_WLibComponentBase
string	m_sSoundHovered
string	m_sSoundClicked
float	m_fAnimationTime
bool	m_bMouseOverToFocus
float	m_fDisabledOpacity
float	m_fAnimationRate
Protected Attributes inherited from SCR_ScriptedWidgetComponent
Widget	m_wRoot

Additional Inherited Members
Static Public Member Functions inherited from SCR_WLibComponentBase
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.
Public Attributes inherited from SCR_ScriptedWidgetComponent
ref ScriptInvoker	m_OnClick = new ScriptInvoker
Static Public Attributes inherited from SCR_WLibComponentBase
static const float	START_ANIMATION_RATE = 10001
static const float	START_ANIMATION_PERIOD = 250
Protected Member Functions inherited from SCR_WLibComponentBase
void	OnEnabled (bool animate)
void	OnDisabled (bool animate)
bool	IsChildWidget (Widget parent, Widget child)
void	SetAnimationRate ()
void	PlaySound (string sound)

Member Function Documentation

GetMessage()

string SCR_WidgetHintComponent.GetMessage

(

)

HandlerAttached()

override void SCR_WidgetHintComponent.HandlerAttached

(

Widget

w

)

Implements SCR_WLibComponentBase.

SetMessage()

void SCR_WidgetHintComponent.SetMessage

(

string

message

)

SetVisible()

override void SCR_WidgetHintComponent.SetVisible	(	bool	visible,
		bool	animate = true
	)

Implements SCR_WLibComponentBase.

UseDefaultMessage()

void SCR_WidgetHintComponent.UseDefaultMessage

(

)

Member Data Documentation

m_bUseBumber

bool SCR_WidgetHintComponent.m_bUseBumber

protected

m_sDefaultMessage

string SCR_WidgetHintComponent.m_sDefaultMessage

protected

m_sWidgetBumper

string SCR_WidgetHintComponent.m_sWidgetBumper

protected

m_sWidgetIcon

string SCR_WidgetHintComponent.m_sWidgetIcon

protected

m_sWidgetMessage

string SCR_WidgetHintComponent.m_sWidgetMessage

protected

m_wBumper

Widget SCR_WidgetHintComponent.m_wBumper

protected

m_wIcon

ImageWidget SCR_WidgetHintComponent.m_wIcon

protected

m_wMessage

TextWidget SCR_WidgetHintComponent.m_wMessage

protected

---

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

• Game/UI/Components/WidgetLibrary/SCR_EditBox/SCR_WidgetHintComponent.c