OpenBlox
A game engine which provides a simple and easy to learn Lua API.
OB::PluginManager Class Reference

#include <PluginManager.h>

Public Member Functions

 PluginManager (OBEngine *eng)
 
virtual ~PluginManager ()
 
std::map< std::string, shared_ptr< Plugin > > getPlugins ()
 
bool loadPlugin (std::string name, shared_ptr< Plugin > plugin)
 
void unloadPlugin (std::string name)
 
void tick ()
 

Detailed Description

The PluginManager class is the proper way to add functionality to OpenBlox. Many OpenBlox core events can be "hooked" into using this class.

Author
John M. Harris, Jr.

Constructor & Destructor Documentation

◆ PluginManager()

OB::PluginManager::PluginManager ( OBEngine eng)

◆ ~PluginManager()

virtual OB::PluginManager::~PluginManager ( )
virtual

Member Function Documentation

◆ getPlugins()

std::map<std::string, shared_ptr<Plugin> > OB::PluginManager::getPlugins ( )

Returns all currently loaded plugins.

Author
John M. Harris, Jr.

◆ loadPlugin()

bool OB::PluginManager::loadPlugin ( std::string  name,
shared_ptr< Plugin plugin 
)

Loads a plugin, if there is no plugin with the provided name already loaded.

Returns
true on success, false if the plugin could not be loaded.
Author
John M. Harris, Jr.

◆ tick()

void OB::PluginManager::tick ( )

◆ unloadPlugin()

void OB::PluginManager::unloadPlugin ( std::string  name)

Unloads the plugin specified by the first parameter. If there is no plugin with that name, this function is no-op.

Author
John M. Harris, Jr.

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