Manager of current layer. More...

Inheritance diagram for SCR_LayersEditorComponent:

Public Member Functions
bool	IsEditingLayersEnabled ()

void	SetEditingLayersEnabled (bool enableLayerEditing)
	Set if layer editing should ne enabled.

ScriptInvoker	GetOnCurrentLayerChange ()
	Used to subscribe to Event_OnCurrentLayerChange.

void	SetCurrentLayer (SCR_EditableEntityComponent entity)
	Set current layer.

void	SetCurrentLayerToParent ()
	Set selection current layer to the parent entity of the current current layer entity.

void	ToggleCurrentLayer (SCR_EditableEntityComponent entity)
	When given entity is the current layer, move one layer up, otherwise set current layer to the entity's composition root (unless it's from inactive layer, in which case set the entity as current layer directly).

SCR_EditableEntityComponent	GetCurrentLayer ()
	Get current layer.

void	CreateNewLayerWithSelected (notnull set< SCR_EditableEntityComponent > entities, vector worldPosition)
	Creates a new layer and add selected entities in it.

SCR_EditableEntityComponent	GetParentBelowCurrentLayer (SCR_EditableEntityComponent entity)
	Get parent below selection current layer, i.e., composition of an entity.

bool	IsUnderCurrentLayer (SCR_EditableEntityComponent entity, bool onlyDirect=false, bool applyExceptions=false)
	Check if the entity is under given current layer.

void	MoveToCurrentLayer (notnull set< SCR_EditableEntityComponent > entities)
	Move all entities under the current root.

void	MoveToLayer (notnull set< SCR_EditableEntityComponent > entities, SCR_EditableEntityComponent layer)
	Move all entities under specific layer.

void	MoveToLayerAndSelect (notnull set< SCR_EditableEntityComponent > entities, SCR_EditableEntityComponent layer, bool selectParentAfterMove=false)
	Move all entities under specific layer then sets the layer as current and sets the entities moved selected Entities which are under other marked entities will remain under them.

void	SplitGroupAndAddCharacters (SCR_EditableCharacterComponent leader, notnull set< SCR_EditableEntityComponent > entities)

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

override void	EOnEditorInit ()
	When the entity is created.

override void	EOnEditorDelete ()
	When the entity is destroyed.

override void	EOnEditorOpen ()
	When the editor is opened.

override void	EOnEditorClose ()
	When the editor is closed.

override void	OnDelete (IEntity owner)

Public Member Functions inherited from SCR_BaseEditorComponent
sealed void	OnInitBase ()

sealed void	OnDeleteBase ()

sealed void	OnRequestBase (bool isOpen)

sealed void	OnOpenedBase ()

sealed void	OnClosedBase ()

sealed void	OnPreActivateBase ()

sealed void	OnActivateBase ()

sealed bool	OnActivateAsyncBase (int attempt)

sealed void	OnPostActivateBase ()

sealed void	OnDeactivateBase ()

sealed void	OnPostDeactivateBase ()

sealed bool	OnDeactivateAsyncBase (int attempt)

sealed 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 ()

Public Attributes
ref ScriptInvoker	Event_OnCurrentLayerChange = new ScriptInvoker

Protected Member Functions
void	OnEditorModeChanged (SCR_EditorModeEntity currentModeEntity, SCR_EditorModeEntity prevModeEntity)

void	CreateNewLayerWithSelectedRpl (notnull array< RplId > entityIDs, vector transform[4], RplId currentLayerID)

void	AddCharactersToGroup (notnull set< SCR_EditableEntityComponent > entities, SCR_EditableEntityComponent group)

void	OnEditableParentChanged (SCR_EditableEntityComponent entity, SCR_EditableEntityComponent newParent, SCR_EditableEntityComponent prevParent)

void	DelayedSelectMovedEntity (SCR_EditableEntityComponent entity)

void	OnSelectionChanged (EEditableEntityState state, set< SCR_EditableEntityComponent > entitiesSelected, set< SCR_EditableEntityComponent > entitiesDeselected)

void	ClearEntitiesSelectAfterMove ()

void	EntitiesSelectAfterMoveDone (SCR_EditableEntityComponent lastEntity)

void	MoveToLayerServer (notnull array< RplId > entityIDs, RplId layerID)

