struct CCL::IScriptingEnvironment

Overview

#include <iscriptingmanager.h>

struct IScriptingEnvironment: public CCL::IUnknown
{
    // methods

    virtual tbool CCL_API isScriptFile (UrlRef path) = 0;

    virtual Scripting::IScript*CCL_API loadScript (
        UrlRef path,
        StringRef packageID = nullptr
    ) = 0;

    virtual Scripting::IScript*CCL_API createScript (
        IStream& stream,
        StringRef fileName,
        StringRef packageID = nullptr,
        IUnknown* package = nullptr
    ) = 0;

    virtual tbool CCL_API executeScript (Variant& returnValue, ScriptRef script) = 0;
    virtual IObject*CCL_API compileScript (ScriptRef script) = 0;
};

Inherited Members

public:
    // methods

    virtual tresult CCL_API queryInterface (UIDRef iid, void** ptr) = 0;
    virtual unsigned int CCL_API retain () = 0;
    virtual unsigned int CCL_API release () = 0;

Detailed Documentation

Methods

virtual tbool CCL_API isScriptFile (UrlRef path) = 0

Check if path points to a script file.

virtual Scripting::IScript*CCL_API loadScript (
    UrlRef path,
    StringRef packageID = nullptr
) = 0

Load script from file.

virtual Scripting::IScript*CCL_API createScript (
    IStream& stream,
    StringRef fileName,
    StringRef packageID = nullptr,
    IUnknown* package = nullptr
) = 0

Create script object from stream and filename.

virtual tbool CCL_API executeScript (Variant& returnValue, ScriptRef script) = 0

Execute script resource directly.

virtual IObject*CCL_API compileScript (ScriptRef script) = 0

Compile script resource.