API Documentation
Static Public Member Functions | List of all members
nkAstraeus::nkAstraeusWrap::LogWrapper Class Referencefinal

Wraps the nkAstraeus::LogManager, and offers functions to use it from a scripting environment. More...

Static Public Member Functions

static void updateEnvironment (nkScripts::Environment *env, LogManager *targetLogManager)
 
static nkScripts::OutputValue log (LogManager *targetLogManager, const nkScripts::DataStack &stack)
 

Detailed Description

Wraps the nkAstraeus::LogManager, and offers functions to use it from a scripting environment.

Member Function Documentation

◆ updateEnvironment()

static void nkAstraeus::nkAstraeusWrap::LogWrapper::updateEnvironment ( nkScripts::Environment env,
LogManager targetLogManager 
)
static

Updates a given environment and set it up to use all functions wrapped by this wrapper.

Parameters
envThe environment to set up.
targetLogManagerThe target log manager, should logging happen within the populated methods.

◆ log()

static nkScripts::OutputValue nkAstraeus::nkAstraeusWrap::LogWrapper::log ( LogManager targetLogManager,
const nkScripts::DataStack stack 
)
static

Wrapper function for LogManager::log. It also overrides the default printing method of the scripting environment.

nkLogLine("Hey") ;
print("Hey") ;
Parameters
targetLogManagerThe target log manager to log into.
stackThe parameter stack.
Returns
The output value, empty.

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