Nazara Engine  0.4
A fast, complete, cross-platform API designed for game development
Nz::PluginManager Class Reference

Core class that represents a manager for plugin. More...

Static Public Member Functions

static void AddDirectory (const String &directoryPath)
 Adds a directory. More...
 
static bool Initialize ()
 Initializes the plugin manager. More...
 
static bool Mount (Plugin plugin)
 Mounts the plugin. More...
 
static bool Mount (const String &pluginPath, bool appendExtension=true)
 Mounts the plugin with a path. More...
 
static void RemoveDirectory (const String &directoryPath)
 Removes a directory. More...
 
static void Unmount (Plugin plugin)
 Unmounts the plugin with a path. More...
 
static void Unmount (const String &pluginPath)
 Unmounts the plugin with a path. More...
 
static void Uninitialize ()
 Uninitializes the plugin manager.
 

Detailed Description

Core class that represents a manager for plugin.

Member Function Documentation

◆ AddDirectory()

void Nz::PluginManager::AddDirectory ( const String directoryPath)
static

Adds a directory.

Parameters
directoryPathPath to the directory
Remarks
Produces a NazaraError if not initialized

◆ Initialize()

bool Nz::PluginManager::Initialize ( )
static

Initializes the plugin manager.

Returns
true if everything is ok

◆ Mount() [1/2]

bool Nz::PluginManager::Mount ( Plugin  plugin)
static

Mounts the plugin.

Returns
true if mounting was a success
Remarks
Produces a NazaraError if not initialized
Produces a NazaraError if plugin is not found
Produces a NazaraError if fail to load plugin
Produces a NazaraError if fail to get symbol PluginLoad
Produces a NazaraError if fail to initialize the plugin with PluginLoad

◆ Mount() [2/2]

bool Nz::PluginManager::Mount ( const String pluginPath,
bool  appendExtension = true 
)
static

Mounts the plugin with a path.

Returns
true if mounting was a success
Parameters
pluginPathPath to the plugin
appendExtensionAdds the extension to the path or not
Remarks
Produces a NazaraError if not initialized
Produces a NazaraError if plugin is not found
Produces a NazaraError if fail to load plugin
Produces a NazaraError if fail to get symbol PluginLoad
Produces a NazaraError if fail to initialize the plugin with PluginLoad

◆ RemoveDirectory()

void Nz::PluginManager::RemoveDirectory ( const String directoryPath)
static

Removes a directory.

Parameters
directoryPathPath to the directory
Remarks
Produces a NazaraError if not initialized

◆ Unmount() [1/2]

void Nz::PluginManager::Unmount ( Plugin  plugin)
static

Unmounts the plugin with a path.

Parameters
pluginPathPath to the plugin
Remarks
Produces a NazaraError if not initialized
Produces a NazaraError if plugin is not loaded

◆ Unmount() [2/2]

void Nz::PluginManager::Unmount ( const String pluginPath)
static

Unmounts the plugin with a path.

Parameters
pluginPathPath to the plugin
Remarks
Produces a NazaraError if not initialized
Produces a NazaraError if plugin is not loaded

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