ADGameDescription Struct Reference

#include <advancedDetector.h>

Public Member Functions
uint32	sizeBuffer () const
void *	toBuffer (void *buffer)

Public Attributes
const char *	gameId
const char *	extra
ADGameFileDescription	filesDescriptions [14]
Common::Language	language
Common::Platform	platform
uint32	flags
const char *	guiOptions

Detailed Description

Data table describing a game variant.

Member Function Documentation

sizeBuffer()

uint32 ADGameDescription::sizeBuffer ( ) const

inline

Calculates the size needed to store all pointed data

toBuffer()

void* ADGameDescription::toBuffer ( void *  buffer )

inline

Fixup all pointers to lie inside buffer and stores the needed data in it

Parameters

buffer

Where the original data is copied in and pointed at

Returns

The new pointer on buffer after the stored data.

Member Data Documentation

gameId

const char* ADGameDescription::gameId

The gameid that identifies the game.

Mainly used for taking the game description from the PlainGameDescriptor table.

extra

const char* ADGameDescription::extra

Field that is used to distinguish between different variants of a game.

The content of this field is inserted in the generated description for the config file game entry. If the kADFlagUseExtraAsHint ADFlag is set, the contents of this field are stored in the config file, and are used to additionally distinguish between game variants. Also, if the ADGF_USEEXTRAASTITLE game flag is set, the contents of this field will be used as a description instead the one extracted from the PlainGameDescriptor table.

filesDescriptions

ADGameFileDescription ADGameDescription::filesDescriptions[14]

A list of individual file entries used for detection.

13 files (last is zero-terminated) is the maximum number of files currently used in ScummVM. A hardcoded number is used here due to a C++ limitation for defining const arrays.

language

Common::Language ADGameDescription::language

Language of the game variant.

platform

Common::Platform ADGameDescription::platform

Platform of the game variant.

flags

uint32 ADGameDescription::flags

A bitmask of extra flags.

The top 16 bits are reserved for generic flags defined in ADGameFlags. This leaves 16 bits to be used by the client code.

guiOptions

const char* ADGameDescription::guiOptions

Game features that are user-controllable.

This list reflects which features of the GUI should be turned on or off in order to minimize user confusion. For instance, there is no point in changing game language in single-language games or have MIDI controls in a game that only supports digital music.

---

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

• engines/advancedDetector.h