ScummVM API documentation
DetectionResults Class Reference

#include <game.h>

Public Member Functions

 DetectionResults (const DetectedGames &detectedGames)
 
DetectedGames listRecognizedGames () const
 
DetectedGames listDetectedGames () const
 
bool foundUnknownGames () const
 
Common::U32String generateUnknownGameReport (bool translate, uint32 wordwrapAt=0) const
 

Detailed Description

Contains a list of games found by the engines' detectors.

Each detected game can either:

  • be fully recognized (e.g. an exact match was found in the detection tables of an engine)
  • be an unknown variant (e.g. a game using files with the same name was found in the detection tables)
  • be recognized with unknown files (e.g. the game was exactly not found in the detection tables, but the detector was able to gather enough data to allow launching the game)

Practically, this means a detected game can be in both the recognized game list and in the unknown game report handled by this class.

Member Function Documentation

◆ listRecognizedGames()

DetectedGames DetectionResults::listRecognizedGames ( ) const

List all the games that were recognized by the engines

Recognized games can be added to the configuration manager and then launched.

◆ listDetectedGames()

DetectedGames DetectionResults::listDetectedGames ( ) const

List all the games that were detected

That includes entries that don't have enough information to be added to the configuration manager.

◆ foundUnknownGames()

bool DetectionResults::foundUnknownGames ( ) const

Were unknown game variants found by the engines?

When unknown game variants are found, an unknown game report can be generated.

◆ generateUnknownGameReport()

Common::U32String DetectionResults::generateUnknownGameReport ( bool  translate,
uint32  wordwrapAt = 0 
) const

Generate a report that we found an unknown game variant.

See also
generateUnknownGameReport

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