SCR_EditorSettingsEntity Interface Reference

Editor settings to override default values in SCR_EditorManagerCore. More...

Inheritance diagram for SCR_EditorSettingsEntity:

Public Member Functions
ResourceName	GetPrefab (ResourceName basePrefab)
	Get editor manager prefab.
bool	IsEditorDisabled ()
	Check if editor is disabled.
bool	IsUnlimitedEditorLegal ()
	Check if unlimited editor (e.g, Game Master) is legal in this scenario, i.e., part of game rules.
void	EnableBaseOverride (bool value)
	When set to true, connecting players will receive editor modes define by these settings, instead of use defaults from SCR_EditorManagerCore.
bool	IsBaseOverrideEnabled ()
	Check if base editor modes are overridden.
bool	GetBaseModes (out EEditorMode modes=0)
	Get base editor modes in this world.
void	SetBaseModes (EEditorMode modes, bool validate=true)
	Set base editor modes in this world.
bool	GetSkipStreamingRules (notnull array< EEditableEntityType > skipStreamingRules)
	Get which EEditableEntityType to not stream in to client when he opens editor.
void	SCR_EditorSettingsEntity (IEntitySource src, IEntity parent)
Public Member Functions inherited from SCR_EditorBaseEntity
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.
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.
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.

Static Public Member Functions
static SCR_EditorSettingsEntity	GetInstance ()

Protected Attributes
ResourceName	m_EditorManagerPrefab
bool	m_bDisableEditor
bool	m_bIsUnlimitedEditorLegal
bool	m_bOverrideBaseModes
EEditorMode	m_BaseModes
ref array< EEditableEntityType >	m_SkipStreamingRules

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

Detailed Description

Editor settings to override default values in SCR_EditorManagerCore.

Constructor & Destructor Documentation

SCR_EditorSettingsEntity()

void SCR_EditorSettingsEntity.SCR_EditorSettingsEntity	(	IEntitySource	src,
		IEntity	parent
	)

Member Function Documentation

EnableBaseOverride()

void SCR_EditorSettingsEntity.EnableBaseOverride

(

bool

value

)

When set to true, connecting players will receive editor modes define by these settings, instead of use defaults from SCR_EditorManagerCore.

\value True to enable override

GetBaseModes()

bool SCR_EditorSettingsEntity.GetBaseModes

(

out EEditorMode

modes = 0

)

Get base editor modes in this world.

Parameters

modes

Variable to be filled with editor mode flags.

Returns

True if the override is enabled

GetInstance()

static SCR_EditorSettingsEntity SCR_EditorSettingsEntity.GetInstance ( )

static

Returns

Local instance of the editor settings entity

GetPrefab()

ResourceName SCR_EditorSettingsEntity.GetPrefab

(

ResourceName

basePrefab

)

Get editor manager prefab.

Parameters

basePrefab

Prefab used when the entity doesn't define custom prefab

Returns

Editor manager prefab.

GetSkipStreamingRules()

bool SCR_EditorSettingsEntity.GetSkipStreamingRules

(

notnull array< EEditableEntityType >

skipStreamingRules

)

Get which EEditableEntityType to not stream in to client when he opens editor.

Parameters

skipStreamingRules

The array of EEditableEntityType for which to skip streaming logic.

Returns

True if there are any streaming rules set.

IsBaseOverrideEnabled()

bool SCR_EditorSettingsEntity.IsBaseOverrideEnabled

(

)

Check if base editor modes are overridden.

Returns

True when override is active

IsEditorDisabled()

bool SCR_EditorSettingsEntity.IsEditorDisabled

(

)

Check if editor is disabled.

FOR DEVELOPMENT PURPOSES ONLY!

Returns

True when disabled

IsUnlimitedEditorLegal()

bool SCR_EditorSettingsEntity.IsUnlimitedEditorLegal

(

)

Check if unlimited editor (e.g, Game Master) is legal in this scenario, i.e., part of game rules.

For example this is enabled in Game Master scenarios which are about GM building the gameplay, but it's disabled in Conflict where only admin can access the editor.

Returns

True when legal

SetBaseModes()

void SCR_EditorSettingsEntity.SetBaseModes	(	EEditorMode	modes,
		bool	validate = true
	)

Set base editor modes in this world.

Parameters

modes	Editor mode flags.
validate	When true, remove non-base modes from already existing editor managers

Member Data Documentation

m_BaseModes

EEditorMode SCR_EditorSettingsEntity.m_BaseModes

protected

m_bDisableEditor

bool SCR_EditorSettingsEntity.m_bDisableEditor

protected

m_bIsUnlimitedEditorLegal

bool SCR_EditorSettingsEntity.m_bIsUnlimitedEditorLegal

protected

m_bOverrideBaseModes

bool SCR_EditorSettingsEntity.m_bOverrideBaseModes

protected

m_EditorManagerPrefab

ResourceName SCR_EditorSettingsEntity.m_EditorManagerPrefab

protected

m_SkipStreamingRules

ref array<EEditableEntityType> SCR_EditorSettingsEntity.m_SkipStreamingRules

protected

---

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

• Game/Editor/Entities/SCR_EditorSettingsEntity.c