API Documentation
ScriptsEngine.h
1 // ScriptEngine.h
3 //
5 
6 namespace nkAstraeus
7 {
13  class ScriptsEngine final
14  {
15  public :
16 
17  // Constructor, destructor
23  ScriptsEngine (System* system = nullptr) noexcept ;
28 
29  // Getters
33  nkScripts::Environment* getEnvironment () const ;
34 
35  // Lifetime
42  bool initialize () ;
46  void shutdown () ;
47 
48  public :
49 
50  // Statics
58  static void setupScriptsEnvironment (nkScripts::Environment* environment, LogManager* targetLogManager) ;
59  } ;
60 }
nkAstraeus::ScriptsEngine::getEnvironment
nkScripts::Environment * getEnvironment() const
nkScripts
Encompasses all API of component NilkinsScripts.
Definition: Environment.h:7
nkAstraeus::System
The main entry point for nkAstraeus engine.
Definition: System.h:15
nkAstraeus::LogManager
Responsible for logging all messages from the component. By registering a nkLog::Logger inside,...
Definition: LogManager.h:13
nkAstraeus::ScriptsEngine
Drives the scripting sub engine.
Definition: ScriptsEngine.h:14
nkAstraeus::ScriptsEngine::setupScriptsEnvironment
static void setupScriptsEnvironment(nkScripts::Environment *environment, LogManager *targetLogManager)
nkAstraeus
Encompasses all API of component NilkinsAstraeus.
Definition: BlurComplexEffect.h:7
nkAstraeus::ScriptsEngine::initialize
bool initialize()
nkAstraeus::ScriptsEngine::shutdown
void shutdown()
nkAstraeus::ScriptsEngine::ScriptsEngine
ScriptsEngine(System *system=nullptr) noexcept