 |
API Documentation
|
|
|
bool isNamespaceSet(nkMemory::StringView name)
void setVar(nkMemory::StringView name, const ScriptObjectReference &value)
UserType * getUserType(nkMemory::StringView name)
Defines an environment in which scripts can execute.
Definition: Environment.h:14
Encompasses all API of component NilkinsScripts.
Definition: Environment.h:7
bool isUserTypeSet(nkMemory::StringView name)
Holds information and allow control over a namespace in a scripting environment.
Definition: Namespace.h:12
Holds all information for a script.
Definition: Script.h:14
UserType * setUserType(nkMemory::StringView name)
A view over data.
Definition: BufferView.h:18
void setEnvironmentFor(INTERPRETER interpretType)
double getVar(nkMemory::StringView name, double defaultValue)
void * getObject(nkMemory::StringView name, nkMemory::StringView userTypeName=nullptr)
int getVar(nkMemory::StringView name, int defaultValue)
bool isFuncSet(nkMemory::StringView name)
bool getVar(nkMemory::StringView name, bool defaultValue)
void setVar(nkMemory::StringView name, int value)
Represents a user type and all the information and control related.
Definition: UserType.h:27
A buffer holding binary data.
Definition: Buffer.h:32
Function * getFunc(nkMemory::StringView name)
bool isVarSet(nkMemory::StringView name)
A reference over an object in the scripting environment.
Definition: ScriptObjectReference.h:30
void setObject(nkMemory::StringView name, nkMemory::StringView userTypeName, void *value)
bool callScriptFunction(const ScriptObjectReference &reference, const DataStack &args, DataStack &expectedOutput)
void setVar(nkMemory::StringView name, double value)
Smart pointer owning the object instance it encapsulates.
Definition: UniquePtr.h:17
float getVar(nkMemory::StringView name, float defaultValue)
Function * setFunc(nkMemory::StringView name)
Namespace * getNamespace(nkMemory::StringView name)
Class holding information about a string, with no ownership over the data.
Definition: StringView.h:22
Holds information about the execution result of a script in an environment.
Definition: ExecutionResult.h:26
INTERPRETER
Supported scripting environments.
Definition: Interpreter.h:12
Namespace * setNamespace(nkMemory::StringView name)
void setVar(nkMemory::StringView name, nkMemory::StringView value)
void requestGarbageCollection()
nkMemory::StringView getVar(nkMemory::StringView name, const char *defaultValue)
void setVar(nkMemory::StringView name, const char *value)
nkMemory::StringView getName() const
bool execute(const Script &script)
ScriptObjectReference deserializeScriptObject(nkMemory::BufferView< unsigned char > object)
nkMemory::StringView getVar(nkMemory::StringView name, nkMemory::StringView defaultValue)
void setVar(nkMemory::StringView name, bool value)
ScriptObjectReference getScriptFunction(nkMemory::StringView name)
Holds information, and controls, over a function in a scripting environment.
Definition: Function.h:50
ScriptObjectReference getVar(nkMemory::StringView name)
void setVar(nkMemory::StringView name, float value)
nkMemory::Buffer serializeScriptObject(const ScriptObjectReference &reference, bool forwardUserDataOwnership=false)
const ExecutionResult & getLastExecutionResult() const
void setName(nkMemory::StringView name)
static nkMemory::UniquePtr< Environment > create() noexcept
Encompasses all API of component NilkinsMemory.
Definition: Allocator.h:7