SCR_EditorSettingsEntity Class Reference

Inheritance diagram for SCR_EditorSettingsEntity:

Protected Member Functions
ResourceName	GetPrefab (ResourceName basePrefab)
bool	IsEditorDisabled ()
bool	IsUnlimitedEditorLegal ()
void	EnableBaseOverride (bool value)
bool	IsBaseOverrideEnabled ()
bool	GetBaseModes (out EEditorMode modes=0)
void	SetBaseModes (EEditorMode modes, bool validate=true)
bool	GetSkipStreamingRules (out notnull array< EEditableEntityType > skipStreamingRules)
void	SCR_EditorSettingsEntity (IEntitySource src, IEntity parent)

Static Protected 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

Detailed Description

Editor settings to override default values in SCR_EditorManagerCore.

Definition at line 12 of file SCR_EditorSettingsEntity.c.

Constructor & Destructor Documentation

SCR_EditorSettingsEntity()

void SCR_EditorSettingsEntity::SCR_EditorSettingsEntity ( IEntitySource src, IEntity parent )

inlineprotected

Definition at line 141 of file SCR_EditorSettingsEntity.c.

Member Function Documentation

EnableBaseOverride()

void SCR_EditorSettingsEntity::EnableBaseOverride ( bool value )

inlineprotected

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

Definition at line 80 of file SCR_EditorSettingsEntity.c.

GetBaseModes()

bool SCR_EditorSettingsEntity::GetBaseModes ( out EEditorMode modes = 0 )

inlineprotected

Get base editor modes in this world.

Parameters

modes

Variable to be filled with editor mode flags.

Returns

True if the override is enabled

Definition at line 97 of file SCR_EditorSettingsEntity.c.

GetInstance()

SCR_EditorSettingsEntity SCR_EditorSettingsEntity::GetInstance ( )

inlinestaticprotected

Returns

Local instance of the editor settings entity

Definition at line 35 of file SCR_EditorSettingsEntity.c.

GetPrefab()

ResourceName SCR_EditorSettingsEntity::GetPrefab ( ResourceName basePrefab )

inlineprotected

Get editor manager prefab.

Parameters

basePrefab

Prefab used when the entity doesn't define custom prefab

Returns

Editor manager prefab.

Definition at line 49 of file SCR_EditorSettingsEntity.c.

GetSkipStreamingRules()

bool SCR_EditorSettingsEntity::GetSkipStreamingRules ( out notnull array< EEditableEntityType > skipStreamingRules )

inlineprotected

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.

Definition at line 132 of file SCR_EditorSettingsEntity.c.

IsBaseOverrideEnabled()

bool SCR_EditorSettingsEntity::IsBaseOverrideEnabled ( )

inlineprotected

Check if base editor modes are overridden.

Returns

True when override is active

Definition at line 88 of file SCR_EditorSettingsEntity.c.

IsEditorDisabled()

bool SCR_EditorSettingsEntity::IsEditorDisabled ( )

inlineprotected

Check if editor is disabled. FOR DEVELOPMENT PURPOSES ONLY!

Returns

True when disabled

Definition at line 60 of file SCR_EditorSettingsEntity.c.

IsUnlimitedEditorLegal()

bool SCR_EditorSettingsEntity::IsUnlimitedEditorLegal ( )

inlineprotected

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

Definition at line 71 of file SCR_EditorSettingsEntity.c.

SetBaseModes()

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

inlineprotected

Set base editor modes in this world.

Parameters

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

Definition at line 107 of file SCR_EditorSettingsEntity.c.

Member Data Documentation

m_BaseModes

EEditorMode SCR_EditorSettingsEntity::m_BaseModes

protected

Definition at line 27 of file SCR_EditorSettingsEntity.c.

m_bDisableEditor

bool SCR_EditorSettingsEntity::m_bDisableEditor

protected

Definition at line 18 of file SCR_EditorSettingsEntity.c.

m_bIsUnlimitedEditorLegal

bool SCR_EditorSettingsEntity::m_bIsUnlimitedEditorLegal

protected

Definition at line 21 of file SCR_EditorSettingsEntity.c.

m_bOverrideBaseModes

bool SCR_EditorSettingsEntity::m_bOverrideBaseModes

protectedattribute

Definition at line 24 of file SCR_EditorSettingsEntity.c.

m_EditorManagerPrefab

ResourceName SCR_EditorSettingsEntity::m_EditorManagerPrefab

protected

Definition at line 15 of file SCR_EditorSettingsEntity.c.

m_SkipStreamingRules

ref array<EEditableEntityType> SCR_EditorSettingsEntity::m_SkipStreamingRules

protected

Definition at line 30 of file SCR_EditorSettingsEntity.c.

---

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

• scripts/Game/Editor/Entities/SCR_EditorSettingsEntity.c