Manager of editor access keys. More...

Inheritance diagram for SCR_AccessKeysEditorComponent:

Public Member Functions
void	AddAccessKey (EEditableEntityAccessKey accessKey)
	Add access key.

void	RemoveAccessKey (EEditableEntityAccessKey accessKey)
	Remove access key.

EEditableEntityAccessKey	GetAccessKey ()
	Get access key.

bool	HasAccess (EEditableEntityAccessKey accessKey)
	Has access to given key.

void	AddEntityAccessKey (SCR_EditableEntityComponent entity, EEditableEntityAccessKey accessKey)
	Add access key to an entity.

void	RemoveEntityAccessKey (SCR_EditableEntityComponent entity, EEditableEntityAccessKey accessKey)
	Remove access key from an entity.

void	LogAvailableEntities ()
	Print out all entities with compatible access keys.

void	LogAccessKey ()
	Print out access keys.

override bool	IsAdmin ()

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 bool	RplSave (ScriptBitWriter writer)

override bool	RplLoad (ScriptBitReader reader)

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

Public Attributes
ref ScriptInvoker	Event_OnChanged = new ScriptInvoker()

Protected Member Functions
void	AddAccessKeyServer (EEditableEntityAccessKey accessKey)

void	RemoveAccessKeyServer (EEditableEntityAccessKey accessKey)

void	AccessKeyChangedOwner (EEditableEntityAccessKey accessKey)

void	AddEntityAccessKeyServer (int entityID, EEditableEntityAccessKey accessKey)

void	RemoveEntityAccessKeyServer (int entityID, EEditableEntityAccessKey accessKey)

string	GetKeyDebug ()

override void	EOnEditorActivate ()
	When the component is activated.

override void	EOnEditorDelete ()
	When the entity is destroyed.

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	EOnEditorOpen ()
	When the editor is opened.

void	EOnEditorClose ()
	When the editor is closed.

void	EOnEditorPreActivate ()
	Before 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)

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

Protected Attributes inherited from SCR_BaseEditorComponent
SCR_EditorBaseEntity	m_Owner

SCR_EditorManagerEntity	m_Manager

SCR_BaseEditorComponent	m_Parent

RplComponent	m_RplComponent

Detailed Description

Manager of editor access keys.

Only entities with at least one matching key will be made available for the editor.

Member Function Documentation

◆ AccessKeyChangedOwner()

void SCR_AccessKeysEditorComponent.AccessKeyChangedOwner ( EEditableEntityAccessKey accessKey )

protected

◆ AddAccessKey()

void SCR_AccessKeysEditorComponent.AddAccessKey ( EEditableEntityAccessKey accessKey )

Add access key.

Parameters

[in] accessKey Key to be added

◆ AddAccessKeyServer()

void SCR_AccessKeysEditorComponent.AddAccessKeyServer ( EEditableEntityAccessKey accessKey )

protected

◆ AddEntityAccessKey()

void SCR_AccessKeysEditorComponent.AddEntityAccessKey	(	SCR_EditableEntityComponent	entity,
		EEditableEntityAccessKey	accessKey
	)

Add access key to an entity.

Parameters

[in]	entity	Affected entity
[in]	accessKey	Key to be added

◆ AddEntityAccessKeyServer()

void SCR_AccessKeysEditorComponent.AddEntityAccessKeyServer	(	int	entityID,
		EEditableEntityAccessKey	accessKey
	)

protected

◆ EOnEditorActivate()

override void SCR_AccessKeysEditorComponent.EOnEditorActivate ( )

protected

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.

◆ EOnEditorDebug()

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

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

Implements SCR_BaseEditorComponent.

◆ EOnEditorDelete()

override void SCR_AccessKeysEditorComponent.EOnEditorDelete ( )

protected

When the entity is destroyed.

Implements SCR_BaseEditorComponent.

◆ EOnEditorInit()

override void SCR_AccessKeysEditorComponent.EOnEditorInit ( )

When the entity is created.

Implements SCR_BaseEditorComponent.

◆ EOnFrame()

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

◆ GetAccessKey()

EEditableEntityAccessKey SCR_AccessKeysEditorComponent.GetAccessKey ( )

Get access key.

Returns: Editor's access key

◆ GetKeyDebug()

string SCR_AccessKeysEditorComponent.GetKeyDebug ( )

protected

◆ HasAccess()

bool SCR_AccessKeysEditorComponent.HasAccess ( EEditableEntityAccessKey accessKey )

Has access to given key.

\accessKey Key to be checked

Returns: True when has access

◆ IsAdmin()

override bool SCR_AccessKeysEditorComponent.IsAdmin ( )

Implements SCR_BaseEditorComponent.

◆ LogAccessKey()

void SCR_AccessKeysEditorComponent.LogAccessKey ( )

Print out access keys.

◆ LogAvailableEntities()

void SCR_AccessKeysEditorComponent.LogAvailableEntities ( )

Print out all entities with compatible access keys.

◆ RemoveAccessKey()

void SCR_AccessKeysEditorComponent.RemoveAccessKey ( EEditableEntityAccessKey accessKey )

Remove access key.

Parameters

[in] accessKey Key to be removed

◆ RemoveAccessKeyServer()

void SCR_AccessKeysEditorComponent.RemoveAccessKeyServer ( EEditableEntityAccessKey accessKey )

protected

◆ RemoveEntityAccessKey()

void SCR_AccessKeysEditorComponent.RemoveEntityAccessKey	(	SCR_EditableEntityComponent	entity,
		EEditableEntityAccessKey	accessKey
	)

Remove access key from an entity.

Parameters

[in]	entity	Affected entity
[in]	accessKey	Key to be removed

◆ RemoveEntityAccessKeyServer()

void SCR_AccessKeysEditorComponent.RemoveEntityAccessKeyServer	(	int	entityID,
		EEditableEntityAccessKey	accessKey
	)

protected

◆ RplLoad()

override bool SCR_AccessKeysEditorComponent.RplLoad ( ScriptBitReader reader )

◆ RplSave()

override bool SCR_AccessKeysEditorComponent.RplSave ( ScriptBitWriter writer )

Member Data Documentation

◆ Event_OnChanged

ref ScriptInvoker SCR_AccessKeysEditorComponent.Event_OnChanged = new ScriptInvoker()

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

Game/Editor/Components/Editor/SCR_AccessKeysEditorComponent.c

Public Member Functions

Public Attributes

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ AccessKeyChangedOwner()

◆ AddAccessKey()

◆ AddAccessKeyServer()

◆ AddEntityAccessKey()

◆ AddEntityAccessKeyServer()

◆ EOnEditorActivate()

◆ EOnEditorDebug()

◆ EOnEditorDelete()

◆ EOnEditorInit()

◆ EOnFrame()

◆ GetAccessKey()

◆ GetKeyDebug()

◆ HasAccess()

◆ IsAdmin()

◆ LogAccessKey()

◆ LogAvailableEntities()

◆ RemoveAccessKey()

◆ RemoveAccessKeyServer()

◆ RemoveEntityAccessKey()

◆ RemoveEntityAccessKeyServer()

◆ RplLoad()

◆ RplSave()

Member Data Documentation

◆ Event_OnChanged