void	OnUserSettingsChanged ()

void	OnEntityUnregistered (SCR_EditableEntityComponent entity)

void	OnEntityAccessKeyChanged (SCR_EditableEntityComponent entity)

void	OnEntityVisibilityChanged (SCR_EditableEntityComponent entity)

void	OnAccessKeysChanged ()

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	EOnEditorRequest (bool isOpen)
	When opening/closing request is sent to server.

void	EOnEditorPreActivate ()
	Before the component is activated.

void	EOnEditorActivate ()
	When the component is activated.

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

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

void	EOnEditorDeactivate ()
	When the component is deactivated.

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
ResourceName	m_sNewLayerPrefab

bool	m_bEditingLayersEnabled

SCR_BaseEditableEntityFilter	m_SelectionFilter

SCR_EditableEntityCore	m_Core

ref set< SCR_EditableEntityComponent >	m_EntitiesToSelectAfterMove = new set<SCR_EditableEntityComponent>()

SCR_EditableEntityComponent	m_NewGroupLeader

bool	m_bSelectAfterMoveCanceled

bool	m_bSelectParentAfterMove

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).

Detailed Description

Manager of current layer.

Examples: d:/jenkins/workspace/ar_data_branches_stable_1.2.1/A4Data/scripts/Game/Editor/Containers/EditableEntityFilters/SCR_RenderedEditableEntityFilter.c.

Member Function Documentation

◆ AddCharactersToGroup()

void SCR_LayersEditorComponent.AddCharactersToGroup	(	notnull set< SCR_EditableEntityComponent >	entities,
		SCR_EditableEntityComponent	group
	)

protected

◆ ClearEntitiesSelectAfterMove()

void SCR_LayersEditorComponent.ClearEntitiesSelectAfterMove ( )

protected

◆ CreateNewLayerWithSelected()

void SCR_LayersEditorComponent.CreateNewLayerWithSelected	(	notnull set< SCR_EditableEntityComponent >	entities,
		vector	worldPosition
	)

Creates a new layer and add selected entities in it.

◆ CreateNewLayerWithSelectedRpl()

void SCR_LayersEditorComponent.CreateNewLayerWithSelectedRpl	(	notnull array< RplId >	entityIDs,
		vector	transform[4],
		RplId	currentLayerID
	)

protected

◆ DelayedSelectMovedEntity()

void SCR_LayersEditorComponent.DelayedSelectMovedEntity ( SCR_EditableEntityComponent entity )

protected

◆ EntitiesSelectAfterMoveDone()

void SCR_LayersEditorComponent.EntitiesSelectAfterMoveDone ( SCR_EditableEntityComponent lastEntity )

protected

◆ EOnEditorClose()

override void SCR_LayersEditorComponent.EOnEditorClose ( )

When the editor is closed.

Implements SCR_BaseEditorComponent.

◆ EOnEditorDebug()

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

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

Implements SCR_BaseEditorComponent.

◆ EOnEditorDelete()

override void SCR_LayersEditorComponent.EOnEditorDelete ( )

When the entity is destroyed.

Implements SCR_BaseEditorComponent.

◆ EOnEditorInit()

override void SCR_LayersEditorComponent.EOnEditorInit ( )

When the entity is created.

Implements SCR_BaseEditorComponent.

◆ EOnEditorOpen()

override void SCR_LayersEditorComponent.EOnEditorOpen ( )

When the editor is opened.

Implements SCR_BaseEditorComponent.

◆ GetCurrentLayer()

SCR_EditableEntityComponent SCR_LayersEditorComponent.GetCurrentLayer ( )

Get current layer.

Returns: Editable entity

Examples: d:/jenkins/workspace/ar_data_branches_stable_1.2.1/A4Data/scripts/Game/Editor/Containers/EditableEntityFilters/SCR_RenderedEditableEntityFilter.c.

◆ GetOnCurrentLayerChange()

ScriptInvoker SCR_LayersEditorComponent.GetOnCurrentLayerChange ( )

Used to subscribe to Event_OnCurrentLayerChange.

Returns: Script invoker is returned to subscribe to.

◆ GetParentBelowCurrentLayer()

