Manager of editable entities in the editor. More...

Inheritance diagram for SCR_EntitiesManagerEditorComponent:

Public Member Functions
SCR_BaseEditableEntityFilter	GetFilter (EEditableEntityState state, bool showError=false)
	Get filter managing given state.

void	GetEntities (EEditableEntityState state, out set< SCR_EditableEntityComponent > entities)
	Get entities of given state.

void	SetInSuccessors (EEditableEntityState state, set< SCR_EditableEntityComponent > entitiesInsert, set< SCR_EditableEntityComponent > entitiesRemove)

void	SetParentEntity (SCR_EditableEntityComponent entity, SCR_EditableEntityComponent parentEntity)
	Set parent of the entity.

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

override void	EOnFrame (IEntity owner, float timeSlice)

override void	EOnEditorActivate ()
	When the component is activated.

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

override void	EOnEditorDeactivate ()
	When the component is deactivated.

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

override void	EOnEditorInit ()
	When the entity is created.

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

Protected Member Functions
void	OnEntityRegistered (SCR_EditableEntityComponent entity)

void	OnEntityUnregistered (SCR_EditableEntityComponent entity)

void	OnParentEntityChanged (SCR_EditableEntityComponent entity, SCR_EditableEntityComponent parentEntity, SCR_EditableEntityComponent parentEntityPrev)

void	SetParentEntityServer (int entityID, int parentEntityID)

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	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	EOnEditorPostActivate ()
	When the component is activated, but after EOnEditorActivate() function was called in all components.

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
int	m_iAsyncIndex

ref set< SCR_EditableEntityComponent >	m_AsyncEntities

Protected Attributes inherited from SCR_BaseEditorComponent
SCR_EditorBaseEntity	m_Owner

SCR_EditorManagerEntity	m_Manager

SCR_BaseEditorComponent	m_Parent

RplComponent	m_RplComponent

Static Protected Attributes
const int	ASYNC_ENTITY_BATCH_SIZE = 1000

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 editable entities in the editor.

Editable entities are locally managed by SCR_EditableEntityCore, this component manages containers (SCR_BaseEditableEntityFilter) which are responsible for tracking entities of specific state.

Member Function Documentation

◆ EOnEditorActivate()

override void SCR_EntitiesManagerEditorComponent.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.

◆ EOnEditorActivateAsync()

override bool SCR_EntitiesManagerEditorComponent.EOnEditorActivateAsync ( int attempt )

When the component is activated.

Asynchronous, can take multiple frames in case of complex operations.

Parameters

[in] attempt Number of previous attempts to activate the component.

Returns: True if the component is activated, false if it isn't (another attempt will follow in the next frame).

Implements SCR_BaseEditorComponent.

◆ EOnEditorDeactivate()

override void SCR_EntitiesManagerEditorComponent.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.

◆ EOnEditorDeactivateAsync()

override bool SCR_EntitiesManagerEditorComponent.EOnEditorDeactivateAsync ( int attempt )

When the component is deactivated.

Asynchronous, can take multiple frames in case of complex operations.

Parameters

[in] attempt Number of previous attempts to deactivate the component.

Returns: true if the component is activated, false if it isn't (another attempt will follow in the next frame).

Implements SCR_BaseEditorComponent.

◆ EOnEditorDebug()

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

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

Implements SCR_BaseEditorComponent.

◆ EOnEditorInit()

override void SCR_EntitiesManagerEditorComponent.EOnEditorInit ( )

When the entity is created.

Implements SCR_BaseEditorComponent.

◆ EOnFrame()

override void SCR_EntitiesManagerEditorComponent.EOnFrame	(	IEntity	owner,
		float	timeSlice
	)

◆ GetEntities()

void SCR_EntitiesManagerEditorComponent.GetEntities	(	EEditableEntityState	state,
		out set< SCR_EditableEntityComponent >	entities
	)

Get entities of given state.

Parameters

	state	Entity state
[out]	entities	Array to be filled with entities

◆ GetFilter()

SCR_BaseEditableEntityFilter SCR_EntitiesManagerEditorComponent.GetFilter	(	EEditableEntityState	state,
		bool	showError = `false`
	)

Get filter managing given state.

Parameters

state	Entity state
showError	True to log a warning message when the filter was not found

Returns: Entity filter

◆ OnEntityRegistered()

void SCR_EntitiesManagerEditorComponent.OnEntityRegistered ( SCR_EditableEntityComponent entity )

protected

◆ OnEntityUnregistered()

void SCR_EntitiesManagerEditorComponent.OnEntityUnregistered ( SCR_EditableEntityComponent entity )

protected

◆ OnParentEntityChanged()

void SCR_EntitiesManagerEditorComponent.OnParentEntityChanged	(	SCR_EditableEntityComponent	entity,
		SCR_EditableEntityComponent	parentEntity,
		SCR_EditableEntityComponent	parentEntityPrev
	)

protected

◆ SetInSuccessors()

void SCR_EntitiesManagerEditorComponent.SetInSuccessors	(	EEditableEntityState	state,
		set< SCR_EditableEntityComponent >	entitiesInsert,
		set< SCR_EditableEntityComponent >	entitiesRemove
	)

◆ SetParentEntity()

void SCR_EntitiesManagerEditorComponent.SetParentEntity	(	SCR_EditableEntityComponent	entity,
		SCR_EditableEntityComponent	parentEntity
	)

Set parent of the entity.

Parameters

entity	Affected entity
parentEntity	New parent. When null, the entity will be moved to the root.

◆ SetParentEntityServer()

void SCR_EntitiesManagerEditorComponent.SetParentEntityServer	(	int	entityID,
		int	parentEntityID
	)

protected

Member Data Documentation

◆ ASYNC_ENTITY_BATCH_SIZE

const int SCR_EntitiesManagerEditorComponent.ASYNC_ENTITY_BATCH_SIZE = 1000

staticprotected

◆ m_AsyncEntities

ref set<SCR_EditableEntityComponent> SCR_EntitiesManagerEditorComponent.m_AsyncEntities

protected

◆ m_iAsyncIndex

int SCR_EntitiesManagerEditorComponent.m_iAsyncIndex

protected

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

Game/Editor/Components/Editor/SCR_EntitiesManagerEditorComponent.c

Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ EOnEditorActivate()

◆ EOnEditorActivateAsync()

◆ EOnEditorDeactivate()

◆ EOnEditorDeactivateAsync()

◆ EOnEditorDebug()

◆ EOnEditorInit()

◆ EOnFrame()

◆ GetEntities()

◆ GetFilter()

◆ OnEntityRegistered()

◆ OnEntityUnregistered()

◆ OnParentEntityChanged()

◆ SetInSuccessors()

◆ SetParentEntity()

◆ SetParentEntityServer()

Member Data Documentation

◆ ASYNC_ENTITY_BATCH_SIZE

◆ m_AsyncEntities

◆ m_iAsyncIndex