SCR_EditorModeEntity Interface Reference

Editor mode entity. More...

Inheritance diagram for SCR_EditorModeEntity:

Public Member Functions
EEditorMode	GetModeType ()
	Get type of this mode.
int	GetOrder ()
	Get order of the mode.
SCR_UIInfo	GetInfo ()
	Get GUI info representing the mode.
bool	IsLimited ()
	Check if the mode is marked as limited.
bool	ShouldCloseAfterRemoval ()
bool	IsCurrent ()
	Check if the mode is currently active.
void	PreActivateMode ()
void	ActivateMode (bool isInit=false)
void	PostActivateMode ()
void	DeactivateMode ()
void	ActivateModeServer ()
void	DeactivateModeServer ()
bool	SendNotificationLocalOnly ()
	If true will only notify the local player when the mode is added or removed else it sends it to all GMs and local player.
bool	GetPreventClose ()
ENotification	GetOnAddNotification ()
	Returns enum for on Add notification.
ENotification	GetOnRemoveNotification ()
	Returns enum for on Remove notification.
override ScriptInvoker	GetOnInit ()
	Get event which is called when editor is initialized.
override ref ScriptInvoker	GetOnRequest ()
	Get event which is called when a request to open/close the editor is sent to server.
override ref ScriptInvoker	GetOnOpened ()
	Get event which is called when editor is opened.
override ref ScriptInvoker	GetOnOpenedServer ()
	Get event which is called when editor is initialized.
override ref ScriptInvoker	GetOnOpenedServerCallback ()
	Get event which is called when editor is initialized.
override ScriptInvoker	GetOnPreActivate ()
	Get event which is called before the entity is activated.
override ScriptInvoker	GetOnActivate ()
	Get event which is called when the entity is activated.
override ScriptInvoker	GetOnPostActivate ()
	Get event which is called when the entity is activated, but after all GetOnActivate() functions were called.
override ScriptInvoker	GetOnDeactivate ()
	Get event which is called when the entity is deactivated.
override ScriptInvoker	GetOnClosed ()
	Get event which is called when the editor is closed.
override ref ScriptInvoker	GetOnClosedServer ()
	Get event which is called when editor is initialized.
override ref ScriptInvoker	GetOnClosedServerCallback ()
	Get event which is called when editor is initialized and async loading finishes.
override ScriptInvoker	GetOnActivateServer ()
	Get event which is called when the entity is activated.
override ScriptInvoker	GetOnDeactivateServer ()
	Get event which is called when the entity is deactivated.
override ScriptInvoker	GetOnDebug ()
	Get event which is called every frame when debug is active.
override bool	IsOpened ()
	Check if editor is currently opened.
override SCR_EditorManagerEntity	GetManager ()
	Get editor manager.
void	InitServer (SCR_EditorManagerEntity editorManager)
void	InitOwner ()
void	SCR_EditorModeEntity (IEntitySource src, IEntity parent)
void	~SCR_EditorModeEntity ()
Public Member Functions inherited from SCR_EditorBaseEntity
int	FindEditorComponents (out array< SCR_BaseEditorComponent > outComponents)
	Get all editor components.

Static Public Member Functions
static SCR_EditorModeEntity	GetInstance ()
	Get current editor mode entity.

Protected Attributes
ENotification	m_ModeAddedNotification
ENotification	m_ModeRemovedNotification
bool	m_bSendNotificationLocalOnly
bool	m_bPreventClose

Additional Inherited Members
Protected Member Functions inherited from SCR_EditorBaseEntity
void	InitComponents (bool isServer)
void	InitComponent (SCR_BaseEditorComponent component, bool isServer)

Detailed Description

Editor mode entity.

Must be a child of SCR_EditorManagerEntity.

• In multiplayer, the entity is local to the player.
• Only one mode can be activated at the same time. Together with it, all its components (SCR_BaseEditorComponent) are activated as well.
• A mode is the primary way to control editor functionality, an each mode can behave differently - use different GUI, camera, etc.
• Player can access the editor mode as long as the entity exists.
  • This is for security reasons. If the mode entity always existed, but mode access for disabled in GUI, functions for communication on server could potentially be exploited.
• Mode entity influences if the editor is considered limited. See SCR_EditorManagerEntity description for more details.
• Default editor mode prefabs are defined in SCR_EditorManagerCore (config is Configs/Core folder).

Constructor & Destructor Documentation

SCR_EditorModeEntity()

void SCR_EditorModeEntity.SCR_EditorModeEntity	(	IEntitySource	src,
		IEntity	parent )

~SCR_EditorModeEntity()

void SCR_EditorModeEntity.~SCR_EditorModeEntity

(

)

Member Function Documentation

ActivateMode()

void SCR_EditorModeEntity.ActivateMode

(

bool

isInit = false

)

ActivateModeServer()

void SCR_EditorModeEntity.ActivateModeServer

(

)

DeactivateMode()

void SCR_EditorModeEntity.DeactivateMode

(

)

DeactivateModeServer()

void SCR_EditorModeEntity.DeactivateModeServer

(

)

GetInfo()

SCR_UIInfo SCR_EditorModeEntity.GetInfo

(

)

Get GUI info representing the mode.

Returns

Info class

GetInstance()

static SCR_EditorModeEntity SCR_EditorModeEntity.GetInstance ( )

static

Get current editor mode entity.

Returns

Editor mode entity

GetManager()

override SCR_EditorManagerEntity SCR_EditorModeEntity.GetManager

(

)

Get editor manager.

Returns

Editor manager

Implements SCR_EditorBaseEntity.

GetModeType()

EEditorMode SCR_EditorModeEntity.GetModeType

