SCR_StatesEditorComponent Interface Reference

Manager of unique editor states. More...

Inheritance diagram for SCR_StatesEditorComponent:

Public Member Functions
bool	IsDefaultState ()
	Check if the current state is default.
EEditorState	GetState ()
	Get current editor state.
bool	SetState (EEditorState state)
	Set current editor state.
void	UnsetState (EEditorState state)
	If given state is the current one, set the state to default.
bool	CanSet (EEditorState state)
	Check if given state can be set.
bool	SetIsWaiting (bool isWaiting)
	Set editor to waiting for server.
bool	IsWaiting ()
	Check if some feature is waiting for server.
void	SetSafeDialog (bool value)
	Tell the system if the currently opened dialog is safe to be ignored in 'waiting' condition.
ScriptInvoker	GetOnStateChange ()
	Get event called when editor state changes.
ScriptInvoker	GetOnIsWaitingChange ()
	Get event called when waiting state changes.
override void	EOnEditorDebug (array< string > debugTexts)
	Every frame while the editor is opened and debug menu is shown.
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 Attributes
MenuBase	m_MenuUponWaiting
bool	m_bIsSafeDialog
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).
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	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)

Detailed Description

Manager of unique editor states.

Member Function Documentation

CanSet()

bool SCR_StatesEditorComponent.CanSet

(

EEditorState

state

)

Check if given state can be set.

Parameters

state

Editor state

EOnEditorDebug()

override void SCR_StatesEditorComponent.EOnEditorDebug

(

array< string >

debugTexts

)

Every frame while the editor is opened and debug menu is shown.

Implements SCR_BaseEditorComponent.

GetOnIsWaitingChange()

ScriptInvoker SCR_StatesEditorComponent.GetOnIsWaitingChange

(

)

Get event called when waiting state changes.

Returns

Script invoker

GetOnStateChange()

ScriptInvoker SCR_StatesEditorComponent.GetOnStateChange

(

)

Get event called when editor state changes.

Returns

Script invoker

GetState()

EEditorState SCR_StatesEditorComponent.GetState

(

)

Get current editor state.

Returns

Editor state

IsDefaultState()

bool SCR_StatesEditorComponent.IsDefaultState

(

)

Check if the current state is default.

Returns

True if default

IsWaiting()

bool SCR_StatesEditorComponent.IsWaiting

(

)

Check if some feature is waiting for server.

Used for example when user click on a button to open attributes, but there's a delay before server processes the request.

Returns

True when waiting

SetIsWaiting()

bool SCR_StatesEditorComponent.SetIsWaiting

(

bool

isWaiting

)

Set editor to waiting for server.

Parameters

isWaiting

True if waiting for server

Returns

When canceling waiting, true is returned if no menu or dialog was opened while waiting.

SetSafeDialog()

void SCR_StatesEditorComponent.SetSafeDialog

(

bool

value

)

Tell the system if the currently opened dialog is safe to be ignored in 'waiting' condition.

Parameters

value

True if the dialog will not prevent waiting status from failing (it would notmally do when any dialog is opened).

SetState()

bool SCR_StatesEditorComponent.SetState

(

EEditorState

state

)

Set current editor state.

Parameters

state

Editor state

UnsetState()

void SCR_StatesEditorComponent.UnsetState

(

EEditorState

state

)

If given state is the current one, set the state to default.

Parameters

state

Editor state

Member Data Documentation

m_bIsSafeDialog

bool SCR_StatesEditorComponent.m_bIsSafeDialog

protected

m_MenuUponWaiting

MenuBase SCR_StatesEditorComponent.m_MenuUponWaiting

protected

---

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

• Game/Editor/Components/Editor/SCR_StatesEditorComponent.c