System to force streaming of all editable entities to client who has opened editor. More...

Inheritance diagram for SCR_DynamicSimulationEditorComponent:

Public Member Functions
override void	EOnEditorActivateServer ()
	When the component is activated (called on server)

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

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	EnableStreaming (bool enable)

void	EnableStreamingForEntity (SCR_EditableEntityComponent entity, bool enable)

void	OnEntityRegistered (SCR_EditableEntityComponent entity)

void	OnEntityUnregistered (SCR_EditableEntityComponent entity)

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

Protected Attributes
RplIdentity	m_EditorIdentity = RplIdentity.Invalid()

ref array< EEditableEntityType >	m_LocalSkipStreamingRules = {}

bool	m_bStreamingRulesInitialized = false

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

System to force streaming of all editable entities to client who has opened editor.

Member Function Documentation

◆ EnableStreaming()

void SCR_DynamicSimulationEditorComponent.EnableStreaming ( bool enable )

protected

◆ EnableStreamingForEntity()

void SCR_DynamicSimulationEditorComponent.EnableStreamingForEntity	(	SCR_EditableEntityComponent	entity,
		bool	enable
	)

protected

◆ EOnEditorActivateServer()

override void SCR_DynamicSimulationEditorComponent.EOnEditorActivateServer ( )

When the component is activated (called on server)

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.

◆ EOnEditorDeactivateServer()

override void SCR_DynamicSimulationEditorComponent.EOnEditorDeactivateServer ( )

When the component is deactivated (called on server)

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.

◆ OnEntityRegistered()

void SCR_DynamicSimulationEditorComponent.OnEntityRegistered ( SCR_EditableEntityComponent entity )

protected

◆ OnEntityUnregistered()

void SCR_DynamicSimulationEditorComponent.OnEntityUnregistered ( SCR_EditableEntityComponent entity )

protected

Member Data Documentation

◆ m_bStreamingRulesInitialized

bool SCR_DynamicSimulationEditorComponent.m_bStreamingRulesInitialized = false

protected

◆ m_EditorIdentity

RplIdentity SCR_DynamicSimulationEditorComponent.m_EditorIdentity = RplIdentity.Invalid()

protected

◆ m_LocalSkipStreamingRules

ref array<EEditableEntityType> SCR_DynamicSimulationEditorComponent.m_LocalSkipStreamingRules = {}

protected

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

Game/Editor/Components/Editor/SCR_DynamicSimulationEditorComponent.c

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ EnableStreaming()

◆ EnableStreamingForEntity()

◆ EOnEditorActivateServer()

◆ EOnEditorDeactivateServer()

◆ OnEntityRegistered()

◆ OnEntityUnregistered()

Member Data Documentation

◆ m_bStreamingRulesInitialized

◆ m_EditorIdentity

◆ m_LocalSkipStreamingRules