SCR_PauseGameTimeEditorComponent Interface Reference

Inheritance diagram for SCR_PauseGameTimeEditorComponent:

Public Member Functions
void	TogglePause ()
	Toggle pause mode, e.g., pause the game when it's not paused.
void	SetPause (bool pause)
	Set pause mode.
void	SetPauseOnOpen (bool pause)
	Set if the game should be paused when the editor is opened.
bool	IsPauseOnOpen ()
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	OnSaved (ESaveType type, string fileName)
override void	EOnEditorOpen ()
	When the editor is opened.
override void	EOnEditorClose ()
	When the editor is closed.
override void	EOnEditorInit ()
	When the entity is created.
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	EOnEditorDelete ()
	When the entity is destroyed.
void	EOnEditorRequest (bool isOpen)
	When opening/closing request is sent to server.
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
bool	m_bPauseOnOpen
ChimeraWorld	m_World
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).

Member Function Documentation

EOnEditorClose()

override void SCR_PauseGameTimeEditorComponent.EOnEditorClose ( )

protected

When the editor is closed.

Implements SCR_BaseEditorComponent.

EOnEditorInit()

override void SCR_PauseGameTimeEditorComponent.EOnEditorInit ( )

protected

When the entity is created.

Implements SCR_BaseEditorComponent.

EOnEditorOpen()

override void SCR_PauseGameTimeEditorComponent.EOnEditorOpen ( )

protected

When the editor is opened.

Implements SCR_BaseEditorComponent.

IsPauseOnOpen()

bool SCR_PauseGameTimeEditorComponent.IsPauseOnOpen

(

)

Returns

True if the game is set to be paused when the editor is opened

OnSaved()

void SCR_PauseGameTimeEditorComponent.OnSaved ( ESaveType  type, string  fileName  )

protected

SetPause()

void SCR_PauseGameTimeEditorComponent.SetPause

(

bool

pause

)

Set pause mode.

Parameters

pause

True to pause the game, false to unpause it

SetPauseOnOpen()

void SCR_PauseGameTimeEditorComponent.SetPauseOnOpen

(

bool

pause

)

Set if the game should be paused when the editor is opened.

Parameters

pause

True to pause the game whent he editor is opened

TogglePause()

void SCR_PauseGameTimeEditorComponent.TogglePause

(

)

Toggle pause mode, e.g., pause the game when it's not paused.

Member Data Documentation

m_bPauseOnOpen

bool SCR_PauseGameTimeEditorComponent.m_bPauseOnOpen

protected

m_World

ChimeraWorld SCR_PauseGameTimeEditorComponent.m_World

protected

---

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

• Game/Editor/Components/Editor/SCR_PauseGameTimeEditorComponent.c