LeechCraft  0.6.70-15082-g543737046d
Modular cross-platform feature rich live environment.
Public Member Functions | List of all members
IScriptLoader Class Referenceabstract

Interface for plugins providing scripting. More...

#include "iscriptloader.h"

Public Member Functions

virtual ~IScriptLoader ()
 
virtual IScriptLoaderInstance_ptr CreateScriptLoaderInstance (const QString &relPath)=0
 Creates an instance of the script loader. More...
 

Detailed Description

Interface for plugins providing scripting.

This interface is to be implemented by plugins that support loading scripts if they wish to provide scripting support for other plugins.

Plugins that wish to load and execute scripts create instances of script loaders and use them for loading script objects.

See the documentation of IScriptLoaderInstance for details about script paths and such.

See also
IScriptLoaderInstance

Definition at line 186 of file iscriptloader.h.

Constructor & Destructor Documentation

◆ ~IScriptLoader()

virtual IScriptLoader::~IScriptLoader ( )
inlinevirtual

Definition at line 189 of file iscriptloader.h.

Member Function Documentation

◆ CreateScriptLoaderInstance()

virtual IScriptLoaderInstance_ptr IScriptLoader::CreateScriptLoaderInstance ( const QString &  relPath)
pure virtual

Creates an instance of the script loader.

The loader instance is the object that is used to load the scripts.

The script loader loads them from the (prefix + relPath) path, where path is one of paths later added to the instance's list of search paths via the IScriptLoaderInstance::AddGlobalPrefix() and IScriptLoaderInstance::AddLocalPrefix() functions.

Ownership is transferred to the caller.

Parameters
[in]relPathThe relative path of the scripts to be loaded.
Returns
The script loader for the given relative path.
The documentation for this class was generated from the following file: