game.h File Reference

#include "common/array.h"
#include "common/hash-str.h"
#include "common/str.h"
#include "common/str-array.h"
#include "common/language.h"
#include "common/platform.h"

Include dependency graph for game.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	PlainGameDescriptor
	A simple structure used to map gameids (like "monkey", "sword1", ...) to nice human readable and descriptive game titles (like "The Secret of Monkey Island"). More...
class	PlainGameList
struct	QualifiedGameDescriptor
	The description of a game supported by an engine. More...
struct	FileProperties
	A record describing the properties of a file. More...
struct	DetectedGame
	Details about a given game. More...
class	DetectionResults
	Contains a list of games found by the engines' detectors. More...
Typedefs
typedef Common::Array < QualifiedGameDescriptor >	QualifiedGameList
typedef Common::HashMap < Common::String, FileProperties, Common::IgnoreCase_Hash, Common::IgnoreCase_EqualTo >	FilePropertiesMap
	A map of all relevant existing files while detecting.
typedef Common::Array < DetectedGame >	DetectedGames
	List of games.
Enumerations
enum	GameSupportLevel { kStableGame = 0, kTestingGame, kUnstableGame }
	Ths is an enum to describe how done a game is. More...
Functions
const PlainGameDescriptor *	findPlainGameDescriptor (const char *gameid, const PlainGameDescriptor *list)
	Given a list of PlainGameDescriptors, returns the first PlainGameDescriptor matching the given gameid.
Common::String	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.
Common::String	generateUnknownGameReport (const DetectedGame &detectedGame, bool translate, bool fullPath, uint32 wordwrapAt=0)

---

Typedef Documentation

typedef Common::Array<DetectedGame> DetectedGames

List of games.

Definition at line 189 of file game.h.

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

A map of all relevant existing files while detecting.

Definition at line 102 of file game.h.

typedef Common::Array<QualifiedGameDescriptor> QualifiedGameList

Definition at line 76 of file game.h.

---

Enumeration Type Documentation

enum GameSupportLevel

Ths is an enum to describe how done a game is.

This also indicates what level of support is expected.

Enumerator:

kStableGame
kTestingGame
kUnstableGame

Definition at line 81 of file game.h.

---

Function Documentation

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.

Definition at line 28 of file game.cpp.

Common::String generateUnknownGameReport	(	const DetectedGame &	detectedGame,
		bool	translate,
		bool	fullPath,
		uint32	wordwrapAt = 0
	)

Definition at line 240 of file game.cpp.

Common::String 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

Definition at line 176 of file game.cpp.