Games

Description

API for managing games by engines.

Classes
struct	PlainGameDescriptor
class	PlainGameList
struct	QualifiedGameDescriptor
struct	FileProperties
struct	DetectedGame
class	DetectionResults

Typedefs
typedef Common::Array< QualifiedGameDescriptor >	QualifiedGameList
typedef Common::HashMap< Common::Path, FileProperties, Common::Path::IgnoreCase_Hash, Common::Path::IgnoreCase_EqualTo >	FilePropertiesMap
typedef Common::HashMap< Common::String, FileProperties, Common::IgnoreCase_Hash, Common::IgnoreCase_EqualTo >	CachedPropertiesMap
typedef Common::Array< DetectedGame >	DetectedGames

Enumerations
enum	GameSupportLevel {   kStableGame = 0, kTestingGame, kUnstableGame, kUnsupportedGame,   kWarningGame }
enum	MD5Properties {   kMD5Head = 0 << 1, kMD5Tail = 1 << 1, kMD5MacResFork = 1 << 2, kMD5MacDataFork = 1 << 3,   kMD5MacResOrDataFork = kMD5MacResFork | kMD5MacDataFork, kMD5MacMask = kMD5MacResFork | kMD5MacDataFork, kMD5Archive = 1 << 4 }

Functions
const PlainGameDescriptor *	findPlainGameDescriptor (const char *gameid, const PlainGameDescriptor *list)
Common::String	md5PropToCachePrefix (MD5Properties val)
Common::U32String	generateUnknownGameReport (const DetectedGames &detectedGames, bool translate, bool fullPath, uint32 wordwrapAt=0)
Common::U32String	generateUnknownGameReport (const DetectedGame &detectedGame, bool translate, bool fullPath, uint32 wordwrapAt=0)

Typedef Documentation

FilePropertiesMap

typedef Common::HashMap<Common::Path, FileProperties, Common::Path::IgnoreCase_Hash, Common::Path::IgnoreCase_EqualTo> FilePropertiesMap

A map of all relevant existing files while detecting.

CachedPropertiesMap

typedef Common::HashMap<Common::String, FileProperties, Common::IgnoreCase_Hash, Common::IgnoreCase_EqualTo> CachedPropertiesMap

A map using a composed key to cache file properties

DetectedGames

typedef Common::Array<DetectedGame> DetectedGames

List of games.

Enumeration Type Documentation

GameSupportLevel

enum GameSupportLevel

Ths is an enum to describe how done a game is. This also indicates what level of support is expected.

MD5Properties

enum MD5Properties

This enum is used to indicate the method of MD5 calculation used for a particular file. The result is used for the more fine tuned reporting of unknown MD5s

Function Documentation

findPlainGameDescriptor()

const PlainGameDescriptor* findPlainGameDescriptor	(	const char *	gameid,
		const PlainGameDescriptor *	list
	)

Given a list of PlainGameDescriptors, returns the first PlainGameDescriptor matching the given gameid. If not match is found return 0. The end of the list must be marked by an entry with gameid 0.

generateUnknownGameReport()

Common::U32String generateUnknownGameReport	(	const DetectedGames &	detectedGames,
		bool	translate,
		bool	fullPath,
		uint32	wordwrapAt = 0
	)

Generate a report that we found an unknown game variant, together with the file names, sizes and MD5 sums.

Parameters

translate	translate the report to the currently active GUI language
fullPath	include the full path where the files are located, otherwise only the name of last component of the path is included
wordwrapAt	word wrap the text part of the report after a number of characters