Events and Time

Description

Functions
virtual uint32	OSystem::getMillis (bool skipRecord=false)=0
virtual void	OSystem::delayMillis (uint msecs)=0
virtual void	OSystem::getTimeAndDate (TimeDate &td, bool skipRecord=false) const =0
virtual Common::TimerManager *	OSystem::getTimerManager ()
Common::EventManager *	OSystem::getEventManager ()
virtual Common::HardwareInputSet *	OSystem::getHardwareInputSet ()
virtual Common::KeymapArray	OSystem::getGlobalKeymaps ()
virtual Common::KeymapperDefaultBindings *	OSystem::getKeymapperDefaultBindings ()

Function Documentation

getMillis()

virtual uint32 OSystem::getMillis ( bool  skipRecord = false )

pure virtual

Get the number of milliseconds since the program was started.

Parameters

skipRecord

Skip recording of this value by the event recorder. This might be needed particularly when we are in an on-screen GUI loop where the player can pause the recording.

Implemented in OSystem_Android, OSystem_Wii, OSystem_N64, OSystem_Dreamcast, OSystem_DS, N3DS::OSystem_3DS, OSystem_iOS7, OSystem_PSP, OSystem_libretro, OSystem_SDL, and OSystem_Atari.

delayMillis()

virtual void OSystem::delayMillis ( uint  msecs )

pure virtual

Delay/sleep for the specified amount of milliseconds.

Implemented in OSystem_Android, OSystem_Wii, OSystem_N64, OSystem_Dreamcast, OSystem_DS, N3DS::OSystem_3DS, OSystem_iOS7, OSystem_PSP, OSystem_libretro, OSystem_SDL, and OSystem_Atari.

getTimeAndDate()

virtual void OSystem::getTimeAndDate ( TimeDate &  td, bool  skipRecord = false  ) const

pure virtual

Get the current time and date, in the local timezone.

On many systems, this corresponds to the combination of time() and localtime().

Implemented in OSystem_Android, OSystem_Wii, OSystem_N64, OSystem_Dreamcast, OSystem_PSP, OSystem_iOS7, OSystem_DS, N3DS::OSystem_3DS, OSystem_libretro, OSystem_SDL, and OSystem_Atari.

getTimerManager()

virtual Common::TimerManager* OSystem::getTimerManager ( )

virtual

Return the timer manager singleton.

For more information, see TimerManager.

Reimplemented in OSystem_SDL.

getEventManager()

Common::EventManager* OSystem::getEventManager ( )

inline

Return the event manager singleton.

For more information, see EventManager.

getHardwareInputSet()

virtual Common::HardwareInputSet* OSystem::getHardwareInputSet ( )

inlinevirtual

Register hardware inputs with keymapper.

Returns

HardwareInputSet with all keys and recommended mappings.

For more information, see keymapper.

Reimplemented in OSystem_Android, OSystem_DS, OSystem_iOS7, N3DS::OSystem_3DS, OSystem_SDL, OSystem_Atari, OSystem_PSP2, OSystem_SDL_Miyoo, OSystem_SDL_Opendingux, OSystem_Switch, and OSystem_PS3.

getGlobalKeymaps()

virtual Common::KeymapArray OSystem::getGlobalKeymaps ( )

inlinevirtual

Return a platform-specific global keymap.

Returns

Keymap with actions appropriate for the platform.

The caller will use and delete the return object.

For more information, see keymapper.

Reimplemented in OSystem_Android, N3DS::OSystem_3DS, OSystem_SDL, and OSystem_Atari.

getKeymapperDefaultBindings()

virtual Common::KeymapperDefaultBindings* OSystem::getKeymapperDefaultBindings ( )

inlinevirtual

Return platform-specific default keybindings.

Returns

KeymapperDefaultBindings populated with keybindings.

For more information, see keymapper.

Reimplemented in OSystem_Android, N3DS::OSystem_3DS, OSystem_SDL_Miyoo, and OSystem_SDL_Opendingux.