Hymn to Beauty
C++ 3D Engine
ScriptFile Class Reference

Information about a file containing a script. More...

#include <ScriptFile.hpp>

Public Member Functions

Json::Value Save () const
 Saves the scriptfile to Json value. More...
 
void Load (const std::string &name)
 Loads the script information. More...
 

Public Attributes

std::string name = ""
 The name of the script. More...
 
std::string path
 The folder containing the script file. More...
 
std::string module = ""
 The name of the module. More...
 
std::vector< std::string > functionList
 A list containing all the functions for the script. More...
 

Detailed Description

Information about a file containing a script.

Member Function Documentation

◆ Load()

void ScriptFile::Load ( const std::string &  name)

Loads the script information.

Parameters
nameName of the script.

◆ Save()

Json::Value ScriptFile::Save ( ) const

Saves the scriptfile to Json value.

Returns
The saved data in a JSON node.

Member Data Documentation

◆ functionList

std::vector<std::string> ScriptFile::functionList

A list containing all the functions for the script.

◆ module

std::string ScriptFile::module = ""

The name of the module.

◆ name

std::string ScriptFile::name = ""

The name of the script.

◆ path

std::string ScriptFile::path

The folder containing the script file.


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