ScummVM API documentation
Plugin Class Referenceabstract

#include <plugins.h>

Inheritance diagram for Plugin:
DynamicPlugin StaticPlugin

Public Member Functions

virtual bool loadPlugin ()=0
 
virtual void unloadPlugin ()=0
 
PluginType getType () const
 
const char * getName () const
 
template<class T >
T & get () const
 
virtual Common::Path getFileName () const
 

Protected Attributes

PluginObject_pluginObject
 
PluginType _type
 

Detailed Description

Abstract base class for the plugin system. Subclasses for this can be used to wrap both static and dynamic plugins. This class refers to a plugin which may or may not be loaded in memory.

Member Function Documentation

◆ getType()

PluginType Plugin::getType ( ) const

The following functions query information from the plugin object once it's loaded into memory.

◆ getFileName()

virtual Common::Path Plugin::getFileName ( ) const
inlinevirtual

The getFileName() function gets the name of the plugin file for those plugins that have files (ie. not static). It doesn't require the plugin object to be loaded into memory, unlike getName()

Reimplemented in DynamicPlugin.


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