Scumm::GameSettings Struct Reference

#include <detection.h>

Public Attributes
const char *	gameid
const char *	variant
const char *	preferredTag
byte	id
byte	version
byte	heversion
int	midi
uint32	features
Common::Platform	platform
const char *	guioptions

Detailed Description

Descriptor of a specific SCUMM game. Used internally to store information about the tons of game variants that exist.

Member Data Documentation

gameid

const char* Scumm::GameSettings::gameid

The gameid of this game.

variant

const char* Scumm::GameSettings::variant

An identifier which can be used to distinguish game variants. This string is also used to augment the description string generated by the detector, and to search the gameFilenamesTable. It is also used to search the MD5 table (it matches the "extra" data in scumm-md5.txt).

Equal to 0 (zero) if and only if the game has precisely one variant. Failing to obey this rule can lead to odd bugs.

preferredTag

const char* Scumm::GameSettings::preferredTag

An optional string that will be added to the 'preferredtarget' computed by the detector.

id

byte Scumm::GameSettings::id

The numerical gameid of this game. This is not in one-to-one correspondence with the gameid above. But if two games settings have the same id (except for GID_HEGAME), then they also have the same gameid ; the converse does not hold in general.

version

byte Scumm::GameSettings::version

The SCUMM version.

heversion

byte Scumm::GameSettings::heversion

The HE subversion.

midi

int Scumm::GameSettings::midi

MidiDriverFlags values

features

uint32 Scumm::GameSettings::features

Bitmask obtained by ORing various GameFeatures enums, and used to en-/disable certain features of this game variant.

platform

Common::Platform Scumm::GameSettings::platform

Platform indicator, this is set to a value different from kPlatformUnknown if this game variant only existed for this specific platform.

guioptions

const char* Scumm::GameSettings::guioptions

Game GUI options. Used to enable/disable certain GUI widgets

---

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

• engines/scumm/detection.h