ScummVM API documentation
Public Member Functions | List of all members
AGSMetaEngineDetection Class Reference
Inheritance diagram for AGSMetaEngineDetection:
AdvancedMetaEngineDetection< AGS::AGSGameDescription > AdvancedMetaEngineDetectionBase MetaEngineDetection PluginObject

Public Member Functions

const char * getName () const override
 
const char * getEngineName () const override
 
const char * getOriginalCopyright () const override
 
const DebugChannelDef * getDebugChannels () const override
 
DetectedGames detectGames (const Common::FSList &fslist, uint32 skipADFlags, bool skipIncomplete) override
 
ADDetectedGame fallbackDetect (const FileMap &allFiles, const Common::FSList &fslist, ADDetectedGameExtraInfo **extra=nullptr) const override
 
- Public Member Functions inherited from AdvancedMetaEngineDetectionBase
PlainGameList getSupportedGames () const override
 
PlainGameDescriptor findGame (const char *gameId) const override
 
uint getMD5Bytes () const override final
 
int getGameVariantCount () const override final
 
void dumpDetectionEntries () const override final
 

Additional Inherited Members

- Static Public Attributes inherited from MetaEngineDetection
static const char GAME_NOT_IMPLEMENTED []
 
- Protected Types inherited from AdvancedMetaEngineDetectionBase
typedef Common::HashMap< Common::Path, Common::FSNode, Common::Path::IgnoreCase_Hash, Common::Path::IgnoreCase_EqualTo > FileMap
 
- Protected Member Functions inherited from AdvancedMetaEngineDetection< AGS::AGSGameDescription >
 AdvancedMetaEngineDetection (const AGS::AGSGameDescription *descs, const PlainGameDescriptor *gameIds)
 
Common::Error identifyGame (DetectedGame &game, const void **descriptor) override
 
- Protected Member Functions inherited from AdvancedMetaEngineDetectionBase
 AdvancedMetaEngineDetectionBase (const void *descs, uint descItemSize, const PlainGameDescriptor *gameIds)
 
virtual ADDetectedGames detectGame (const Common::FSNode &parent, const FileMap &allFiles, Common::Language language, Common::Platform platform, const Common::String &extra, uint32 skipADFlags=0, bool skipIncomplete=false)
 
ADDetectedGame detectGameFilebased (const FileMap &allFiles, const ADFileBasedFallback *fileBasedFallback) const
 
void composeFileHashMap (FileMap &allFiles, const Common::FSList &fslist, int depth, const Common::Path &parentName=Common::Path()) const
 
bool getFileProperties (const FileMap &allFiles, MD5Properties md5prop, const Common::Path &fname, FileProperties &fileProps) const
 
virtual DetectedGame toDetectedGame (const ADDetectedGame &adGame, ADDetectedGameExtraInfo *extraInfo=nullptr) const
 
bool cleanupPirated (ADDetectedGames &matched) const
 
- Protected Attributes inherited from AdvancedMetaEngineDetectionBase
const byte * _gameDescriptors
 
const uint _descItemSize
 
const PlainGameDescriptor * _gameIds
 
uint _md5Bytes
 
uint32 _flags
 
Common::String _guiOptions
 
uint32 _maxScanDepth
 
const char *const * _directoryGlobs
 
int _maxAutogenLength
 
int _fullPathGlobsDepth
 

Member Function Documentation

◆ getName()

const char* AGSMetaEngineDetection::getName ( ) const
inlineoverridevirtual

Get the engine ID.

Implements MetaEngineDetection.

◆ getEngineName()

const char* AGSMetaEngineDetection::getEngineName ( ) const
inlineoverridevirtual

Get the engine name.

Implements MetaEngineDetection.

◆ getOriginalCopyright()

const char* AGSMetaEngineDetection::getOriginalCopyright ( ) const
inlineoverridevirtual

Return some copyright information about the original engine.

Implements MetaEngineDetection.

◆ getDebugChannels()

const DebugChannelDef* AGSMetaEngineDetection::getDebugChannels ( ) const
inlineoverridevirtual

Return a list of engine specified debug channels

If engine has no specified debug channels or not supported yet, then it will return NULL

Returns
A list of engine specified debug channels

Reimplemented from MetaEngineDetection.

◆ detectGames()

DetectedGames AGSMetaEngineDetection::detectGames ( const Common::FSList &  fslist,
uint32  skipADFlags,
bool  skipIncomplete 
)
overridevirtual

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.

Reimplemented from AdvancedMetaEngineDetectionBase.

◆ fallbackDetect()

ADDetectedGame AGSMetaEngineDetection::fallbackDetect ( const FileMap &  allFiles,
const Common::FSList &  fslist,
ADDetectedGameExtraInfo **  extra = nullptr 
) const
overridevirtual

An (optional) generic fallback detection function that is invoked if the regular MD5-based detection failed to detect anything.

Reimplemented from AdvancedMetaEngineDetectionBase.

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