ScummVM API documentation
Obsolete game IDs

Description

API for managing obsolete game IDs and updating the config file.

Classes

struct  Engines::ObsoleteGameID
 

Functions

void Engines::upgradeTargetIfNecessary (const ObsoleteGameID *obsoleteList)
 
PlainGameDescriptor Engines::findGameID (const char *gameid, const PlainGameDescriptor *gameids, const ObsoleteGameID *obsoleteList=0)
 

Function Documentation

◆ upgradeTargetIfNecessary()

void Engines::upgradeTargetIfNecessary ( const ObsoleteGameID obsoleteList)

Check if the currently active game target has an obsolete gameid; if so, replace it by the correct new gameid. This function is typically invoked by a MetaEngine::createInstance implementation.

◆ findGameID()

PlainGameDescriptor Engines::findGameID ( const char *  gameid,
const PlainGameDescriptor gameids,
const ObsoleteGameID obsoleteList = 0 
)

Scan through the given list of plain game descriptors specified and search for 'gameid' in there. If a match is found, returns a GameDescriptor with gameid and description set.

Optionally can take a list of obsolete game ids into account in order to support obsolete gameids.