Manager of current layer. More...

Inheritance diagram for SCR_HighlightedEditorComponent:

Public Member Functions
bool	IsEntityHighlighted (SCR_EditableEntityComponent entity)
	Returns if entity is highlighted.

bool	GetEntityHighlightedState (SCR_EditableEntityComponent entity, out EEditableEntityHighlight highlight, out int highlightAmount)
	Returns the highlight state and how many flags active or will return false if not highlighted.

bool	HasSpecificHighlight (SCR_EditableEntityComponent entity, EEditableEntityHighlight highlight)
	Returns if entity has a specific highlight.

ScriptInvoker	GetOnAddHighlight ()

ScriptInvoker	GetOnRemoveHighlight ()

ScriptInvoker	GetOnUpdateHighlight ()

override void	EOnEditorOpenServer ()
	When the editor is opened (called on server)

override void	EOnEditorCloseServer ()
	When the editor is closed (called on server)

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

Protected Member Functions
void	AddHighlight (SCR_EditableEntityComponent entity, EEditableEntityHighlight highlight)

void	AddHighlightRpc (RplId entityID, EEditableEntityHighlight allHighlights)

void	AddHighlightToListRpc (RplId entityID, EEditableEntityHighlight allHighlights)

void	RemoveHighlight (SCR_EditableEntityComponent entity, EEditableEntityHighlight highlight)

void	RemoveHighlightRpc (RplId entityID, EEditableEntityHighlight allHighlights)

void	RemoveHighlightFromListRpc (RplId entityID)

void	CleanupHighlightedMap ()

int	GetHighlightCount (EEditableEntityHighlight highlight)

void	FactionSpawnPointsInit ()

void	OnFactionSpawnPointsUpdated (Faction faction, int factionSpawnPointCount)

void	FactionTasksInit ()

void	OnFactionTasksUpdated (Faction faction, int factionTaskCount)

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	EOnEditorInit ()
	When the entity is created.

void	EOnEditorDelete ()
	When the entity is destroyed.

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.

void	EOnEditorActivate ()
	When 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	EOnEditorDebug (array< string > debugTexts)
	Every frame while the editor is opened and debug menu is shown.

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	EOnEditorOpenServerCallback ()
	When the editor is opened (called on server after async loading finished on client)

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)

Protected Attributes
SCR_DelegateFactionManagerComponent	m_DelegateFactionManager

ref ScriptInvoker	Event_OnAddHighlight = new ScriptInvoker

ref ScriptInvoker	Event_OnUpdateHighlight = new ScriptInvoker

ref ScriptInvoker	Event_OnRemoveHighlight = new ScriptInvoker

bool	m_bReplicationIsRunning

ref map< SCR_EditableEntityComponent, EEditableEntityHighlight >	m_HighlightedEntities = new map<SCR_EditableEntityComponent, EEditableEntityHighlight>

Protected Attributes inherited from SCR_BaseEditorComponent
SCR_EditorBaseEntity	m_Owner

SCR_EditorManagerEntity	m_Manager

SCR_BaseEditorComponent	m_Parent

RplComponent	m_RplComponent

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

Detailed Description

Manager of current layer.

Member Function Documentation

◆ AddHighlight()

void SCR_HighlightedEditorComponent.AddHighlight	(	SCR_EditableEntityComponent	entity,
		EEditableEntityHighlight	highlight
	)

protected

◆ AddHighlightRpc()

void SCR_HighlightedEditorComponent.AddHighlightRpc	(	RplId	entityID,
		EEditableEntityHighlight	allHighlights
	)

protected

◆ AddHighlightToListRpc()

void SCR_HighlightedEditorComponent.AddHighlightToListRpc	(	RplId	entityID,
		EEditableEntityHighlight	allHighlights
	)

protected

◆ CleanupHighlightedMap()

void SCR_HighlightedEditorComponent.CleanupHighlightedMap ( )

protected

◆ EOnEditorCloseServer()

override void SCR_HighlightedEditorComponent.EOnEditorCloseServer ( )

When the editor is closed (called on server)

Implements SCR_BaseEditorComponent.

◆ EOnEditorOpenServer()

override void SCR_HighlightedEditorComponent.EOnEditorOpenServer ( )

When the editor is opened (called on server)

Implements SCR_BaseEditorComponent.

◆ FactionSpawnPointsInit()

void SCR_HighlightedEditorComponent.FactionSpawnPointsInit ( )

protected

◆ FactionTasksInit()

void SCR_HighlightedEditorComponent.FactionTasksInit ( )

protected

◆ GetEntityHighlightedState()

