SCR_MenuLayoutEditorComponent Interface Reference

Inheritance diagram for SCR_MenuLayoutEditorComponent:

Public Member Functions
SCR_EditableEntityUIConfig	GetEditableEntityUI ()
	Get configuration of editable entity UI.
bool	GetCursorWorldPos (out vector worldPos, TraceFlags flags=-1)
	Get world position below cursor.
IEntity	GetTraceEntity ()
	Get entity under cursor, even if it's not editable.
override void	EOnEditorPostActivate ()
	When the component is activated, but after EOnEditorActivate() function was called in all components.
override void	EOnEditorPostDeactivate ()
	When the component is deactivated, but after the next mode is activated.
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.
void	ResetEditorComponent ()
	Reset values controlled by the component.
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 ()

Protected Attributes
ResourceName	m_AlwaysShownLayout
ResourceName	m_HideableLayout
Widget	m_AlwaysShownWidget
Widget	m_HideableWidget
SCR_CursorEditorUIComponent	m_CursorComponent
Protected Attributes inherited from SCR_BaseEditorComponent
SCR_EditorBaseEntity	m_Owner
SCR_EditorManagerEntity	m_Manager
SCR_BaseEditorComponent	m_Parent
RplComponent	m_RplComponent

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.
void	EOnEditorActivate ()
	When the component is activated.
bool	EOnEditorActivateAsync (int attempt)
	When the component is activated.
void	EOnEditorDeactivate ()
	When the component is deactivated.
bool	EOnEditorDeactivateAsync (int attempt)
	When the component is deactivated.
void	EOnEditorDebug (array< string > debugTexts)
	Every frame while the editor is opened and debug menu is shown.
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)

Member Function Documentation

EOnEditorPostActivate()

override void SCR_MenuLayoutEditorComponent.EOnEditorPostActivate

(

)

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

Implements SCR_BaseEditorComponent.

EOnEditorPostDeactivate()

override void SCR_MenuLayoutEditorComponent.EOnEditorPostDeactivate

(

)

When the component is deactivated, but after the next mode is activated.

Implements SCR_BaseEditorComponent.

GetCursorWorldPos()

bool SCR_MenuLayoutEditorComponent.GetCursorWorldPos	(	out vector	worldPos,
		TraceFlags	flags = -1 )

Get world position below cursor.

Parameters

[out]	worldPos	Vector to be filled with world position
	flags	Trace flags to be used (send -1 for default flags)

Returns

True if the cursor is above world position (e.g., not pointing at sky)

GetEditableEntityUI()

SCR_EditableEntityUIConfig SCR_MenuLayoutEditorComponent.GetEditableEntityUI

(

)

Get configuration of editable entity UI.

Returns

Editable entity UI config

GetTraceEntity()

IEntity SCR_MenuLayoutEditorComponent.GetTraceEntity

(

)

Get entity under cursor, even if it's not editable.

To get editable entity under cursor, use SCR_BaseEditableEntityFilter of type EEditableEntityState.HOVER.

Returns

Entity under cursor

Member Data Documentation

m_AlwaysShownLayout

ResourceName SCR_MenuLayoutEditorComponent.m_AlwaysShownLayout

protected

m_AlwaysShownWidget

Widget SCR_MenuLayoutEditorComponent.m_AlwaysShownWidget

protected

m_CursorComponent

SCR_CursorEditorUIComponent SCR_MenuLayoutEditorComponent.m_CursorComponent

protected

m_HideableLayout

ResourceName SCR_MenuLayoutEditorComponent.m_HideableLayout

protected

m_HideableWidget

Widget SCR_MenuLayoutEditorComponent.m_HideableWidget

protected

---

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

• Game/Editor/Components/Editor/SCR_MenuLayoutEditorComponent.c