SCR_EditorBaseEntity Interface Reference

Base editor entity which provides overridable functions. More...

Inheritance diagram for SCR_EditorBaseEntity:

Public Member Functions
bool	IsOpened ()
	Check if editor is currently opened.
SCR_EditorManagerEntity	GetManager ()
	Get editor manager.
int	FindEditorComponents (out array< SCR_BaseEditorComponent > outComponents)
	Get all editor components.
Owner Invokers
Script invokers called on owner's machine.
ScriptInvoker	GetOnInit ()
	Get event which is called when editor is initialized.
ScriptInvoker	GetOnRequest ()
	Get event which is called when a request to open/close the editor is sent to server.
ScriptInvoker	GetOnOpened ()
	Get event which is called when editor is opened.
ScriptInvoker	GetOnPreActivate ()
	Get event which is called before the entity is activated.
ScriptInvoker	GetOnActivate ()
	Get event which is called when the entity is activated.
ScriptInvoker	GetOnPostActivate ()
	Get event which is called when the entity is activated, but after all GetOnActivate() functions were called.
ScriptInvoker	GetOnDeactivate ()
	Get event which is called when the entity is deactivated.
ScriptInvoker	GetOnClosed ()
	Get event which is called when the editor is closed.
ScriptInvoker	GetOnDebug ()
	Get event which is called every frame when debug is active.
Server Invokers
Script invokers called on server.
ScriptInvoker	GetOnOpenedServer ()
	Get event which is called when editor is initialized.
ScriptInvoker	GetOnOpenedServerCallback ()
	Get event which is called when editor is initialized.
ScriptInvoker	GetOnClosedServer ()
	Get event which is called when editor is initialized.
ScriptInvoker	GetOnClosedServerCallback ()
	Get event which is called when editor is initialized and async loading finishes.
ScriptInvoker	GetOnActivateServer ()
	Get event which is called when the entity is activated.
ScriptInvoker	GetOnDeactivateServer ()
	Get event which is called when the entity is deactivated.

Protected Member Functions
void	InitComponents (bool isServer)
void	InitComponent (SCR_BaseEditorComponent component, bool isServer)

Detailed Description

Base editor entity which provides overridable functions.

Editor components (SCR_BaseEditorComponent) can be attached only to entities inheriting from this base class.

Member Function Documentation

FindEditorComponents()

int SCR_EditorBaseEntity.FindEditorComponents

(

out array< SCR_BaseEditorComponent >

outComponents

)

Get all editor components.

Parameters

[out]

outComponents

Array to be filled by components (it's not cleared before filling!)

Returns

Number of components

GetManager()

SCR_EditorManagerEntity SCR_EditorBaseEntity.GetManager

(

)

Get editor manager.

Returns

Editor manager

Implemented in SCR_EditorManagerEntity, and SCR_EditorModeEntity.

GetOnActivate()

ScriptInvoker SCR_EditorBaseEntity.GetOnActivate

(

)

Get event which is called when the entity is activated.

Returns

script invoker

Implemented in SCR_EditorManagerEntity, and SCR_EditorModeEntity.

GetOnActivateServer()

ScriptInvoker SCR_EditorBaseEntity.GetOnActivateServer

(

)

Get event which is called when the entity is activated.

Returns

script invoker

Implemented in SCR_EditorManagerEntity, and SCR_EditorModeEntity.

GetOnClosed()

ScriptInvoker SCR_EditorBaseEntity.GetOnClosed

(

)

Get event which is called when the editor is closed.

Returns

script invoker

Implemented in SCR_EditorManagerEntity, and SCR_EditorModeEntity.

GetOnClosedServer()

ScriptInvoker SCR_EditorBaseEntity.GetOnClosedServer

(

)

Get event which is called when editor is initialized.

Returns

script invoker

Implemented in SCR_EditorManagerEntity, and SCR_EditorModeEntity.

GetOnClosedServerCallback()

ScriptInvoker SCR_EditorBaseEntity.GetOnClosedServerCallback

(

)

Get event which is called when editor is initialized and async loading finishes.

Returns

script invoker

Implemented in SCR_EditorManagerEntity, and SCR_EditorModeEntity.

GetOnDeactivate()

ScriptInvoker SCR_EditorBaseEntity.GetOnDeactivate

(

)

Get event which is called when the entity is deactivated.

Returns

script invoker

Implemented in SCR_EditorManagerEntity, and SCR_EditorModeEntity.

GetOnDeactivateServer()

ScriptInvoker SCR_EditorBaseEntity.GetOnDeactivateServer

(

)

Get event which is called when the entity is deactivated.

Returns

script invoker

Implemented in SCR_EditorManagerEntity, and SCR_EditorModeEntity.

GetOnDebug()

ScriptInvoker SCR_EditorBaseEntity.GetOnDebug

(

)

Get event which is called every frame when debug is active.

Returns

script invoker

Implemented in SCR_EditorManagerEntity, and SCR_EditorModeEntity.

GetOnInit()

ScriptInvoker SCR_EditorBaseEntity.GetOnInit

(

)

Get event which is called when editor is initialized.

Returns

script invoker

Implemented in SCR_EditorManagerEntity, and SCR_EditorModeEntity.

GetOnOpened()

ScriptInvoker SCR_EditorBaseEntity.GetOnOpened

(

)

Get event which is called when editor is opened.

Returns

script invoker

Implemented in SCR_EditorManagerEntity, and SCR_EditorModeEntity.

GetOnOpenedServer()

ScriptInvoker SCR_EditorBaseEntity.GetOnOpenedServer

(

)

Get event which is called when editor is initialized.

Returns

script invoker

Implemented in SCR_EditorManagerEntity, and SCR_EditorModeEntity.

GetOnOpenedServerCallback()

ScriptInvoker SCR_EditorBaseEntity.GetOnOpenedServerCallback

(

)

Get event which is called when editor is initialized.

Returns

script invoker

Implemented in SCR_EditorManagerEntity, and SCR_EditorModeEntity.

GetOnPostActivate()

ScriptInvoker SCR_EditorBaseEntity.GetOnPostActivate

(

)

Get event which is called when the entity is activated, but after all GetOnActivate() functions were called.

Returns

script invoker

Implemented in SCR_EditorManagerEntity, and SCR_EditorModeEntity.

GetOnPreActivate()

ScriptInvoker SCR_EditorBaseEntity.GetOnPreActivate

(

)

Get event which is called before the entity is activated.

Returns

script invoker

Implemented in SCR_EditorManagerEntity, and SCR_EditorModeEntity.

GetOnRequest()

ScriptInvoker SCR_EditorBaseEntity.GetOnRequest

(

)

Get event which is called when a request to open/close the editor is sent to server.

Returns

script invoker

Implemented in SCR_EditorManagerEntity, and SCR_EditorModeEntity.

InitComponent()

void SCR_EditorBaseEntity.InitComponent ( SCR_BaseEditorComponent  component, bool  isServer  )

protected

InitComponents()

void SCR_EditorBaseEntity.InitComponents ( bool  isServer )

protected

IsOpened()

bool SCR_EditorBaseEntity.IsOpened

(

)

Check if editor is currently opened.

Returns

True if opened

Implemented in SCR_EditorManagerEntity, and SCR_EditorModeEntity.

---

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

• Game/Editor/Entities/SCR_EditorBaseEntity.c