SCR_EditorMenuOverlayLayer Interface Reference

Public Member Functions
EEditorMenuOverlayLayer	GetLayer ()
	Get layer type.
int	GetOverlays (out notnull array< SCR_EditorMenuOverlay > outOverlays)
	Get all overlays within this layer.
void	SetCurrentOverlay (int index, bool forced=false)
	Set current overlay.
void	ResetOverlay ()
	Set overlay to defautl value.
SCR_EditorMenuOverlay	GetCurrentOverlay ()
	Get current overlay.
int	GetCurrentOverlayIndex ()
	Get index of current overlay.
Widget	GetOverlayWidget ()
	Get widget representing the overlay.
void	ActivateLayer ()
void	PostActivateLayer (SCR_MenuEditorComponent menu, WorkspaceWidget workspace)
	Create widgets of all overlays within the layer.
void	ExitLayer (SCR_MenuEditorComponent menu)
	Delete all overlays within the layer.
ScriptInvoker	GetOnOverlayChanged ()
	Get event invoker every time the overlay changes.
void	SCR_EditorMenuOverlayLayer ()

Protected Member Functions
void	OnHide (float opacity)
void	RefreshOverlay ()
void	UpdateCustomRoot ()
Widget	GetRootWidget (Widget rootWidget, string widgetName)

Constructor & Destructor Documentation

SCR_EditorMenuOverlayLayer()

void SCR_EditorMenuOverlayLayer.SCR_EditorMenuOverlayLayer

(

)

Member Function Documentation

ActivateLayer()

void SCR_EditorMenuOverlayLayer.ActivateLayer

(

)

ExitLayer()

void SCR_EditorMenuOverlayLayer.ExitLayer

(

SCR_MenuEditorComponent

menu

)

Delete all overlays within the layer.

GetCurrentOverlay()

SCR_EditorMenuOverlay SCR_EditorMenuOverlayLayer.GetCurrentOverlay

(

)

Get current overlay.

Returns

Overlay

GetCurrentOverlayIndex()

int SCR_EditorMenuOverlayLayer.GetCurrentOverlayIndex

(

)

Get index of current overlay.

Returns

Index

GetLayer()

EEditorMenuOverlayLayer SCR_EditorMenuOverlayLayer.GetLayer

(

)

Get layer type.

Returns

Layer type

GetOnOverlayChanged()

ScriptInvoker SCR_EditorMenuOverlayLayer.GetOnOverlayChanged

(

)

Get event invoker every time the overlay changes.

Returns

Script invoker

GetOverlays()

int SCR_EditorMenuOverlayLayer.GetOverlays

(

out notnull array< SCR_EditorMenuOverlay >

outOverlays

)

Get all overlays within this layer.

Parameters

[out]

outOverlays

Array to be filled with overlays

Returns

Number of overlays

GetOverlayWidget()

Widget SCR_EditorMenuOverlayLayer.GetOverlayWidget

(

)

Get widget representing the overlay.

Returns

Widget

GetRootWidget()

Widget SCR_EditorMenuOverlayLayer.GetRootWidget ( Widget  rootWidget, string  widgetName  )

protected

OnHide()

void SCR_EditorMenuOverlayLayer.OnHide ( float  opacity )

protected

PostActivateLayer()

void SCR_EditorMenuOverlayLayer.PostActivateLayer	(	SCR_MenuEditorComponent	menu,
		WorkspaceWidget	workspace
	)

Create widgets of all overlays within the layer.

Inactive overlays will be hidden, and activated only when they become current.

Parameters

menu	Menu in which the overlay is screated
workspace	GUI workspace

RefreshOverlay()

void SCR_EditorMenuOverlayLayer.RefreshOverlay ( )

protected

ResetOverlay()

void SCR_EditorMenuOverlayLayer.ResetOverlay

(

)

Set overlay to defautl value.

SetCurrentOverlay()

void SCR_EditorMenuOverlayLayer.SetCurrentOverlay	(	int	index,
		bool	forced = false
	)

Set current overlay.

Parameters

index	Overlay index from pre-defined list
forced	Set the current overlay even if the current one is the same (used on init)

UpdateCustomRoot()

void SCR_EditorMenuOverlayLayer.UpdateCustomRoot ( )

protected

---

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

• Game/Editor/Components/Editor/SCR_MenuOverlaysEditorComponent.c