SCR_EditableEntityComponent SCR_LayersEditorComponent.GetParentBelowCurrentLayer ( SCR_EditableEntityComponent entity )

Get parent below selection current layer, i.e., composition of an entity.

When the entity is directly below current layer, the entity will be returned. When the entity is above the current layer, null is returned. Entity with IGNORE_LAYERS flag is always returned directly.

Parameters

entity Queried entity

Returns: Editable entity

◆ IsEditingLayersEnabled()

bool SCR_LayersEditorComponent.IsEditingLayersEnabled ( )

Returns: True if layer editing is enabled

◆ IsUnderCurrentLayer()

bool SCR_LayersEditorComponent.IsUnderCurrentLayer	(	SCR_EditableEntityComponent	entity,
		bool	onlyDirect = `false`,
		bool	applyExceptions = `false`
	)

Check if the entity is under given current layer.

Parameters

entity	Queried entity
onlyDirect	True to check if the entity is directly under current layer, false to check it recursively

Returns: True if under current layer, or if flagged with EEditableEntityFlag.IGNORE_LAYERS

◆ MoveToCurrentLayer()

void SCR_LayersEditorComponent.MoveToCurrentLayer ( notnull set< SCR_EditableEntityComponent > entities )

Move all entities under the current root.

Entities which are under other marked entities will remain under them.

Parameters

entities Affected entities

◆ MoveToLayer()

void SCR_LayersEditorComponent.MoveToLayer	(	notnull set< SCR_EditableEntityComponent >	entities,
		SCR_EditableEntityComponent	layer
	)

Move all entities under specific layer.

Entities which are under other marked entities will remain under them.

Parameters

entities	Affected entities
layer	Target layer

◆ MoveToLayerAndSelect()

void SCR_LayersEditorComponent.MoveToLayerAndSelect	(	notnull set< SCR_EditableEntityComponent >	entities,
		SCR_EditableEntityComponent	layer,
		bool	selectParentAfterMove = `false`
	)

Move all entities under specific layer then sets the layer as current and sets the entities moved selected Entities which are under other marked entities will remain under them.

Parameters

entities	Affected entities
layer	Target layer

◆ MoveToLayerServer()

void SCR_LayersEditorComponent.MoveToLayerServer	(	notnull array< RplId >	entityIDs,
		RplId	layerID
	)

protected

◆ OnAccessKeysChanged()

void SCR_LayersEditorComponent.OnAccessKeysChanged ( )

protected

◆ OnDelete()

override void SCR_LayersEditorComponent.OnDelete ( IEntity owner )

◆ OnEditableParentChanged()

void SCR_LayersEditorComponent.OnEditableParentChanged	(	SCR_EditableEntityComponent	entity,
		SCR_EditableEntityComponent	newParent,
		SCR_EditableEntityComponent	prevParent
	)

protected

◆ OnEditorModeChanged()

void SCR_LayersEditorComponent.OnEditorModeChanged	(	SCR_EditorModeEntity	currentModeEntity,
		SCR_EditorModeEntity	prevModeEntity
	)

protected

◆ OnEntityAccessKeyChanged()

void SCR_LayersEditorComponent.OnEntityAccessKeyChanged ( SCR_EditableEntityComponent entity )

protected

◆ OnEntityUnregistered()

void SCR_LayersEditorComponent.OnEntityUnregistered ( SCR_EditableEntityComponent entity )

protected

◆ OnEntityVisibilityChanged()

void SCR_LayersEditorComponent.OnEntityVisibilityChanged ( SCR_EditableEntityComponent entity )

protected

◆ OnSelectionChanged()

void SCR_LayersEditorComponent.OnSelectionChanged	(	EEditableEntityState	state,
		set< SCR_EditableEntityComponent >	entitiesSelected,
		set< SCR_EditableEntityComponent >	entitiesDeselected
	)

protected

◆ OnUserSettingsChanged()

void SCR_LayersEditorComponent.OnUserSettingsChanged ( )

protected

◆ SetCurrentLayer()

void SCR_LayersEditorComponent.SetCurrentLayer ( SCR_EditableEntityComponent entity )

Set current layer.

When a entity is focused / selected, it will include all siblings up to this current layer.

Parameters

entity Editable entity

◆ SetCurrentLayerToParent()

