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

Details about a given game. More...

#include <game.h>

Collaboration diagram for DetectedGame:

List of all members.

Public Member Functions

 DetectedGame ()
 DetectedGame (const PlainGameDescriptor &pgd)
 DetectedGame (const Common::String &id, const Common::String &description, Common::Language language=Common::UNK_LANG, Common::Platform platform=Common::kPlatformUnknown, const Common::String &extra=Common::String())
void setGUIOptions (const Common::String &options)
void appendGUIOptions (const Common::String &str)
Common::String getGUIOptions () const
void addExtraEntry (const Common::String &key, const Common::String &value)
 Allows adding of extra entries to be saved as part of the detection entry in the configuration file.

Public Attributes

const char * engineName
 The name of the engine supporting the detected game.
bool hasUnknownFiles
 A game was detected, but some files were not recognized.
FilePropertiesMap matchedFiles
 An optional list of the files that were used to match the game with the engine's detection tables.
bool canBeAdded
 This detection entry contains enough data to add the game to the configuration manager and launch it.
Common::String gameId
Common::String preferredTarget
Common::String description
Common::Language language
Common::Platform platform
Common::String path
Common::String shortPath
Common::String extra
GameSupportLevel gameSupportLevel
 What level of support is expected of this game.
Common::StringMap _extraConfigEntries
 A list of extra keys to write to the configuration file.

Private Member Functions

Common::String updateDesc () const
 Update the description string by appending (EXTRA/PLATFORM/LANG) to it.

Private Attributes

Common::String _guiOptions

Detailed Description

Details about a given game.

While PlainGameDescriptor refers to a game supported by an engine, this refers to a game copy that has been detected by an engine's detector. It contains all the necessary data to add the game to the configuration manager and / or to launch it.

Definition at line 99 of file game.h.


Constructor & Destructor Documentation

DetectedGame::DetectedGame (  ) 

Definition at line 52 of file game.cpp.

DetectedGame::DetectedGame ( const PlainGameDescriptor pgd  )  [explicit]

Definition at line 61 of file game.cpp.

DetectedGame::DetectedGame ( const Common::String id,
const Common::String description,
Common::Language  language = Common::UNK_LANG,
Common::Platform  platform = Common::kPlatformUnknown,
const Common::String extra = Common::String() 
)

Definition at line 74 of file game.cpp.


Member Function Documentation

void DetectedGame::addExtraEntry ( const Common::String key,
const Common::String value 
) [inline]

Allows adding of extra entries to be saved as part of the detection entry in the configuration file.

Remarks:
Any entry added using this should not be relied on being present in the configuration file, since starting games directly from the command line bypasses the game detection code

Definition at line 165 of file game.h.

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

Definition at line 95 of file game.cpp.

Common::String DetectedGame::getGUIOptions (  )  const [inline]

Definition at line 110 of file game.h.

void DetectedGame::setGUIOptions ( const Common::String options  ) 

Definition at line 91 of file game.cpp.

Common::String DetectedGame::updateDesc (  )  const [private]

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 102 of file game.cpp.


Member Data Documentation

A list of extra keys to write to the configuration file.

Definition at line 156 of file game.h.

Definition at line 176 of file game.h.

This detection entry contains enough data to add the game to the configuration manager and launch it.

See also:
matchedGame

Definition at line 137 of file game.h.

Definition at line 141 of file game.h.

The name of the engine supporting the detected game.

Definition at line 115 of file game.h.

Definition at line 146 of file game.h.

Definition at line 139 of file game.h.

What level of support is expected of this game.

Definition at line 151 of file game.h.

A game was detected, but some files were not recognized.

This can happen when the md5 or size of the detected files did not match the engine's detection tables. When this is true, the list of matched files below contains detail about the unknown files.

See also:
matchedFiles

Definition at line 125 of file game.h.

Definition at line 142 of file game.h.

An optional list of the files that were used to match the game with the engine's detection tables.

Definition at line 130 of file game.h.

Definition at line 144 of file game.h.

Definition at line 143 of file game.h.

Definition at line 145 of file game.h.


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


Generated on Sat Sep 14 2019 05:03:13 for ResidualVM by doxygen 1.7.1
curved edge   curved edge