#include <metaengine.h>

Inheritance diagram for MetaEngineDetection:

Public Member Functions
virtual const char *	getName () const =0

virtual const char *	getEngineName () const =0

virtual const char *	getOriginalCopyright () const =0

virtual PlainGameList	getSupportedGames () const =0

virtual PlainGameDescriptor	findGame (const char *gameId) const =0

virtual DetectedGames	detectGames (const Common::FSList &fslist, uint32 skipADFlags=0, bool skipIncomplete=false)=0

virtual uint	getMD5Bytes () const =0

virtual int	getGameVariantCount () const

virtual void	dumpDetectionEntries () const =0

virtual const DebugChannelDef *	getDebugChannels () const

Detailed Description

A meta engine factory for Engine instances with the added ability of listing and detecting supported games.

Every engine "plugin" provides a hook to get an instance of a MetaEngineDetection subclass for that "engine plugin". For example, SCUMM provides ScummMetaEngineDetection. This is then in turn used by the frontend code to detect games, and other useful functionality.

To instantiate actual Engine objects, see the class MetaEngine.

Member Function Documentation

◆ getName()

virtual const char* MetaEngineDetection::getName ( ) const

pure virtual

Get the engine ID.

Implements PluginObject.

Implemented in UltimaMetaEngineDetection, AGSMetaEngineDetection, M4MetaEngineDetection, TwpMetaEngineDetection, TetraedgeMetaEngineDetection, CrabMetaEngineDetection, ImmortalMetaEngineDetection, and Hpl1MetaEngineDetection.

◆ getEngineName()

virtual const char* MetaEngineDetection::getEngineName ( ) const

pure virtual

Get the engine name.

Implemented in UltimaMetaEngineDetection, AGSMetaEngineDetection, M4MetaEngineDetection, TwpMetaEngineDetection, CrabMetaEngineDetection, TetraedgeMetaEngineDetection, ImmortalMetaEngineDetection, and Hpl1MetaEngineDetection.

◆ getOriginalCopyright()

virtual const char* MetaEngineDetection::getOriginalCopyright ( ) const

pure virtual

Return some copyright information about the original engine.

Implemented in UltimaMetaEngineDetection, AGSMetaEngineDetection, M4MetaEngineDetection, TwpMetaEngineDetection, TetraedgeMetaEngineDetection, CrabMetaEngineDetection, ImmortalMetaEngineDetection, and Hpl1MetaEngineDetection.

◆ getSupportedGames()

virtual PlainGameList MetaEngineDetection::getSupportedGames ( ) const

pure virtual

Return a list of games supported by this engine.

Implemented in AdvancedMetaEngineDetection.

◆ findGame()

virtual PlainGameDescriptor MetaEngineDetection::findGame ( const char * gameId ) const

pure virtual

Query the engine for a PlainGameDescriptor for the specified gameid, if any.

Implemented in AdvancedMetaEngineDetection.

◆ detectGames()

virtual DetectedGames MetaEngineDetection::detectGames	(	const Common::FSList &	fslist,
		uint32	skipADFlags = `0`,
		bool	skipIncomplete = `false`
	)

pure virtual

Run the engine's game detector on the given list of files, and return a (possibly empty) list of games supported by the engine that were found among the given files.

Implemented in AdvancedMetaEngineDetection, and AGSMetaEngineDetection.