ResidualVM logo ResidualVM website - Forums - Contact us BuildBot - Doxygen - Wiki curved edge

GameDescriptor Class Reference

A hashmap describing details about a given game. More...

#include <game.h>

Inheritance diagram for GameDescriptor:
Collaboration diagram for GameDescriptor:

List of all members.

Public Member Functions

 GameDescriptor ()
 GameDescriptor (const PlainGameDescriptor &pgd, Common::String guioptions=Common::String())
 GameDescriptor (const Common::String &gameid, const Common::String &description, Common::Language language=Common::UNK_LANG, Common::Platform platform=Common::kPlatformUnknown, Common::String guioptions=Common::String(), GameSupportLevel gsl=kStableGame)
void updateDesc (const char *extra=0)
 Update the description string by appending (EXTRA/PLATFORM/LANG) to it.
void setGUIOptions (Common::String options)
void appendGUIOptions (const Common::String &str)
GameSupportLevel getSupportLevel ()
 What level of support is expected of this game.
void setSupportLevel (GameSupportLevel gsl)
Common::Stringgameid ()
Common::Stringdescription ()
const Common::Stringgameid () const
const Common::Stringdescription () const
Common::Language language () const
Common::Platform platform () const
const Common::Stringpreferredtarget () const

Detailed Description

A hashmap describing details about a given game.

In a sense this is a refined version of PlainGameDescriptor, as it also contains a gameid and a description string. But in addition, platform and language settings, as well as arbitrary other settings, can be contained in a GameDescriptor. This is an essential part of the glue between the game engines and the launcher code.

Definition at line 66 of file game.h.


Constructor & Destructor Documentation

GameDescriptor::GameDescriptor (  ) 

Definition at line 37 of file game.cpp.

GameDescriptor::GameDescriptor ( const PlainGameDescriptor pgd,
Common::String  guioptions = Common::String() 
)

Definition at line 42 of file game.cpp.

GameDescriptor::GameDescriptor ( const Common::String gameid,
const Common::String description,
Common::Language  language = Common::UNK_LANG,
Common::Platform  platform = Common::kPlatformUnknown,
Common::String  guioptions = Common::String(),
GameSupportLevel  gsl = kStableGame 
)

Definition at line 50 of file game.cpp.


Member Function Documentation

void GameDescriptor::appendGUIOptions ( const Common::String str  ) 

Definition at line 70 of file game.cpp.

const Common::String& GameDescriptor::description (  )  const [inline]

Definition at line 96 of file game.h.

Common::String& GameDescriptor::description (  )  [inline]

Definition at line 94 of file game.h.

const Common::String& GameDescriptor::gameid (  )  const [inline]

Definition at line 95 of file game.h.

Common::String& GameDescriptor::gameid (  )  [inline]

Definition at line 93 of file game.h.

GameSupportLevel GameDescriptor::getSupportLevel (  ) 

What level of support is expected of this game.

Definition at line 101 of file game.cpp.

Common::Language GameDescriptor::language (  )  const [inline]

Definition at line 97 of file game.h.

Common::Platform GameDescriptor::platform (  )  const [inline]

Definition at line 98 of file game.h.

const Common::String& GameDescriptor::preferredtarget (  )  const [inline]

Definition at line 100 of file game.h.

void GameDescriptor::setGUIOptions ( Common::String  options  ) 

Definition at line 63 of file game.cpp.

void GameDescriptor::setSupportLevel ( GameSupportLevel  gsl  ) 

Definition at line 113 of file game.cpp.

void GameDescriptor::updateDesc ( const char *  extra = 0  ) 

Update the description string by appending (EXTRA/PLATFORM/LANG) to it.

Values that are missing are omitted, so e.g. (EXTRA/LANG) would be added if no platform has been specified but a language and an extra string.

Definition at line 74 of file game.cpp.


The documentation for this class was generated from the following files:


Generated on Sat Jul 28 2018 05:01:19 for ResidualVM by doxygen 1.7.1
curved edge   curved edge