SCR_MapEditorComponent Interface Reference

Manager of editable entities which players control (i.e., their avatars). More...

Inheritance diagram for SCR_MapEditorComponent:

Public Member Functions
bool	GetMapAvailable ()
void	SetMapHandler (SCR_MapEditorUIComponent mapHandler)
ResourceName	GetMapConfigPrefab ()
void	ToggleMap ()
void	ShowMap (bool show)
void	OnPlacingPreviewCreate ()
override void	OnPostInit (IEntity owner)
override void	EOnDeactivate (IEntity owner)
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
bool	IsEditorMapOpen ()
void	OnLimitedChange (bool isLimited)
SCR_MapEditorUIComponent	FindMapHandler ()
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	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)

Protected Attributes
string	m_sOpeningEditorMapSfx
string	m_sClosingEditorMapSfx
ResourceName	m_sMapConfigEditorPrefab
SCR_MapEntity	m_MapEntity
SCR_EditorManagerEntity	m_EditorManager
MapItem	m_CameraIcon
bool	m_bWasMapOpened
bool	m_bIsInit
SCR_MapEditorUIComponent	m_MapHandler
ref Color	m_CameraIconColor = Color.White
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 editable entities which players control (i.e., their avatars).

Member Function Documentation

EOnDeactivate()

override void SCR_MapEditorComponent.EOnDeactivate

(

IEntity

owner

)

FindMapHandler()

SCR_MapEditorUIComponent SCR_MapEditorComponent.FindMapHandler ( )

protected

GetMapAvailable()

bool SCR_MapEditorComponent.GetMapAvailable

(

)

GetMapConfigPrefab()

ResourceName SCR_MapEditorComponent.GetMapConfigPrefab

(

)

IsEditorMapOpen()

bool SCR_MapEditorComponent.IsEditorMapOpen ( )

protected

OnLimitedChange()

void SCR_MapEditorComponent.OnLimitedChange ( bool  isLimited )

protected

OnPlacingPreviewCreate()

void SCR_MapEditorComponent.OnPlacingPreviewCreate

(

)

OnPostInit()

override void SCR_MapEditorComponent.OnPostInit

(

IEntity

owner

)

Implements SCR_BaseEditorComponent.

SetMapHandler()

void SCR_MapEditorComponent.SetMapHandler

(

SCR_MapEditorUIComponent

mapHandler

)

ShowMap()

void SCR_MapEditorComponent.ShowMap

(

bool

show

)

ToggleMap()

void SCR_MapEditorComponent.ToggleMap

(

)

Member Data Documentation

m_bIsInit

bool SCR_MapEditorComponent.m_bIsInit

protected

m_bWasMapOpened

bool SCR_MapEditorComponent.m_bWasMapOpened

protected

m_CameraIcon

MapItem SCR_MapEditorComponent.m_CameraIcon

protected

m_CameraIconColor

ref Color SCR_MapEditorComponent.m_CameraIconColor = Color.White

protected

m_EditorManager

SCR_EditorManagerEntity SCR_MapEditorComponent.m_EditorManager

protected

m_MapEntity

SCR_MapEntity SCR_MapEditorComponent.m_MapEntity

protected

m_MapHandler

SCR_MapEditorUIComponent SCR_MapEditorComponent.m_MapHandler

protected

m_sClosingEditorMapSfx

string SCR_MapEditorComponent.m_sClosingEditorMapSfx

protected

m_sMapConfigEditorPrefab

ResourceName SCR_MapEditorComponent.m_sMapConfigEditorPrefab

protected

m_sOpeningEditorMapSfx

string SCR_MapEditorComponent.m_sOpeningEditorMapSfx

protected

---

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

• Game/Editor/Components/Editor/SCR_MapEditorComponent.c