Subsystem modules

Description

For backend authors only, the following pointers (= "slots") to various subsystem managers / factories / etc. can and should be set to a suitable instance of the respective type.

For some of the slots, a default instance is set if your backend does not do so. For details, refer to the documentation of each slot.

A backend may set up slot values in its initBackend() method, its constructor, or somewhere in between. But it must set a slot's value no later than in its initBackend() implementation, because OSystem::initBackend() will create any default instances if none have been set yet (and for other slots, will verify that one has been set; if not, an error may be generated).

Functions
virtual Common::SaveFileManager *	OSystem::getSavefileManager ()
virtual Common::TextToSpeechManager *	OSystem::getTextToSpeechManager ()
virtual Common::DialogManager *	OSystem::getDialogManager ()
virtual DLC::Store *	OSystem::getDLCStore ()
virtual FilesystemFactory *	OSystem::getFilesystemFactory ()

Variables
AudioCDManager *	OSystem::_audiocdManager
Common::EventManager *	OSystem::_eventManager
Common::TimerManager *	OSystem::_timerManager
Common::SaveFileManager *	OSystem::_savefileManager
Common::TextToSpeechManager *	OSystem::_textToSpeechManager
Common::DialogManager *	OSystem::_dialogManager
FilesystemFactory *	OSystem::_fsFactory
DLC::Store *	OSystem::_dlcStore
Common::U32String	OSystem::_clipboard
bool	OSystem::_dummyUnused

Function Documentation

getSavefileManager()

virtual Common::SaveFileManager* OSystem::getSavefileManager ( )

virtual

Return the SaveFileManager, which is used to store and load savestates and other modifiable persistent game data.

For more information, see SaveFileManager.

Reimplemented in OSystem_SDL.

getTextToSpeechManager()

virtual Common::TextToSpeechManager* OSystem::getTextToSpeechManager ( )

inlinevirtual

Return the TextToSpeechManager, used to handle text-to-speech features.

Returns

The TextToSpeechManager for the current architecture.

getDialogManager()

virtual Common::DialogManager* OSystem::getDialogManager ( )

inlinevirtual

Return the DialogManager, which is used to handle system dialogs.

Returns

The DialogManager for the current architecture.

getDLCStore()

virtual DLC::Store* OSystem::getDLCStore ( )

inlinevirtual

Return the DLC Store, used to implement DLC manager functions.

Returns

The Store for the current architecture/distribution platform.

getFilesystemFactory()

virtual FilesystemFactory* OSystem::getFilesystemFactory ( )

virtual

Return the FilesystemFactory object, depending on the current architecture.

Returns

The FSNode factory for the current architecture.

Reimplemented in OSystem_Wii, and OSystem_PSP.

Variable Documentation

_audiocdManager

AudioCDManager* OSystem::_audiocdManager

protected

No default value is provided for _audiocdManager by OSystem. However, BaseBackend::initBackend() does set a default value if none has been set before.

Note

_audiocdManager is deleted by the OSystem destructor.

_eventManager

Common::EventManager* OSystem::_eventManager

protected

No default value is provided for _eventManager by OSystem. However, EventsBaseBackend::initBackend() does set a default value if none has been set before.

Note

_eventManager is deleted by the OSystem destructor.

_timerManager

Common::TimerManager* OSystem::_timerManager

protected

No default value is provided for _timerManager by OSystem.

Note

_timerManager is deleted by the OSystem destructor.

_savefileManager

Common::SaveFileManager* OSystem::_savefileManager

protected

No default value is provided for _savefileManager by OSystem.

Note

_savefileManager is deleted by the OSystem destructor.

_textToSpeechManager

Common::TextToSpeechManager* OSystem::_textToSpeechManager

protected

No default value is provided for _textToSpeechManager by OSystem.

Note

_textToSpeechManager is deleted by the OSystem destructor.

_dialogManager

Common::DialogManager* OSystem::_dialogManager

protected

No default value is provided for _dialogManager by OSystem.

Note

_dialogManager is deleted by the OSystem destructor.

_fsFactory

FilesystemFactory* OSystem::_fsFactory

protected

No default value is provided for _fsFactory by OSystem.

Note that _fsFactory is typically required very early on, so it usually should be set in the backends constructor or shortly thereafter, and before initBackend() is called.

Note

_fsFactory is deleted by the OSystem destructor.

_dlcStore

DLC::Store* OSystem::_dlcStore

protected

Used by the DLC Manager implementation

_clipboard

Common::U32String OSystem::_clipboard

protected

Used by the default clipboard implementation, for backends that don't implement clipboard support.

_dummyUnused

bool OSystem::_dummyUnused

protected

Workaround for a bug in the osx_intel toolchain introduced by 014bef9eab9fb409cfb3ec66830e033e4aaa29a9. Adding this variable fixes it.