ISystemUserCallback

C++
struct ISystemUserCallback {
};
File

ISystem.h

Description

User defined callback, which can be passed to ISystem.

ISystemUserCallback::~ISystemUserCallback Destructor
C++
ISystemUserCallback::GetMemoryUsage Method
C++
virtual void GetMemoryUsage(ICrySizer* pSizer) = 0;
Description

Collects the memory information in the user program/application.

ISystemUserCallback::OnError Method

Signals to User that engine error occurred.

C++
virtual bool OnError(const char * szErrorString) = 0;
Returns

True to Halt execution or false to ignore this error

ISystemUserCallback::OnInit Method
C++
virtual void OnInit(ISystem *);
Description

Initialization callback. This is called early in CSystem::Init(), before any of the other callback methods is called.

See Also

CSystem::Init()

ISystemUserCallback::OnInitProgress Method
C++
virtual void OnInitProgress(const char * sProgressMsg) = 0;
Description

Notifies user, usually editor, about initialization progress in system.

ISystemUserCallback::OnProcessSwitch Method
C++
virtual void OnProcessSwitch() = 0;
Description

Notifies user that system wants to switch out of current process.

Example

Called when pressing ESC in game mode to go to Menu.

ISystemUserCallback::OnQuit Method

Quit callback.

C++
virtual void OnQuit();
See Also

CSystem::Quit()

ISystemUserCallback::OnShutdown Method

Shutdown callback.

C++
virtual void OnShutdown();
ISystemUserCallback::OnSystemConnect Method
C++
virtual void OnSystemConnect(ISystem * pSystem);
Description

This method is called at the earliest point the ISystem pointer can be used the log might not be yet there.

ISystemUserCallback::OnUpdate Method
C++
virtual void OnUpdate();
Description

Notify user of an update iteration. Called in the update loop.

ISystemUserCallback::ShowMessage Method
C++
virtual int ShowMessage(const char* text, const char* caption, unsigned int uType);
Description

Show message by provider.