ScummVM API documentation
DetectedGame Struct Reference

#include <game.h>

Public Member Functions

 DetectedGame (const Common::String &engine, const PlainGameDescriptor &pgd)
 
 DetectedGame (const Common::String &engine, 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(), bool unsupported=false)
 
void setGUIOptions (const Common::String &options)
 
void appendGUIOptions (const Common::String &str)
 
const Common::StringgetGUIOptions () const
 
void addExtraEntry (const Common::String &key, const Common::String &value)
 

Public Attributes

Common::String engineId
 
bool hasUnknownFiles
 
bool isSelected = false
 
FilePropertiesMap matchedFiles
 
bool canBeAdded
 
Common::String gameId
 
Common::String preferredTarget
 
Common::String description
 
Common::Language language
 
Common::Platform platform
 
Common::Path path
 
Common::String shortPath
 
Common::String extra
 
GameSupportLevel gameSupportLevel
 
Common::StringMap _extraConfigEntries
 

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.

Member Function Documentation

◆ addExtraEntry()

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

Member Data Documentation

◆ hasUnknownFiles

bool DetectedGame::hasUnknownFiles

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

◆ isSelected

bool DetectedGame::isSelected = false

A game was detected and is selected in the Mass Add list.

◆ matchedFiles

FilePropertiesMap DetectedGame::matchedFiles

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

◆ canBeAdded

bool DetectedGame::canBeAdded

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

See also
matchedGame

◆ gameSupportLevel

GameSupportLevel DetectedGame::gameSupportLevel

What level of support is expected of this game

◆ _extraConfigEntries

Common::StringMap DetectedGame::_extraConfigEntries

A list of extra keys to write to the configuration file


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