bool SCR_HighlightedEditorComponent.GetEntityHighlightedState	(	SCR_EditableEntityComponent	entity,
		out EEditableEntityHighlight	highlight,
		out int	highlightAmount
	)

Returns the highlight state and how many flags active or will return false if not highlighted.

Parameters

	entity	to get highlight
[out]	highlight
[out]	highlightAmount	amount of highlights active on entity

Returns: true if highlighted

◆ GetHighlightCount()

int SCR_HighlightedEditorComponent.GetHighlightCount ( EEditableEntityHighlight highlight )

protected

◆ GetOnAddHighlight()

ScriptInvoker SCR_HighlightedEditorComponent.GetOnAddHighlight ( )

◆ GetOnRemoveHighlight()

ScriptInvoker SCR_HighlightedEditorComponent.GetOnRemoveHighlight ( )

◆ GetOnUpdateHighlight()

ScriptInvoker SCR_HighlightedEditorComponent.GetOnUpdateHighlight ( )

◆ HasSpecificHighlight()

bool SCR_HighlightedEditorComponent.HasSpecificHighlight	(	SCR_EditableEntityComponent	entity,
		EEditableEntityHighlight	highlight
	)

Returns if entity has a specific highlight.

Parameters

entity	to get is highlight
highlight	to check for

Returns: true if highlighted by that specific highlight

◆ IsEntityHighlighted()

bool SCR_HighlightedEditorComponent.IsEntityHighlighted ( SCR_EditableEntityComponent entity )

Returns if entity is highlighted.

Parameters

entity to get is highlight

Returns: true if highlighted

◆ OnFactionSpawnPointsUpdated()

void SCR_HighlightedEditorComponent.OnFactionSpawnPointsUpdated	(	Faction	faction,
		int	factionSpawnPointCount
	)

protected

◆ OnFactionTasksUpdated()

void SCR_HighlightedEditorComponent.OnFactionTasksUpdated	(	Faction	faction,
		int	factionTaskCount
	)

protected

◆ RemoveHighlight()

void SCR_HighlightedEditorComponent.RemoveHighlight	(	SCR_EditableEntityComponent	entity,
		EEditableEntityHighlight	highlight
	)

protected

◆ RemoveHighlightFromListRpc()

void SCR_HighlightedEditorComponent.RemoveHighlightFromListRpc ( RplId entityID )

protected

◆ RemoveHighlightRpc()

void SCR_HighlightedEditorComponent.RemoveHighlightRpc	(	RplId	entityID,
		EEditableEntityHighlight	allHighlights
	)

protected

Member Data Documentation

◆ Event_OnAddHighlight

ref ScriptInvoker SCR_HighlightedEditorComponent.Event_OnAddHighlight = new ScriptInvoker

protected

◆ Event_OnRemoveHighlight

ref ScriptInvoker SCR_HighlightedEditorComponent.Event_OnRemoveHighlight = new ScriptInvoker

protected

◆ Event_OnUpdateHighlight

ref ScriptInvoker SCR_HighlightedEditorComponent.Event_OnUpdateHighlight = new ScriptInvoker

protected

◆ m_bReplicationIsRunning

bool SCR_HighlightedEditorComponent.m_bReplicationIsRunning

protected

◆ m_DelegateFactionManager

SCR_DelegateFactionManagerComponent SCR_HighlightedEditorComponent.m_DelegateFactionManager

protected

◆ m_HighlightedEntities

ref map<SCR_EditableEntityComponent, EEditableEntityHighlight> SCR_HighlightedEditorComponent.m_HighlightedEntities = new map<SCR_EditableEntityComponent, EEditableEntityHighlight>

protected

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

Game/Editor/Components/Editor/SCR_HighlightedEditorComponent.c

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ AddHighlight()

◆ AddHighlightRpc()

◆ AddHighlightToListRpc()

◆ CleanupHighlightedMap()

◆ EOnEditorCloseServer()

◆ EOnEditorOpenServer()

◆ FactionSpawnPointsInit()

◆ FactionTasksInit()

◆ GetEntityHighlightedState()

◆ GetHighlightCount()

◆ GetOnAddHighlight()

◆ GetOnRemoveHighlight()

◆ GetOnUpdateHighlight()

◆ HasSpecificHighlight()

◆ IsEntityHighlighted()

◆ OnFactionSpawnPointsUpdated()

◆ OnFactionTasksUpdated()

◆ RemoveHighlight()

◆ RemoveHighlightFromListRpc()

◆ RemoveHighlightRpc()

Member Data Documentation

◆ Event_OnAddHighlight

◆ Event_OnRemoveHighlight

◆ Event_OnUpdateHighlight

◆ m_bReplicationIsRunning

◆ m_DelegateFactionManager

◆ m_HighlightedEntities