(

)

Get type of this mode.

Returns

Mode type

GetOnActivate()

override ScriptInvoker SCR_EditorModeEntity.GetOnActivate

(

)

Get event which is called when the entity is activated.

Returns

script invoker

Implements SCR_EditorBaseEntity.

GetOnActivateServer()

override ScriptInvoker SCR_EditorModeEntity.GetOnActivateServer

(

)

Get event which is called when the entity is activated.

Returns

script invoker

Implements SCR_EditorBaseEntity.

GetOnAddNotification()

ENotification SCR_EditorModeEntity.GetOnAddNotification

(

)

Returns enum for on Add notification.

Returns

ENotification on Add

GetOnClosed()

override ScriptInvoker SCR_EditorModeEntity.GetOnClosed

(

)

Get event which is called when the editor is closed.

Returns

script invoker

Implements SCR_EditorBaseEntity.

GetOnClosedServer()

override ref ScriptInvoker SCR_EditorModeEntity.GetOnClosedServer

(

)

Get event which is called when editor is initialized.

Returns

script invoker

Implements SCR_EditorBaseEntity.

GetOnClosedServerCallback()

override ref ScriptInvoker SCR_EditorModeEntity.GetOnClosedServerCallback

(

)

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

Returns

script invoker

Implements SCR_EditorBaseEntity.

GetOnDeactivate()

override ScriptInvoker SCR_EditorModeEntity.GetOnDeactivate

(

)

Get event which is called when the entity is deactivated.

Returns

script invoker

Implements SCR_EditorBaseEntity.

GetOnDeactivateServer()

override ScriptInvoker SCR_EditorModeEntity.GetOnDeactivateServer

(

)

Get event which is called when the entity is deactivated.

Returns

script invoker

Implements SCR_EditorBaseEntity.

GetOnDebug()

override ScriptInvoker SCR_EditorModeEntity.GetOnDebug

(

)

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

Returns

script invoker

Implements SCR_EditorBaseEntity.

GetOnInit()

override ScriptInvoker SCR_EditorModeEntity.GetOnInit

(

)

Get event which is called when editor is initialized.

Returns

script invoker

Implements SCR_EditorBaseEntity.

GetOnOpened()

override ref ScriptInvoker SCR_EditorModeEntity.GetOnOpened

(

)

Get event which is called when editor is opened.

Returns

script invoker

Implements SCR_EditorBaseEntity.

GetOnOpenedServer()

override ref ScriptInvoker SCR_EditorModeEntity.GetOnOpenedServer

(

)

Get event which is called when editor is initialized.

Returns

script invoker

Implements SCR_EditorBaseEntity.

GetOnOpenedServerCallback()

override ref ScriptInvoker SCR_EditorModeEntity.GetOnOpenedServerCallback

(

)

Get event which is called when editor is initialized.

Returns

script invoker

Implements SCR_EditorBaseEntity.

GetOnPostActivate()

override ScriptInvoker SCR_EditorModeEntity.GetOnPostActivate

(

)

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

Returns

script invoker

Implements SCR_EditorBaseEntity.

GetOnPreActivate()

override ScriptInvoker SCR_EditorModeEntity.GetOnPreActivate

(

)

Get event which is called before the entity is activated.

Returns

script invoker

Implements SCR_EditorBaseEntity.

GetOnRemoveNotification()

ENotification SCR_EditorModeEntity.GetOnRemoveNotification

(

)

Returns enum for on Remove notification.

Returns

ENotification on Remove

GetOnRequest()

override ref ScriptInvoker SCR_EditorModeEntity.GetOnRequest

(

)

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

Returns

script invoker

Implements SCR_EditorBaseEntity.

GetOrder()

int SCR_EditorModeEntity.GetOrder

(

)

Get order of the mode.

Returns

Order

GetPreventClose()

bool SCR_EditorModeEntity.GetPreventClose

(

)

InitOwner()

void SCR_EditorModeEntity.InitOwner

(

)

InitServer()

void SCR_EditorModeEntity.InitServer

(

SCR_EditorManagerEntity

editorManager

)

IsCurrent()

bool SCR_EditorModeEntity.IsCurrent

(

)

Check if the mode is currently active.

Returns

True when active

IsLimited()

bool SCR_EditorModeEntity.IsLimited

(

)

Check if the mode is marked as limited.

Returns

True when limited

IsOpened()

override bool SCR_EditorModeEntity.IsOpened

(

)

Check if editor is currently opened.

Returns

True if opened

Implements SCR_EditorBaseEntity.

PostActivateMode()

void SCR_EditorModeEntity.PostActivateMode

(

)

PreActivateMode()

void SCR_EditorModeEntity.PreActivateMode

(

)

SendNotificationLocalOnly()

bool SCR_EditorModeEntity.SendNotificationLocalOnly

(

)

If true will only notify the local player when the mode is added or removed else it sends it to all GMs and local player.

Returns

If should send locally

ShouldCloseAfterRemoval()

bool SCR_EditorModeEntity.ShouldCloseAfterRemoval

(

)

Returns

When true, removing this mode when it's current will close the editor instead of switching to the next available mode.

Member Data Documentation

m_bPreventClose

bool SCR_EditorModeEntity.m_bPreventClose

protected

m_bSendNotificationLocalOnly

bool SCR_EditorModeEntity.m_bSendNotificationLocalOnly

protected

m_ModeAddedNotification

ENotification SCR_EditorModeEntity.m_ModeAddedNotification

protected

m_ModeRemovedNotification

ENotification SCR_EditorModeEntity.m_ModeRemovedNotification

protected

---

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

• Game/Editor/Entities/SCR_EditorModeEntity.c