ScummVM API documentation
Public Member Functions | Public Attributes | List of all members
M4MetaEngine Class Reference
Inheritance diagram for M4MetaEngine:
AdvancedMetaEngine< M4::M4GameDescription > AdvancedMetaEngineBase MetaEngine PluginObject

Public Member Functions

const char * getName () const override
 
Common::Error createInstance (OSystem *syst, Engine **engine, const M4::M4GameDescription *desc) const override
 
bool hasFeature (MetaEngineFeature f) const override
 
const ADExtraGuiOptionsMap * getAdvancedExtraGuiOptions () const override
 
SaveStateDescriptor querySaveMetaInfos (const char *target, int slot) const override
 
void getSavegameThumbnail (Graphics::Surface &thumb) override
 
- Public Member Functions inherited from AdvancedMetaEngineBase
Common::Error createInstance (OSystem *syst, Engine **engine, const DetectedGame &gameDescriptor, const void *metaEngineDescriptor) override
 
virtual ADDetectedGame fallbackDetectExtern (uint md5Bytes, const FileMap &allFiles, const Common::FSList &fslist, ADDetectedGameExtraInfo **extra=nullptr) const
 
bool getFilePropertiesExtern (uint md5Bytes, const FileMap &allFiles, MD5Properties md5prop, const Common::Path &fname, FileProperties &fileProps) const
 
- Public Member Functions inherited from MetaEngine
virtual SaveStateList listSaves (const char *target) const
 
SaveStateList listSaves (const char *target, bool saveMode) const
 
virtual int getAutosaveSlot () const
 
virtual int getMaximumSaveSlot () const
 
virtual bool removeSaveState (const char *target, int slot) const
 
virtual Common::String getSavegameFile (int saveGameIdx, const char *target=nullptr) const
 
Common::String getSavegameFilePattern (const char *target=nullptr) const
 
virtual Common::Array< Common::Keymap * > initKeymaps (const char *target) const
 
virtual void registerDefaultSettings (const Common::String &target) const
 
virtual GUI::OptionsContainerWidget * buildEngineOptionsWidget (GUI::GuiObject *boss, const Common::String &name, const Common::String &target) const
 
virtual Common::AchievementsPlatform getAchievementsPlatform (const Common::String &target) const
 
virtual const Common::AchievementsInfo getAchievementsInfo (const Common::String &target) const
 
virtual const Common::AchievementDescriptionList * getAchievementDescriptionList () const
 
void appendExtendedSave (Common::OutSaveFile *saveFile, uint32 playtime, Common::String desc, bool isAutosave)
 
void appendExtendedSaveToStream (Common::WriteStream *saveFile, uint32 playtime, Common::String desc, bool isAutosave, uint32 offset=0)
 
bool copySaveFileToFreeSlot (const char *target, int slot)
 

Public Attributes

Graphics::Surface * _thumbnail = nullptr
 

Additional Inherited Members

- Public Types inherited from AdvancedMetaEngineBase
typedef Common::HashMap< Common::Path, Common::FSNode, Common::Path::IgnoreCase_Hash, Common::Path::IgnoreCase_EqualTo > FileMap
 
- Public Types inherited from MetaEngine
enum  MetaEngineFeature {
  kSupportsListSaves, kSupportsLoadingDuringStartup, kSupportsDeleteSave, kSavesSupportMetaInfo,
  kSavesSupportThumbnail, kSavesSupportCreationDate, kSavesSupportPlayTime, kSimpleSavesNames,
  kSavesUseExtendedFormat
}
 
- Static Public Member Functions inherited from MetaEngine
static void parseSavegameHeader (ExtendedSavegameHeader *header, SaveStateDescriptor *desc)
 
static void fillDummyHeader (ExtendedSavegameHeader *header)
 
static void decodeSavegameDate (const ExtendedSavegameHeader *header, uint16 &outYear, uint8 &outMonth, uint8 &outDay)
 
static void decodeSavegameTime (const ExtendedSavegameHeader *header, uint8 &outHour, uint8 &outMinute)
 
static WARN_UNUSED_RESULT bool readSavegameHeader (Common::InSaveFile *in, ExtendedSavegameHeader *header, bool skipThumbnail=true)
 
- Protected Member Functions inherited from AdvancedMetaEngine< M4::M4GameDescription >
Common::Error createInstance (OSystem *syst, Engine **engine, const void *desc) const override final
 
void deleteInstance (Engine *engine, const DetectedGame &gameDescriptor, const void *meDescriptor) override
 
- Protected Member Functions inherited from AdvancedMetaEngineBase
const ExtraGuiOptions getExtraGuiOptions (const Common::String &target) const override final
 
bool checkExtendedSaves (MetaEngineFeature f) const
 
- Protected Member Functions inherited from MetaEngine
int findEmptySaveSlot (const char *target)
 

Member Function Documentation

◆ getName()

const char* M4MetaEngine::getName ( ) const
overridevirtual

Return the name of the engine plugin based on the engineID.

The engineID must match the one from MetaEngine.

See also
MetaEngine::getName().

Implements AdvancedMetaEngineBase.

◆ hasFeature()

bool M4MetaEngine::hasFeature ( MetaEngineFeature  f) const
overridevirtual

Determine whether the engine supports the specified MetaEngine feature.

Used by e.g. the launcher to determine whether to enable the Load button.

Reimplemented from MetaEngine.

◆ getAdvancedExtraGuiOptions()

const ADExtraGuiOptionsMap* M4MetaEngine::getAdvancedExtraGuiOptions ( ) const
overridevirtual

Returns a map containing all the extra game GUI options the engine supports.

Reimplemented from AdvancedMetaEngineBase.

◆ querySaveMetaInfos()

SaveStateDescriptor M4MetaEngine::querySaveMetaInfos ( const char *  target,
int  slot 
) const
overridevirtual

Return meta information from the specified save state.

Depending on the MetaEngineFeatures set, this can include thumbnails, save date and time, play time.

Parameters
targetName of a config manager target.
slotSlot number of the save state.

Reimplemented from MetaEngine.

◆ getSavegameThumbnail()

void M4MetaEngine::getSavegameThumbnail ( Graphics::Surface &  thumb)
overridevirtual

Convert the current screen contents to a thumbnail. Can be overriden by individual engine meta engines to provide their own thumb, such as hiding any on-screen save dialog so that it won't appear in the thumbnail.

Reimplemented from MetaEngine.

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