Manager of menu overlays. More...

Inheritance diagram for SCR_MenuOverlaysEditorComponent:

Public Member Functions
SCR_EditorMenuOverlayLayer	GetOverlayLayer (EEditorMenuOverlayLayer layerType)
	Get overlay layer script object which holds all of its parameters.

override void	ResetEditorComponent ()
	Reset values controlled by the component.

override void	EOnEditorDebug (array< string > debugTexts)
	Every frame while the editor is opened and debug menu is shown.

override void	EOnEditorActivate ()
	When the component is activated.

override void	EOnEditorPostActivate ()
	When the component is activated, but after EOnEditorActivate() function was called in all components.

override void	EOnEditorDeactivate ()
	When the component is deactivated.

Public Member Functions inherited from SCR_BaseEditorComponent
void	OnInitBase ()

void	OnDeleteBase ()

void	OnRequestBase (bool isOpen)

void	OnOpenedBase ()

void	OnClosedBase ()

void	OnPreActivateBase ()

void	OnActivateBase ()

bool	OnActivateAsyncBase (int attempt)

void	OnPostActivateBase ()

void	OnDeactivateBase ()

void	OnPostDeactivateBase ()

bool	OnDeactivateAsyncBase (int attempt)

void	OnEffectBase (SCR_BaseEditorEffect effect)

SCR_EditorManagerEntity	GetManager ()
	Get editor manager this component belongs to.

SCR_BaseEditorComponent	FindEditorComponent (TypeName type, bool showError=false, bool modeFirst=false)
	Get the editor manager to which this component belongs.

EntityComponentPrefabData	GetEditorComponentData ()
	Get prefab data of this component.

bool	IsRemoved ()
	Check if the component is being deleted.

ScriptInvoker	GetOnEffect ()
	Get event called when an effect is activated.

void	InitServer ()

void	InitOwner ()

override void	OnPostInit (IEntity owner)

void	SCR_BaseEditorComponent (IEntityComponentSource src, IEntity ent, IEntity parent)

void	~SCR_BaseEditorComponent ()

Additional Inherited Members
Static Public Member Functions inherited from SCR_BaseEditorComponent
static Managed	GetInstance (TypeName type, bool showError=false, bool modeFirst=false)
	Get the local instance of a component attached on editor manager (SCR_EditorManagerEntity).

static Managed	GetInstance (SCR_EditorBaseEntity editorManager, TypeName type, bool showError=false)
	Get instance of a component attached on specific editor manager / mode (SCR_EditorBaseEntity).

static int	GetAllInstances (TypeName type, out notnull array< Managed > outComponents)
	Get component instances on editor manager (SCR_EditorBaseEntity) and all its modes (SCR_EditorModeEntity).

Protected Member Functions inherited from SCR_BaseEditorComponent
bool	IsOnEditorManager ()

bool	IsOwner ()

bool	IsProxy ()

bool	IsMaster ()

bool	IsAdmin ()

SCR_BaseEditorComponent	GetParentComponent ()

void	SetParentComponent (SCR_BaseEditorComponent parent)

void	SendNotification (ENotification notificationID, int selfID=0, int targetID=0, vector position=vector.Zero)

void	EOnEditorInit ()
	When the entity is created.

void	EOnEditorDelete ()
	When the entity is destroyed.

void	EOnEditorRequest (bool isOpen)
	When opening/closing request is sent to server.

void	EOnEditorOpen ()
	When the editor is opened.

void	EOnEditorClose ()
	When the editor is closed.

void	EOnEditorPreActivate ()
	Before the component is activated.

bool	EOnEditorActivateAsync (int attempt)
	When the component is activated.

bool	EOnEditorDeactivateAsync (int attempt)
	When the component is deactivated.

void	EOnEditorPostDeactivate ()
	When the component is deactivated, but after the next mode is activated.

void	EOnEffect (SCR_BaseEditorEffect effect)
	When an effect is created in reaction an an event.

void	EOnEditorInitServer ()
	When the entity is created (called on server)

void	EOnEditorDeleteServer ()
	When the entity is destroyed (called on server)

void	EOnEditorOpenServer ()
	When the editor is opened (called on server)

void	EOnEditorOpenServerCallback ()
	When the editor is opened (called on server after async loading finished on client)

void	EOnEditorCloseServer ()
	When the editor is closed (called on server)

void	EOnEditorCloseServerCallback ()
	When the editor is closed (called on server after async loading finished on client)

void	EOnEditorActivateServer ()
	When the component is activated (called on server)

void	EOnEditorDeactivateServer ()
	When the component is deactivated (called on server)

Protected Attributes inherited from SCR_BaseEditorComponent
SCR_EditorBaseEntity	m_Owner

SCR_EditorManagerEntity	m_Manager

SCR_BaseEditorComponent	m_Parent

RplComponent	m_RplComponent

Detailed Description

Manager of menu overlays.

Multiple overlays can be present at the same time, one per each layer type (SCR_EditorMenuOverlayLayer).

Overlays are created in the menu created by SCR_MenuEditorComponent. They won't work if that editor component is not available.

Member Function Documentation

◆ EOnEditorActivate()

override void SCR_MenuOverlaysEditorComponent.EOnEditorActivate ( )

When the component is activated.

When attached on SCR_EditorManagerEntity, this is executed together with EOnEditorOpen()
When attached on SCR_EditorModeEntity, it's executed when the mode is activated

Implements SCR_BaseEditorComponent.

◆ EOnEditorDeactivate()

override void SCR_MenuOverlaysEditorComponent.EOnEditorDeactivate ( )

When the component is deactivated.

When attached on SCR_EditorManagerEntity, this is executed together with EOnEditorClose()
When attached on SCR_EditorModeEntity, it's executed when the mode is deactivated

Implements SCR_BaseEditorComponent.

◆ EOnEditorDebug()

override void SCR_MenuOverlaysEditorComponent.EOnEditorDebug ( array< string > debugTexts )

Every frame while the editor is opened and debug menu is shown.

Implements SCR_BaseEditorComponent.

◆ EOnEditorPostActivate()

override void SCR_MenuOverlaysEditorComponent.EOnEditorPostActivate ( )

When the component is activated, but after EOnEditorActivate() function was called in all components.

Implements SCR_BaseEditorComponent.

◆ GetOverlayLayer()

SCR_EditorMenuOverlayLayer SCR_MenuOverlaysEditorComponent.GetOverlayLayer ( EEditorMenuOverlayLayer layerType )

Get overlay layer script object which holds all of its parameters.

Parameters

layerType Overlay type

Returns: Layer object

◆ ResetEditorComponent()

override void SCR_MenuOverlaysEditorComponent.ResetEditorComponent ( )

Reset values controlled by the component.

To be overridden by child classes.

Implements SCR_BaseEditorComponent.

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

Game/Editor/Components/Editor/SCR_MenuOverlaysEditorComponent.c

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ EOnEditorActivate()

◆ EOnEditorDeactivate()

◆ EOnEditorDebug()

◆ EOnEditorPostActivate()

◆ GetOverlayLayer()

◆ ResetEditorComponent()