API Documentation
Script.h
1 // Script.h
3 //
5 
6 namespace nkScripts
7 {
13  class Script final : public nkExport::Exportable
14  {
15  public :
16 
20  Script () noexcept ;
24  virtual ~Script () ;
25 
26  // Getters
34  nkMemory::StringView getName () const ;
38  nkMemory::StringView getSources () const ;
43 
44  // Setters
50  void setTargetInterpreter (INTERPRETER interpreter) ;
58  void setName (nkMemory::StringView name) ;
64  void setSources (nkMemory::StringView sources) ;
65 
71  bool load () ;
75  void unload () ;
76 
82  virtual void exportClassToTree (nkExport::Node* rootNode) override ;
88  virtual void importClassFromTree (nkExport::Node* rootNode) override ;
89  } ;
90 }
nkScripts::Script::getName
nkMemory::StringView getName() const
nkScripts
Encompasses all API of component NilkinsScripts.
Definition: Environment.h:7
nkScripts::Script
Holds all information for a script.
Definition: Script.h:14
nkExport::Exportable
An interface to define objects that can be exported using this component.
Definition: Exportable.h:15
nkScripts::Script::getTargetInterpreter
INTERPRETER getTargetInterpreter() const
nkExport
Encompasses all API of component NilkinsExport.
Definition: Base64Encoder.h:7
nkScripts::Script::Script
Script() noexcept
nkScripts::Script::setTargetInterpreter
void setTargetInterpreter(INTERPRETER interpreter)
nkScripts::Script::importClassFromTree
virtual void importClassFromTree(nkExport::Node *rootNode) override
nkScripts::Script::getLastCompilationResult
const CompilationResult & getLastCompilationResult() const
nkScripts::Script::unload
void unload()
nkScripts::CompilationResult
Holds information about script loading attempt.
Definition: CompilationResult.h:24
nkScripts::INTERPRETER
INTERPRETER
Supported scripting environments.
Definition: Interpreter.h:12
nkScripts::Script::exportClassToTree
virtual void exportClassToTree(nkExport::Node *rootNode) override
nkScripts::Script::getSources
nkMemory::StringView getSources() const
nkScripts::Script::setSources
void setSources(nkMemory::StringView sources)
nkScripts::Script::setName
void setName(nkMemory::StringView name)
nkScripts::Script::load
bool load()
nkMemory
Encompasses all API of component NilkinsMemory.
Definition: Allocator.h:7