SCR_StatesEditorComponent Class Reference

Inheritance diagram for SCR_StatesEditorComponent:

Protected Member Functions
bool	IsDefaultState ()
EEditorState	GetState ()
bool	SetState (EEditorState state)
void	UnsetState (EEditorState state)
bool	CanSet (EEditorState state)
bool	SetIsWaiting (bool isWaiting)
bool	IsWaiting ()
void	SetSafeDialog (bool value)
ScriptInvoker	GetOnStateChange ()
ScriptInvoker	GetOnIsWaitingChange ()
override void	EOnEditorDebug (array< string > debugTexts)

Protected Attributes
MenuBase	m_MenuUponWaiting
bool	m_bIsSafeDialog

Detailed Description

Manager of unique editor states

Definition at line 9 of file SCR_StatesEditorComponent.c.

Member Function Documentation

CanSet()

bool SCR_StatesEditorComponent::CanSet ( EEditorState state )

inlineprotected

Check if given state can be set.

Parameters

state

Editor state

Definition at line 66 of file SCR_StatesEditorComponent.c.

EOnEditorDebug()

override void SCR_StatesEditorComponent::EOnEditorDebug ( array< string > debugTexts )

inlineprotected

Definition at line 148 of file SCR_StatesEditorComponent.c.

GetOnIsWaitingChange()

ScriptInvoker SCR_StatesEditorComponent::GetOnIsWaitingChange ( )

inlineprotected

Get event called when waiting state changes.

Returns

Script invoker

Definition at line 143 of file SCR_StatesEditorComponent.c.

GetOnStateChange()

ScriptInvoker SCR_StatesEditorComponent::GetOnStateChange ( )

inlineprotected

Get event called when editor state changes.

Returns

Script invoker

Definition at line 135 of file SCR_StatesEditorComponent.c.

GetState()

EEditorState SCR_StatesEditorComponent::GetState ( )

inlineprotected

Get current editor state.

Returns

Editor state

Definition at line 33 of file SCR_StatesEditorComponent.c.

IsDefaultState()

bool SCR_StatesEditorComponent::IsDefaultState ( )

inlineprotected

Check if the current state is default

Returns

True if default

Definition at line 25 of file SCR_StatesEditorComponent.c.

IsWaiting()

bool SCR_StatesEditorComponent::IsWaiting ( )

inlineprotected

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

Definition at line 118 of file SCR_StatesEditorComponent.c.

SetIsWaiting()

bool SCR_StatesEditorComponent::SetIsWaiting ( bool isWaiting )

inlineprotected

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.

Definition at line 93 of file SCR_StatesEditorComponent.c.

SetSafeDialog()

void SCR_StatesEditorComponent::SetSafeDialog ( bool value )

inlineprotected

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

Definition at line 126 of file SCR_StatesEditorComponent.c.

SetState()

bool SCR_StatesEditorComponent::SetState ( EEditorState state )

inlineprotected

Set current editor state.

Parameters

state

Editor state

Definition at line 41 of file SCR_StatesEditorComponent.c.

UnsetState()

void SCR_StatesEditorComponent::UnsetState ( EEditorState state )

inlineprotected

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

Parameters

state

Editor state

Definition at line 58 of file SCR_StatesEditorComponent.c.

Member Data Documentation

m_bIsSafeDialog

bool SCR_StatesEditorComponent::m_bIsSafeDialog

protected

Definition at line 19 of file SCR_StatesEditorComponent.c.

m_MenuUponWaiting

MenuBase SCR_StatesEditorComponent::m_MenuUponWaiting

protected

Definition at line 18 of file SCR_StatesEditorComponent.c.

---

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

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