ScummVM API documentation

Description

API for managing various functions of the engine.

Classes

class  PauseToken
 
class  Engine
 
class  ChainedGamesManager
 

Functions

void GUIErrorMessage (const Common::U32String &msg, const char *url=nullptr)
 
void GUIErrorMessage (const Common::String &msg, const char *url=nullptr)
 
void GUIErrorMessageWithURL (const Common::U32String &msg, const char *url)
 
void GUIErrorMessageWithURL (const Common::String &msg, const char *url)
 
void GUIErrorMessageFormatU32StringPtr (const Common::U32String *fmt,...)
 
template<class... TParam>
void GUIErrorMessageFormat (const Common::U32String &fmt, TParam... param)
 
void GUIErrorMessageFormat (MSVC_PRINTF const char *fmt,...) GCC_PRINTF(1
 

Variables

Engineg_engine
 

Chained games

#define ChainedGamesMan   ChainedGamesManager::instance()
 

Macro Definition Documentation

◆ ChainedGamesMan

#define ChainedGamesMan   ChainedGamesManager::instance()

Convenience shortcut for accessing the chained games manager.

Function Documentation

◆ GUIErrorMessage() [1/2]

void GUIErrorMessage ( const Common::U32String msg,
const char *  url = nullptr 
)

Initialize graphics and show an error message.

◆ GUIErrorMessage() [2/2]

void GUIErrorMessage ( const Common::String msg,
const char *  url = nullptr 
)

Initialize graphics and show an error message.

◆ GUIErrorMessageWithURL() [1/2]

void GUIErrorMessageWithURL ( const Common::U32String msg,
const char *  url 
)

Initialize graphics and show an error message.

◆ GUIErrorMessageWithURL() [2/2]

void GUIErrorMessageWithURL ( const Common::String msg,
const char *  url 
)

Initialize graphics and show an error message.

◆ GUIErrorMessageFormatU32StringPtr()

void GUIErrorMessageFormatU32StringPtr ( const Common::U32String fmt,
  ... 
)

Initialize graphics and show an error message.

◆ GUIErrorMessageFormat() [1/2]

template<class... TParam>
void GUIErrorMessageFormat ( const Common::U32String fmt,
TParam...  param 
)
inline

Initialize graphics and show an error message.

◆ GUIErrorMessageFormat() [2/2]

void GUIErrorMessageFormat ( MSVC_PRINTF const char *  fmt,
  ... 
)

Initialize graphics and show an error message.

Variable Documentation

◆ g_engine

Engine* g_engine

Current workaround for MidiEmu & error().