SCR_EntitiesManagerEditorComponent Class Reference

Inheritance diagram for SCR_EntitiesManagerEditorComponent:

Protected Member Functions
SCR_BaseEditableEntityFilter	GetFilter (EEditableEntityState state, bool showError=false)
void	GetEntities (EEditableEntityState state, out set< SCR_EditableEntityComponent > entities)
void	SetInSuccessors (EEditableEntityState state, set< SCR_EditableEntityComponent > entitiesInsert, set< SCR_EditableEntityComponent > entitiesRemove)
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)
void	SetParentEntity (SCR_EditableEntityComponent entity, SCR_EditableEntityComponent parentEntity)
override void	EOnEditorDebug (array< string > debugTexts)
override void	EOnFrame (IEntity owner, float timeSlice)
override void	EOnEditorActivate ()
override bool	EOnEditorActivateAsync (int attempt)
override void	EOnEditorDeactivate ()
override bool	EOnEditorDeactivateAsync (int attempt)
override void	EOnEditorInit ()

Protected Attributes
const int	ASYNC_ENTITY_BATCH_SIZE = 1000
int	m_iAsyncIndex
ref set< SCR_EditableEntityComponent >	m_AsyncEntities

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.

Definition at line 13 of file SCR_EntitiesManagerEditorComponent.c.

Member Function Documentation

EOnEditorActivate()

override void SCR_EntitiesManagerEditorComponent::EOnEditorActivate ( )

inlineprotected

Definition at line 185 of file SCR_EntitiesManagerEditorComponent.c.

EOnEditorActivateAsync()

override bool SCR_EntitiesManagerEditorComponent::EOnEditorActivateAsync ( int attempt )

inlineprotected

Definition at line 198 of file SCR_EntitiesManagerEditorComponent.c.

EOnEditorDeactivate()

override void SCR_EntitiesManagerEditorComponent::EOnEditorDeactivate ( )

inlineprotected

Definition at line 215 of file SCR_EntitiesManagerEditorComponent.c.

EOnEditorDeactivateAsync()

override bool SCR_EntitiesManagerEditorComponent::EOnEditorDeactivateAsync ( int attempt )

inlineprotected

Definition at line 225 of file SCR_EntitiesManagerEditorComponent.c.

EOnEditorDebug()

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

inlineprotected

Definition at line 148 of file SCR_EntitiesManagerEditorComponent.c.

EOnEditorInit()

override void SCR_EntitiesManagerEditorComponent::EOnEditorInit ( )

inlineprotected

Definition at line 270 of file SCR_EntitiesManagerEditorComponent.c.

EOnFrame()

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

inlineprotected

Definition at line 176 of file SCR_EntitiesManagerEditorComponent.c.

GetEntities()

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

inlineprotected

Get entities of given state.

Parameters

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

Definition at line 53 of file SCR_EntitiesManagerEditorComponent.c.

GetFilter()

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

inlineprotected

Get filter managing given state.

Parameters

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

Returns

Entity filter

Definition at line 34 of file SCR_EntitiesManagerEditorComponent.c.

OnEntityRegistered()

void SCR_EntitiesManagerEditorComponent::OnEntityRegistered ( SCR_EditableEntityComponent entity )

inlineprotected

Definition at line 91 of file SCR_EntitiesManagerEditorComponent.c.

OnEntityUnregistered()

void SCR_EntitiesManagerEditorComponent::OnEntityUnregistered ( SCR_EditableEntityComponent entity )

inlineprotected

Definition at line 101 of file SCR_EntitiesManagerEditorComponent.c.

OnParentEntityChanged()

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

inlineprotected

Definition at line 110 of file SCR_EntitiesManagerEditorComponent.c.

SetInSuccessors()

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

inlineprotected

Definition at line 69 of file SCR_EntitiesManagerEditorComponent.c.

SetParentEntity()

void SCR_EntitiesManagerEditorComponent::SetParentEntity ( SCR_EditableEntityComponent entity, SCR_EditableEntityComponent parentEntity )

inlineprotected

Set parent of the entity.

Parameters

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

Definition at line 137 of file SCR_EntitiesManagerEditorComponent.c.

SetParentEntityServer()

void SCR_EntitiesManagerEditorComponent::SetParentEntityServer ( int entityID, int parentEntityID )

inlineprotected

Definition at line 126 of file SCR_EntitiesManagerEditorComponent.c.

Member Data Documentation

ASYNC_ENTITY_BATCH_SIZE

const int SCR_EntitiesManagerEditorComponent::ASYNC_ENTITY_BATCH_SIZE = 1000

protected

Definition at line 15 of file SCR_EntitiesManagerEditorComponent.c.

m_AsyncEntities

ref set<SCR_EditableEntityComponent> SCR_EntitiesManagerEditorComponent::m_AsyncEntities

protected

Definition at line 27 of file SCR_EntitiesManagerEditorComponent.c.

m_iAsyncIndex

int SCR_EntitiesManagerEditorComponent::m_iAsyncIndex

protected

Definition at line 26 of file SCR_EntitiesManagerEditorComponent.c.

---

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

• scripts/Game/Editor/Components/Editor/SCR_EntitiesManagerEditorComponent.c