SCR_BaseTooltipEditorUIComponent Interface Reference

Inheritance diagram for SCR_BaseTooltipEditorUIComponent:

Public Member Functions
void	UpdateTooltip (Managed instance=null)
bool	SetTooltip (SCR_UIInfo info, Managed instance=null)
override bool	IsUnique ()
	Is the component to exist only in one instance?
Public Member Functions inherited from MenuRootSubComponent
Widget	GetWidget ()
	Get widget to which the component belongs to.
MenuRootBase	GetMenu ()
	Get menu of which the widget is part of.
MenuRootComponent	GetRootComponent ()
	Get root component of this subcomponent,.
void	HandlerAttachedScripted (Widget w)
	Event called when subcomponent is initialized.
override void	HandlerAttached (Widget w)
override void	HandlerDeattached (Widget w)

Protected Attributes
string	m_sNameWidgetName
string	m_sDescriptionWidgetName
string	m_sIconWidgetName
Protected Attributes inherited from SCR_BaseEditorUIComponent
vector	m_vClickPosCancel

Additional Inherited Members
Static Public Attributes inherited from SCR_BaseEditorUIComponent
const int	CANCEL_CLICK_MAX_DIS = 5
const int	CANCEL_CLICK_MAX_TIME = 500
Protected Member Functions inherited from SCR_BaseEditorUIComponent
vector	OnCancelDown ()
bool	OnCancelUp ()
void	OnCancelExpired ()

Member Function Documentation

IsUnique()

override bool SCR_BaseTooltipEditorUIComponent.IsUnique

(

)

Is the component to exist only in one instance?

If so, it will be registered in the list of components and can be searched for. To be overwritten by inherited classes.

Returns

True if unique

Implements MenuRootSubComponent.

SetTooltip()

bool SCR_BaseTooltipEditorUIComponent.SetTooltip	(	SCR_UIInfo	info,
		Managed	instance = null )

Parameters

[in]	info
[in]	instance

Returns

Implemented in SCR_ActionTooltipEditorUIComponent, and SCR_EntityTooltipEditorUIComponent.

UpdateTooltip()

void SCR_BaseTooltipEditorUIComponent.UpdateTooltip

(

Managed

instance = null

)

Parameters

[in]

instance

Implemented in SCR_EntityTooltipEditorUIComponent.

Member Data Documentation

m_sDescriptionWidgetName

string SCR_BaseTooltipEditorUIComponent.m_sDescriptionWidgetName

protected

m_sIconWidgetName

string SCR_BaseTooltipEditorUIComponent.m_sIconWidgetName

protected

m_sNameWidgetName

string SCR_BaseTooltipEditorUIComponent.m_sNameWidgetName

protected

---

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

• Game/Editor/UI/Components/Tooltips/Tooltips/SCR_BaseTooltipEditorUIComponent.c