void SCR_LayersEditorComponent.SetCurrentLayerToParent ( )

Set selection current layer to the parent entity of the current current layer entity.

Parameters

entity Editable entity

◆ SetEditingLayersEnabled()

void SCR_LayersEditorComponent.SetEditingLayersEnabled ( bool enableLayerEditing )

Set if layer editing should ne enabled.

When disabled, it will not be possible to enter layers or move entities between them.

Parameters

enableLayerEditing True to enable layer editing

◆ SplitGroupAndAddCharacters()

void SCR_LayersEditorComponent.SplitGroupAndAddCharacters	(	SCR_EditableCharacterComponent	leader,
		notnull set< SCR_EditableEntityComponent >	entities
	)

◆ ToggleCurrentLayer()

void SCR_LayersEditorComponent.ToggleCurrentLayer ( SCR_EditableEntityComponent entity )

When given entity is the current layer, move one layer up, otherwise set current layer to the entity's composition root (unless it's from inactive layer, in which case set the entity as current layer directly).

Parameters

entity Editable entity

Member Data Documentation

◆ Event_OnCurrentLayerChange

ref ScriptInvoker SCR_LayersEditorComponent.Event_OnCurrentLayerChange = new ScriptInvoker

◆ m_bEditingLayersEnabled

bool SCR_LayersEditorComponent.m_bEditingLayersEnabled

protected

◆ m_bSelectAfterMoveCanceled

bool SCR_LayersEditorComponent.m_bSelectAfterMoveCanceled

protected

◆ m_bSelectParentAfterMove

bool SCR_LayersEditorComponent.m_bSelectParentAfterMove

protected

◆ m_Core

SCR_EditableEntityCore SCR_LayersEditorComponent.m_Core

protected

◆ m_EntitiesToSelectAfterMove

ref set<SCR_EditableEntityComponent> SCR_LayersEditorComponent.m_EntitiesToSelectAfterMove = new set<SCR_EditableEntityComponent>()

protected

◆ m_NewGroupLeader

SCR_EditableEntityComponent SCR_LayersEditorComponent.m_NewGroupLeader

protected

◆ m_SelectionFilter

SCR_BaseEditableEntityFilter SCR_LayersEditorComponent.m_SelectionFilter

protected

◆ m_sNewLayerPrefab

ResourceName SCR_LayersEditorComponent.m_sNewLayerPrefab

protected

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

Game/Editor/Components/Editor/SCR_LayersEditorManager.c

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ AddCharactersToGroup()

◆ ClearEntitiesSelectAfterMove()

◆ CreateNewLayerWithSelected()

◆ CreateNewLayerWithSelectedRpl()

◆ DelayedSelectMovedEntity()

◆ EntitiesSelectAfterMoveDone()

◆ EOnEditorClose()

◆ EOnEditorDebug()

◆ EOnEditorDelete()

◆ EOnEditorInit()

◆ EOnEditorOpen()

◆ GetCurrentLayer()

◆ GetOnCurrentLayerChange()

◆ GetParentBelowCurrentLayer()

◆ IsEditingLayersEnabled()

◆ IsUnderCurrentLayer()

◆ MoveToCurrentLayer()

◆ MoveToLayer()

◆ MoveToLayerAndSelect()

◆ MoveToLayerServer()

◆ OnAccessKeysChanged()

◆ OnDelete()

◆ OnEditableParentChanged()

◆ OnEditorModeChanged()

◆ OnEntityAccessKeyChanged()

◆ OnEntityUnregistered()

◆ OnEntityVisibilityChanged()

◆ OnSelectionChanged()

◆ OnUserSettingsChanged()

◆ SetCurrentLayer()

◆ SetCurrentLayerToParent()

◆ SetEditingLayersEnabled()

◆ SplitGroupAndAddCharacters()

◆ ToggleCurrentLayer()

Member Data Documentation

◆ Event_OnCurrentLayerChange

◆ m_bEditingLayersEnabled

◆ m_bSelectAfterMoveCanceled

◆ m_bSelectParentAfterMove

◆ m_Core

◆ m_EntitiesToSelectAfterMove

◆ m_NewGroupLeader

◆ m_SelectionFilter

◆ m_sNewLayerPrefab