SCR_HideEditorUIComponent Interface Reference

Inheritance diagram for SCR_HideEditorUIComponent:

Public Member Functions
void	SetVisible (bool visible, bool instant=false)
	Set widget visibility.
ScriptInvoker	GetOnOpacityChange ()
override void	HandlerAttachedScripted (Widget w)
	Event called when subcomponent is initialized.
override void	HandlerDeattached (Widget w)
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 Member Functions
void	Show ()
void	SetMenuVisible (bool visible)
void	SetWidgetOpacity (Widget widget, float opacity)
void	OnMenuUpdate (float tDelta)
void	OnMenuInit ()
Protected Member Functions inherited from SCR_BaseEditorUIComponent
vector	OnCancelDown ()
bool	OnCancelUp ()
void	OnCancelExpired ()
Protected Member Functions inherited from MenuRootSubComponent
bool	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.

Protected Attributes
float	m_fTransitionSpeed
ref array< string >	m_aShowActions
SCR_MenuEditorComponent	m_EditorMenuManager
float	m_fTargetOpacity = 1
bool	m_bInTransition
ref ScriptInvoker	Event_OnOpacityChange
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

Member Function Documentation

GetOnOpacityChange()

ScriptInvoker SCR_HideEditorUIComponent.GetOnOpacityChange

(

)

Returns

event invoker every time opacity changes.

HandlerAttachedScripted()

override void SCR_HideEditorUIComponent.HandlerAttachedScripted

(

Widget

w

)

Event called when subcomponent is initialized.

Called only after all other subcomponents were registered as well and can be searched for. To be overwritten by inherited classes.

Parameters

Widget

Implements MenuRootSubComponent.

HandlerDeattached()

override void SCR_HideEditorUIComponent.HandlerDeattached

(

Widget

w

)

Implements MenuRootSubComponent.

OnMenuInit()

void SCR_HideEditorUIComponent.OnMenuInit ( )

protected

OnMenuUpdate()

void SCR_HideEditorUIComponent.OnMenuUpdate ( float  tDelta )

protected

SetMenuVisible()

void SCR_HideEditorUIComponent.SetMenuVisible ( bool  visible )

protected

SetVisible()

void SCR_HideEditorUIComponent.SetVisible	(	bool	visible,
		bool	instant = false
	)

Set widget visibility.

Parameters

[in]	visible	True when visible
[in]	instant	True to set visibility instantly, false to animate it

SetWidgetOpacity()

void SCR_HideEditorUIComponent.SetWidgetOpacity ( Widget  widget, float  opacity  )

protected

Show()

void SCR_HideEditorUIComponent.Show ( )

protected

Member Data Documentation

Event_OnOpacityChange

ref ScriptInvoker SCR_HideEditorUIComponent.Event_OnOpacityChange

protected

m_aShowActions

ref array<string> SCR_HideEditorUIComponent.m_aShowActions

protected

m_bInTransition

bool SCR_HideEditorUIComponent.m_bInTransition

protected

m_EditorMenuManager

SCR_MenuEditorComponent SCR_HideEditorUIComponent.m_EditorMenuManager

protected

m_fTargetOpacity

float SCR_HideEditorUIComponent.m_fTargetOpacity = 1

protected

m_fTransitionSpeed

float SCR_HideEditorUIComponent.m_fTransitionSpeed

protected

---

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

• Game/Editor/UI/Components/Common/SCR_HideEditorUIComponent.c